{ "libs": [ { "path": "@wix/wix-code-types/dist/types/common/wix-sdk-contextual-client.d.ts", "content": "type Primitive = number | string | boolean | bigint | symbol | null | undefined;\ntype Tags = Record;\ntype Context = Record;\ntype Contexts = Record;\ninterface SpanContextData {\n traceId: string;\n spanId: string;\n}\ninterface Span {\n spanContext(): SpanContextData;\n end(): void;\n}\ninterface ManualSpan {\n end(): void;\n fail(error: unknown): void;\n}\ninterface SpanOptions {\n name: string;\n tags?: Tags;\n}\ninterface EndSpanOptions {\n name: string;\n}\ninterface Breadcrumb {\n type?: string;\n category?: string;\n message: string;\n level?: \"info\" | \"warning\" | \"error\";\n data?: Record;\n}\ninterface CaptureContext {\n level?: \"info\" | \"warning\" | \"error\";\n tags?: Tags;\n contexts?: Contexts;\n}\ninterface MonitoringClient {\n /**\n * Captures an exception event and sends it to Sentry.\n * @param error The error to capture\n * @param captureContext Optional additional data to attach to the Sentry e vent.\n */\n captureException(error: unknown, captureContext?: CaptureContext): void;\n /**\n * Captures a message event and sends it to Sentry.\n * @param message The message to capture\n * @param captureContext Define the level of the message or pass in additional data to attach to the message.\n */\n captureMessage(message: string, captureContext?: CaptureContext): void;\n /**\n * Wraps a function with a span and finishes the span after the function is done. The created span is the active span and will be used as parent by other spans created inside the function, as long as the function is executed while the scope is active.\n * @param spanOptions The options for the span\n * @param callback The function to wrap with a span\n * @returns The return value of the callback\n */\n startSpan(spanOptions: SpanOptions, callback: (span: Span | undefined) => T): T;\n /**\n * Starts a manual span. The span needs to be finished manually by either calling end() or fail() using the returned span object or by calling endSpanManual().\n * @param spanOptions The options for the span\n * @returns A span object that allows to end the span successfully or fail it.\n */\n startSpanManual(spanOptions: SpanOptions): ManualSpan;\n /**\n * Ends a manual span and sends it to Sentry. Spans can be ended using a MonitoringClient instance which wasn't necessarily used to start the span.\n * Calling this method will end the last span with the same name that was started using startSpanManual() and will ignore the others.\n * @param spanOptions The options for the span\n */\n endSpanManual(spanOptions: EndSpanOptions): void;\n /**\n * Records a new breadcrumb which will be attached to future events.\n * Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.\n * @param breadcrumb The breadcrumb to record.\n */\n addBreadcrumb(breadcrumb: Breadcrumb): void;\n}\ninterface PlatformShowErrorProps {\n message?: string;\n action?: {\n text: string;\n onClick: () => void;\n };\n requestId?: string | null;\n}\ntype PlatformShowError = (props: PlatformShowErrorProps) => void;\ndeclare global {\n // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.\n interface SymbolConstructor {\n readonly observable: symbol;\n }\n}\ntype Host = {\n channel?: {\n observeState(callback: (props: unknown, environment: Environment) => unknown): {\n disconnect: () => void;\n } | Promise<{\n disconnect: () => void;\n }>;\n };\n environment?: Environment;\n /**\n * Optional name of the environment, use for logging\n */\n name?: string;\n /**\n * Optional bast url to use for API requests, for example `www.wixapis.com`\n */\n apiBaseUrl?: string;\n /**\n * Optional function to get a monitoring client\n */\n getMonitoringClient?: () => MonitoringClient;\n /**\n * Optional function to display an error notification to the user.\n * Can be used to show a toast, modal, or any other UI element\n * that informs the user about an error that occurred.\n */\n showError?: PlatformShowError;\n /**\n * Possible data to be provided by every host, for cross cutting concerns\n * like internationalization, billing, etc.\n */\n essentials?: {\n /**\n * The language of the currently viewed session\n */\n language?: string;\n /**\n * The locale of the currently viewed session\n */\n locale?: string;\n /**\n * The timezone of the currently viewed session\n */\n timezone?: string;\n /**\n * Any headers that should be passed through to the API requests\n */\n passThroughHeaders?: Record;\n };\n};\ndeclare global {\n interface ContextualClient {\n }\n}\ndeclare global {\n /**\n * A global interface to set the exposure toggle for the SDK.\n * @example\n * ```ts\n * declare global {\n * interface SDKExposureToggle {\n * alpha: true;\n * }\n * }\n */\n interface SDKExposureToggle {\n }\n}\ndeclare global {\n /**\n * A global interface to set the type mode for the SDK.\n * @example\n * ```ts\n * declare global {\n * interface SDKTypeMode {\n * strict: true;\n * }\n * }\n */\n interface SDKTypeMode {\n }\n}\ndeclare global {\n interface ContextualClient {\n host: Host;\n }\n}\nexport { Host };\n" }, { "path": "@wix/wix-code-types/dist/types/common/anyProperties.d.ts", "content": "declare interface AnyProperties {\n [prop: string]: any;\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/$w.d.ts", "content": "import wixDataset from 'wix-dataset';\ndeclare global {\n /**\n * The `$w` namespace contains everything you need in order to work\n * with your site's components.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.html#)\n */\n namespace $w {\n /**\n * An object used to customize the opening of a comment box.\n */\n type CommentBoxOptions = {\n /**\n * When `true`, the comment box opens, focuses, and displays an action bar.\n * When `false`, the comment box just opens. Defaults to `true`.\n */\n focus?: boolean;\n /**\n * When `true`, the comment box is scrolled into view. Defaults to `true`.\n */\n scroll?: boolean;\n };\n /**\n * An object containing data about the newly created comment in the `WixComments` element.\n */\n type WidgetComment = {\n /**\n * Comment author.\n */\n authorName: string;\n /**\n * Date and time the comment was created.\n */\n createdDate: string;\n /**\n * Comment ID.\n */\n commentId: string;\n /**\n * Comment ID of the parent comment. If the comment is a top-level comment, the value is `undefined`.\n */\n parentCommentId: string;\n /**\n * The plain text content of the comment.\n */\n content: string;\n /**\n * Comment type.\n * + `COMMENT`: An original or initial comment inside the comments thread. This comment is a parent comment.\n * + `REPLY`: A response to a parent comment.\n */\n type: string;\n };\n type dataset = wixDataset.Dataset;\n type router_dataset = wixDataset.DynamicDataset;\n type BasicEventHandler = () => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type CheckboxGroupValidator = (value: string[], reject: Function) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type CheckboxValidator = (value: string, reject: Function) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type DatePickerValidator = (value: Date, reject: Function) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type DropdownValidator = (value: string, reject: Function) => void;\n type EventHandler = (event: Event) => void;\n type ForItemCallback = ($item: $w, itemData: any, index: number) => void;\n /**\n * Handles events fired when a gallery moves to a new image.\n */\n type GalleryItemChangedEventHandler = (event: GalleryItemChangedEvent) => void;\n /**\n * Handles events fired when an image in a gallery is clicked.\n */\n type GalleryItemClickedEventHandler = (event: GalleryItemClickedEvent) => void;\n /**\n * Handles events fired when a gallery starts navigation.\n */\n type GalleryNavigationStartEventHandler = (event: GalleryNavigationStartEvent) => void;\n /**\n * Handles events fired when the code in an HtmlComponent sends a message.\n */\n type HtmlComponentMessageEventHandler = (event: HtmlComponentMessageEvent) => void;\n type HtmlElementEventHandler = (event: HtmlComponentMessageEvent) => void;\n /**\n * Handles events fired when a user hovers over a star on the rating component.\n */\n type IconMouseInEventHandler = (event: IconMouseInEvent) => void;\n type ItemReadyEventHandler = ($item: $w, itemData: any, index: number) => void;\n type ItemRemovedEventHandler = (itemData: any) => void;\n /**\n * Handles events fired when the keyboard is pressed.\n */\n type KeyboardEventHandler = (event: KeyboardEvent) => void;\n /**\n * Handles events fired when the mouse is used on a menu item.\n */\n type MenuItemMouseEventHandler = (event: MenuItemMouseEvent) => void;\n /**\n * Handles events fired when the mouse is clicked.\n */\n type MouseEventHandler = (event: MouseEvent) => void;\n /**\n * The callback function that runs when a comment is added or removed from the `WixComments` element.\n */\n type OnCommentCountChangeCallback = (count: number) => void;\n /**\n * The callback function that runs when a new comment is created in the `WixComments` element.\n */\n type OnCommentCreateCallback = (comment: WidgetComment) => void;\n /**\n * Handles events fired when an item in a quick action bar is clicked.\n */\n type QuickActionBarItemClickedEventHandler = (event: QuickActionBarItemClickedEvent) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type RadioButtonGroupValidator = (value: string, reject: Function) => void;\n /**\n * Function that runs when all page elements have finished loading.\n */\n type ReadyHandler = () => Promise | void;\n /**\n * Handles events fired when a table cell is selected.\n */\n type TableCellEventHandler = (event: TableCellEvent) => void;\n /**\n * Handles events fired when a table row is selected.\n */\n type TableRowEventHandler = (event: TableRowEvent) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type TextBoxValidator = (value: string, reject: Function) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type TextInputValidator = (value: string, reject: Function) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type UploadButtonValidator = (value: UploadButton.File[], reject: Function) => void;\n /**\n * Function that runs when custom validation is checked.\n */\n type Validator = (value: any, reject: Function) => void;\n type ViewChangeEventHandler = (event: ViewChangeEvent) => void;\n type ViewChangeOperation = (options: AppointmentField.OperationOptions) => any;\n /**\n * An [accordion element](https://support.wix.com/en/article/editor-x-adding-and-customizing-an-accordion-5177642#adding-and-managing-accordion-items)\n * is a container that holds multiple collapsible accordion item elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Accordion.html#)\n */\n interface Accordion extends Element {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Accordion.html#accessibility)\n */\n readonly accessibility: Accordion.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Accordion.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Accordion.html#tabIndex)\n */\n tabIndex: number;\n }\n /**\n * The [account nav bar](https://support.wix.com/en/article/site-members-adding-and-customizing-your-login-bar) is the menu in a user profile.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AccountNavBar.html#)\n */\n interface AccountNavBar extends Element, HiddenCollapsedMixin {\n }\n /**\n * [Address input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-an-address-input-element)\n * is used for entering addresses. It lets users type\n * an address, and suggests exact locations using Google Maps services.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#)\n */\n interface AddressInput extends LabelMixin, FormElement, DisabledMixin, RequiredMixin, ReadOnlyMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#accessibility)\n */\n readonly accessibility: AddressInput.Accessibility;\n /**\n * Sets or gets the filter of the address input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#filter)\n */\n filter: AddressInput.AddressFilter;\n /**\n * Sets or gets the placeholder of the address input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#placeholder)\n */\n placeholder: string;\n /**\n * Sets or gets the value of the address input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#value)\n */\n value: AddressInput.Address;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#onCustomValidation)\n */\n onCustomValidation(validator: AddressInput.AddressInputValidator, override?: boolean): void;\n }\n /**\n * [Anchors](https://www.wix.com/support/html5/article/about-anchors)\n * are invisible position markers which you can place anywhere on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Anchor.html#)\n */\n interface Anchor extends Node, ViewportMixin {\n /**\n * Gets the name of an anchor.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Anchor.html#name)\n */\n readonly name: string;\n }\n /**\n * Use an `AppointmentField` to select dates, times, and timezones for scheduling appointments.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#)\n */\n interface AppointmentField extends FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, RequiredMixin {\n /**\n * Sets or gets a list of dates and times that a site visitor can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#dateTimeRanges)\n */\n dateTimeRanges: AppointmentField.dateTimeRangeInfo;\n /**\n * Sets or gets a list of days in the week that are not selectable.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#disabledDaysOfWeek)\n */\n disabledDaysOfWeek: number[];\n /**\n * Sets or gets the latest date that a site visitor can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#maxDate)\n */\n maxDate: Date;\n /**\n * Sets or gets the earliest date that a site visitor can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#minDate)\n */\n minDate: Date;\n /**\n * Sets or gets the minimum amount of time before an appointment starts that a time slot is displayed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#schedulingNotice)\n */\n schedulingNotice: number;\n /**\n * Sets or gets the interval between the times displayed in the time picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#timeIncrements)\n */\n timeIncrements: number;\n /**\n * Sets or gets the title of an appointment field.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#title)\n */\n title: string;\n /**\n * Sets or gets the time format.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#useAmPmFormat)\n */\n useAmPmFormat: boolean;\n /**\n * Sets or gets the date and time value of the appointment field.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#value)\n */\n value: Date;\n /**\n * Sets or gets the timezone dropdown value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#visitorTimeZone)\n */\n visitorTimeZone: string;\n /**\n * Adds an event handler that triggers when the appointment field's year or month changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#onViewChange)\n * @eventType onViewChange\n */\n onViewChange(handler: ViewChangeEventHandler, operation?: ViewChangeOperation, timeout?: number): void;\n /**\n * Resets the appointment field to its original values.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#reset)\n */\n reset(): void;\n }\n /**\n * The [audio player](https://support.wix.com/en/article/about-the-wix-audio-player) is an element for playing audio files.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#)\n */\n interface AudioPlayer extends Element, HiddenCollapsedMixin {\n /**\n * Sets or gets the name of the artist displayed in an audio player.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#artistName)\n */\n artistName: string;\n /**\n * Sets or gets the cover image displayed in an audio player.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#coverImage)\n */\n coverImage: string;\n /**\n * Gets the current play time from the beginning of the audio track, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#currentTime)\n */\n readonly currentTime: number;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets the total play time of the audio track, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#duration)\n */\n readonly duration: number;\n /**\n * Indicates if the volume is currently muted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#isMuted)\n */\n readonly isMuted: boolean;\n /**\n * Indicates if an audio track is currently playing.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#isPlaying)\n */\n readonly isPlaying: boolean;\n /**\n * Sets or gets the file location of the audio file.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#src)\n */\n src: string;\n /**\n * Sets or gets the track name displayed in an audio player.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#trackName)\n */\n trackName: string;\n /**\n * Sets or gets an audio player's volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#volume)\n */\n volume: number;\n /**\n * Mutes audio volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#mute)\n */\n mute(): Promise;\n /**\n * Adds an event handler that runs when playback has ended.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#onEnded)\n * @eventType onEnded\n */\n onEnded(handler: EventHandler): AudioPlayer;\n /**\n * Adds an event handler that runs when playback is paused.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#onPause)\n * @eventType onPause\n */\n onPause(handler: EventHandler): AudioPlayer;\n /**\n * Adds an event handler that runs when playback is started or restarted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#onPlay)\n * @eventType onPlay\n */\n onPlay(handler: EventHandler): AudioPlayer;\n /**\n * Adds an event handler that runs when playback progresses.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#onProgress)\n * @eventType onProgress\n */\n onProgress(handler: EventHandler): AudioPlayer;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#pause)\n */\n pause(): Promise;\n /**\n * Begins or resumes playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#play)\n */\n play(): Promise;\n /**\n * Moves playback to the specified time, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#seek)\n */\n seek(time: number): Promise;\n /**\n * Stops playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#stop)\n */\n stop(): Promise;\n /**\n * Toggles playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#togglePlay)\n */\n togglePlay(): Promise;\n /**\n * Unmutes audio volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AudioPlayer.html#unmute)\n */\n unmute(): Promise;\n }\n /**\n * An avatar for the Blocks widget.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Avatar.html#)\n */\n interface Avatar extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets the first name for the person the avatar represents.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Avatar.html#firstName)\n */\n firstName: string;\n /**\n * Sets or gets the last name for the person the avatar represents.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Avatar.html#lastName)\n */\n lastName: string;\n /**\n * Sets or gets an avatar's size.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Avatar.html#size)\n */\n size: number;\n /**\n * Sets or gets the URL of the avatar's image.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Avatar.html#src)\n */\n src: string;\n }\n /**\n * An avatar group for the Blocks widget.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AvatarGroup.html#)\n */\n interface AvatarGroup extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets the size of the avatars in the avatar group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AvatarGroup.html#avatarSize)\n */\n avatarSize: number;\n /**\n * Sets or gets a list of avatars to contain in the avatar group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AvatarGroup.html#avatars)\n */\n avatars: Avatar[];\n /**\n * Sets or gets the maximum number of avatars to display in the `avatarGroup` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AvatarGroup.html#maxAvatars)\n */\n maxAvatars: number;\n /**\n * Whether to display the count of hidden avatars in the group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AvatarGroup.html#showHiddenAvatarCount)\n */\n showHiddenAvatarCount: boolean;\n }\n /**\n * Provides functionality for [background images](https://support.wix.com/en/article/wix-editor-adding-an-image-to-your-page-background) in certain elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Background.html#)\n */\n interface Background {\n /**\n * Sets or gets an object containing information about the element's background.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Background.html#background)\n */\n background: Background.BackgroundOptions;\n }\n /**\n * Container [boxes](https://support.wix.com/en/article/container-boxes)\n * are used to structure your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Box.html#)\n */\n interface Box extends Element, HiddenCollapsedMixin, ClickableMixin, ContainableMixin, StyleMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Box.html#accessibility)\n */\n readonly accessibility: Box.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Box.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the box's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Box.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Box.html#tabIndex)\n */\n tabIndex: number;\n }\n /**\n * [Breadcrumbs](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-breadcrumbs) are used for navigating between site pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#)\n */\n interface Breadcrumbs extends HiddenCollapsedMixin, ViewportMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#accessibility)\n */\n readonly accessibility: Breadcrumbs.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Indicates if an ellipsis is displayed in the breadcrumbs trail.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#isEllipsisVisible)\n */\n readonly isEllipsisVisible: boolean;\n /**\n * Sets or gets breadcrumbs items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#items)\n */\n items: Breadcrumbs.Item[];\n /**\n * Sets or gets the number of items that appear in the breadcrumbs trail after an ellipsis.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#itemsAfterEllipsis)\n */\n itemsAfterEllipsis: number;\n /**\n * Sets or gets the number of items that appear in the breadcrumbs trail before an ellipsis.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#itemsBeforeEllipsis)\n */\n itemsBeforeEllipsis: number;\n /**\n * Hides an ellipsis displayed in a breadcrumbs element and displays the middle items of the breadcrumbs trail instead.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#hideEllipsis)\n */\n hideEllipsis(): void;\n /**\n * Displays an ellipsis in a breadcrumbs element instead of the middle items of the breadcrumbs trail.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#showEllipsis)\n */\n showEllipsis(): void;\n }\n /**\n * A [button](https://support.wix.com/en/article/wix-editor-about-buttons) on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#)\n */\n interface Button extends Element, HiddenCollapsedMixin, DisabledMixin, LinkableMixin, ClickableMixin, StyleMixin, LabelMixin, EffectsMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#accessibility)\n */\n readonly accessibility: Button.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the icon image displayed on the button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#icon)\n */\n icon: string;\n /**\n * Sets or gets the animation triggers for a button's icon.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#iconAnimationTriggers)\n */\n iconAnimationTriggers: string[];\n /**\n * Indicates if the button’s icon is collapsed or expanded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#iconCollapsed)\n */\n readonly iconCollapsed: boolean;\n /**\n * Sets or gets a button's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#label)\n */\n label: string;\n /**\n * Sets or gets the button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#link)\n */\n link: string;\n /**\n * Gets an object containing information about the button's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Runs the button's icon animation backward, transitioning from the icon's end shape to the start shape.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#animateIconBackward)\n */\n animateIconBackward(): void;\n /**\n * Runs the button's icon animation forward, transitioning from the icon's start shape to the end shape.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#animateIconForward)\n */\n animateIconForward(): void;\n /**\n * Collapses the button’s icon and sets its `iconCollapsed` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#collapseIcon)\n */\n collapseIcon(): Promise;\n /**\n * Expands the button’s icon and sets its `iconCollapsed` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#expandIcon)\n */\n expandIcon(): Promise;\n /**\n * Adds an event handler that runs when the pointer is moved\n * onto the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#onMouseIn)\n */\n onMouseIn(handler: MouseEventHandler): Button;\n /**\n * Adds an event handler that runs when the pointer is moved\n * off of the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#onMouseOut)\n */\n onMouseOut(handler: MouseEventHandler): Button;\n }\n /**\n * The [reCAPTCHA](https://support.wix.com/en/article/about-recaptcha)\n * element allows you to present a challenge-response test to site visitors to determine whether they are human or a bot.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#)\n */\n interface Captcha extends Element, FocusMixin, HiddenCollapsedMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets the reCAPTCHA token.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#token)\n */\n readonly token: string;\n /**\n * Adds an event handler that runs when a connection error occurs while completing the CAPTCHA challenge.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#onError)\n * @eventType onError\n */\n onError(handler: Captcha.ErrorHandler): void;\n /**\n * Adds an event handler that runs when the CAPTCHA token expires.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#onTimeout)\n * @eventType onTimeout\n */\n onTimeout(handler: Captcha.TimeoutHandler): void;\n /**\n * Adds an event handler that runs when the CAPTCHA challenge is successfully completed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#onVerified)\n * @eventType onVerified\n */\n onVerified(handler: Captcha.VerifiedHandler): void;\n /**\n * Resets the reCAPTCHA element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#reset)\n */\n reset(): Promise;\n }\n /**\n * An icon that leads users to the shopping cart.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CartIcon.html#)\n */\n interface CartIcon extends Element, HiddenCollapsedMixin {\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-stores.cart.addProducts()](https://dev.wix.com/docs/velo/api-reference/wix-stores-frontend/cart/add-products).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CartIcon.html#addProductsToCart)\n */\n addProductsToCart(products: CartIcon.AddToCartItem[]): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-ecom-backend.currentCart.addToCurrentCart()](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/add-to-current-cart).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CartIcon.html#addToCart)\n */\n addToCart(productID: string, quantity: number, options?: CartIcon.AddToCartOptions): Promise;\n }\n /**\n * A [chatbox](https://support.wix.com/en/article/editor-x-adding-and-customizing-chat) is an element for sending and receiving chat messages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#)\n */\n interface Chatbox extends Element, HiddenMixin {\n /**\n * Indicates if an element appears on all pages or only on the current page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#global)\n */\n readonly global: boolean;\n /**\n * Indicates if the chatbox is visible or hidden.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#hidden)\n */\n readonly hidden: boolean;\n /**\n * Indicates if the element is actually visible.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#isVisible)\n */\n readonly isVisible: boolean;\n /**\n * Indicates if the chatbox is maximized.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#maximized)\n */\n readonly maximized: boolean;\n /**\n * Note: This standard element property is not relevant for Chatbox.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#parent)\n */\n readonly parent: Node;\n /**\n * Expands the chatbox and focuses it on the specified chat channel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#focusChannel)\n */\n focusChannel(channelInfo: Chatbox.ChannelInfo): Promise;\n /**\n * Gets a chatbox channel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#getChannel)\n */\n getChannel(channelInfo: Chatbox.ChannelInfo): Promise;\n /**\n * Gets a list of available chat channels for a site visitor.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#getChannelList)\n */\n getChannelList(): Promise;\n /**\n * Expands the chatbox and sets its [`maximized`](#maximized) property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#maximize)\n */\n maximize(): Promise;\n /**\n * Collapses the chatbox and sets its [`maximized`](#maximized) property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#minimize)\n */\n minimize(): Promise;\n /**\n * An event that fires when the chatbox is maximized.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#onMaximize)\n */\n onMaximize(handler: BasicEventHandler): void;\n /**\n * An event that fires when a site visitor receives a chat message.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#onMessageReceived)\n */\n onMessageReceived(message: Chatbox.Message): void;\n /**\n * An event that fires when a site visitor sends a chat message.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#onMessageSent)\n */\n onMessageSent(message: Chatbox.Message): void;\n /**\n * An event that fires when the chatbox is minimized.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#onMinimize)\n */\n onMinimize(handler: BasicEventHandler): void;\n /**\n * Note: This standard element event is not relevant for Chatbox.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#onViewportEnter)\n * @eventType viewportEnter\n */\n onViewportEnter(handler: EventHandler): Element;\n /**\n * Note: This standard element event is not relevant for Chatbox.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#onViewportLeave)\n * @eventType viewportLeave\n */\n onViewportLeave(handler: EventHandler): Element;\n /**\n * Note: This standard element function is not relevant for Chatbox.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#scrollTo)\n */\n scrollTo(): Promise;\n /**\n * Sends a chat message from a site visitor.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#sendMessage)\n */\n sendMessage(messageInfo: Chatbox.MessageInfo): Promise;\n }\n /**\n * [Checkboxes](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-checkbox) are used for a single binary choice.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#)\n */\n interface Checkbox extends LabelMixin, FormElement, DisabledMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin, CheckedMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#accessibility)\n */\n readonly accessibility: Checkbox.Accessibility;\n /**\n * Sets or gets whether a checkbox is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#checked)\n */\n checked: boolean;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets or sets if a checkbox is required to be checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#required)\n */\n required: boolean;\n /**\n * Gets an object containing information about the checkbox's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Sets or gets a checkbox's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#onCustomValidation)\n */\n onCustomValidation(validator: CheckboxValidator, override?: boolean): void;\n }\n /**\n * [Checkbox groups](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-checkbox) are used for selecting any number of the given\n * options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#)\n */\n interface CheckboxGroup extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#accessibility)\n */\n readonly accessibility: CheckboxGroup.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the options of a checkbox group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#options)\n */\n options: CheckboxGroup.Option[];\n /**\n * Sets or gets the indices of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#selectedIndices)\n */\n selectedIndices: number[];\n /**\n * Gets an object containing information about the checkbox group's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the value of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#value)\n */\n value: string[];\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#onCustomValidation)\n */\n onCustomValidation(validator: CheckboxGroupValidator, override?: boolean): void;\n }\n /**\n * Provides functionality for elements that can be checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckedMixin.html#)\n */\n interface CheckedMixin {\n /**\n * Sets or gets whether the element is checked or not.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckedMixin.html#checked)\n */\n checked: boolean;\n }\n /**\n * Provides functionality for elements that can be clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ClickableMixin.html#)\n */\n interface ClickableMixin {\n /**\n * Adds an event handler that runs when the element is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ClickableMixin.html#onClick)\n * @eventType click\n */\n onClick(handler: MouseEventHandler): Element;\n /**\n * Adds an event handler that runs when the element is double-clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ClickableMixin.html#onDblClick)\n * @eventType dblClick\n */\n onDblClick(handler: MouseEventHandler): Element;\n }\n /**\n * Provides functionality for elements that can be collapsed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsedMixin.html#)\n */\n interface CollapsedMixin {\n /**\n * Indicates if the element is collapsed or expanded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsedMixin.html#collapsed)\n */\n readonly collapsed: boolean;\n /**\n * Collapses the element and sets its `collapsed` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsedMixin.html#collapse)\n */\n collapse(): Promise;\n /**\n * Expands the element and sets its `collapsed` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsedMixin.html#expand)\n */\n expand(): Promise;\n }\n /**\n * [Collapsible text](https://support.wix.com/en/article/adding-and-setting-up-ellipsis-text) is a text element for managing large amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#)\n */\n interface CollapsibleText extends Element, HiddenCollapsedMixin, ClickableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#accessibility)\n */\n readonly accessibility: CollapsibleText.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Indicates whether the ellipsis functionality is turned on.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#ellipsisEnabled)\n */\n readonly ellipsisEnabled: boolean;\n /**\n * Sets or gets the maximum number of lines of introductory text in the collapsible text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#maxLines)\n */\n maxLines: number;\n /**\n * Sets or gets the data object of the read more action for the collapsible text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#readMoreActionData)\n */\n readMoreActionData: CollapsibleText.ExpandOnCurrentPage | CollapsibleText.LinkToContent;\n /**\n * Sets or gets the type of read more action for the collapsible text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#readMoreActionType)\n */\n readMoreActionType: string;\n /**\n * Sets or gets the plain-text content of a collapsible text element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#text)\n */\n text: string;\n /**\n * Adds a read more button that links to the remaining text when clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#addReadMoreButton)\n */\n addReadMoreButton(buttonText?: string): void;\n /**\n * Collapses the collapsible text and displays the introductory text with an ellipsis.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#collapseText)\n */\n collapseText(): void;\n /**\n * Turns off the ellipsis functionality.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#disableEllipsis)\n */\n disableEllipsis(): void;\n /**\n * Turns on the ellipsis functionality.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#enableEllipsis)\n */\n enableEllipsis(): void;\n /**\n * Expands the collapsible text, displays the full text, and hides the ellipsis.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#expandText)\n */\n expandText(): void;\n /**\n * Removes the read more button that links to the remaining text when clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#removeReadMoreButton)\n */\n removeReadMoreButton(): void;\n }\n /**\n * A [column](https://support.wix.com/en/article/wix-editor-attaching-elements-to-strips-and-columns)\n * is a component part of a `ColumnStrip`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Column.html#)\n */\n interface Column extends Element, HiddenCollapsedMixin, Background, ClickableMixin, ContainableMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Column.html#accessibility)\n */\n readonly accessibility: Column.Accessibility;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Column.html#tabIndex)\n */\n tabIndex: number;\n }\n /**\n * A [column strip](https://support.wix.com/en/article/wix-editor-attaching-elements-to-strips-and-columns) is a strip of column elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#)\n */\n interface ColumnStrip extends Element, Background, HiddenCollapsedMixin, ClickableMixin, ContainableMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#accessibility)\n */\n readonly accessibility: ColumnStrip.Accessibility;\n /**\n * Gets an object containing information about the column strip's background, such as its image or video source.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#background)\n */\n readonly background: Document.BackgroundOptions;\n /**\n * Gets a list of all the columns contained in the column strip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#columns)\n */\n readonly columns: Column[];\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#tabIndex)\n */\n tabIndex: number;\n }\n /**\n * Provides functionality for elements that can contain other elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ContainableMixin.html#)\n */\n interface ContainableMixin {\n /**\n * Gets an array of the elements that are contained within the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ContainableMixin.html#children)\n */\n readonly children: (Element & AnyProperties)[];\n }\n /**\n * A [container](https://support.wix.com/en/article/studio-editor-using-containers) for Repeater items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Container.html#)\n */\n interface Container extends Element, HiddenCollapsedMixin, Background, ClickableMixin, ContainableMixin, EffectsMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Container.html#accessibility)\n */\n readonly accessibility: Container.Accessibility;\n /**\n * Adds an event handler that runs when a keyboard key is pressed while the container or one of its child elements is focused.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Container.html#onKeyPress)\n * @eventType keyPress\n */\n onKeyPress(eventHandler: KeyboardEventHandler): Element;\n }\n /**\n * Provides functionality for manipulating custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#)\n */\n interface CustomClassList {\n /**\n * Adds custom CSS classes to an element's class list.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#add)\n */\n add(...className: string[]): void;\n /**\n * Indicates whether the element's class list contains a specified custom CSS class.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#contains)\n */\n contains(className: string): boolean;\n /**\n * Removes custom CSS classes from an element's class list.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#remove)\n */\n remove(...className: string[]): void;\n /**\n * Replaces a custom CSS class of an element with a different custom CSS class.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#replace)\n */\n replace(currentClassName: string, newClassName: string): boolean;\n /**\n * Toggles an element's custom CSS class.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#toggle)\n */\n toggle(className: string): boolean;\n /**\n * Gets an array of strings listing an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomClassList.html#values)\n */\n values(): string[];\n }\n /**\n * [Custom element](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/custom-elements/about-custom-elements) provides an API for rendering a custom element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomElement.html#)\n */\n interface CustomElement extends Element, HiddenCollapsedMixin {\n /**\n * Sets or gets the SEO markup to be rendered for search engine bots.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomElement.html#seoMarkup)\n */\n seoMarkup: string;\n /**\n * Registers a callback function in Velo for an event triggered from the custom element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomElement.html#on)\n */\n on(eventName: string, callBackFunction: Function): void;\n /**\n * Sets an HTML attribute on the custom element's DOM node.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CustomElement.html#setAttribute)\n */\n setAttribute(key: string, value: string | boolean | number): void;\n }\n /**\n * A button on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#)\n */\n interface DashboardButton extends ClickableMixin, DisabledMixin, HiddenCollapsedMixin, LinkableMixin {\n /**\n * Indicates whether the dashboard button is currently loading.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#isLoaderVisible)\n */\n readonly isLoaderVisible: boolean;\n /**\n * Sets or gets the dashboard button's label.\n *\n * Max: 120 characters\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#label)\n */\n label: string;\n /**\n * Sets or gets the dashboard button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#link)\n */\n link: string;\n /**\n * Sets or gets the dashboard button prefix.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#prefix)\n */\n prefix: string | null;\n /**\n * Sets or gets the relationship between the page containing the dashboard button\n * link and the target page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#rel)\n */\n rel: string;\n /**\n * Sets or gets the dashboard button suffix.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#suffix)\n */\n suffix: string | null;\n /**\n * Sets or gets the target of the dashboard button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#target)\n */\n target: string | null;\n /**\n * Hides the button's loading indicator.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#hideLoader)\n */\n hideLoader(): void;\n /**\n * Shows the dashboard button's loading indicator.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardButton.html#showLoader)\n */\n showLoader(): void;\n }\n /**\n * An element for displaying headings on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardHeading.html#)\n */\n interface DashboardHeading extends HiddenCollapsedMixin {\n /**\n * Sets or gets the text of a dashboard heading element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardHeading.html#text)\n */\n text: string;\n }\n /**\n * An icon button on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardIconButton.html#)\n */\n interface DashboardIconButton extends HiddenCollapsedMixin, ClickableMixin, DisabledMixin, LinkableMixin {\n /**\n * Sets or gets the dashboard icon button's icon.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardIconButton.html#icon)\n */\n icon: string;\n /**\n * Sets or gets the dashboard icon button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardIconButton.html#link)\n */\n link: string;\n /**\n * Sets or gets the relationship between the page containing the dashboard icon\n * button link and the target page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardIconButton.html#rel)\n */\n rel: string;\n /**\n * Sets or gets the target of the dashboard icon button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardIconButton.html#target)\n */\n target: string | null;\n /**\n * Sets or gets the dashboard icon button's tooltip content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardIconButton.html#tooltip)\n */\n tooltip: string;\n }\n /**\n * An element for directing visitors to important information on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInfoIcon.html#)\n */\n interface DashboardInfoIcon extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInfoIcon.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets the element's tooltip link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInfoIcon.html#tooltipLink)\n */\n tooltipLink: string;\n /**\n * Sets or gets the element's tooltip link text.\n *\n * Max: 120 characters\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInfoIcon.html#tooltipLinkText)\n */\n tooltipLinkText: string;\n /**\n * Adds an event handler that runs when the link within a tooltip is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInfoIcon.html#onTooltipLinkClick)\n * @eventType click\n */\n onTooltipLinkClick(handler: EventHandler): Element;\n }\n /**\n * An input element for capturing small amounts of text on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#)\n */\n interface DashboardInput extends HiddenCollapsedMixin, ValueMixin, DisabledMixin {\n /**\n * Sets or gets the dashboard input's label.\n *\n * Max: 120 characters\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#label)\n */\n label: string;\n /**\n * Sets or gets the placeholder text content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#placeholder)\n */\n placeholder: string;\n /**\n * Sets or gets the dashboard input prefix.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#prefix)\n */\n prefix: string;\n /**\n * Indicates if the dashboard input element is read-only.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#readOnly)\n */\n readOnly: boolean;\n /**\n * Sets or gets the dashboard input suffix.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#suffix)\n */\n suffix: string;\n /**\n * Sets or gets the dashboard input element's tooltip content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets the value in the dashboard input field.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when a key is pressed inside the dashboard input field.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#onKeyPress)\n * @eventType keyPress\n */\n onKeyPress(eventHandler: KeyboardEventHandler): Element;\n /**\n * Adds an event handler that runs when the key is released within the dashboard input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardInput.html#onKeyRelease)\n * @eventType keyRelease\n */\n onKeyRelease(handler: KeyboardEventHandler): Element;\n }\n /**\n * An input element for capturing numbers on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#)\n */\n interface DashboardNumberInput extends HiddenCollapsedMixin, ValueMixin, DisabledMixin {\n /**\n * Sets or gets the dashboard number input's label.\n *\n * Max: 1200 characters\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#label)\n */\n label: string;\n /**\n * Sets or gets the maximum allowed input value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#max)\n */\n max: number;\n /**\n * Sets or gets the minimum allowed number value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#min)\n */\n min: number;\n /**\n * Sets or gets the placeholder text content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#placeholder)\n */\n placeholder: string;\n /**\n * Indicates if the dashboard number input element is read-only.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#readOnly)\n */\n readOnly: boolean;\n /**\n * Sets or gets the dashboard number input's tooltip content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets the value in the dashboard number input field.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#value)\n */\n value: number;\n /**\n * Adds an event handler that runs when a key is pressed within\n * the input field.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#onKeyPress)\n * @eventType keyPress\n */\n onKeyPress(eventHandler: KeyboardEventHandler): Element;\n /**\n * Adds an event handler that runs when the key is released within an input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardNumberInput.html#onKeyRelease)\n * @eventType keyRelease\n */\n onKeyRelease(handler: KeyboardEventHandler): Element;\n }\n /**\n * An element for displaying text on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardText.html#)\n */\n interface DashboardText extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets the plain-text contents of a text element.\n *\n * Max: 1200 characters\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardText.html#text)\n */\n text: string;\n }\n /**\n * A text button on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#)\n */\n interface DashboardTextButton extends HiddenCollapsedMixin, DisabledMixin, ClickableMixin, LinkableMixin {\n /**\n * Sets or gets the button's label.\n *\n * Max: 1200 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#label)\n */\n label: string;\n /**\n * Sets or gets the dashboard text button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#link)\n */\n link: string;\n /**\n * Sets or gets the dashboard text button prefix.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#prefix)\n */\n prefix: string;\n /**\n * Sets or gets the relationship between the page containing the dashboard text\n * button link and the target page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#rel)\n */\n rel: string;\n /**\n * Sets or gets the dashboard text button suffix.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#suffix)\n */\n suffix: string;\n /**\n * Sets or gets the target of the dashboard text button's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardTextButton.html#target)\n */\n target: string | null;\n }\n /**\n * An element for creating a single binary choice on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardToggleSwitch.html#)\n */\n interface DashboardToggleSwitch extends HiddenCollapsedMixin, DisabledMixin {\n /**\n * Sets or gets the state of the toggle switch.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardToggleSwitch.html#checked)\n */\n checked: boolean;\n /**\n * Sets or gets the toggle switch label.\n *\n * Max: 120 characters\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardToggleSwitch.html#label)\n */\n label: string | null;\n /**\n * Sets or gets the toggle switch's tooltip content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardToggleSwitch.html#tooltip)\n */\n tooltip: string | null;\n /**\n * Adds an event handler that runs when the state of the toggle switch changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DashboardToggleSwitch.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * A dataset connects page elements to a set of items in a data collection.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#)\n */\n interface Dataset {\n /**\n * Adds a new blank item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#add)\n */\n add(): Promise;\n /**\n * Returns the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getCurrentItem)\n */\n getCurrentItem(): any;\n /**\n * Returns the current item's index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getCurrentItemIndex)\n */\n getCurrentItemIndex(): number;\n /**\n * Gets the index of the dataset's current page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getCurrentPageIndex)\n */\n getCurrentPageIndex(): number;\n /**\n * Returns the selected items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getItems)\n */\n getItems(fromIndex: number, numberOfItems: number): Promise;\n /**\n * Gets the dataset's page size.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getPageSize)\n */\n getPageSize(): number;\n /**\n * Returns the number of items in the dataset that match its filter criteria.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getTotalCount)\n */\n getTotalCount(): number;\n /**\n * Gets the number of pages in the dataset.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#getTotalPageCount)\n */\n getTotalPageCount(): number;\n /**\n * Indicates if there is a next item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if there is a next page of data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#hasNextPage)\n */\n hasNextPage(): boolean;\n /**\n * Indicates if there is a previous item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#hasPrevious)\n */\n hasPrevious(): boolean;\n /**\n * Indicates if there is a previous page of data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#hasPreviousPage)\n */\n hasPreviousPage(): boolean;\n /**\n * Loads the next page of data in addition to the current data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#loadMore)\n */\n loadMore(): Promise;\n /**\n * Loads the specified page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#loadPage)\n */\n loadPage(pageIndex: number): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available. Use the\n * [`add()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/add) function instead.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#new)\n */\n new (): Promise;\n /**\n * Saves the current item and moves to the next item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#next)\n */\n next(): Promise;\n /**\n * Moves to the next page of data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#nextPage)\n */\n nextPage(): Promise;\n /**\n * Adds an event handler that runs just after a save.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onAfterSave)\n * @eventType afterSave\n */\n onAfterSave(handler: Dataset.AfterSaveHandler): void;\n /**\n * Adds an event handler that runs just before a save.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onBeforeSave)\n */\n onBeforeSave(handler: Dataset.BeforeSaveHandler): void;\n /**\n * Adds an event handler that runs when the current index changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onCurrentIndexChanged)\n * @eventType currentIndexChanged\n */\n onCurrentIndexChanged(handler: Dataset.CurrentIndexChangedHandler): void;\n /**\n * Adds an event handler that runs when an error occurs.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onError)\n * @eventType datasetError\n */\n onError(handler: Dataset.ErrorHandler): void;\n /**\n * Adds an event handler that runs when a value of the current item changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onItemValuesChanged)\n * @eventType itemValuesChanged\n */\n onItemValuesChanged(handler: Dataset.ItemValuesChangedHandler): void;\n /**\n * Adds an event handler that runs when the dataset is ready.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onReady)\n * @eventType datasetReady\n */\n onReady(handler: Dataset.ReadyHandler): void;\n /**\n * The `onReadyAsync()` function returns a Promise that resolves when a dataset is ready.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#onReadyAsync)\n */\n onReadyAsync(): Promise;\n /**\n * Saves the current item and moves to the previous item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#previous)\n */\n previous(): Promise;\n /**\n * Moves to the previous page of data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#previousPage)\n */\n previousPage(): Promise;\n /**\n * Refetches the contents of the dataset from the collection.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#refresh)\n */\n refresh(): Promise;\n /**\n * Removes the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#remove)\n */\n remove(): Promise;\n /**\n * Reverts the current item to its saved value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#revert)\n */\n revert(): Promise;\n /**\n * Saves the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#save)\n */\n save(): Promise;\n /**\n * Sets the current item by index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#setCurrentItemIndex)\n */\n setCurrentItemIndex(index: number): Promise;\n /**\n * Updates the value of a field in the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#setFieldValue)\n */\n setFieldValue(fieldKey: string, value: any): void;\n /**\n * Updates the values of a set of fields in the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#setFieldValues)\n */\n setFieldValues(fieldValues: any): void;\n /**\n * Sets the dataset filter.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#setFilter)\n */\n setFilter(filter: any): Promise;\n /**\n * Sets the dataset's page size.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#setPageSize)\n */\n setPageSize(pageSize: number): Promise;\n /**\n * Sets the dataset sort order.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#setSort)\n */\n setSort(sort: WixDataSort): Promise;\n }\n /**\n * A [date picker](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/formatting-layout/formatting-dates#displaying-dates-in-date-pickers)\n * is used for entering dates. It lets site visitors populate a\n * date field by picking a date using a calendar popup.\n * You can enable and disable dates, date ranges, and days of the week on your date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#)\n */\n interface DatePicker extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#accessibility)\n */\n readonly accessibility: DatePicker.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the format of the date displayed in the date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#dateFormat)\n */\n dateFormat: string;\n /**\n * Sets or gets ranges of dates that a site visitor can't select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#disabledDateRanges)\n */\n disabledDateRanges: DatePicker.DateRange[];\n /**\n * **Deprecated.** This property will continue to work, but a newer version is available at [`disabledDateRanges`](https://dev.wix.com/docs/velo/api-reference/$w/date-picker/disabled-date-ranges).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#disabledDates)\n */\n disabledDates: Date[];\n /**\n * Sets or gets the days of the week that a site visitor can't select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#disabledDaysOfWeek)\n */\n disabledDaysOfWeek: number[];\n /**\n * Sets or gets ranges of dates that a site visitor can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#enabledDateRanges)\n */\n enabledDateRanges: DatePicker.DateRange[];\n /**\n * Sets or gets the latest date that a site visitor can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#maxDate)\n */\n maxDate: Date;\n /**\n * Sets or gets the earliest date that a site visitor can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#minDate)\n */\n minDate: Date;\n /**\n * Sets or gets the date picker's timezone.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#timeZone)\n */\n timeZone: string;\n /**\n * Sets or gets the value of the date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#value)\n */\n value: Date;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#onCustomValidation)\n */\n onCustomValidation(validator: DatePickerValidator, override?: boolean): void;\n /**\n * Adds an event handler that triggers when the date picker's view changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#onViewChange)\n * @eventType onViewChange\n */\n onViewChange(handler: ViewChangeEventHandler, operation?: ViewChangeOperation, timeout?: number): void;\n }\n /**\n * An object representing an element's styles in the disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Disabled.html#)\n */\n interface Disabled {\n /**\n * Sets or gets the background color of an element in its disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Disabled.html#backgroundColor)\n */\n backgroundColor: string;\n /**\n * Sets or gets the border color of an element in its disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Disabled.html#borderColor)\n */\n borderColor: string;\n /**\n * Sets or gets the text color of an element in its disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Disabled.html#color)\n */\n color: string;\n /**\n * Sets or gets the icon color of an element in its disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Disabled.html#iconColor)\n */\n iconColor: string;\n }\n /**\n * Provides functionality for elements that can be disabled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DisabledMixin.html#)\n */\n interface DisabledMixin {\n /**\n * Indicates if the element is enabled or disabled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DisabledMixin.html#enabled)\n */\n readonly enabled: boolean;\n /**\n * Disables the element and sets its `enabled` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DisabledMixin.html#disable)\n */\n disable(): Promise;\n /**\n * Enables the element and sets its `enabled` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DisabledMixin.html#enable)\n */\n enable(): Promise;\n }\n /**\n * A [Document](https://support.wix.com/en/article/wix-editor-managing-your-sites-pages) is a complete web page, which consists of a Header, Page, and Footer.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Document.html#)\n */\n interface Document {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Document.html#accessibility)\n */\n readonly accessibility: Document.Accessibility;\n /**\n * Gets an object containing information about the document's background, such as its image or video source.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Document.html#background)\n */\n readonly background: Document.BackgroundOptions;\n /**\n * Gets the document's Header, Page, and Footer.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Document.html#children)\n */\n readonly children: Node[];\n /**\n * Gets the document's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Document.html#type)\n */\n readonly type: string;\n }\n /**\n * [Dropdowns](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-dropdown-selection-for-a-form-submission)\n * are used for selecting one of a number of options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#)\n */\n interface Dropdown extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#accessibility)\n */\n readonly accessibility: Dropdown.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets a dropdown's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#label)\n */\n label: string;\n /**\n * Sets or gets the options in a dropdown.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#options)\n */\n options: Dropdown.Option[];\n /**\n * Sets or gets the dropdown's placeholder text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#placeholder)\n */\n placeholder: string;\n /**\n * Sets or gets the index of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#selectedIndex)\n */\n selectedIndex: number;\n /**\n * Gets an object containing information about the dropdown's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Sets or gets an element's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#onChange)\n */\n onChange(handler: EventHandler): Dropdown;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#onCustomValidation)\n */\n onCustomValidation(validator: DropdownValidator, override?: boolean): void;\n }\n /**\n * A dynamic dataset connects page elements on a dynamic page to a set of items in a data collection.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DynamicDataset.html#)\n */\n interface DynamicDataset extends Dataset {\n /**\n * Gets the next dynamic page URL.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DynamicDataset.html#getNextDynamicPage)\n */\n getNextDynamicPage(): Promise;\n /**\n * Gets the previous dynamic page URL.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DynamicDataset.html#getPreviousDynamicPage)\n */\n getPreviousDynamicPage(): Promise;\n }\n /**\n * Use effect options to customize an effect when [showing]($w.HiddenMixin.html#show) or [hiding]($w.HiddenMixin.html#hide) an element.\n * Effect options include arcs, bouncing, fading, flipping, floating, flying in/out, folding, gliding and more.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.EffectOptions.html#)\n */\n interface EffectOptions {\n }\n /**\n * Functionality for displaying the [effects](https://support.wix.com/en/article/studio-editor-about-animations#:~:text=client%27s%20exact%20needs.-,Hover%20and%20click%20interactions,-Add%20cool%20effects) defined for an element using Wix Studio.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#)\n */\n interface Effects {\n /**\n * Gets an element's currently applied effects.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#activeEffects)\n */\n readonly activeEffects: string[];\n /**\n * Gets all of the effects defined for an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#allEffects)\n */\n readonly allEffects: string[];\n /**\n * Applies one or more of an element's effects.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#applyEffects)\n */\n applyEffects(effects: string[]): void;\n /**\n * Removes all of an element's applied effects.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#removeAllEffects)\n */\n removeAllEffects(): void;\n /**\n * Removes one or more of an element's effects.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#removeEffects)\n */\n removeEffects(effects: string[]): void;\n /**\n * Toggles the state of one or more of an element's effects.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Effects.html#toggleEffects)\n */\n toggleEffects(effects: string[]): void;\n }\n /**\n * Provides functionality for elements with [effects](https://support.wix.com/en/article/studio-editor-adding-a-preset-click-or-hover-interaction) defined using Wix Studio.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.EffectsMixin.html#)\n */\n interface EffectsMixin {\n /**\n * An object containing functionality for displaying the [effects](https://support.wix.com/en/article/studio-editor-adding-a-preset-click-or-hover-interaction) defined for an element using Wix Studio.\n *\n * >**Note:** This API can only be used in Wix Studio.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.EffectsMixin.html#effects)\n */\n readonly effects: Effects;\n }\n /**\n * Provides basic functionality for elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#)\n */\n interface Element extends Node, ViewportMixin {\n /**\n * Indicates if an element was temporarily deleted from the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction).\n * Use the [`restore`](#restore) function to restore the deleted element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#deleted)\n */\n readonly deleted: boolean;\n /**\n * Indicates if an element is currently in the [DOM structure](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#rendered)\n */\n readonly rendered: boolean;\n /**\n * Deletes an element from the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction).\n * This is a temporary deletion. Use [`restore`](#restore) to restore the deleted element.\n *\n * SEO crawlers cannot find content in an element whose `deleted` status is `true`.\n * Content in an element that is in `hidden` status can be found by crawlers.\n *\n * >**Note:** An element whose `deleted` status is `true` can be edited.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#delete)\n */\n delete(): Promise;\n /**\n * Adds an event handler that runs when the pointer is moved\n * onto the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#onMouseIn)\n * @eventType mouseenter\n */\n onMouseIn(handler: MouseEventHandler): Element;\n /**\n * Adds an event handler that runs when the pointer is moved\n * off of the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#onMouseOut)\n * @eventType mouseleave\n */\n onMouseOut(handler: MouseEventHandler): Element;\n /**\n * Restores a deleted element to the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Element.html#restore)\n */\n restore(): Promise;\n }\n /**\n * Events are fired when certain actions occur to elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Event.html#)\n */\n interface Event {\n /**\n * Gets the context in which an event was fired.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Event.html#context)\n */\n readonly context: Event.EventContext;\n /**\n * Gets the element that the event was fired on.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Event.html#target)\n */\n readonly target: Element & AnyProperties;\n /**\n * Gets the type of event that was fired.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Event.html#type)\n */\n readonly type: string;\n }\n /**\n * Provides functionality for elements that can set and lose focus.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.FocusMixin.html#)\n */\n interface FocusMixin {\n /**\n * Removes focus from the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.FocusMixin.html#blur)\n */\n blur(): void;\n /**\n * Places focus on the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.FocusMixin.html#focus)\n */\n focus(): void;\n /**\n * Adds an event handler that runs when the element loses focus.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.FocusMixin.html#onBlur)\n * @eventType blur\n */\n onBlur(handler: EventHandler): Element;\n /**\n * Adds an event handler that runs when the element receives focus.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.FocusMixin.html#onFocus)\n * @eventType focus\n */\n onFocus(handler: EventHandler): Element;\n }\n /**\n * The [footer](https://support.wix.com/en/article/wix-editor-about-your-sites-footer) is the area of your site that appears at the bottom and\n * throughout all of your pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Footer.html#)\n */\n interface Footer extends Element, ClickableMixin, ContainableMixin, StyleMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Footer.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the footer's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Footer.html#style)\n */\n readonly style: Style;\n }\n /**\n * A [form](https://support.wix.com/en/article/wix-forms-adding-and-setting-up-a-form-on-your-site)\n * is a container for the input elements and buttons in a `WixForms` `$w` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Form.html#)\n */\n interface Form extends Element, ClickableMixin, ContainableMixin, HiddenCollapsedMixin, StyleMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Form.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the styles of the form.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Form.html#style)\n */\n readonly style: Style;\n }\n /**\n * Provides functionality related to user input elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.FormElement.html#)\n */\n interface FormElement extends Element, ValidatableMixin, ValueMixin {\n }\n /**\n * A [Gallery](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-gallery) displays multiple items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#)\n */\n interface Gallery extends Element, HiddenCollapsedMixin, PlayableMixin {\n /**\n * Sets or gets the action that occurs when an item in the gallery is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#clickAction)\n */\n clickAction: string;\n /**\n * Gets the index of the gallery's current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#currentIndex)\n */\n readonly currentIndex: number;\n /**\n * Gets an object containing information about the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#currentItem)\n */\n readonly currentItem: Gallery.ImageItem | Gallery.VideoItem;\n /**\n * Gets an object containing information about the gallery's capabilities.\n *\n * >**Note:** For [gallery types](https://support.wix.com/en/article/wix-editor-customizing-your-gallery-design#switching-to-a-different-gallery-type) that display one item at a time such as a slide show layout, `isPlayable` and `hasCurrentItem` are `false` .\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#galleryCapabilities)\n */\n readonly galleryCapabilities: Gallery.GalleryCapabilities;\n /**\n * Sets or gets the items in a gallery.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#items)\n */\n items: Gallery.ImageItem[] | Gallery.VideoItem[];\n /**\n * Determines if a gallery's navigation arrows are shown.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#showNavigationButtons)\n */\n showNavigationButtons: boolean;\n /**\n * Whether navigation to the next gallery item is enabled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#navigateNextEnabled)\n */\n navigateNextEnabled(): boolean;\n /**\n * Whether navigation to the previous gallery item is enabled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#navigatePreviousEnabled)\n */\n navigatePreviousEnabled(): boolean;\n /**\n * Navigates to a specific gallery item index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#navigateToIndex)\n */\n navigateToIndex(index: number, animationDuration?: number): void;\n /**\n * Adds an event handler that runs when a gallery's current item changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#onCurrentItemChanged)\n * @eventType imageChanged\n */\n onCurrentItemChanged(handler: GalleryItemChangedEventHandler): Gallery;\n /**\n * Adds an event handler that runs when the gallery starts navigation.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#onGalleryNavigationStart)\n */\n onGalleryNavigationStart(handler: GalleryNavigationStartEventHandler): void;\n /**\n * Adds an event handler that runs when an item in a gallery is\n * clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#onItemClicked)\n * @eventType itemClicked\n */\n onItemClicked(handler: GalleryItemClickedEventHandler): Gallery;\n /**\n * Triggers a click event on the specified gallery item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#triggerItemClick)\n */\n triggerItemClick(itemIndex?: number): void;\n }\n /**\n * Event that is fired when a gallery moves to a new image.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryItemChangedEvent.html#)\n */\n interface GalleryItemChangedEvent extends Event {\n /**\n * Gets the gallery item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryItemChangedEvent.html#item)\n */\n readonly item: Gallery.ImageItem | Gallery.VideoItem;\n /**\n * Gets the gallery item's index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryItemChangedEvent.html#itemIndex)\n */\n readonly itemIndex: number;\n }\n /**\n * Event that is fired when an image in a gallery is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryItemClickedEvent.html#)\n */\n interface GalleryItemClickedEvent extends GalleryItemChangedEvent, Event {\n }\n /**\n * Event that is fired when a gallery starts navigation.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#)\n */\n interface GalleryNavigationStartEvent {\n /**\n * Gets the gallery animation duration in milliseconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#animationDuration)\n */\n readonly animationDuration: number;\n /**\n * Gets whether the gallery is playing automatically.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#autoplay)\n */\n readonly autoplay: boolean;\n /**\n * Gets whether the gallery is scrolling continuously.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#continuousScroll)\n */\n readonly continuousScroll: boolean;\n /**\n * Gets the index of the current item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#currentIndex)\n */\n readonly currentIndex: number;\n /**\n * Gets the direction in which the gallery is scrolling.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#scrollDirection)\n */\n readonly scrollDirection: string;\n /**\n * Gets the speed and smoothness of the transition effect when navigating between slides.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#slideTransition)\n */\n readonly slideTransition: string;\n /**\n * Gets the element that the event was fired on.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GalleryNavigationStartEvent.html#target)\n */\n target: void;\n }\n /**\n * A [Google map element](https://www.wix.com/support/html5/article/adding-google-maps)\n * that allows you to display a given location.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GoogleMap.html#)\n */\n interface GoogleMap extends Element, HiddenCollapsedMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GoogleMap.html#accessibility)\n */\n readonly accessibility: GoogleMap.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GoogleMap.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the location information of a map's marked location.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GoogleMap.html#location)\n */\n location: GoogleMap.MapLocation;\n }\n /**\n * Represents the icon button that closes the [hamburger menu](https://support.wix.com/en/article/editor-x-using-hamburger-menus).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerCloseButton.html#)\n */\n interface HamburgerCloseButton extends Element, HiddenCollapsedMixin, StyleMixin, LabelMixin, EffectsMixin {\n /**\n * Sets or gets the icon image displayed on the button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerCloseButton.html#icon)\n */\n icon: string;\n /**\n * Adds an event handler that runs when the element is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerCloseButton.html#onClick)\n * @eventType click\n */\n onClick(handler: MouseEventHandler): Element;\n }\n /**\n * The hamburger menu container holds the items of an expanded\n * [hamburger menu](https://support.wix.com/en/article/studio-editor-using-hamburger-menus).\n * It features a list of menu items that navigate to sections or pages on your site,\n * a fullscreen overlay, and a button to close the menu.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerMenuContainer.html#)\n */\n interface HamburgerMenuContainer extends Element, ClickableMixin, ContainableMixin {\n /**\n * Indicates if the hamburger menu container is currently open.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerMenuContainer.html#opened)\n */\n readonly opened: boolean;\n /**\n * Closes the hamburger menu container.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerMenuContainer.html#close)\n */\n close(): Promise;\n /**\n * Adds an event handler that is triggered when the menu container is closed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerMenuContainer.html#onClose)\n * @eventType close\n */\n onClose(handler: EventHandler): void;\n /**\n * Adds an event handler that is triggered when the menu container is opened.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerMenuContainer.html#onOpen)\n * @eventType open\n */\n onOpen(handler: EventHandler): void;\n /**\n * Opens the hamburger menu container.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerMenuContainer.html#open)\n */\n open(): Promise;\n }\n /**\n * Represents the icon button that opens the [hamburger menu](https://support.wix.com/en/article/editor-x-using-hamburger-menus).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerOpenButton.html#)\n */\n interface HamburgerOpenButton extends Element, HiddenCollapsedMixin, StyleMixin, LabelMixin, EffectsMixin {\n /**\n * Sets or gets the icon image displayed on the button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerOpenButton.html#icon)\n */\n icon: string;\n /**\n * Adds an event handler that runs when the element is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerOpenButton.html#onClick)\n * @eventType click\n */\n onClick(handler: MouseEventHandler): Element;\n }\n /**\n * Represents the fullscreen overlay that appears when the [hamburger menu](https://support.wix.com/en/article/editor-x-using-hamburger-menus) is open.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HamburgerOverlay.html#)\n */\n interface HamburgerOverlay extends Element, ClickableMixin, ContainableMixin {\n }\n /**\n * The [header](https://support.wix.com/en/article/wix-editor-about-your-sites-header) is the area of your site that appears at the top and\n * throughout all of your pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Header.html#)\n */\n interface Header extends Element, ClickableMixin, ContainableMixin, StyleMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Header.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the header's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Header.html#style)\n */\n readonly style: Style;\n }\n /**\n * Provides functionality for all elements that can be hidden or collapsed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenCollapsedElement.html#)\n */\n interface HiddenCollapsedElement extends Element, HiddenCollapsedMixin {\n }\n /**\n * Provides functionality for all elements that can be hidden or collapsed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenCollapsedMixin.html#)\n */\n interface HiddenCollapsedMixin extends HiddenMixin, CollapsedMixin {\n }\n /**\n * Provides functionality for elements that can be hidden.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenMixin.html#)\n */\n interface HiddenMixin {\n /**\n * Indicates if the element is visible or hidden.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenMixin.html#hidden)\n */\n readonly hidden: boolean;\n /**\n * Indicates if the element is actually visible.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenMixin.html#isVisible)\n */\n readonly isVisible: boolean;\n /**\n * Hides the element and sets its `hidden` property\n * to `true`, using an effect if specified.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenMixin.html#hide)\n */\n hide(effectName?: string, effectOptions?: EffectOptions.ArcEffectOptions | EffectOptions.BounceEffectOptions | EffectOptions.FadeEffectOptions | EffectOptions.FlipEffectOptions | EffectOptions.FloatEffectOptions | EffectOptions.FlyEffectOptions | EffectOptions.FoldEffectOptions | EffectOptions.GlideEffectOptions | EffectOptions.PuffEffectOptions | EffectOptions.RollEffectOptions | EffectOptions.SlideEffectOptions | EffectOptions.SpinEffectOptions | EffectOptions.TurnEffectOptions | EffectOptions.ZoomEffectOptions): Promise;\n /**\n * Shows the element and sets its `hidden` property\n * to `false`, using an effect if specified.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HiddenMixin.html#show)\n */\n show(effectName?: string, effectOptions?: EffectOptions.ArcEffectOptions | EffectOptions.BounceEffectOptions | EffectOptions.FadeEffectOptions | EffectOptions.FlipEffectOptions | EffectOptions.FloatEffectOptions | EffectOptions.FlyEffectOptions | EffectOptions.FoldEffectOptions | EffectOptions.GlideEffectOptions | EffectOptions.PuffEffectOptions | EffectOptions.RollEffectOptions | EffectOptions.SlideEffectOptions | EffectOptions.SpinEffectOptions | EffectOptions.TurnEffectOptions | EffectOptions.ZoomEffectOptions): Promise;\n }\n /**\n * An object representing an element's styles in the hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Hover.html#)\n */\n interface Hover {\n /**\n * Sets or gets the background color of an element in its hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Hover.html#backgroundColor)\n */\n backgroundColor: string;\n /**\n * Sets or gets the border color of an element in its hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Hover.html#borderColor)\n */\n borderColor: string;\n /**\n * Sets or gets the text color of an element in its hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Hover.html#color)\n */\n color: string;\n /**\n * Sets or gets the icon color of an element in its hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Hover.html#iconColor)\n */\n iconColor: string;\n }\n /**\n * An [HtmlComponent](https://support.wix.com/en/article/velo-working-with-the-html-iframe-element) is a container for internal or external HTML code.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#)\n */\n interface HtmlComponent extends IFrame {\n /**\n * Sets or gets the browser permissions for the HTML Component.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#allow)\n */\n allow: string;\n /**\n * Sets or gets whether the HTML Component displays scrollbars.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#scrolling)\n */\n scrolling: string;\n /**\n * Sets or gets the URL of the HTML Component's code.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#src)\n */\n src: string;\n /**\n * Allows the HTML Component to be put into full screen mode.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#allowFullScreen)\n */\n allowFullScreen(): HtmlComponent;\n /**\n * Adds an event handler that runs when the HTML Component\n * sends a message.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#onMessage)\n * @eventType message\n */\n onMessage(handler: HtmlComponentMessageEventHandler): HtmlComponent;\n /**\n * Sends a message to the HTML Component.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponent.html#postMessage)\n */\n postMessage(message: string | number | boolean | any | any[]): void;\n }\n /**\n * Event that is fired when the code in an HtmlComponent sends a message.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponentMessageEvent.html#)\n */\n interface HtmlComponentMessageEvent extends Event {\n /**\n * Gets the event data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.HtmlComponentMessageEvent.html#data)\n */\n readonly data: any;\n }\n /**\n * Event that is fired when a user hovers over a star on a ratings input component.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.IconMouseInEvent.html#)\n */\n interface IconMouseInEvent extends Event {\n /**\n * Gets the display label that corresponds to the icon that the mouse entered.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.IconMouseInEvent.html#label)\n */\n readonly label: string;\n /**\n * Gets the value (1-5) that corresponds to the icon that the mouse entered.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.IconMouseInEvent.html#value)\n */\n readonly value: number;\n }\n /**\n * Provides functionality for iframe-based elements, such as [`HtmlComponent`]($w.HtmlComponent.html).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.IFrame.html#)\n */\n interface IFrame extends Element, HiddenCollapsedMixin {\n }\n /**\n * [Images](https://support.wix.com/en/article/wix-media-supported-media-file-types-and-file-sizes?tabs=Images)\n * are stored in the [Media Manager](https://support.wix.com/en/article/about-the-media-manager)\n * or retrieved from an external web location.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#)\n */\n interface Image extends Element, HiddenCollapsedMixin, LinkableMixin, ClickableMixin, EffectsMixin {\n /**\n * Sets or gets an image's alt text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#alt)\n */\n alt: string;\n /**\n * Sets or gets the action that occurs when an image is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#clickAction)\n */\n clickAction: string;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets how an image is placed inside an image element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#fitMode)\n */\n fitMode: string;\n /**\n * Sets or gets the file location of the image.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#src)\n */\n src: string;\n /**\n * Sets or gets an image's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Image.html#tooltip)\n */\n tooltip: string;\n }\n /**\n * Event that is fired when the keyboard is pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.KeyboardEvent.html#)\n */\n interface KeyboardEvent extends Event {\n /**\n * Indicates if the Option key on a Mac or Alt key on a PC was pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.KeyboardEvent.html#altKey)\n */\n readonly altKey: boolean;\n /**\n * Indicates if the Control (Ctrl) key was pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.KeyboardEvent.html#ctrlKey)\n */\n readonly ctrlKey: boolean;\n /**\n * Gets a string representation of the key that was pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.KeyboardEvent.html#key)\n */\n readonly key: string;\n /**\n * Indicates if the ⌘ Command key on a Mac or ⊞ Windows key on a PC was pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.KeyboardEvent.html#metaKey)\n */\n readonly metaKey: boolean;\n /**\n * Indicates if the Shift key was pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.KeyboardEvent.html#shiftKey)\n */\n readonly shiftKey: boolean;\n }\n /**\n * Provides functionality for elements that have a label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.LabelMixin.html#)\n */\n interface LabelMixin {\n /**\n * Sets or gets the label of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.LabelMixin.html#label)\n */\n label: string;\n }\n /**\n * Provides functionality for elements that can act as links.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.LinkableMixin.html#)\n */\n interface LinkableMixin {\n /**\n * Sets or gets the element's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.LinkableMixin.html#link)\n */\n link: string;\n /**\n * Gets or sets the relationship between the link's source page and the target page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.LinkableMixin.html#rel)\n */\n rel: string;\n /**\n * Sets or gets the target of the element's link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.LinkableMixin.html#target)\n */\n target: string;\n }\n /**\n * The [Lottie](https://support.wix.com/en/article/wix-editor-importing-lottie-animations-to-your-site)\n * element is used for adding and customizing a Lottie animation.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#)\n */\n interface Lottie extends Element, FocusMixin, HiddenCollapsedMixin, ClickableMixin {\n /**\n * Sets or gets a Lottie animation's alt text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#alt)\n */\n alt: string;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets whether the Lottie animation plays in a loop.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#loop)\n */\n loop: boolean;\n /**\n * Sets or gets the Lottie animation's playback speed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#speed)\n */\n speed: number;\n /**\n * Sets or gets the source of the Lottie animation.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#src)\n */\n src: string;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#pause)\n */\n pause(): void;\n /**\n * Begins or resumes playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#play)\n */\n play(): void;\n /**\n * Stops the playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Lottie.html#stop)\n */\n stop(): void;\n }\n /**\n * A container for media items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MediaBox.html#)\n */\n interface MediaBox extends Element, HiddenCollapsedMixin, Background {\n }\n /**\n * [Menus](https://support.wix.com/en/article/wix-editor-adding-a-site-menu) are used for navigating between site pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#)\n */\n interface Menu extends Element, HiddenCollapsedMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#accessibility)\n */\n readonly accessibility: Menu.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets menu items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#menuItems)\n */\n menuItems: Menu.MenuItem[];\n /**\n * Adds an event handler that runs when a user clicks a menu item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#onItemClick)\n * @eventType ItemMouseClick\n */\n onItemClick(handler: MenuItemMouseEventHandler): Menu.MenuItem;\n /**\n * Adds an event handler that runs when a user double clicks a menu item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#onItemDblClick)\n * @eventType ItemMouseDblClick\n */\n onItemDblClick(handler: MenuItemMouseEventHandler): Menu.MenuItem;\n /**\n * Adds an event handler that runs when a user hovers over a menu item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#onItemMouseIn)\n * @eventType ItemMouseIn\n */\n onItemMouseIn(handler: MenuItemMouseEventHandler): Menu.MenuItem;\n /**\n * Adds an event handler that runs when a user stops hovering over a menu item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#onItemMouseOut)\n * @eventType ItemMouseOut\n */\n onItemMouseOut(handler: MenuItemMouseEventHandler): Menu.MenuItem;\n }\n /**\n * A [menu container](https://support.wix.com/en/article/wix-editor-about-the-mobile-menu) holds the elements in a\n * mobile menu that are used for navigating between mobile site pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuContainer.html#)\n */\n interface MenuContainer extends Element {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuContainer.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Closes a mobile menu.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuContainer.html#close)\n */\n close(): Promise;\n /**\n * Opens a mobile menu.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuContainer.html#open)\n */\n open(): Promise;\n }\n /**\n * Event that is fired when the mouse is used on a menu item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#)\n */\n interface MenuItemMouseEvent extends Event {\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the browser's viewable area.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#clientX)\n */\n readonly clientX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the browser's viewable area.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#clientY)\n */\n readonly clientY: number;\n /**\n * The menu item on which the event occurred.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#item)\n */\n readonly item: Menu.MenuItem;\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the element that triggered this event.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#offsetX)\n */\n readonly offsetX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the element that triggered this event.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#offsetY)\n */\n readonly offsetY: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#pageX)\n */\n readonly pageX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#pageY)\n */\n readonly pageY: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the screen or screens.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#screenX)\n */\n readonly screenX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the screen or screens.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MenuItemMouseEvent.html#screenY)\n */\n readonly screenY: number;\n }\n /**\n * A button element on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileButton.html#)\n */\n interface MobileButton extends MobileElement, MobileHiddenCollapsedMixin, MobileDisabledMixin, MobilePressableMixin {\n /**\n * Sets or gets a mobile button's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileButton.html#label)\n */\n label: string;\n }\n /**\n * A container element for repeater items on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileContainer.html#)\n */\n interface MobileContainer extends MobileElement, MobileHiddenCollapsedMixin, MobilePressableMixin, ContainableMixin {\n }\n /**\n * A mobile date picker\n * is used for entering dates. It lets mobile app users populate a\n * date field by picking a date using a calendar popup.\n * You can enable and disable dates, date ranges, and days of the week on your date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#)\n */\n interface MobileDatePicker extends Element, DisabledMixin, HiddenCollapsedMixin, MobileValueMixin, ReadOnlyMixin, RequiredMixin {\n /**\n * Gets the format of the date displayed in the mobile date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#dateFormat)\n */\n dateFormat: string;\n /**\n * Sets or gets ranges of dates that an app user can't select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#disabledDateRanges)\n */\n disabledDateRanges: MobileDatePicker.DateRange[];\n /**\n * Sets or gets the days of the week that an app user can't select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#disabledDaysOfWeek)\n */\n disabledDaysOfWeek: number[];\n /**\n * Sets or gets ranges of dates that an app user can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#enabledDateRanges)\n */\n enabledDateRanges: MobileDatePicker.DateRange[];\n /**\n * Sets or gets the label of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#label)\n */\n label: string;\n /**\n * Sets or gets the latest date that an app user can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#maxDate)\n */\n maxDate: Date;\n /**\n * Sets or gets the earliest date that an app user can select.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#minDate)\n */\n minDate: Date;\n /**\n * Sets or gets the mobile date picker's placeholder text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#placeholder)\n */\n placeholder: string;\n /**\n * Sets or gets the mobile date picker's timezone.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#timeZone)\n */\n timeZone: string;\n }\n /**\n * Provides functionality for mobile elements that can be disabled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDisabledMixin.html#)\n */\n interface MobileDisabledMixin {\n /**\n * Indicates if the mobile element is enabled or disabled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDisabledMixin.html#enabled)\n */\n readonly enabled: boolean;\n /**\n * Disables the mobile element and sets its `enabled` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDisabledMixin.html#disable)\n */\n disable(): Promise;\n /**\n * Enables the mobile element and sets its `enabled` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDisabledMixin.html#enable)\n */\n enable(): Promise;\n }\n /**\n * Provides basic functionality for mobile elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileElement.html#)\n */\n interface MobileElement {\n /**\n * Gets the mobile element's ID.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileElement.html#id)\n */\n readonly id: string;\n /**\n * Gets the mobile element's parent element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileElement.html#parent)\n */\n readonly parent: Node;\n /**\n * Gets the mobile element's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileElement.html#type)\n */\n readonly type: string;\n }\n /**\n * Provides functionality for input elements on mobile apps.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileFormElementMixin.html#)\n */\n interface MobileFormElementMixin extends MobileElement, MobileValueMixin {\n /**\n * Sets or gets whether to validate the mobile element when it loses focus.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileFormElementMixin.html#validateOnBlur)\n */\n validateOnBlur: boolean;\n }\n /**\n * Provides functionality for all mobile elements that can be hidden or collapsed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenCollapsedMixin.html#)\n */\n interface MobileHiddenCollapsedMixin extends MobileHiddenMixin, CollapsedMixin {\n /**\n * Indicates if the element is collapsed or expanded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenCollapsedMixin.html#collapsed)\n */\n readonly collapsed: boolean;\n /**\n * Collapses the element and sets its `collapsed` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenCollapsedMixin.html#collapse)\n */\n collapse(): Promise;\n /**\n * Expands the element and sets its `collapsed` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenCollapsedMixin.html#expand)\n */\n expand(): Promise;\n }\n /**\n * Provides functionality for mobile elements that can be hidden.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenMixin.html#)\n */\n interface MobileHiddenMixin extends HiddenMixin {\n /**\n * Indicates if the element is visible or hidden.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenMixin.html#hidden)\n */\n readonly hidden: boolean;\n /**\n * Indicates if the element is actually visible.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenMixin.html#isVisible)\n */\n readonly isVisible: boolean;\n /**\n * Hides the element and sets its `hidden` property\n * to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenMixin.html#hide)\n */\n hide(): Promise;\n /**\n * Shows the element and sets its `hidden` property\n * to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileHiddenMixin.html#show)\n */\n show(): Promise;\n }\n /**\n * An image element on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileImage.html#)\n */\n interface MobileImage extends MobileElement, MobileHiddenCollapsedMixin, MobilePressableMixin {\n /**\n * Sets or gets the image's source.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileImage.html#src)\n */\n src: string;\n }\n /**\n * A picker for selecting items on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#)\n */\n interface MobilePicker extends MobileElement, LabelMixin, MobileValueMixin, MobileHiddenCollapsedMixin, MobileDisabledMixin, MobilePressableMixin {\n /**\n * Sets or gets the picker's options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#options)\n */\n options: MobilePicker.Option[];\n /**\n * Sets or gets the option dialog's subtitle.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#optionsDialogSubtitle)\n */\n optionsDialogSubtitle: string;\n /**\n * Sets or gets the option dialog's title.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#optionsDialogTitle)\n */\n optionsDialogTitle: string;\n /**\n * Sets or gets the indicies of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#selectedIndices)\n */\n selectedIndices: number[];\n /**\n * Sets or gets the value of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when the mobile picker element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): MobilePicker;\n }\n /**\n * Provides functionality for elements on a mobile app that can be pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePressableMixin.html#)\n */\n interface MobilePressableMixin {\n /**\n * Adds an event handler that runs when the element is pressed for more than 500 milliseconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePressableMixin.html#onLongPress)\n * @eventType longPress\n */\n onLongPress(handler: EventHandler): MobileElement;\n /**\n * Adds an event handler that runs when an element on a mobile app is pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePressableMixin.html#onPress)\n * @eventType press\n */\n onPress(handler: EventHandler): MobileElement;\n /**\n * Adds an event handler that runs immediately when an element on a mobile app is pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePressableMixin.html#onPressIn)\n * @eventType pressIn\n */\n onPressIn(handler: EventHandler): MobileElement;\n /**\n * Adds an event handler that runs when an element on a mobile app is released after being pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePressableMixin.html#onPressOut)\n * @eventType pressOut\n */\n onPressOut(handler: EventHandler): MobileElement;\n }\n /**\n * The [repeater](https://support.wix.com/en/article/wix-editor-adding-and-managing-repeaters-lists-grids) mobile\n * element is used to create repeating layouts on a mobile app widget.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileRepeater.html#)\n */\n interface MobileRepeater extends MobileElement, MobileHiddenCollapsedMixin {\n /**\n * Sets or gets the repeater data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileRepeater.html#data)\n */\n data: any[];\n /**\n * Runs a function for each repeated item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileRepeater.html#forEachItem)\n */\n forEachItem(callback: ForItemCallback): void;\n /**\n * Runs a function for each repeated item with the given IDs.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileRepeater.html#forItems)\n */\n forItems(itemIds: string[], callback: ForItemCallback): void;\n /**\n * Sets the function that runs when a new repeated item is created.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileRepeater.html#onItemReady)\n * @eventType itemReady\n */\n onItemReady(handler: ItemReadyEventHandler): MobileRepeater;\n /**\n * Sets the function that runs when a repeated item is removed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileRepeater.html#onItemRemoved)\n * @eventType itemRemoved\n */\n onItemRemoved(handler: ItemRemovedEventHandler): MobileRepeater;\n }\n /**\n * A switch used for a single binary choice on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileSwitch.html#)\n */\n interface MobileSwitch extends MobileElement, MobileDisabledMixin, MobileHiddenCollapsedMixin {\n /**\n * Sets or gets the value of the switch state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileSwitch.html#value)\n */\n value: boolean;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileSwitch.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * A text element on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileText.html#)\n */\n interface MobileText extends MobileElement, MobileHiddenCollapsedMixin, MobilePressableMixin {\n /**\n * Sets or gets the plain-text contents of a text element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileText.html#text)\n */\n text: string;\n }\n /**\n * A [text input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-text-input) element for capturing small amounts of text on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileTextInput.html#)\n */\n interface MobileTextInput extends MobileElement, LabelMixin, MobileFormElementMixin, MobileHiddenCollapsedMixin, MobileDisabledMixin {\n /**\n * Sets or gets the input element's placeholder text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileTextInput.html#placeholder)\n */\n placeholder: string;\n }\n /**\n * Provides functionality for mobile elements that have values.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#)\n */\n interface MobileValueMixin {\n /**\n * Indicates if an input element's value is valid.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#valid)\n */\n readonly valid: boolean;\n /**\n * Sets or gets whether to validate the mobile element when its value changes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#validateOnChange)\n */\n validateOnChange: boolean;\n /**\n * Sets or gets whether to validate the mobile element when it is loaded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#validateOnStart)\n */\n validateOnStart: boolean;\n /**\n * Sets or gets the validations for mobile elements in a form.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#validations)\n */\n validations: MobileValueMixin.Validation[];\n /**\n * Sets or gets an element's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#value)\n */\n value: any;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): MobileElement;\n }\n /**\n * [Mobile Video player](https://support.wix.com/en/article/wix-video-displaying-videos-on-your-site) is an element for presenting videos.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#)\n */\n interface MobileVideoPlayer extends Element, HiddenCollapsedMixin {\n /**\n * Gets the current play time from the beginning of the current video, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#currentTime)\n */\n readonly currentTime: number;\n /**\n * Sets or gets the description of a video.\n * > **Note:** Setting a video description only works when a mobile video player is presenting a\n * > video uploaded to your app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#description)\n */\n description: string;\n /**\n * Gets the total play time of the current video in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#duration)\n */\n readonly duration: number;\n /**\n * Indicates if the volume is currently muted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#isMuted)\n */\n readonly isMuted: boolean;\n /**\n * Indicates if a video is currently playing.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#isPlaying)\n */\n readonly isPlaying: boolean;\n /**\n * Sets or gets the image shown in the video player before the video is played.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#poster)\n */\n poster: string;\n /**\n * Sets or gets the file location of the current video.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#src)\n */\n src: string;\n /**\n * Sets or gets the title displayed in a mobile video player.\n * > **Note:** Setting a video title only works when a mobile video player is presenting a\n * > video uploaded to your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#title)\n */\n title: string;\n /**\n * Sets or gets the video player volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#volume)\n */\n volume: number;\n /**\n * Mutes video volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#mute)\n */\n mute(): Promise;\n /**\n * Moves to the next item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#next)\n */\n next(): Promise;\n /**\n * Adds an event handler that runs when playback has ended.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#onEnded)\n * @eventType onEnded\n */\n onEnded(handler: EventHandler): MobileVideoPlayer;\n /**\n * Adds an event handler that runs when playback is paused.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#onPause)\n * @eventType onPause\n */\n onPause(handler: EventHandler): MobileVideoPlayer;\n /**\n * Adds an event handler that runs when playback is started or restarted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#onPlay)\n * @eventType onPlay\n */\n onPlay(handler: EventHandler): MobileVideoPlayer;\n /**\n * Adds an event handler that runs when playback progresses.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#onProgress)\n * @eventType onProgress\n */\n onProgress(handler: EventHandler): MobileVideoPlayer;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#pause)\n */\n pause(): Promise;\n /**\n * Begins or resumes playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#play)\n */\n play(): Promise;\n /**\n * Moves to the previous image or slide.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#previous)\n */\n previous(): Promise;\n /**\n * Moves playback to the specified time, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#seek)\n */\n seek(time: number): Promise;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#stop)\n */\n stop(): Promise;\n /**\n * Toggles playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#togglePlay)\n */\n togglePlay(): Promise;\n /**\n * Unmutes video volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileVideoPlayer.html#unmute)\n */\n unmute(): Promise;\n }\n /**\n * Event that is fired when the mouse is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#)\n */\n interface MouseEvent extends Event {\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the browser's viewable area.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#clientX)\n */\n readonly clientX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the browser's viewable area.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#clientY)\n */\n readonly clientY: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the element that triggered this event.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#offsetX)\n */\n readonly offsetX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the element that triggered this event.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#offsetY)\n */\n readonly offsetY: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#pageX)\n */\n readonly pageX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#pageY)\n */\n readonly pageY: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * left edge of the screen or screens.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#screenX)\n */\n readonly screenX: number;\n /**\n * Gets the distance in pixels between the pointer and the\n * top edge of the screen or screens.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MouseEvent.html#screenY)\n */\n readonly screenY: number;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#)\n */\n interface MultiStateBox extends Element, HiddenCollapsedMixin, ClickableMixin, ContainableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#accessibility)\n */\n readonly accessibility: MultiStateBox.Accessibility;\n /**\n * Gets the multi-state box's current state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#currentState)\n */\n readonly currentState: State;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets a list of all the states contained in the multi-state box.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#states)\n */\n readonly states: State[];\n /**\n * Sets or gets the tab index of a multi-state box on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Change the multi-state box's current state to a specific state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#changeState)\n */\n changeState(stateReference: string | State): Promise;\n /**\n * Adds an event handler that runs when the multi-state box moves to a new state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#onChange)\n * @eventType change\n */\n onChange(eventHandler: EventHandler): MultiStateBox;\n }\n /**\n * Provides basic functionality for all Wix objects, including objects\n * that are not [elements]($w.Element.html).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Node.html#)\n */\n interface Node {\n /**\n * Indicates if an element appears on all pages or only on the current page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Node.html#global)\n */\n readonly global: boolean;\n /**\n * Gets the element's ID.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Node.html#id)\n */\n readonly id: string;\n /**\n * Gets the element's parent element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Node.html#parent)\n */\n readonly parent: Node;\n /**\n * Gets the element's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Node.html#type)\n */\n readonly type: string;\n /**\n * Scrolls the page to the top of the element using an animation.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Node.html#scrollTo)\n */\n scrollTo(): Promise;\n }\n /**\n * A [page](https://support.wix.com/en/article/wix-editor-adding-a-page-to-your-site) is a web page that can contain other elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Page.html#)\n */\n interface Page extends Element, ClickableMixin, ContainableMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Page.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets the page's [SEO description](https://support.wix.com/en/article/adding-seo-page-titles-and-descriptions-meta-tags).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Page.html#description)\n */\n readonly description: string;\n /**\n * Gets the page's keywords.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Page.html#keywords)\n */\n readonly keywords: string[];\n /**\n * Gets the page's title.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Page.html#title)\n */\n readonly title: string;\n /**\n * Indicates if the page is included in the site's menu.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Page.html#visibleInMenu)\n */\n readonly visibleInMenu: boolean;\n }\n /**\n * [Pagination](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-pagination-bar) is an element for working with paging.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#)\n */\n interface Pagination extends Element, DisabledMixin, HiddenCollapsedMixin, ClickableMixin, ViewportMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#accessibility)\n */\n readonly accessibility: Pagination.Accessibility;\n /**\n * Sets or gets the current page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#currentPage)\n */\n currentPage: number;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Navigation layout type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#navigationType)\n */\n navigationType: string;\n /**\n * Whether the Next button is enabled in the pagination bar.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#nextEnabled)\n */\n nextEnabled: boolean;\n /**\n * Whether the Previous button is enabled in the pagination bar.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#previousEnabled)\n */\n previousEnabled: boolean;\n /**\n * Sets or gets the total number of pages shown in a pagination bar.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#totalPages)\n */\n totalPages: number;\n /**\n * Adds an event handler that runs when the pagination bar\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#onChange)\n * @eventType Change\n */\n onChange(handler: EventHandler): Pagination;\n /**\n * Adds an event handler that runs when the Next button in the pagination bar is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#onNextClicked)\n * @eventType Click\n */\n onNextClicked(handler: EventHandler): Pagination;\n /**\n * Adds an event handler that runs when the Previous button in the pagination bar is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#onPreviousClicked)\n * @eventType Click\n */\n onPreviousClicked(handler: EventHandler): Pagination;\n }\n /**\n * A button on your Blocks panel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#)\n */\n interface PanelButton extends HiddenCollapsedMixin, Element, DisabledMixin, LinkableMixin {\n /**\n * Sets or gets the button's label (the text that appears on the button).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#buttonLabel)\n */\n buttonLabel: string;\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the text above the button (field title). Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#label)\n */\n label: string;\n /**\n * Sets or gets the element's link to an external site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#link)\n */\n link: string;\n /**\n * Sets or gets the relationship between the page containing the panel button\n * link and the target page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#rel)\n */\n rel: string;\n /**\n * Sets or gets the button's size.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#size)\n */\n size: string;\n /**\n * Sets or gets the button's skin.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#skin)\n */\n skin: string;\n /**\n * Sets or gets whether the button is stretched to the full width of the panel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#stretched)\n */\n stretched: boolean;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#tooltip)\n */\n tooltip: string;\n /**\n * Adds an event handler that runs when the element is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#onClick)\n * @eventType click\n */\n onClick(handler: EventHandler): Element;\n }\n /**\n * Panel checkbox groups are used in the Blocks panel builder for selecting any number of the given options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#)\n */\n interface PanelCheckboxGroup extends HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#label)\n */\n label: string;\n /**\n * Sets or gets the options of the checkbox group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#options)\n */\n options: PanelCheckboxGroup.option[];\n /**\n * Sets or gets the indices of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#selectedIndices)\n */\n selectedIndices: number[];\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets the value of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#value)\n */\n value: string[];\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * Panel color picker elements are used in the Wix Blocks panel builder for selecting colors.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelColorPicker.html#)\n */\n interface PanelColorPicker extends PanelElementMixin, HiddenCollapsedMixin, Element, DisabledMixin, PanelElementMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelColorPicker.html#divider)\n */\n divider: string;\n /**\n * Sets or gets an element's color value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelColorPicker.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when an element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelColorPicker.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * Panel dropdowns are used in the Blocks panel builder for selecting one of a number of options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#)\n */\n interface PanelDropdown extends HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element. Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#label)\n */\n label: string;\n /**\n * Sets or gets the options in the dropdown.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#options)\n */\n options: PanelDropdown.option[];\n /**\n * Sets or gets the placeholder text of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#placeholder)\n */\n placeholder: string;\n /**\n * Sets or gets the index of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#selectedIndex)\n */\n selectedIndex: number;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets an element's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * Provides functionality for panel elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelElementMixin.html#)\n */\n interface PanelElementMixin extends LabelMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelElementMixin.html#divider)\n */\n divider: string;\n }\n /**\n * Panel font and color picker elements are used in the Wix Blocks panel builder for selecting fonts and colors.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#)\n */\n interface PanelFontAndColorPicker extends PanelElementMixin, HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets an element's color.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#color)\n */\n color: string;\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#divider)\n */\n divider: string;\n /**\n * Sets or gets an element's font.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#fontFamily)\n */\n fontFamily: string;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#tooltip)\n */\n tooltip: string;\n /**\n * Adds an event handler that runs when an element's color value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#onColorChange)\n * @eventType change\n */\n onColorChange(handler: EventHandler): Element;\n /**\n * Adds an event handler that runs when an element's font value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelFontAndColorPicker.html#onFontChange)\n * @eventType change\n */\n onFontChange(handler: EventHandler): Element;\n }\n /**\n * Panel radio button groups are used in the Blocks panel builder for selecting one of a number of options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#)\n */\n interface PanelRadioButtonGroup extends HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#label)\n */\n label: string;\n /**\n * Sets or gets the options in the radio button group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#options)\n */\n options: PanelRadioButtonGroup.option[];\n /**\n * Sets or gets the index of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#selectedIndex)\n */\n selectedIndex: number;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets an element's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * A rich text element is used in the Blocks panel builder to display text followed by a link.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRichText.html#)\n */\n interface PanelRichText extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRichText.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the URL of the rich text's link\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRichText.html#link)\n */\n link: string;\n /**\n * Sets or gets the label of the rich text's link\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRichText.html#linkLabel)\n */\n linkLabel: string;\n /**\n * Sets or gets the target of the rich text's link\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRichText.html#target)\n */\n target: string;\n /**\n * Sets or gets the text part of the rich text element (without the link). Maximum length is 120,000 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRichText.html#text)\n */\n text: string;\n }\n /**\n * Displays a section heading in the Blocks panel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSectionDivider.html#)\n */\n interface PanelSectionDivider extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets the label of an element. Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSectionDivider.html#label)\n */\n label: string;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSectionDivider.html#tooltip)\n */\n tooltip: string;\n }\n /**\n * Panel sliders allow site creators to select a number from a given range.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#)\n */\n interface PanelSlider extends HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element. Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#label)\n */\n label: string;\n /**\n * Sets or gets the slider's maximum value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#max)\n */\n max: number;\n /**\n * Sets or gets the slider's minimum value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#min)\n */\n min: number;\n /**\n * Sets or gets the slider's step value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#step)\n */\n step: number;\n /**\n * Sets or gets an element's tooltip. Maximum length is 1200 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets the unit of a slider's numeric input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#unit)\n */\n unit: string;\n /**\n * Sets or gets the value of the slider.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#value)\n */\n value: number;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelSlider.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * An input element in a Blocks panel for capturing small amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#)\n */\n interface PanelTextInput extends HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element. Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#label)\n */\n label: string;\n /**\n * Sets or gets the maximum number of characters in the input text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#maxLength)\n */\n maxLength: number;\n /**\n * Sets or gets the placeholder text of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#placeholder)\n */\n placeholder: string;\n /**\n * Sets or gets whether the value of the input element is read-only (cannot be modified by users).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#readOnly)\n */\n readOnly: boolean;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets an element's value.\n * Maximum length is 120 characters.\n * To reset the element, restoring any placeholder text, set the value\n * property to `null` or `undefined`.\n *\n * > **Note**: Changing an element's `value` in code does not trigger an `onChange` event.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelTextInput.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * A Panel thumbnail groups allow users to select an option using a set of thumbnail images in a Blocks panel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#)\n */\n interface PanelThumbnails extends HiddenCollapsedMixin, Element {\n /**\n * Sets or gets the number of thumbnail columns. Minimum is 1, maximum is 5.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#columnCount)\n */\n columnCount: number;\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element. Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#label)\n */\n label: string;\n /**\n * Sets or gets the options in the thumbnail group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#options)\n */\n options: PanelThumbnails.option[];\n /**\n * Gets the index of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#selectedIndex)\n */\n selectedIndex: number;\n /**\n * Sets or gets an element's tooltip.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#tooltip)\n */\n tooltip: string;\n /**\n * Sets or gets an element's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * Toggle switches are used in a Blocks panel for a single binary choice.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelToggleSwitch.html#)\n */\n interface PanelToggleSwitch extends HiddenCollapsedMixin, Element, DisabledMixin {\n /**\n * Sets or gets whether the toggle switch is on or off.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelToggleSwitch.html#checked)\n */\n checked: boolean;\n /**\n * Sets or gets the type of divider displayed under the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelToggleSwitch.html#divider)\n */\n divider: string;\n /**\n * Sets or gets the label of an element. Maximum length is 120 characters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelToggleSwitch.html#label)\n */\n label: string;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelToggleSwitch.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * Provides functionality for elements that can be played.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#)\n */\n interface PlayableMixin {\n /**\n * Indicates if the element is currently playing.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#isPlaying)\n */\n readonly isPlaying: boolean;\n /**\n * Moves to the next item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#next)\n */\n next(): Promise;\n /**\n * Adds an event handler that runs when playback is paused.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#onPause)\n * @eventType autoplayOff\n */\n onPause(handler: EventHandler): Gallery & Slideshow;\n /**\n * Adds an event handler that runs when playback is started or restarted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#onPlay)\n * @eventType autoplayOn\n */\n onPlay(handler: EventHandler): Gallery & Slideshow;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#pause)\n */\n pause(): void;\n /**\n * Begins or resumes playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#play)\n */\n play(): void;\n /**\n * Moves to the previous image or slide.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PlayableMixin.html#previous)\n */\n previous(): Promise;\n }\n /**\n * A post page for a specific blog post.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PostPage.html#)\n */\n interface PostPage extends Element, HiddenCollapsedMixin {\n /**\n * Gets the all the information associated with the current blog post.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PostPage.html#getPost)\n */\n getPost(): Promise;\n }\n /**\n * A store page for a specific product.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#)\n */\n interface ProductPage extends Element, HiddenCollapsedMixin {\n /**\n * Gets the values of a product's [custom text fields](https://support.wix.com/en/article/wix-stores-allowing-customers-to-add-a-message-when-purchasing-a-product).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#getCustomText)\n */\n getCustomText(): Promise;\n /**\n * Gets all the information associated with the current product.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#getProduct)\n */\n getProduct(): ProductPage.Productv1 & ProductPage.Productv3;\n /**\n * Gets the quantity of a product on the Product Page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#getQuantity)\n */\n getQuantity(): Promise;\n /**\n * Gets the selected [product option](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options) choices of a product on the Product Page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#getSelectedChoices)\n */\n getSelectedChoices(): Promise;\n /**\n * Gets the variant ID of the selected [product variant](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#getSelectedVariantId)\n */\n getSelectedVariantId(): Promise;\n /**\n * Adds an event handler that runs when the **Add To Cart** button on the Product Page is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#onAddToCart)\n */\n onAddToCart(addToCartEventHandler: ProductPage.addToCartEventHandler): Promise;\n /**\n * Adds an event handler that runs when the **Buy Now** button on the Product Page is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#onBuyNow)\n */\n onBuyNow(buyNowEventHandler: ProductPage.buyNowEventHandler): Promise;\n /**\n * Adds an event handler that runs when a [product option](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options) choice is selected.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#onChoiceSelected)\n */\n onChoiceSelected(choiceSelectedEventhandler: ProductPage.choiceSelectedEventHandler): Promise;\n /**\n * Adds an event handler that runs when a product's quantity is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#onQuantityChanged)\n */\n onQuantityChanged(quantityChangedEventHandler: ProductPage.quantityChangedEventHandler): Promise;\n /**\n * Sets the **Add To Cart** button's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#setAddToCartLabel)\n */\n setAddToCartLabel(label: string): Promise;\n /**\n * Sets the **Buy Now** button's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#setBuyNowLabel)\n */\n setBuyNowLabel(label: string): Promise;\n /**\n * Sets the quantity of a product on the Product Page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#setQuantity)\n */\n setQuantity(value: number): Promise;\n }\n /**\n * A [progress bar](https://support.wix.com/en/article/cms-adding-and-setting-up-a-progress-bar) is an element for displaying the status of an ongoing process.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#)\n */\n interface ProgressBar extends Element, HiddenCollapsedMixin, StyleMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#accessibility)\n */\n readonly accessibility: ProgressBar.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the progress bar's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets a progress bar's target value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#targetValue)\n */\n targetValue: number;\n /**\n * Sets or gets a progress bar's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#value)\n */\n value: number;\n }\n /**\n * A [quick action bar](https://support.wix.com/en/article/adding-and-setting-up-the-quick-action-bar-on-your-mobile-site)\n * helps your visitors contact you instantly from their mobile devices.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBar.html#)\n */\n interface QuickActionBar extends HiddenCollapsedMixin, StyleMixin {\n /**\n * Sets or gets a quick action bar's alignment.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBar.html#alignment)\n */\n alignment: boolean;\n /**\n * Sets or gets a quick action bar's color scheme.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBar.html#colorScheme)\n */\n colorScheme: string;\n /**\n * Sets or gets whether a quick action bar's color scheme is inverted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBar.html#invertColorScheme)\n */\n invertColorScheme: boolean;\n /**\n * Sets or gets whether a quick action bar's labels are shown.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBar.html#showLabels)\n */\n showLabels: boolean;\n /**\n * Adds an event handler that runs when an item in a quick action bar is\n * clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBar.html#onItemClicked)\n * @eventType itemClicked\n */\n onItemClicked(handler: QuickActionBarItemClickedEventHandler): QuickActionBar;\n }\n /**\n * Event that is fired when a quick action bar item is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBarItemClickedEvent.html#)\n */\n interface QuickActionBarItemClickedEvent extends Event {\n /**\n * Gets the gallery item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBarItemClickedEvent.html#item)\n */\n readonly item: QuickActionBarItemClickedEvent.QuickActionBarItem;\n /**\n * Gets the quick action bar item's index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBarItemClickedEvent.html#itemIndex)\n */\n readonly itemIndex: number;\n }\n /**\n * [Radio button groups](https://support.wix.com/en/article/content-manager-adding-and-setting-up-radio-buttons) are used for selecting one of a number of\n * options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#)\n */\n interface RadioButtonGroup extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#accessibility)\n */\n readonly accessibility: RadioButtonGroup.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the disabled items by their index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#disabledItemsByIndices)\n */\n disabledItemsByIndices: number[];\n /**\n * Sets or gets the options in a radio button group.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#options)\n */\n options: RadioButtonGroup.Option[];\n /**\n * Sets or gets the index of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#selectedIndex)\n */\n selectedIndex: number;\n /**\n * Gets an object containing information about the radio button group's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the value of the selected option.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#onCustomValidation)\n */\n onCustomValidation(validator: RadioButtonGroupValidator, override?: boolean): void;\n }\n /**\n * [Range sliders](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-range-slider)\n * allow site visitors to select a range of values within a given range.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#)\n */\n interface RangeSlider extends Element, ValueMixin, DisabledMixin, HiddenCollapsedMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#accessibility)\n */\n readonly accessibility: RangeSlider.Accessibility;\n /**\n * Sets or gets the label of a range slider.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#label)\n */\n label: string;\n /**\n * Sets or gets the maximum value of a range slider.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#max)\n */\n max: number;\n /**\n * Sets or gets the minimum value of a range slider.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#min)\n */\n min: number;\n /**\n * Sets or gets the prefix of a range slider's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#prefix)\n */\n prefix: string;\n /**\n * Sets or gets a range slider's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#sliderType)\n */\n sliderType: string;\n /**\n * Sets or gets a range slider's step value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#step)\n */\n step: number;\n /**\n * Sets or gets a range slider's step type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#stepType)\n */\n stepType: string;\n /**\n * Sets or gets the suffix of a range slider's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#suffix)\n */\n suffix: string;\n /**\n * Sets or gets the value(s) of a range slider's handle(s).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#value)\n */\n value: number | number[];\n }\n /**\n * A [ratings display](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-ratings-display-element)\n * element allows you to display a value to your users\n * using icons.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsDisplay.html#)\n */\n interface RatingsDisplay extends Element, HiddenCollapsedMixin, ClickableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsDisplay.html#accessibility)\n */\n readonly accessibility: RatingsDisplay.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsDisplay.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the displayed number of ratings.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsDisplay.html#numRatings)\n */\n numRatings: number;\n /**\n * Sets or gets the displayed rating.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsDisplay.html#rating)\n */\n rating: number;\n }\n /**\n * A [ratings input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-ratings-input-element)\n * element allows you to capture a value from your users\n * using icons.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#)\n */\n interface RatingsInput extends FormElement, DisabledMixin, RequiredMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, ViewportMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#accessibility)\n */\n readonly accessibility: RatingsInput.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the rating value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#value)\n */\n value: number;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#onCustomValidation)\n */\n onCustomValidation(validator: RatingsInput.RatingsInputValidator, override?: boolean): void;\n /**\n * Sets the function that runs when a user's mouse enters one of the rating icons.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#onIconMouseIn)\n * @eventType IconMouseIn\n */\n onIconMouseIn(handler: IconMouseInEventHandler): RatingsInput;\n }\n /**\n * The [React component](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/react-components/about-the-wix-react-component) element allows you to add your own [React](https://react.dev/) component.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReactComponent.html#)\n */\n interface ReactComponent extends Element, HiddenCollapsedMixin {\n /**\n * Sets or gets the React component's [props](https://react.dev/learn/passing-props-to-a-component).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReactComponent.html#props)\n */\n props: any;\n }\n /**\n * Event that is fired when a specific action is performed on the React element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReactEvent.html#)\n */\n interface ReactEvent {\n /**\n * Gets the context in which an event was fired.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReactEvent.html#context)\n */\n readonly context: Event.EventContext;\n /**\n * Gets the React component's $w element that the event was fired on.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReactEvent.html#wixTarget)\n */\n wixTarget: Element;\n }\n /**\n * Provides functionality for input elements that support readonly mode.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReadOnlyMixin.html#)\n */\n interface ReadOnlyMixin {\n /**\n * Sets or gets if a user can modify the value of the input element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ReadOnlyMixin.html#readOnly)\n */\n readOnly: boolean;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#)\n */\n interface Repeater extends Element, HiddenCollapsedMixin, EffectsMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the repeater data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#data)\n */\n data: any[];\n /**\n * Runs a function for each repeated item.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#forEachItem)\n */\n forEachItem(callback: ForItemCallback): void;\n /**\n * Runs a function for each repeated item with the given IDs.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#forItems)\n */\n forItems(itemIds: string[], callback: ForItemCallback): void;\n /**\n * Sets the function that runs when a new repeated item is created.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#onItemReady)\n * @eventType itemReady\n */\n onItemReady(handler: ItemReadyEventHandler): Repeater;\n /**\n * Sets the function that runs when a repeated item is removed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Repeater.html#onItemRemoved)\n * @eventType itemRemoved\n */\n onItemRemoved(handler: ItemRemovedEventHandler): Repeater;\n }\n /**\n * Provides functionality for input elements that can be required to have a value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RequiredMixin.html#)\n */\n interface RequiredMixin {\n /**\n * Sets or gets whether an input element is required to have a value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RequiredMixin.html#required)\n */\n required: boolean;\n }\n /**\n * The Rich Content Viewer is an element that displays rich content created using the\n * [Rich Content Editor](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-rich-content-and-adding-it-to-a-dynamic-page)\n * in the CMS (Content Management System).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichContentViewer.html#)\n */\n interface RichContentViewer extends Element, HiddenCollapsedMixin {\n /**\n * Sets or gets the element's content.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichContentViewer.html#content)\n */\n content: any | null;\n }\n /**\n * A [rich text box](https://support.wix.com/article/content-manager-adding-and-setting-up-a-text-input)\n * is an input element for entering information in rich text format. It shouldn't be confused with the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction), which provides access to a rich content field in a collection and can include various media types.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichTextBox.html#)\n */\n interface RichTextBox extends FormElement, DisabledMixin, TextInputMixin, HiddenCollapsedMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichTextBox.html#accessibility)\n */\n readonly accessibility: RichTextBox.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichTextBox.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * **This standard element function is not supported for RichTextBox.**\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichTextBox.html#onInput)\n */\n onInput(eventHandler: EventHandler): Element;\n }\n /**\n * A button used to initiate a site [search](https://support.wix.com/en/article/about-wix-site-search).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#)\n */\n interface SearchButton extends Element, HiddenCollapsedMixin, DisabledMixin, ClickableMixin, StyleMixin, LabelMixin, EffectsMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#accessibility)\n */\n readonly accessibility: SearchButton.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the icon image displayed on the button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#icon)\n */\n icon: string;\n /**\n * Indicates if the button’s icon is collapsed or expanded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#iconCollapsed)\n */\n readonly iconCollapsed: boolean;\n /**\n * Sets or gets a button's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#label)\n */\n label: string;\n /**\n * Gets an object containing information about the button's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Gets the element's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#type)\n */\n readonly type: string;\n /**\n * Collapses the button’s icon and sets its `iconCollapsed` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#collapseIcon)\n */\n collapseIcon(): Promise;\n /**\n * Expands the button’s icon and sets its `iconCollapsed` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#expandIcon)\n */\n expandIcon(): Promise;\n /**\n * Adds an event handler that runs when the pointer is moved\n * onto the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#onMouseIn)\n */\n onMouseIn(handler: MouseEventHandler): SearchButton;\n /**\n * Adds an event handler that runs when the pointer is moved\n * off of the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#onMouseOut)\n */\n onMouseOut(handler: MouseEventHandler): SearchButton;\n }\n /**\n * [Section](https://support.wix.com/en/article/wix-editor-about-sections) is a container component used to divide your page into meaningful segments.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Section.html#)\n */\n interface Section extends Element, Background, HiddenCollapsedMixin, ClickableMixin, ContainableMixin, EffectsMixin, StyleMixin {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Section.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the Section's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Section.html#style)\n */\n readonly style: Style;\n }\n /**\n * [Selection tags](https://support.wix.com/en/article/adding-and-setting-up-selection-tags) are used for selecting one or more options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#)\n */\n interface SelectionTags extends FormElement, HiddenCollapsedMixin, DisabledMixin, ClickableMixin, StyleMixin, RequiredMixin, ValidatableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#accessibility)\n */\n readonly accessibility: SelectionTags.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets a list of items which will be rendered as tags.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#options)\n */\n options: SelectionTags.Option[];\n /**\n * Sets or gets the indices of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#selectedIndices)\n */\n selectedIndices: number[];\n /**\n * Gets an object containing information about the selection tags' styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the values of the selected options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#value)\n */\n value: string[];\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#onCustomValidation)\n */\n onCustomValidation(validator: SelectionTags.SelectionTagsValidator, override?: boolean): void;\n }\n /**\n * [Signature input](https://support.wix.com/en/article/wix-forms-adding-a-signature-field) lets site visitors enter signatures.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#)\n */\n interface SignatureInput extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, StyleMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#accessibility)\n */\n readonly accessibility: SignatureInput.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the signature input element's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#style)\n */\n readonly style: Style;\n /**\n * Gets the value of a signature input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#value)\n */\n readonly value: string;\n /**\n * Clears the signature.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#clear)\n */\n clear(): void;\n /**\n * Adds an event handler that runs when a signature input element's value\n * is changed by a site visitor.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#onChange)\n */\n onChange(handler: EventHandler): SignatureInput;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#onCustomValidation)\n */\n onCustomValidation(validator: SignatureInput.SignatureInputValidator, override?: boolean): void;\n }\n /**\n * A [slide](https://support.wix.com/en/article/wix-editor-managing-the-slides-in-your-slideshow)\n * from a [slideshow]($w.Slideshow.html) that can contain other elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slide.html#)\n */\n interface Slide extends Element, Background, ContainableMixin {\n /**\n * Gets the slide's ID.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slide.html#id)\n */\n readonly id: string;\n /**\n * Gets the name of the slide.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slide.html#name)\n */\n readonly name: string;\n }\n /**\n * [Sliders](https://support.wix.com/en/article/adding-and-setting-up-a-slider) allow users to select a number from a given range.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#)\n */\n interface Slider extends Element, ValueMixin, DisabledMixin, HiddenCollapsedMixin, FocusMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#accessibility)\n */\n readonly accessibility: Slider.Accessibility;\n /**\n * Sets or gets the slider's maximum value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#max)\n */\n max: number;\n /**\n * Sets or gets the slider's minimum value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#min)\n */\n min: number;\n /**\n * Sets or gets a slider's step value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#step)\n */\n step: number;\n /**\n * Sets or gets a slider's step type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#stepType)\n */\n stepType: string;\n /**\n * Sets or gets the value of the slider.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#value)\n */\n value: number;\n }\n /**\n * [Slideshows](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-slideshow) are playable containers for slides.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#)\n */\n interface Slideshow extends Element, HiddenCollapsedMixin, PlayableMixin, ClickableMixin, ContainableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#accessibility)\n */\n readonly accessibility: Slideshow.Accessibility;\n /**\n * Gets the index of the slideshow's current slide.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#currentIndex)\n */\n readonly currentIndex: number;\n /**\n * Gets the slideshow's current slide.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#currentSlide)\n */\n readonly currentSlide: Slide;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets whether a slideshow's navigation buttons are shown.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#showNavigationButtons)\n */\n showNavigationButtons: boolean;\n /**\n * Set or returns whether a slideshow's slide buttons are shown.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#showSlideButtons)\n */\n showSlideButtons: boolean;\n /**\n * Gets a list of all the slides contained in the slideshow.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#slides)\n */\n readonly slides: Slide[];\n /**\n * Change the slideshow's current slide to a specific slide or index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#changeSlide)\n */\n changeSlide(slideReference: number | Slide): Promise;\n /**\n * Adds an event handler that runs when the slideshow moves to a new slide.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#onChange)\n * @eventType change\n */\n onChange(eventHandler: EventHandler): Slideshow;\n }\n /**\n * The [slideshow button](https://support.wix.com/en/article/wix-editor-displaying-navigation-buttons-and-arrows-on-your-slideshow)\n * is a button element on a [slideshow]($w.Slideshow.html).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#)\n */\n interface SlideshowButton extends Element, HiddenCollapsedMixin, DisabledMixin, ClickableMixin, StyleMixin, LabelMixin, EffectsMixin {\n /**\n * Sets or gets the icon image displayed on the slideshow button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#icon)\n */\n icon: string;\n /**\n * Indicates if the slideshow button icon is collapsed or expanded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#iconCollapsed)\n */\n readonly iconCollapsed: boolean;\n /**\n * Sets or gets the label of a slideshow button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#label)\n */\n label: string;\n /**\n * Gets an object containing information about the styles of a slideshow button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#style)\n */\n readonly style: Style;\n /**\n * Collapses the icon of a slideshow button and sets its `iconCollapsed` property to `true`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#collapseIcon)\n */\n collapseIcon(): Promise;\n /**\n * Expands the slideshow button icon and sets its `iconCollapsed` property to `false`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#expandIcon)\n */\n expandIcon(): Promise;\n /**\n * Adds an event handler that runs when the pointer is moved\n * onto the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#onMouseIn)\n */\n onMouseIn(handler: MouseEventHandler): SlideshowButton;\n /**\n * Adds an event handler that runs when the pointer is moved\n * off of the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SlideshowButton.html#onMouseOut)\n */\n onMouseOut(handler: MouseEventHandler): SlideshowButton;\n }\n /**\n * A [state](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/other-elements/multi-state-boxes/setting-up-your-multi-state-box#navigate-your-states)\n * from a [multi-state box]($w.MultiStateBox.html) that can contain other elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.State.html#)\n */\n interface State extends Element, Background, ContainableMixin {\n /**\n * Gets the state's ID.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.State.html#id)\n */\n readonly id: string;\n }\n /**\n * An object representing an element's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#)\n */\n interface Style {\n /**\n * Sets or gets the background color of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#backgroundColor)\n */\n backgroundColor: string;\n /**\n * Sets or gets the border color of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#borderColor)\n */\n borderColor: string;\n /**\n * Sets or gets the border radius of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#borderRadius)\n */\n borderRadius: string;\n /**\n * Sets or gets the border width of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#borderWidth)\n */\n borderWidth: string;\n /**\n * Sets or gets the text color of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#color)\n */\n color: string;\n /**\n * Gets an object containing information about the element's styles in the disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#disabled)\n */\n readonly disabled: Disabled;\n /**\n * Sets or gets the foreground color of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#foregroundColor)\n */\n foregroundColor: string;\n /**\n * Gets an object containing information about the element's styles in their hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#hover)\n */\n readonly hover: Hover;\n /**\n * Sets or gets the icon color of an element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Style.html#iconColor)\n */\n iconColor: string;\n }\n /**\n * Provides functionality for elements that can be styled in their disabled state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.StyleDisabledState.html#)\n */\n interface StyleDisabledState {\n }\n /**\n * Provides functionality for elements that can be styled in their hover state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.StyleHoverState.html#)\n */\n interface StyleHoverState {\n }\n /**\n * Provides functionality for elements that can be styled.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.StyleMixin.html#)\n */\n interface StyleMixin {\n /**\n * Gets an object containing information about the element's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.StyleMixin.html#style)\n */\n readonly style: Style;\n }\n /**\n * [Switches](https://support.wix.com/en/article/adding-and-setting-up-a-switch-element) are used for a single binary choice.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Switch.html#)\n */\n interface Switch extends Element, DisabledMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, ValueMixin, CheckedMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Switch.html#accessibility)\n */\n readonly accessibility: Switch.Accessibility;\n /**\n * Sets or gets whether a switch is on or off.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Switch.html#checked)\n */\n checked: boolean;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Switch.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * **Note: This standard element property is not relevant for Switch. Use [`checked`](#checked) instead.**\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Switch.html#value)\n */\n readonly value: string;\n }\n /**\n * A [tab](https://support.wix.com/en/article/wix-editor-about-tabs) within a [tabs]($w.Tabs.html) element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tab.html#)\n */\n interface Tab extends Element, Background, ContainableMixin {\n /**\n * Gets the tab's ID.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tab.html#id)\n */\n readonly id: string;\n /**\n * Sets or gets the tab's label.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tab.html#label)\n */\n label: string;\n /**\n * Gets the element's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tab.html#type)\n */\n readonly type: string;\n }\n /**\n * A [table](https://support.wix.com/en/article/content-manager-displaying-collection-content-in-a-table) for displaying data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#)\n */\n interface Table extends Element, HiddenCollapsedMixin, ClickableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#accessibility)\n */\n readonly accessibility: Table.Accessibility;\n /**\n * Sets or gets the defining properties of the columns in a table.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#columns)\n */\n columns: Table.Column[];\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets the function that is called when a new page of table data is to be displayed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#dataFetcher)\n */\n dataFetcher: Function;\n /**\n * Sets or gets the table's pagination options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#pagination)\n */\n pagination: Table.PaginationOptions;\n /**\n * Sets or gets the table's row data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#rows)\n */\n rows: any[];\n /**\n * Adds an event handler that runs when a table cell is selected.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#onCellSelect)\n * @eventType cellSelect\n */\n onCellSelect(eventHandler: TableCellEventHandler): Table;\n /**\n * Adds an event handler that runs when the table's data is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#onDataChange)\n * @eventType dataChange\n */\n onDataChange(eventHandler: EventHandler): void;\n /**\n * Adds an event handler that runs when a table row is selected.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#onRowSelect)\n * @eventType rowSelect\n */\n onRowSelect(eventHandler: TableRowEventHandler): Table;\n /**\n * Fetches the most current data and updates the table.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#refresh)\n */\n refresh(): void;\n /**\n * Selects a table row by index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#selectRow)\n */\n selectRow(index: number): void;\n /**\n * Updates the row data of a single row at the specified index.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#updateRow)\n */\n updateRow(index: number, rowData: any): void;\n }\n /**\n * Event that is fired when a table cell is selected.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableCellEvent.html#)\n */\n interface TableCellEvent extends Event {\n /**\n * Gets the column ID of the selected cell.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableCellEvent.html#cellColumnId)\n */\n readonly cellColumnId: string;\n /**\n * Gets the data from the selected cell.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableCellEvent.html#cellData)\n */\n readonly cellData: string;\n /**\n * Gets the row index of the selected cell.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableCellEvent.html#cellRowIndex)\n */\n readonly cellRowIndex: number;\n }\n /**\n * Event that is fired when a table row is selected.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableRowEvent.html#)\n */\n interface TableRowEvent extends Event {\n /**\n * Gets the data for the selected row.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableRowEvent.html#rowData)\n */\n readonly rowData: any;\n /**\n * Gets the index of the selected row.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TableRowEvent.html#rowIndex)\n */\n readonly rowIndex: number;\n }\n /**\n * A [tabs](https://support.wix.com/en/article/wix-editor-about-tabs) element is a container that holds multiple\n * [tabs]($w.Tab.html), displaying one at a time.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#)\n */\n interface Tabs extends Element, HiddenCollapsedMixin, ClickableMixin, ContainableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#accessibility)\n */\n readonly accessibility: Tabs.Accessibility;\n /**\n * Gets the tab currently displayed in the tabs element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#currentTab)\n */\n readonly currentTab: Tab;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets the tabs element's default tab.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#defaultTab)\n */\n readonly defaultTab: Tab;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Gets a list of all the tabs contained in the tabs element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#tabs)\n */\n readonly tabs: Tab[];\n /**\n * Gets the element's type.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#type)\n */\n readonly type: string;\n /**\n * Changes the tabs element's current tab.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#changeTab)\n */\n changeTab(tabReference: string | Tab): Promise;\n /**\n * Adds an event handler that runs when the tabs element moves to a different tab.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#onChange)\n * @eventType change\n */\n onChange(eventHandler: EventHandler): void;\n /**\n * Adds an event handler that runs when any tab menu item is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#onTabItemClicked)\n * @eventType click\n */\n onTabItemClicked(eventHandler: EventHandler): Tabs;\n /**\n * Changes the order of the tabs in a tabs element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#orderTabs)\n */\n orderTabs(orderedTabIds: string[] | Tab[]): Promise;\n }\n /**\n * [Text](https://support.wix.com/en/article/wix-editor-adding-and-editing-text) provides functionality for text elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#)\n */\n interface Text extends Element, HiddenCollapsedMixin, ClickableMixin, EffectsMixin, FocusMixin, StyleMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#accessibility)\n */\n readonly accessibility: Text.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the contents of a text element using standard HTML.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#html)\n */\n html: string;\n /**\n * Gets an object containing information about the Text's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Sets or gets the plain-text contents of a text element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#text)\n */\n text: string;\n }\n /**\n * [Text box](https://support.wix.com/en/article/wix-editor-adding-and-editing-text) is an input element for capturing large amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#)\n */\n interface TextBox extends LabelMixin, FormElement, DisabledMixin, TextInputMixin, HiddenCollapsedMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, StyleMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#accessibility)\n */\n readonly accessibility: TextBox.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets an object containing information about the text box's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Sets or gets a text input's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#value)\n */\n value: string;\n /**\n * Determines if the text contains line breaks when its value is read.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#wrap)\n */\n wrap: string;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#onCustomValidation)\n */\n onCustomValidation(validator: TextBoxValidator, override?: boolean): void;\n }\n /**\n * The TextEffects element is a decorative text element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextEffects.html#)\n */\n interface TextEffects extends Element, HiddenCollapsedMixin, LinkableMixin {\n /**\n * Sets or gets the plain-text content of the `textEffects` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextEffects.html#text)\n */\n text: string;\n }\n /**\n * [Text input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-text-input) is an element for capturing small amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#)\n */\n interface TextInput extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, TextInputMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, StyleMixin, RequiredMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#accessibility)\n */\n readonly accessibility: TextInput.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the input type of an Input element. Does not change the type of data stored in the text input's `value` property, which will remain a string.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#inputType)\n */\n inputType: string;\n /**\n * Sets or gets the maximum value for a text input element whose\n * type is set to **Number**.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#max)\n */\n max: number;\n /**\n * Sets or gets the minimum value for a text input element whose\n * type is set to **Number**.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#min)\n */\n min: number;\n /**\n * Indicates if the number spinner is hidden or visible for a numeric text input element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#numberSpinnerHidden)\n */\n readonly numberSpinnerHidden: boolean;\n /**\n * Gets an object containing information about the text input's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#style)\n */\n readonly style: Style;\n /**\n * Sets or gets the tab index of an element on a site page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#tabIndex)\n */\n tabIndex: number;\n /**\n * Gets a ValidityState object that contains\n * detailed information about the validity states of the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#validity)\n */\n readonly validity: ValidatableMixin.ValidityState;\n /**\n * Sets or gets a text input's value. This value will always be of type string, regardless of the text input's [`inputType`](#inputtype).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#value)\n */\n value: string;\n /**\n * Hides the number spinner for a numeric text input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#hideNumberSpinner)\n */\n hideNumberSpinner(): void;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#onCustomValidation)\n */\n onCustomValidation(validator: TextInputValidator, override?: boolean): void;\n /**\n * Shows the number spinner for a numeric text input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#showNumberSpinner)\n */\n showNumberSpinner(): void;\n }\n /**\n * Provides functionality for elements that accept text as input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInputMixin.html#)\n */\n interface TextInputMixin {\n /**\n * Sets or gets the maximum number of characters that can be entered.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInputMixin.html#maxLength)\n */\n maxLength: number;\n /**\n * Sets or gets the element's placeholder text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInputMixin.html#placeholder)\n */\n placeholder: string;\n /**\n * Adds an event handler that runs when the input element receives\n * input.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInputMixin.html#onInput)\n * @eventType onInput\n */\n onInput(eventHandler: EventHandler): Element;\n /**\n * Adds an event handler that runs when the cursor is inside the\n * input element and a key is pressed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInputMixin.html#onKeyPress)\n * @eventType keyPress\n */\n onKeyPress(eventHandler: KeyboardEventHandler): Element;\n }\n /**\n * The TextMarquee element displays a line of text that moves horizontally.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMarquee.html#)\n */\n interface TextMarquee extends Element, HiddenCollapsedMixin, LinkableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMarquee.html#accessibility)\n */\n readonly accessibility: TextMarquee.Accessibility;\n /**\n * Sets or gets the plain-text content of a TextMarquee element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMarquee.html#text)\n */\n text: string;\n }\n /**\n * The TextMask element is used for masking media inside text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMask.html#)\n */\n interface TextMask extends Element, Background, HiddenCollapsedMixin, LinkableMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMask.html#accessibility)\n */\n readonly accessibility: TextMask.Accessibility;\n /**\n * Sets or gets an object containing information about the TextMask's background.\n *\n * Setting the `src` property sets the source of the TextMask's background. The `src` property can be set to an image or a video. Images can either be from the [Media Manager](https://support.wix.com/en/article/about-the-media-manager) or an external image from any web location. Videos must come from the Media Manager.\n *\n * The supported URL formats are:\n * + Images from the Media Manager: `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n * + Videos from the Media Manager: `wix:video://v1//#posterUri=&posterWidth=&posterHeight=`\n * + Images from the web: `http(s)://`\n *\n * The URL for Media Manager images and videos is the `fileUrl` value returned by the [`listFiles()`](https://www.wix.com/velo/reference/wix-media-v2/files/listfiles) function.\n *\n * Getting the `src` property gets the source of the TextMask's background.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMask.html#background)\n */\n background: Background.BackgroundOptions;\n /**\n * Sets or gets the plain-text content of a TextMask element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMask.html#text)\n */\n text: string;\n }\n /**\n * The TextParticles element displays a line of text as animated particles that fluidly disperse and regroup.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#)\n */\n interface TextParticles extends Element, HiddenCollapsedMixin, LinkableMixin {\n /**\n * Sets or gets the plain-text content of a TextParticles element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#text)\n */\n text: string;\n /**\n * Registers an event handler that runs when the text particles animation pauses.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#onPause)\n */\n onPause(handler: EventHandler): TextParticles;\n /**\n * Registers an event handler that runs when the text particles animation begins playing.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#onPlay)\n */\n onPlay(handler: EventHandler): TextParticles;\n /**\n * Registers an event handler that runs when the text particles animation stops.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#onStop)\n */\n onStop(handler: EventHandler): TextParticles;\n /**\n * Pauses the currently playing animation.\n *\n * Pausing an animation triggers the `onPause()` event handler.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#pause)\n */\n pause(): Promise;\n /**\n * Plays the text particles animation for the beginning or from the point where the animation was paused.\n *\n * The first animation play of the queue triggers the `onPlay()` event handler.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#play)\n */\n play(): Promise;\n /**\n * Stops the currently playing animation and resets it to its initial state. The visibility of the text in the initial state depends on the type of animation that was playing.\n *\n * Stopping an animation triggers the `onStop()` event handler.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextParticles.html#stop)\n */\n stop(): Promise;\n }\n /**\n * A thank you page displayed when an order is created.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ThankYouPage.html#)\n */\n interface ThankYouPage extends Element, HiddenCollapsedMixin {\n /**\n * Gets the order associated with the current page.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ThankYouPage.html#getOrder)\n */\n getOrder(): Promise;\n }\n /**\n * [Time picker](https://support.wix.com/en/article/time-picker-settings) is an input element for capturing the time of day.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#)\n */\n interface TimePicker extends LabelMixin, FocusMixin, DisabledMixin, HiddenCollapsedMixin, RequiredMixin, ReadOnlyMixin, FormElement {\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the time slots that are available for a time picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#enabledTimes)\n */\n enabledTimes: TimePicker.TimeSlot[];\n /**\n * Sets or gets the number of minutes the time picker steps.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#step)\n */\n step: number;\n /**\n * Sets or gets whether the time picker uses 12-hour or 24-hour format.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#useAmPmFormat)\n */\n useAmPmFormat: boolean;\n /**\n * Sets or gets a time picker's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#value)\n */\n value: string;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#onCustomValidation)\n */\n onCustomValidation(validator: TimePicker.TimePickerValidator, override?: boolean): void;\n }\n /**\n * An [upload button](https://support.wix.com/en/article/content-manager-adding-and-setting-up-an-upload-button) enables site visitors to upload files to your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#)\n */\n interface UploadButton extends LabelMixin, FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, StyleMixin, RequiredMixin {\n /**\n * Sets or gets the label on the upload button.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#buttonLabel)\n */\n buttonLabel: string;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the maximum amount of files a site visitor can upload at a time.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#fileLimit)\n */\n fileLimit: number;\n /**\n * Sets or gets the type of file a site visitor can upload.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#fileType)\n */\n fileType: string;\n /**\n * Gets an object containing information about the upload button's styles.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#style)\n */\n readonly style: Style;\n /**\n * Indicates if a required file was selected, and if the file is valid for upload to the Media Manager.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#valid)\n */\n readonly valid: boolean;\n /**\n * Gets a message indicating why the file is invalid or could not be uploaded. Contains\n * empty string if the file is valid and successfully uploaded.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#validationMessage)\n */\n readonly validationMessage: string;\n /**\n * Gets a ValidityState object that contains\n * detailed information about the validity states of the file to upload.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#validity)\n */\n readonly validity: UploadButton.ValidityState;\n /**\n * Returns a list of files that are pending upload.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#value)\n */\n readonly value: UploadButton.File[];\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#onCustomValidation)\n */\n onCustomValidation(validator: UploadButtonValidator, override?: boolean): void;\n /**\n * Clears the files that are pending upload.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#reset)\n */\n reset(): void;\n /**\n * **Deprecated.** This function will continue to work, but a newer version is available. Use the\n * [`uploadFiles()`](#uploadFiles) function instead.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#startUpload)\n */\n startUpload(): Promise;\n /**\n * Uploads the files that the site visitor has chosen.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#uploadFiles)\n */\n uploadFiles(): Promise;\n }\n /**\n * Provides functionality for elements that can be validated.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#)\n */\n interface ValidatableMixin {\n /**\n * Indicates if an input element's value is valid.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#valid)\n */\n readonly valid: boolean;\n /**\n * Gets a message indicating why the element is invalid, or an\n * empty string if the message is valid.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#validationMessage)\n */\n readonly validationMessage: string;\n /**\n * Gets a ValidityState object that contains\n * detailed information about the validity states of the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#validity)\n */\n readonly validity: ValidatableMixin.ValidityState;\n /**\n * Adds an event handler that runs when the element's validation is checked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#onCustomValidation)\n */\n onCustomValidation(validator: Validator, override?: boolean): void;\n /**\n * Resets the element's visual validity indication.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#resetValidityIndication)\n */\n resetValidityIndication(): void;\n /**\n * Updates the element's visual validity indication based on its current validity state.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#updateValidityIndication)\n */\n updateValidityIndication(): void;\n }\n /**\n * Adds the value property to elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValueMixin.html#)\n */\n interface ValueMixin {\n /**\n * Sets or gets an element's value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValueMixin.html#value)\n */\n value: any;\n /**\n * Adds an event handler that runs when an input element's value\n * is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValueMixin.html#onChange)\n * @eventType change\n */\n onChange(handler: EventHandler): Element;\n }\n /**\n * [Vector images](https://support.wix.com/en/article/wix-editor-about-vector-art) are digital illustrations based on geometric shapes.\n * They maintain their high quality when resized.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VectorImage.html#)\n */\n interface VectorImage extends Element, HiddenCollapsedMixin, LinkableMixin, ClickableMixin, EffectsMixin {\n /**\n * Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) and other accessibility properties for the element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VectorImage.html#accessibility)\n */\n readonly accessibility: VectorImage.Accessibility;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VectorImage.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the file location of the vector image.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VectorImage.html#src)\n */\n src: string;\n }\n /**\n * **Deprecated.**\n * This API will continue to work, but a newer version is available at\n * [Video Player]($w/video-player).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Video.html#)\n */\n interface Video extends Element, HiddenCollapsedMixin {\n /**\n * Sets or gets the URL of the video.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Video.html#videoUrl)\n */\n videoUrl: string;\n }\n /**\n * [Video box](https://support.wix.com/en/article/videobox) is an element for displaying videos in customizable video containers.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#)\n */\n interface VideoBox extends Element, HiddenCollapsedMixin {\n /**\n * Gets the current play time from the beginning of the current video, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#currentTime)\n */\n readonly currentTime: number;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Gets the total play time of the current video, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#duration)\n */\n readonly duration: number;\n /**\n * Indicates if the volume is currently muted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#isMuted)\n */\n readonly isMuted: boolean;\n /**\n * Indicates if a video is currently playing.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#isPlaying)\n */\n readonly isPlaying: boolean;\n /**\n * Sets or gets the file location of the current video.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#src)\n */\n src: string;\n /**\n * Sets or gets the video box volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#volume)\n */\n readonly volume: number;\n /**\n * Mutes video box volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#mute)\n */\n mute(): Promise;\n /**\n * Adds an event handler that runs when the playback has ended.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#onEnded)\n * @eventType onEnded\n */\n onEnded(handler: EventHandler): VideoBox;\n /**\n * **Note: This standard element property is not relevant for VideoBox.**\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#onMouseIn)\n * @eventType mouseenter\n */\n onMouseIn(handler: MouseEventHandler): Element;\n /**\n * **Note: This standard element property is not relevant for VideoBox.**\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#onMouseOut)\n * @eventType mouseleave\n */\n onMouseOut(handler: MouseEventHandler): Element;\n /**\n * Adds an event handler that runs when the playback is paused.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#onPause)\n * @eventType onPause\n */\n onPause(handler: EventHandler): VideoBox;\n /**\n * Adds an event handler that runs when the playback is started or restarted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#onPlay)\n * @eventType onPlay\n */\n onPlay(handler: EventHandler): VideoBox;\n /**\n * Adds an event handler that runs when the playback progresses.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#onProgress)\n * @eventType onProgress\n */\n onProgress(handler: EventHandler): VideoBox;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#pause)\n */\n pause(): Promise;\n /**\n * Begins or resumes playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#play)\n */\n play(): Promise;\n /**\n * Stops the playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#stop)\n */\n stop(): Promise;\n /**\n * Toggles playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#togglePlay)\n */\n togglePlay(): Promise;\n /**\n * Unmutes video volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoBox.html#unmute)\n */\n unmute(): Promise;\n }\n /**\n * [Video player](https://support.wix.com/en/article/wix-video-displaying-videos-on-your-site) is an element for presenting videos.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#)\n */\n interface VideoPlayer extends Element, HiddenCollapsedMixin {\n /**\n * Gets the current play time from the beginning of the current video, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#currentTime)\n */\n readonly currentTime: number;\n /**\n * A property that represents an element's custom CSS classes.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#customClassList)\n */\n readonly customClassList: CustomClassList;\n /**\n * Sets or gets the description of a video.\n * > **Notes:**\n * > - Setting a video description only works when a video player is presenting a\n * > video uploaded to your site.\n * > - Getting a video description does not work when a video player is presenting a\n * > video from Facebook, Twitch, or YouTube.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#description)\n */\n description: string;\n /**\n * Gets the total play time of the current video, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#duration)\n */\n readonly duration: number;\n /**\n * Indicates if the volume is currently muted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#isMuted)\n */\n readonly isMuted: boolean;\n /**\n * Indicates if a video is currently playing.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#isPlaying)\n */\n readonly isPlaying: boolean;\n /**\n * Sets or gets the image shown in the video player before the video is played.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#poster)\n */\n poster: string;\n /**\n * Sets or gets the file location of the current video.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#src)\n */\n src: string;\n /**\n * Sets or gets the title displayed in a video player.\n * > **Notes:**\n * > - Setting a video title only works when a video player is presenting a\n * > video uploaded to your site.\n * > - Getting a video title does not work when a video player is presenting a\n * > video from Facebook, Twitch, or YouTube.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#title)\n */\n title: string;\n /**\n * Sets or gets the video player volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#volume)\n */\n volume: number;\n /**\n * Mutes video volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#mute)\n */\n mute(): Promise;\n /**\n * Adds an event handler that runs when playback has ended.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#onEnded)\n * @eventType onEnded\n */\n onEnded(handler: EventHandler): VideoPlayer;\n /**\n * Adds an event handler that runs when playback is paused.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#onPause)\n * @eventType onPause\n */\n onPause(handler: EventHandler): VideoPlayer;\n /**\n * Adds an event handler that runs when playback is started or restarted.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#onPlay)\n * @eventType onPlay\n */\n onPlay(handler: EventHandler): VideoPlayer;\n /**\n * Adds an event handler that runs when playback progresses.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#onProgress)\n * @eventType onProgress\n */\n onProgress(handler: EventHandler): VideoPlayer;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#pause)\n */\n pause(): Promise;\n /**\n * Begins or resumes playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#play)\n */\n play(): Promise;\n /**\n * Moves playback to the specified time, in seconds.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#seek)\n */\n seek(time: number): Promise;\n /**\n * Pauses playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#stop)\n */\n stop(): Promise;\n /**\n * Toggles playback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#togglePlay)\n */\n togglePlay(): Promise;\n /**\n * Unmutes video volume.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VideoPlayer.html#unmute)\n */\n unmute(): Promise;\n }\n /**\n * The ViewChangeEvent is triggered when the month or year changes on a date picker or appointment field element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewChangeEvent.html#)\n */\n interface ViewChangeEvent {\n /**\n * Gets the context in which an event was triggered.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewChangeEvent.html#context)\n */\n readonly context: Event.EventContext;\n /**\n * Gets the options that relate to the date picker or appointment field view change event.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewChangeEvent.html#options)\n */\n readonly options: ViewChangeEvent.ViewChangeEventOptions;\n /**\n * Gets the type of event that was triggered.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewChangeEvent.html#type)\n */\n readonly type: string;\n }\n /**\n * Provides functionality for elements that can be scrolled into and out\n * of view.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewportMixin.html#)\n */\n interface ViewportMixin {\n /**\n * Adds an event handler that runs when an element is displayed\n * in the viewable part of the current window.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewportMixin.html#onViewportEnter)\n * @eventType viewportEnter\n */\n onViewportEnter(handler: EventHandler): Element;\n /**\n * Adds an event handler that runs when an element is no longer\n * displayed in the viewable part of the current window.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewportMixin.html#onViewportLeave)\n * @eventType viewportLeave\n */\n onViewportLeave(handler: EventHandler): Element;\n }\n /**\n * The [`WixComments`](https://support.wix.com/en/article/wix-comments-an-overview) element is a customizable widget for site visitors to leave comments and feedback.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#)\n */\n interface WixComments extends Element {\n /**\n * Indicates whether the `WixComments` element is locked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#locked)\n */\n readonly locked: boolean;\n /**\n * Closes all comment boxes on the `WixComments` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#closeCommentBoxes)\n */\n closeCommentBoxes(): Promise;\n /**\n * Locks the `WixComments` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#lock)\n */\n lock(): void;\n /**\n * Adds an event handler that runs when a comment is added or removed from the `WixComments` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#onCommentCountChange)\n */\n onCommentCountChange(callback: OnCommentCountChangeCallback): Promise;\n /**\n * Adds an event handler that runs when a new comment is created in the `WixComments` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#onCommentCreate)\n */\n onCommentCreate(callback: OnCommentCreateCallback): Promise;\n /**\n * Opens the comment box closest to the element that called the function.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#openNearestCommentBox)\n */\n openNearestCommentBox(commentBoxOptions?: CommentBoxOptions): Promise;\n /**\n * Retrieves a comment thread with a unique resource ID, or creates one if it doesn't exist.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#setResourceId)\n */\n setResourceId(resourceId: string): void;\n /**\n * Unlocks the `WixComments` element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixComments.html#unlock)\n */\n unlock(): void;\n }\n /**\n * Provides functionality for refining a filter.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#)\n */\n interface WixDataFilter {\n /**\n * Adds an `and` condition to the filter.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#and)\n */\n and(filter: WixDataFilter): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value is within a specified range.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#between)\n */\n between(propertyName: string, rangeStart: string | number | Date, rangeEnd: string | number | Date): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value contains a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#contains)\n */\n contains(propertyName: string, string: string): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value ends with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#endsWith)\n */\n endsWith(propertyName: string, string: string): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#eq)\n */\n eq(propertyName: string, value: any): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#ge)\n */\n ge(propertyName: string, value: string | number | Date): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#gt)\n */\n gt(propertyName: string, value: string | number | Date): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property values equals all of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#hasAll)\n */\n hasAll(propertyName: string, value: string | number | Date | any[]): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value equals any of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#hasSome)\n */\n hasSome(propertyName: string, value: string | number | Date | any[]): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property does not exist or does not have any value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#isEmpty)\n */\n isEmpty(propertyName: string): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property has any value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#isNotEmpty)\n */\n isNotEmpty(propertyName: string): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#le)\n */\n le(propertyName: string, value: string | number | Date): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#lt)\n */\n lt(propertyName: string, value: string | number | Date): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#ne)\n */\n ne(propertyName: string, value: any): WixDataFilter;\n /**\n * Adds a `not` condition to the filter.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#not)\n */\n not(filter: WixDataFilter): WixDataFilter;\n /**\n * Adds an `or` condition to the filter.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#or)\n */\n or(filter: WixDataFilter): WixDataFilter;\n /**\n * Refines a filter to match items whose specified property value starts with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataFilter.html#startsWith)\n */\n startsWith(propertyName: string, string: string): WixDataFilter;\n }\n /**\n * Provides functionality for refining a sort.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataSort.html#)\n */\n interface WixDataSort {\n /**\n * Adds a sort, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataSort.html#ascending)\n */\n ascending(...propertyName: string[]): WixDataFilter;\n /**\n * Adds a sort, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixDataSort.html#descending)\n */\n descending(...propertyName: string[]): WixDataFilter;\n }\n /**\n * A [WixEvents](https://support.wix.com/en/article/adding-wix-events-to-your-site) element displays your site's events.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixEvents.html#)\n */\n interface WixEvents extends Element, HiddenCollapsedMixin {\n /**\n * Sets or gets the event category displayed in a Wix Events element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixEvents.html#categoryId)\n */\n categoryId: string;\n }\n /**\n * A `$w` element for enabling your site contacts and visitors to work with the Wix Forms app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixForms.html#)\n */\n interface WixForms extends HiddenCollapsedMixin {\n /**\n * Adds an event handler that runs when a site visitor starts to submit a Wix Form yet before the form is actually submitted and sent to the server.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixForms.html#onWixFormSubmit)\n * @eventType WixFormSubmitEvent\n */\n onWixFormSubmit(eventHandler: WixForms.WixFormSubmitEventHandler): void;\n /**\n * Adds an event handler that runs when a site visitor submits a Wix Form and it is successfully received by the server.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixForms.html#onWixFormSubmitted)\n * @eventType WixFormSubmittedEvent\n */\n onWixFormSubmitted(eventHandler: WixForms.WixFormSubmittedEventHandler): void;\n /**\n * Adds an event handler that runs when a site visitor is not able to successfully submit a Wix Form to the server.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixForms.html#onWixFormSubmittedError)\n * @eventType WixFormSubmittedErrorEvent\n */\n onWixFormSubmittedError(eventHandler: WixForms.WixFormSubmittedErrorEventHandler): void;\n }\n /**\n * An event that is fired when a site visitor clicks a submit button on a [`WixForms`](https://dev.wix.com/docs/velo/velo-only-apis/$w/wix-forms/introduction) element and the Wix Form is about to be submitted to the server.\n * You do not need to import `$w` or `wix-crm` to work with Wix Forms events.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormSubmitEvent.html#)\n */\n interface WixFormSubmitEvent extends Event {\n }\n /**\n * An event that is fired when a site visitor clicks a submit button on a [`WixForms`](https://dev.wix.com/docs/velo/velo-only-apis/$w/wix-forms/introduction) element but the Wix Form is not successfully submitted to the server.\n * You do not need to import `$w` or `wix-crm` to work with Wix Forms events.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormSubmittedErrorEvent.html#)\n */\n interface WixFormSubmittedErrorEvent extends Event {\n /**\n * Gets the error code for a failed Wix Form submission.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormSubmittedErrorEvent.html#code)\n */\n readonly code: string;\n /**\n * Gets the error message for a failed Wix Form submission.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormSubmittedErrorEvent.html#message)\n */\n readonly message: string;\n }\n /**\n * An event that is fired when a site visitor clicks a submit button on a [`WixForms`](https://dev.wix.com/docs/velo/velo-only-apis/$w/wix-forms/introduction) element and the Wix Form is successfully submitted to the server.\n * You do not need to import `$w` or `wix-crm` to work with Wix Forms events.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormSubmittedEvent.html#)\n */\n interface WixFormSubmittedEvent extends Event {\n }\n /**\n * A `WixFormsV2` element displays customizable forms, collects all the info that a site visitor entered into the form fields, and lets you track all form submissions in the dashboard.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#)\n */\n interface WixFormsV2 extends Element, HiddenCollapsedMixin {\n /**\n * Gets Wix Form field values.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#getFieldValues)\n */\n getFieldValues(): any;\n /**\n * Gets the total number of steps in a Wix Form.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#getStepCount)\n */\n getStepCount(): number;\n /**\n * Gets the current step number of a Wix Form. Counting starts from 1.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#getStepNumber)\n */\n getStepNumber(): number;\n /**\n * Navigates to the given Wix Form step. If an invalid number is passed, `navigateToStep()` doesn't run.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#navigateToStep)\n */\n navigateToStep(stepNumber: number): void;\n /**\n * Runs a callback when a site visitor changes Wix Form field values.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#onFieldValueChange)\n */\n onFieldValueChange(callback: WixFormsV2.OnFieldValueChangeCallback): void;\n /**\n * Runs a callback when a Wix Form navigates to another step.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#onStepNumberChange)\n */\n onStepNumberChange(callback: WixFormsV2.OnStepNumberChangeCallback): void;\n /**\n * Runs a callback when a site visitor starts to submit a Wix Form yet before the form is actually submitted and sent to the server.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#onSubmit)\n */\n onSubmit(callback: WixFormsV2.OnSubmitCallback): void;\n /**\n * Runs a callback when a site visitor is not able to successfully submit a Wix Form to the server.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#onSubmitFailure)\n */\n onSubmitFailure(callback: WixFormsV2.OnSubmitFailureCallback): void;\n /**\n * Runs a callback when a site visitor submits a Wix Form and it is successfully received by the server.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#onSubmitSuccess)\n */\n onSubmitSuccess(callback: WixFormsV2.OnSubmitSuccessCallback): void;\n /**\n * Sets Wix Form field values.\n * Setting the invalid field values fires the `onFieldValuesChange()` callback. The callback returns fields with the valid values previously set.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#setFieldValues)\n */\n setFieldValues(formValues: any): void;\n /**\n * Submits a Wix Form.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#submit)\n */\n submit(): Promise;\n }\n /**\n * An [accordion element](https://support.wix.com/en/article/editor-x-adding-and-customizing-an-accordion-5177642#adding-and-managing-accordion-items)\n * is a container that holds multiple collapsible accordion item elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Accordion.html#)\n */\n namespace Accordion {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Indicates whether the element is currently active or selected in a set of related items. This allows assistive technologies to relay to site visitors which element in a set is currently in focus.\n * Only 1 element in a set should have a value other than `'false'` at any time to ensure that assistive technologies correctly identify which element is currently in focus or active.\n *\n * Supported values:\n * - `'true'`: Represents the current element in an unordered set of related elements.\n * - `'false'`: Indicates that the element in a set isn't currently active or selected.\n * - `'page'`: Represents the current page in a multi-page site.\n * - `'step'`: Marks the currently active step in a multi-step process such as a checkout flow.\n * - `'date'`: Represents the currently selected date in a calendar.\n *\n * If `ariaCurrent` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaCurrent?: string;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(“#myElement”).accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Sets or gets the error message of an input element by referencing another element by ID. This property informs those using assistive technologies about validation issues. Use `ariaErrorMessage` in conjunction with `ariaInvalid` to indicate that the input is invalid and to provide context for the error.\n *\n * Example: `$w(\"#myInputElement\").accessibility.ariaErrorMessage = $w(\"#inputErrorText\");`\n */\n ariaErrorMessage?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of site visitor interaction on a site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaExpanded?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(“#myElement”).accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n };\n }\n /**\n * [Address input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-an-address-input-element)\n * is used for entering addresses. It lets users type\n * an address, and suggests exact locations using Google Maps services.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AddressInput.html#)\n */\n namespace AddressInput {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * An object representing a physical address.\n */\n type Address = {\n /**\n * Address in human-readable format. The formatted address is displayed in the address input element.\n */\n formatted: string;\n /**\n * Address coordinates.\n */\n location?: AddressInput.AddressLocation;\n /**\n * Address street name and number.\n */\n streetAddress?: AddressInput.StreetAddress;\n /**\n * Address city.\n */\n city?: string;\n /**\n * Address subdivision of a country, such as a state or province.\n */\n subdivision?: string;\n /**\n * Address country.\n */\n country?: string;\n /**\n * Address postal code.\n */\n postalCode?: string;\n };\n /**\n * An object containing a filter for filtering address suggestions\n * in an address input. Suggestions are restricted to addresses within\n * the specified country.\n * > **Note:** Currently only filtering by country is supported.\n */\n type AddressFilter = {\n /**\n * [ISO_3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code.\n */\n country?: string;\n };\n /**\n * An object containing the coordinates of an address.\n */\n type AddressLocation = {\n /**\n * Address latitude.\n */\n latitude: number;\n /**\n * Address longitude.\n */\n longitude: number;\n };\n /**\n * An object containing the street name and number of an address.\n */\n type StreetAddress = {\n /**\n * Street name.\n */\n name: string;\n /**\n * Street number.\n */\n number?: string;\n };\n /**\n * Function that runs when custom validation is checked.\n */\n type AddressInputValidator = (value: AddressInput.Address, reject: Function) => void;\n }\n /**\n * Use an `AppointmentField` to select dates, times, and timezones for scheduling appointments.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.AppointmentField.html#)\n */\n namespace AppointmentField {\n type OperationOptions = {\n /**\n * Start date of the currently displayed month.\n */\n startDate: Date;\n /**\n * End date of the currently displayed month.\n */\n endDate: Date;\n };\n type dateTimeRange = {\n /**\n * Date and time of the start of the range.\n */\n startDateTime: Date;\n /**\n * Date and time of the end of the range.\n */\n endDateTime: Date;\n };\n type dateTimeRangeInfo = {\n /**\n * Date range type. Valid values: `'enabledRanges'`\n */\n type: string;\n /**\n * Array of dateTimeRange objects.\n */\n payload: AppointmentField.dateTimeRange[];\n };\n }\n /**\n * Provides functionality for [background images](https://support.wix.com/en/article/wix-editor-adding-an-image-to-your-page-background) in certain elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Background.html#)\n */\n namespace Background {\n /**\n * An object used by the `background` property that contains the background options.\n */\n type BackgroundOptions = {\n /**\n * The file location of the background image or video.\n * Setting the `src` property changes the\n * displayed image or video to the image or video found at the new `src` value.\n *\n * Getting the `src` property returns the\n * location of the current image or video file.\n *\n * Images can either be from the [Media Manager](https://support.wix.com/en/article/about-the-media-manager)\n * or an external image from any web location. Videos must come from the\n * [Media Manager](https://support.wix.com/en/article/about-the-media-manager).\n *\n * The URL formats supported are:\n *\n * + Images from the Media Manager:\n * `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n * + Videos from the Media Manager:\n * `wix:video://v1//#posterUri=&posterWidth=&posterHeight=`\n * + Images from the web:\n * `http(s)://`\n */\n src: string;\n };\n }\n /**\n * Container [boxes](https://support.wix.com/en/article/container-boxes)\n * are used to structure your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Box.html#)\n */\n namespace Box {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates whether the element is currently active or selected in a set of related items. This allows assistive technologies to relay to site visitors which element in a set is currently in focus.\n * Only 1 element in a set should have a value other than `'false'` at any time to ensure that assistive technologies correctly identify which element is currently in focus or active.\n *\n * Supported values:\n * - `'true'`: Represents the current element in an unordered set of related elements.\n * - `'false'`: Indicates that the element in a set isn't currently active or selected.\n * - `'page'`: Represents the current page in a multi-page site.\n * - `'step'`: Marks the currently active step in a multi-step process such as a checkout flow.\n * - `'date'`: Represents the currently selected date in a calendar.\n *\n * If `ariaCurrent` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaCurrent?: string;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Identifies the element that is controlled by visitor interactions with this element. This property helps assistive technologies convey which elements are affected by the controlling element. For example, a button element that opens a popup window when clicked controls the popup element.\n */\n ariaControls?: Element;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of site visitor interaction on a site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaExpanded?: boolean;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n /**\n * Indicates to assistive technology users whether the element is currently pressed. `ariaPressed` is only relevant for buttons that act as toggles or have a pressed/unpressed state. If `ariaPressed` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaPressed?: string;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n /**\n * Defines a more specific description to help clarify the `role` of an element. This property is useful for non-interactive container element roles, such as `\"region\"` or `\"group\"`, and for enhancing the context of interactive elements like buttons. Use `ariaRoleDescription` carefully, as improper use can confuse visitors and affect their understanding of the element's purpose.\n */\n ariaRoleDescription?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * [Breadcrumbs](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-breadcrumbs) are used for navigating between site pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Breadcrumbs.html#)\n */\n namespace Breadcrumbs {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n };\n /**\n * An object that contains the attributes of a breadcrumbs item.\n */\n type Item = {\n /**\n * The label of the breadcrumbs item. This is text that the site visitor sees and can click to navigate. Required if `icon` isn't specified. If not specified, `label` is omitted from the returned array.\n */\n label?: string;\n /**\n * The icon of the breadcrumbs item. This is a vector image that the site visitor sees and can click to navigate. Required if `label` isn't specified. If not specified, the `icon` key is omitted from the returned array.\n *\n * The vector image file can be an image file from the Media Manager, an external SVG image from any web location, or a literal SVG XML string.\n *\n * The formats supported are:\n * + Vector images from the Media Manager: `wix:vector://v1//`\n * + Vector images from the web: `http(s)://`\n * + Vector XML string: `...`\n */\n icon?: string;\n /**\n * Optional link for the breadcrumbs item as a URL relative to your site's home page. This is the link the site visitor navigates to when they click on a breadcrumbs item. The page opens in the same window/tab.\n *\n * If a link isn't specified, it's `undefined` in the breadcrumbs object. The corresponding label or icon isn't clickable.\n *\n * >**Note:**\n * > In the default breadcrumbs `items` array generated for a page, any `link` properties contain absolute URLs, not relative ones.\n */\n link?: string;\n /**\n * Setting `isCurrent` to `true` for a breadcrumbs item causes the item to appear highlighted in the breadcrumbs element.\n * You can use this property to indicate which page in a breadcrumbs trail is currently displayed. In a default `items` array, the last item's `isCurrent` value is `true`.\n * >**Note:** The value of `isCurrent` isn't validated against which page is actually displayed. It can also be set to `true` for multiple breadcrumbs items.\n */\n isCurrent?: boolean;\n };\n }\n /**\n * A [button](https://support.wix.com/en/article/wix-editor-about-buttons) on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Button.html#)\n */\n namespace Button {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of site visitor interaction on a site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaExpanded?: boolean;\n /**\n * Indicates to assistive technology users whether the element is currently pressed. `ariaPressed` is only relevant for buttons that act as toggles or have a pressed/unpressed state. If `ariaPressed` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaPressed?: string;\n /**\n * Indicates to assistive technology users whether an element triggers an interactive popup such as a menu or dropdown. If `ariaHasPopup` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaHasPopup?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Identifies the element that is controlled by visitor interactions with this element. This property helps assistive technologies convey which elements are affected by the controlling element. For example, a button element that opens a popup window when clicked controls the popup element.\n */\n ariaControls?: Element;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n /**\n * Adds extra text before or after a text element for screen readers and other assistive technologies. This property helps provide extra context to text elements on a site page. The added text doesn't affect a site visually but is read aloud by screen readers for those who rely on assistive technology. For example, you can add the prefix \"bold text\" to a bold text element because screen readers don't effectively communicate text styles such as bold, italicize, and strikethrough.\n */\n screenReader?: Button.ScreenReader;\n };\n /**\n * Adds hidden text before or after a text element using the `screenReader.prefix` and `screenReader.suffix` properties. This helps screen readers better understand the content of your text element. For example, screen readers don't effectively communicate text styles such as bold and strikethrough. Use `screenReader` to provide context for the styled text.\n */\n type ScreenReader = {\n /**\n * Extra text added before a text element.\n *\n * Max: 1000 characters\n */\n prefix?: string;\n /**\n * Extra text added after a text element.\n *\n * Max: 1000 characters\n */\n suffix?: string;\n };\n }\n /**\n * The [reCAPTCHA](https://support.wix.com/en/article/about-recaptcha)\n * element allows you to present a challenge-response test to site visitors to determine whether they are human or a bot.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Captcha.html#)\n */\n namespace Captcha {\n /**\n * An error event handler.\n */\n type ErrorHandler = () => void;\n /**\n * A timeout event handler.\n */\n type TimeoutHandler = () => void;\n /**\n * A verification event handler.\n */\n type VerifiedHandler = () => Promise | void;\n }\n /**\n * An icon that leads users to the shopping cart.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CartIcon.html#)\n */\n namespace CartIcon {\n /**\n * An object used to pass a custom text field when adding a product to\n * the shopping cart with options.\n */\n type AddToCartCustomTextField = {\n /**\n * Custom text field title.\n */\n title: string;\n /**\n * Custom text field value.\n */\n value: string;\n };\n /**\n * An object used when adding multiple products to the shopping cart.\n */\n type AddToCartItem = {\n /**\n * The ID of the product to add to the cart.\n */\n productId: string;\n /**\n * The number of product units to add to the cart.\n */\n quantity: number;\n /**\n * Specific product options to add to the cart.\n */\n options?: CartIcon.AddToCartOptions;\n };\n /**\n * An object used when adding a product to the shopping cart with options.\n */\n type AddToCartOptions = {\n /**\n * Product options to use when adding the product to the cart.\n * The object contains `key:value` pairs where the key is the option name and the value is the chosen option value.\n */\n choices: any;\n /**\n * Custom text fields to use when adding the product to the cart.\n */\n customTextFields: CartIcon.AddToCartCustomTextField[];\n };\n }\n /**\n * A [chatbox](https://support.wix.com/en/article/editor-x-adding-and-customizing-chat) is an element for sending and receiving chat messages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Chatbox.html#)\n */\n namespace Chatbox {\n /**\n * An object representing a chat channel.\n */\n type Channel = {\n /**\n * ID of the channel.\n */\n id: string;\n /**\n * Display information associated with the channel.\n */\n displayData: Chatbox.DisplayData;\n /**\n * An array of messages sent over the channel. Currently only the last message is included.\n */\n messages: Chatbox.Message[];\n };\n /**\n * An object containing information about a chat channel.\n */\n type ChannelInfo = {\n /**\n * ID of a chat channel.\n */\n channelId?: string;\n /**\n * Type of chat channel.\n * One of the following:\n *\n * + `\"Focused\"`: Currently focused channel.\n * + `\"Business\"`: Business channel.\n */\n type?: string;\n };\n /**\n * An object representing display information associated with a [`Channel`](#channel).\n */\n type DisplayData = {\n /**\n * The image associated with the channel.\n * One of the following:\n *\n * + For private social channels, the image associated with the site member's account. If there is no image associated with the account, defaults to the avatar image.\n * + For group social channels, the image associated with the chat group.\n * + For business channels, `image` is not currently supported.\n */\n image: string;\n /**\n * For social channels, the member's name or chat group name. For business channels, the site's [display name](wix-site-backend.generalInfo.html#getSiteDisplayName).\n */\n name: string;\n /**\n * Only supported for business channels. Initials of the site's business.\n */\n initials: string;\n };\n /**\n * An object that contains information about a chat message.\n */\n type Message = {\n /**\n * ID of the channel on which the message was sent.\n */\n channelId: string;\n /**\n * Type of message. Currently only `TEXT` is supported.\n */\n type: string;\n /**\n * First 250 characters of the chat message. Currently only text is included in the summary.\n */\n summary: string;\n /**\n * The sender's member ID. For a message sent from the site's business, the site owner's member ID.\n */\n participantId: string;\n /**\n * Date and time the message was sent.\n */\n createdAt: Date;\n /**\n * Content of the message.\n */\n payload: Chatbox.MessagePayload;\n /**\n * An object representing additional contextual message information included in a chat message. Only relevant for messages sent using the backend [`sendMessage()`](https://dev.wix.com/docs/sdk/backend-modules/inbox/messages/send-message) function. Site visitors do not see metadata.\n */\n metadata?: any;\n };\n /**\n * An object representing a chat message to be sent.\n */\n type MessageInfo = {\n /**\n * The text to be sent in the message.\n */\n messageText: string;\n /**\n * The ID of the channel over which the message is sent. If empty, message is sent to the site's business.\n */\n channelId?: string;\n };\n /**\n * The content of a chat message.\n */\n type MessagePayload = {\n /**\n * Text of the chat message.\n */\n text: string;\n };\n }\n /**\n * [Checkboxes](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-checkbox) are used for a single binary choice.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Checkbox.html#)\n */\n namespace Checkbox {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether an element's input value is invalid or if a required input field is empty. When `true`, assistive technologies alert site visitors that the element's input value doesn't meet the expected criteria or that the required field is empty. When `false`, the value entered is valid or the field isn't required. This helps assistive technology users identify and correct errors in form submissions.\n */\n ariaInvalid?: boolean;\n /**\n * Indicates to assistive technology users whether an input element has a required field or action. If `ariaRequired` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies. The `ariaRequired` property doesn't inform assistive technologies if the required input value is valid.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaRequired?: string;\n /**\n * Identifies the element that is controlled by visitor interactions with this element. This property helps assistive technologies convey which elements are affected by the controlling element. For example, a button element that opens a popup window when clicked controls the popup element.\n */\n ariaControls?: Element;\n /**\n * Sets or gets the error message of an input element by referencing another element by ID. This property informs those using assistive technologies about validation issues. Use `ariaErrorMessage` in conjunction with `ariaInvalid` to indicate that the input is invalid and to provide context for the error.\n *\n * Example: `$w(\"#myInputElement\").accessibility.ariaErrorMessage = $w(\"#inputErrorText\");`\n */\n ariaErrorMessage?: Text | CollapsibleText;\n };\n }\n /**\n * [Checkbox groups](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-checkbox) are used for selecting any number of the given\n * options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CheckboxGroup.html#)\n */\n namespace CheckboxGroup {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * An object used by the `options` property that contains the attributes of a checkbox item.\n */\n type Option = {\n /**\n * The value of the checkbox option. This is what you use in code and is what is stored in your collections. Mandatory if `label` is not specified.\n */\n value?: string;\n /**\n * The label of the checkbox option. This is what a user sees. Mandatory if `value` is not specified.\n */\n label?: string;\n };\n }\n /**\n * [Collapsible text](https://support.wix.com/en/article/adding-and-setting-up-ellipsis-text) is a text element for managing large amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.CollapsibleText.html#)\n */\n namespace CollapsibleText {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * Expands content overflow on current page.\n */\n type ExpandOnCurrentPage = {\n /**\n * Text of the read more button. Defaults to `Read more`.\n */\n readMoreButtonText?: string;\n /**\n * Text of the read less button. Defaults to `Read less`.\n */\n readLessButtonText?: string;\n /**\n * Whether the collapsible text is currently collapsed. Defaults to `true`.\n */\n collapsed?: boolean;\n };\n /**\n * Links to the content overflow.\n */\n type LinkToContent = {\n /**\n * Link for the remaining text. Supports all link types.\n */\n link: string;\n /**\n * Determines where the link opens, either in the current page or in a new page.\n * One of:\n * `\"_blank\"`: The link opens in a new tab or window.\n * `\"_self\"`: The link opens in the tab or window.\n *\n * Defaults to `\"_blank\"`.\n *\n * Note: Link targets are only supported for external web links, for example, `https://www.wix.com`.\n */\n target?: string;\n /**\n * Whether the read more button is visible. Defaults to `false`.\n */\n readMoreButtonVisible?: boolean;\n /**\n * Text of the read more button. Defaults to 'Link to full article'.\n */\n readMoreButtonText?: string;\n };\n }\n /**\n * A [column](https://support.wix.com/en/article/wix-editor-attaching-elements-to-strips-and-columns)\n * is a component part of a `ColumnStrip`.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Column.html#)\n */\n namespace Column {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n };\n }\n /**\n * A [column strip](https://support.wix.com/en/article/wix-editor-attaching-elements-to-strips-and-columns) is a strip of column elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ColumnStrip.html#)\n */\n namespace ColumnStrip {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n };\n }\n /**\n * A [container](https://support.wix.com/en/article/studio-editor-using-containers) for Repeater items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Container.html#)\n */\n namespace Container {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Indicates whether the element is visible to or hidden from users that rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.\n */\n ariaHidden?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(“#myElement”).accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(“#myElement”).accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates whether the element is currently active or selected in a set of related items. This allows assistive technologies to relay to site visitors which element in a set is currently in focus.\n * Only 1 element in a set should have a value other than `'false'` at any time to ensure that assistive technologies correctly identify which element is currently in focus or active.\n *\n * Supported values:\n * - `'true'`: Represents the current element in an unordered set of related elements.\n * - `'false'`: Indicates that the element in a set is not currently active or selected.\n * - `'page'`: Represents the current page in a multi-page site.\n * - `'step'`: Marks the currently active step in a multi-step process such as a checkout flow.\n * - `'date'`: Represents the currently selected date in a calendar.\n *\n * If `ariaCurrent` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.\n */\n ariaCurrent?: string;\n };\n }\n /**\n * A dataset connects page elements to a set of items in a data collection.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dataset.html#)\n */\n namespace Dataset {\n /**\n * An object representing a dataset error.\n */\n type DatasetError = {\n /**\n * Error code.\n */\n code: string;\n /**\n * Error message.\n */\n message: string;\n };\n /**\n * An object used by the `getItems()` function that contains the items retrieved and the total number of items in the dataset that match its filter criteria\n */\n type GetItemsResult = {\n /**\n * List of items objects where `key:value` pairs are the field IDs and field values of the retrieved items, including all hidden fields.\n */\n items: any[];\n /**\n * The number of items in the dataset that match its filter criteria.\n */\n totalCount: number;\n /**\n * The index in the dataset of the first item in the items property.\n */\n offset: number;\n };\n /**\n * An after save event handler.\n */\n type AfterSaveHandler = (itemBeforeSave: any, itemAfterSave: any) => void;\n /**\n * A before save event handler.\n */\n type BeforeSaveHandler = () => Promise | boolean;\n /**\n * A current item index change event handler.\n */\n type CurrentIndexChangedHandler = (index: number) => void;\n /**\n * An error event handler.\n */\n type ErrorHandler = (operation: string, error: Dataset.DatasetError) => void;\n /**\n * A current item value change event handler.\n */\n type ItemValuesChangedHandler = (itemBeforeChange: any, updatedItem: any) => void;\n /**\n * A dataset ready event handler.\n */\n type ReadyHandler = () => void;\n }\n /**\n * A [date picker](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/formatting-layout/formatting-dates#displaying-dates-in-date-pickers)\n * is used for entering dates. It lets site visitors populate a\n * date field by picking a date using a calendar popup.\n * You can enable and disable dates, date ranges, and days of the week on your date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.DatePicker.html#)\n */\n namespace DatePicker {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n };\n /**\n * An object containing the start and end dates of a range of dates.\n */\n type DateRange = {\n /**\n * Start date for the range. The `startDate` is inclusive,\n * meaning it's included in the range. The start date must be earlier than or the same as the\n * end date of the range.\n */\n startDate: Date;\n /**\n * End date for the range. The `endDate` is inclusive,\n * meaning it's included in the range. The end date must be later than or the same as the\n * start date of the range.\n */\n endDate: Date;\n };\n }\n /**\n * A [Document](https://support.wix.com/en/article/wix-editor-managing-your-sites-pages) is a complete web page, which consists of a Header, Page, and Footer.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Document.html#)\n */\n namespace Document {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Indicates whether the element is currently active or selected in a set of related items. This allows assistive technologies to relay to site visitors which element in a set is currently in focus.\n * Only 1 element in a set should have a value other than `'false'` at any time to ensure that assistive technologies correctly identify which element is currently in focus or active.\n *\n * Supported values:\n * - `'true'`: Represents the current element in an unordered set of related elements.\n * - `'false'`: Indicates that the element in a set isn't currently active or selected.\n * - `'page'`: Represents the current page in a multi-page site.\n * - `'step'`: Marks the currently active step in a multi-step process such as a checkout flow.\n * - `'date'`: Represents the currently selected date in a calendar.\n *\n * If `ariaCurrent` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaCurrent?: string;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technologies that an interactive element is currently disabled, even if it's visible. When `true`, assistive technologies inform site visitors that the element can't be interacted with. When `false` or not set, the element is considered enabled.\n */\n ariaDisabled?: boolean;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of site visitor interaction on a site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaExpanded?: boolean;\n /**\n * Indicates to assistive technology users whether an element triggers an interactive popup such as a menu or dropdown. If `ariaHasPopup` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaHasPopup?: string;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Indicates to assistive technology users whether the element is currently pressed. `ariaPressed` is only relevant for buttons that act as toggles or have a pressed/unpressed state. If `ariaPressed` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaPressed?: string;\n };\n /**\n * An object used by the `background` property that contains the background options.\n */\n type BackgroundOptions = {\n /**\n * The file location of the background image.\n *\n * Setting the `src` property changes the\n * displayed image or video to the image or video found at the new `src` value.\n *\n * Getting the `src` property returns the\n * location of the current image or video file.\n *\n * Images can either be from the [Media Manager](https://support.wix.com/en/article/about-the-media-manager)\n * or an external image from any web location. Videos must come from the\n * [Media Manager](https://support.wix.com/en/article/about-the-media-manager).\n *\n * The URL formats supported are:\n *\n * + Images from the Media Manager:\n * `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n * + Videos from the Media Manager:\n * `wix:video://v1//#posterUri=&posterWidth=&posterHeight=`\n * + Images from the web:\n * `http(s)://`\n */\n src: string;\n };\n }\n /**\n * [Dropdowns](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-dropdown-selection-for-a-form-submission)\n * are used for selecting one of a number of options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Dropdown.html#)\n */\n namespace Dropdown {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether an element's input value is invalid or if a required input field is empty. When `true`, assistive technologies alert site visitors that the element's input value doesn't meet the expected criteria or that the required field is empty. When `false`, the value entered is valid or the field isn't required. This helps assistive technology users identify and correct errors in form submissions.\n */\n ariaInvalid?: boolean;\n /**\n * Indicates to assistive technology users whether an input element has a required field or action. If `ariaRequired` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all. The `ariaRequired` property doesn't inform assistive technologies if the required input value is valid.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaRequired?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n /**\n * Identifies the element that is controlled by visitor interactions with this element. This property helps assistive technologies convey which elements are affected by the controlling element. For example, a button element that opens a popup window when clicked controls the popup element.\n */\n ariaControls?: Element;\n /**\n * Sets or gets the error message of an input element by referencing another element by ID. This property informs those using assistive technologies about validation issues. Use `ariaErrorMessage` in conjunction with `ariaInvalid` to indicate that the input is invalid and to provide context for the error.\n *\n * Example: `$w(\"#myInputElement\").accessibility.ariaErrorMessage = $w(\"#inputErrorText\");`\n */\n ariaErrorMessage?: Text | CollapsibleText;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n };\n /**\n * An object used by the `options` property that contains the attributes of a dropdown list item.\n */\n type Option = {\n /**\n * The value of the dropdown option. This is what you use in code and is what is stored in your collections. Mandatory if `label` is not specified.\n */\n value?: string;\n /**\n * The label of the dropdown option. This is what a user sees. Mandatory if `value` is not specified.\n */\n label?: string;\n };\n }\n /**\n * Use effect options to customize an effect when [showing]($w.HiddenMixin.html#show) or [hiding]($w.HiddenMixin.html#hide) an element.\n * Effect options include arcs, bouncing, fading, flipping, floating, flying in/out, folding, gliding and more.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.EffectOptions.html#)\n */\n namespace EffectOptions {\n /**\n * An object used to customize the `\"arc\"` effect.\n */\n type ArcEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"left\"`, `\"right\"`. Defaults to `\"left\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"bounce\"` effect.\n */\n type BounceEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"topLeft\"`, `\"topRight\"`, `\"bottomRight\"`,\n * `\"bottomLeft\"`, `\"center\"`. Defaults to `\"topLeft\"`.\n */\n direction?: string;\n /**\n * Valid values: `\"soft\"`, `\"medium\"`, `\"hard\"`. Defaults to `\"medium\"`.\n */\n intensity?: string;\n };\n /**\n * An object used to customize the `\"fade\"` effect.\n */\n type FadeEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n };\n /**\n * An object used to customize the `\"flip\"` effect.\n */\n type FlipEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"top\"`, `\"right\"`, `\"bottom\"`, `\"left\"`. Defaults to `\"right\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"float\"` effect.\n */\n type FloatEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"top\"`, `\"right\"`, `\"bottom\"`, `\"left\"`. Defaults to `\"right\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"fly\"` effect.\n */\n type FlyEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"top\"`, `\"right\"`, `\"bottom\"`, `\"left\"`. Defaults to `\"right\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"fold\"` effect.\n */\n type FoldEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"top\"`, `\"right\"`, `\"bottom\"`, `\"left\"`. Defaults to `\"left\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"glide\"` effect.\n */\n type GlideEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `0`-`360` degrees. Defaults to `0`.\n */\n angle?: number;\n /**\n * Valid values: `0`-`300` pixels. Defaults to `0`.\n */\n distance?: number;\n };\n /**\n * An object used to customize the `\"puff\"` effect.\n */\n type PuffEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n };\n /**\n * An object used to customize the `\"roll\"` effect.\n */\n type RollEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"top\"`, `\"right\"`, `\"bottom\"`, `\"left\"`. Defaults to `\"left\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"slide\"` effect.\n */\n type SlideEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"top\"`, `\"right\"`, `\"bottom\"`, `\"left\"`. Defaults to `\"left\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"spin\"` effect.\n */\n type SpinEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `cw`, `ccw`. Defaults to `cw`.\n */\n direction?: string;\n /**\n * Valid values: `1`-`15`. Defaults to `5`.\n */\n cycles?: number;\n };\n /**\n * An object used to customize the `\"turn\"` effect.\n */\n type TurnEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n /**\n * Valid values: `\"right\"`, `\"left\"`. Defaults to `\"right\"`.\n */\n direction?: string;\n };\n /**\n * An object used to customize the `\"zoom\"` effect.\n */\n type ZoomEffectOptions = {\n /**\n * Valid values: `0`-`4000` milliseconds. Defaults to `1200`.\n */\n duration?: number;\n /**\n * Valid values: `0`-`8000` milliseconds. Defaults to `0`.\n */\n delay?: number;\n };\n }\n /**\n * Events are fired when certain actions occur to elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Event.html#)\n */\n namespace Event {\n /**\n * An object that contains information about the context in which an event was fired.\n */\n type EventContext = {\n /**\n * `\"GLOBAL_SCOPE\"` for events fired outside\n * of repeaters, or `\"COMPONENT_SCOPE\"` for events fired from repeaters.\n */\n type: string;\n /**\n * ID of the repeater item where the\n * event was fired from.\n */\n itemId: string;\n };\n }\n /**\n * A [Gallery](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-gallery) displays multiple items.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Gallery.html#)\n */\n namespace Gallery {\n /**\n * An object used by the `galleryCapabilities` property that contains the capabilities of a gallery.\n */\n type GalleryCapabilities = {\n /**\n * Indicates if the gallery supports play operations.\n */\n isPlayable: boolean;\n /**\n * Indicates if the gallery supports the notion of a current item.\n */\n hasCurrentItem: boolean;\n /**\n * Indicates if the gallery supports navigation buttons.\n */\n hasNavigationButtons: boolean;\n };\n /**\n * An object used by the Gallery properties `items` and `currentItem` to represent a single gallery image.\n */\n type ImageItem = {\n /**\n * Item type. Value is `\"image\"`.\n */\n type: string;\n /**\n * Item slug.\n */\n slug?: string;\n /**\n * Image source URL.\n */\n src: string;\n /**\n * Image description. Descriptions over 100 characters are truncated.\n */\n description?: string;\n /**\n * Image title.\n */\n title?: string;\n /**\n * URL of the image's clickable link.\n */\n link?: string;\n };\n /**\n * An object used by the Gallery properties `items` and `currentItem` to represent a single gallery video.\n */\n type VideoItem = {\n /**\n * Item type. Value is `\"video\"`.\n */\n type: string;\n /**\n * Item slug.\n */\n slug?: string;\n /**\n * Video source URL.\n */\n src: string;\n /**\n * Video description. Descriptions over 100 characters are truncated.\n */\n description?: string;\n /**\n * Video title.\n */\n title?: string;\n /**\n * URL of the video's clickable link.\n */\n link?: string;\n /**\n * Video thumbnail URL.\n */\n thumbnail?: string;\n };\n }\n /**\n * A [Google map element](https://www.wix.com/support/html5/article/adding-google-maps)\n * that allows you to display a given location.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.GoogleMap.html#)\n */\n namespace GoogleMap {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\n */\n lang?: string;\n };\n /**\n * An object used by the `location` property that\n * contains the attributes of a marked map location.\n */\n type MapLocation = {\n /**\n * The latitude of the location. Must be between -90 and 90.\n */\n latitude: number;\n /**\n * The longitude of the location. Must be between -180 and 180.\n */\n longitude: number;\n /**\n * The description of the location.\n */\n description?: string;\n };\n }\n /**\n * [Menus](https://support.wix.com/en/article/wix-editor-adding-a-site-menu) are used for navigating between site pages.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Menu.html#)\n */\n namespace Menu {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Adds extra text before or after a text element for screen readers and other assistive technologies. This property helps provide extra context to text elements on a site page. The added text doesn't affect a site visually but is read aloud by screen readers for those who rely on assistive technology. For example, you can add the prefix \"bold text\" to a bold text element because screen readers don't effectively communicate text styles such as bold, italicize, and strikethrough.\n */\n screenReader?: Menu.ScreenReader;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * An object that contains the attributes of a menu item.\n */\n type MenuItem = {\n /**\n * The label of the menu item. This is text that the site visitor sees in the menu and can click to navigate.\n *\n * If not specified, and the page that the link property references is:\n * + An external page or an empty string: The menu defaults to the menu items based on site pages only, as defined in the Editor, and an error is logged to the console.\n * + A page nested under a folder: The specific menu item label defaults to the name of the corresponding page as defined in the Editor.\n * + A regular, non-nested, site page: The `label` for the menu item gets its value from the name of the page that the `link` property references.\n *\n * Min: 1 character\n *\n * Max: 40 characters\n */\n label?: string;\n /**\n * Setting `selected` to `true` for a menu item causes the item to appear highlighted in the menu element.\n * You can use this property to indicate which page is currently being displayed.\n *\n * >**Note:** The value of `selected` isn't validated against which page is actually displayed. For example, you can write code that misleadingly sets `selected` to `true` for multiple menu items.\n *\n * When not defined explicitly using the `selected` property, the `selected` value is derived from the currently-active page in the site's _main_ menu\n * (as defined when managing the menu in the Editor) and not derived from a currently-active page in a _custom_ menu.\n *\n * Default: `false`\n */\n selected?: boolean;\n /**\n * Optional link for the menu item. This is the link the site visitor navigates to when they click on a menu item.\n * The different types of links you can use are:\n *\n * + `/localPageURL`: Another page on your site, such as `/about` or `/rentals/shortterm`.\n * + `/`: Your site's home page.\n * + `http(s)://`: An external web address, such as `https://www.mortgagecalculator.org/`.\n * + `wix:document://`: A document stored in the Media Manager, such as `wix:document://v1/9bec_52fb06ea/filename.xls`.\n * + `mailto:?subject=`: An email, such as `mailto:michael@example.com?subject=Coming%20Soon`.\n * + `tel:`: A phone number, such as `tel:+1-555-555-5555`.\n *\n * If `link` isn't specified, the corresponding label isn't clickable.\n *\n * Specifying an empty string is not supported. The menu defaults to the menu items as defined in the Editor and an error is logged to the console.\n *\n * Min: 1 character\n *\n * Max: 40 characters\n */\n link?: string;\n /**\n * Whether the link opens in the same window/tab or in a new window/tab.\n * + `_self`. The page opens in the same window/tab.\n * + `_blank`. The page opens in a new window/tab.\n *\n * > **Note:** `target` doesn't work when previewing your site.\n *\n *\n * Default: `_self`\n */\n target?: string;\n /**\n * Menus can have additional levels of submenus. Vertical menus can have\n * 1 level of submenus. Horizontal menus can have 2 additional levels of submenus.\n */\n menuItems?: Menu.MenuItem[];\n /**\n * A unique ID that can be used to customize events triggered on a menu item.\n * For example, when a visitor clicks a menu item, the ID can be checked in order to trigger the appropriate action for that menu item.\n */\n id?: string;\n };\n /**\n * Adds hidden text before or after a text element using the `screenReader.prefix` and `screenReader.suffix` properties. This helps screen readers better understand the content of your text element. For example, screen readers don't effectively communicate text styles such as bold and strikethrough. Use `screenReader` to provide context for the styled text.\n */\n type ScreenReader = {\n /**\n * Extra text added before an element.\n *\n * Max: 1000 characters\n */\n prefix?: string;\n /**\n * Extra text added after an element.\n *\n * Max: 1000 characters\n */\n suffix?: string;\n };\n }\n /**\n * A mobile date picker\n * is used for entering dates. It lets mobile app users populate a\n * date field by picking a date using a calendar popup.\n * You can enable and disable dates, date ranges, and days of the week on your date picker.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileDatePicker.html#)\n */\n namespace MobileDatePicker {\n /**\n * An object containing the start and end dates of a range of dates.\n */\n type DateRange = {\n /**\n * Start date for the range. The `startDate` is inclusive,\n * meaning it's included in the range. The start date must be earlier than or the same as the\n * end date of the range.\n */\n startDate: Date;\n /**\n * End date for the range. The `endDate` is inclusive,\n * meaning it's included in the range. The end date must be later than or the same as the\n * start date of the range.\n */\n endDate: Date;\n };\n }\n /**\n * A picker for selecting items on a mobile app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobilePicker.html#)\n */\n namespace MobilePicker {\n type Option = {\n /**\n * The value of the mobile picker option. This is what you use in code and is what is stored in your collections. Mandatory if `label` is not specified.\n */\n value?: string;\n /**\n * The label of the mobile picker option. This is what a mobile app user sees. Mandatory if `value` is not specified.\n */\n label?: string;\n /**\n * The description of the mobile picker option. This is what a mobile app user sees.\n */\n description?: string;\n /**\n * Whether the mobile picker option is selected.\n */\n selected?: boolean;\n /**\n * Whether the mobile picker option is enabled.\n */\n enabled?: boolean;\n };\n }\n /**\n * Provides functionality for mobile elements that have values.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.MobileValueMixin.html#)\n */\n namespace MobileValueMixin {\n type Validation = {\n /**\n * The validation type.\n * Supported values:\n * + 'required'\n * + 'url'\n * + 'numeric'\n * + 'wholeNumber'\n * + 'decimalNumber'\n */\n validationType: string;\n /**\n * The validation message.\n */\n message: string;\n };\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/$w.MultiStateBox.html#)\n */\n namespace MultiStateBox {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates whether the element is currently active or selected in a set of related items. This allows assistive technologies to relay to site visitors which element in a set is currently in focus.\n * Only 1 element in a set should have a value other than `'false'` at any time to ensure that assistive technologies correctly identify which element is currently in focus or active.\n *\n * Supported values:\n * - `'true'`: Represents the current element in an unordered set of related elements.\n * - `'false'`: Indicates that the element in a set isn't currently active or selected.\n * - `'page'`: Represents the current page in a multi-page site.\n * - `'step'`: Marks the currently active step in a multi-step process such as a checkout flow.\n * - `'date'`: Represents the currently selected date in a calendar.\n *\n * If `ariaCurrent` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaCurrent?: string;\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Sets or gets the error message of an input element by referencing another element by ID. This property informs those using assistive technologies about validation issues. Use `ariaErrorMessage` in conjunction with `ariaInvalid` to indicate that the input is invalid and to provide context for the error.\n *\n * Example: `$w(\"#myInputElement\").accessibility.ariaErrorMessage = $w(\"#inputErrorText\");`\n */\n ariaErrorMessage?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of site visitor interaction on a site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaExpanded?: boolean;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n };\n }\n /**\n * [Pagination](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-pagination-bar) is an element for working with paging.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Pagination.html#)\n */\n namespace Pagination {\n /**\n * An object containing attributes to make your Wix elements more accessible\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * A button on your Blocks panel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelButton.html#)\n */\n namespace PanelButton {\n /**\n * An object representing an SVG icon.\n */\n type icon = {\n /**\n * An SVG element\n */\n svgId: string;\n };\n }\n /**\n * Panel checkbox groups are used in the Blocks panel builder for selecting any number of the given options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelCheckboxGroup.html#)\n */\n namespace PanelCheckboxGroup {\n /**\n * An object representing a checkbox option.\n */\n type option = {\n /**\n * The label of the checkbox option. This is what a user sees.\n */\n label: string;\n /**\n * The value of the checkbox option. This is what you use in code.\n */\n value: string;\n };\n }\n /**\n * Panel dropdowns are used in the Blocks panel builder for selecting one of a number of options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelDropdown.html#)\n */\n namespace PanelDropdown {\n /**\n * An object representing a dropdown option.\n */\n type option = {\n /**\n * The label of the dropdown option. This is what a user sees.\n */\n label: string;\n /**\n * The value of the dropdown option. This is what you use in code.\n */\n value: string;\n };\n }\n /**\n * Panel radio button groups are used in the Blocks panel builder for selecting one of a number of options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelRadioButtonGroup.html#)\n */\n namespace PanelRadioButtonGroup {\n /**\n * An object representing a radio button option.\n */\n type option = {\n /**\n * The label of the radio button option. This is what a user sees.\n */\n label: string;\n /**\n * The value of the radio button option. This is what you use in code.\n */\n value: string;\n };\n }\n /**\n * A Panel thumbnail groups allow users to select an option using a set of thumbnail images in a Blocks panel.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PanelThumbnails.html#)\n */\n namespace PanelThumbnails {\n /**\n * An object representing a thumbnail option.\n */\n type option = {\n /**\n * The label of the thumbnail option, optionally displayed below the thumbnail. Maximum 120 chars.\n */\n label: string;\n /**\n * The value of the thumbnail option. This is what you use in code.\n */\n value: string;\n };\n }\n /**\n * A post page for a specific blog post.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.PostPage.html#)\n */\n namespace PostPage {\n /**\n * An object representing a blog post on a post page.\n * > **Note:**\n * `viewCount` and `likeCount` data used on your site pages is eventually consistent and may require up\n * to 24 hours to update. To make sure new post views and likes are included on your site in real time,\n * [disable caching](https://support.wix.com/en/article/caching-your-sites-pages) for\n * any page that uses `viewCount` or `likeCount` data. Note that disabling caching may increase your page loading time.\n */\n type BlogPost = {\n /**\n * Post ID.\n */\n _id: string;\n /**\n * Post title.\n */\n title: string;\n /**\n * Text of the post.\n */\n plainContent: string;\n /**\n * Date the post was originally published.\n */\n publishedDate: Date;\n /**\n * Number of times the post was viewed.\n */\n viewCount: number;\n /**\n * Number of likes the post received.\n */\n likeCount: number;\n /**\n * Number of comments the post received.\n */\n commentCount: number;\n /**\n * Date the post was most recently published.\n */\n lastPublishedDate: Date;\n /**\n * Indicates whether the cover image is displayed in the post.\n */\n coverImageDisplayed: boolean;\n /**\n * Estimated time in minutes required to read the post.\n */\n timeToRead: number;\n /**\n * Indicates whether the post was pinned to the top of the blog feed.\n */\n pinned: boolean;\n /**\n * Indicates whether the post is set as featured in the post settings. Featured posts appear in custom blog feeds.\n */\n featured: boolean;\n /**\n * List of all hashtags in the post.\n */\n hashtags: string[];\n /**\n * The post's cover [image]($w.Image.html#src).\n */\n coverImage: string;\n /**\n * Relative URL of the post page on your published site.\n */\n postPageUrl: string;\n /**\n * A few lines of text that appear in the blog feed. Defined\n * in [Post Settings](https://support.wix.com/en/article/editing-excerpts-in-the-new-wix-blog) or default of first 160 characters of the post.\n */\n excerpt: string;\n };\n }\n /**\n * A store page for a specific product.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProductPage.html#)\n */\n namespace ProductPage {\n /**\n * Product brand.\n */\n type Brand = {\n /**\n * Brand name.\n */\n name: string;\n /**\n * Brand ID.\n */\n _id: string;\n };\n /**\n * Breadcrumbs.\n */\n type Breadcrumb = {\n /**\n * Category ID.\n */\n categoryId: string;\n /**\n * Category name.\n */\n categoryName: string;\n /**\n * Category slug.\n */\n categorySlug: string;\n };\n /**\n * Breadcrumbs of the `mainCategoryId`.\n */\n type BreadcrumbsInfo = {\n /**\n * Breadcrumbs.\n */\n breadcrumbs: ProductPage.Breadcrumb[];\n };\n /**\n * Option render type.\n */\n type ChoiceType = {\n /**\n * Text choice.\n */\n CHOICE_TEXT: string;\n /**\n * Single color choice.\n */\n ONE_COLOR: string;\n UNKNOWN_CHOICE_TYPE: string;\n };\n /**\n * Choices settings.\n */\n type ChoicesSettings = {\n /**\n * List of available choices for the option.\n */\n choices: ProductPage.ConnectedOptionChoice;\n };\n /**\n * Product modifiers.\n */\n type ConnectedModifier = {\n /**\n * Modifier title.\n */\n name: string;\n /**\n * ID of a customization with `customizationType: \"MODIFIER\"`.\n */\n _id: string;\n /**\n * Whether customer input is required for this modifier.\n */\n mandatory: boolean;\n /**\n * Modifier render type.\n */\n modifierRenderType: ProductPage.ModifierRenderType;\n /**\n * Choices settings.\n */\n choicesSettings?: ProductPage.ModifierChoicesSettings;\n /**\n * Free text modifier settings.\n */\n freeTextSettings?: ProductPage.FreeTextSettings;\n };\n /**\n * List of modifier choices.\n */\n type ConnectedModifierChoice = {\n /**\n * Added price.\n */\n addedPrice: string;\n /**\n * Choice ID.\n */\n choiceId: string;\n /**\n * Choice type.\n */\n choiceType: ProductPage.ChoiceType;\n /**\n * Modifier key. Used for eCommerce integration.\n */\n key: string;\n /**\n * Product media.\n */\n linkedMedia: ProductPage.ProductMedia;\n /**\n * Choice name.\n */\n name: string;\n /**\n * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).\n */\n colorCode: string;\n };\n /**\n * Product option (e.g., \"Size\", \"Color\").\n */\n type ConnectedOption = {\n /**\n * Option name.\n */\n name: string;\n /**\n * ID of a customization with `customizationType: \"PRODUCT_OPTION\"`.\n */\n _id: string;\n /**\n * Option render type.\n */\n optionRenderType: ProductPage.ProductOptionRenderType;\n /**\n * Choices settings.\n */\n choicesSettings: ProductPage.ChoicesSettings;\n };\n /**\n * Choices settings.\n */\n type ConnectedOptionChoice = {\n /**\n * Choice ID.\n */\n choiceId: string;\n /**\n * Choice type.\n */\n choiceType: ProductPage.ChoiceType;\n /**\n * Whether at least one variant with this choice is in stock in the default location of the store.\n *\n * For example, a product with Color and Size options has these variants: [Blue, Small] which is out of stock and [Red, Large] which is in stock.\n * For choice Blue, this field is `false`. For choice Red, this field is `true`.\n */\n inStock: boolean;\n /**\n * Product media to display when this choice is selected.\n *\n * When not empty, only these images are shown when a customer selects this choice.\n * Otherwise, all product images are shown. When multiple choices from different options are selected,\n * only media present in `linkedMedia` of ALL selected choices are shown.\n * For example, if `Color: Red` has images 1, 2, 3 and `Material: Silk` has images 2, 3, 5,\n * then only images 2 and 3 are shown when both are selected.\n */\n linkedMedia: ProductPage.ProductMedia;\n /**\n * Choice name. For text choices, this field also contains the choice value.\n */\n name: string;\n /**\n * Whether at least one variant with this choice is visible.\n *\n * Default: `false`\n */\n visible: boolean;\n /**\n * Single color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color). For example, `#FF0000` for red.\n */\n colorCode: string;\n };\n /**\n * List of categories that directly contain this product.\n */\n type DirectCategoriesInfo = {\n /**\n * Array of direct category items. Each has `id` (string), `name` (string), and `position` (number).\n */\n items: any[];\n };\n /**\n * Discount type.\n */\n type DiscountType = {\n /**\n * Discount by a specific amount.\n */\n AMOUNT: string;\n /**\n * Discount by a percentage.\n */\n PERCENT: string;\n UNKNOWN_DISCOUNT: string;\n };\n /**\n * Custom extended fields for the product.\n */\n type ExtendedFields = {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces: ProductPage.Struct;\n };\n /**\n * File type.\n */\n type FileType = {\n /**\n * Secure archive file.\n */\n SECURE_ARCHIVE: string;\n /**\n * Secure document file.\n */\n SECURE_DOCUMENT: string;\n /**\n * Secure music file.\n */\n SECURE_MUSIC: string;\n /**\n * Secure picture file.\n */\n SECURE_PICTURE: string;\n /**\n * Secure video file.\n */\n SECURE_VIDEO: string;\n /**\n * Unspecified file type.\n */\n UNSPECIFIED: string;\n };\n /**\n * Fixed amount.\n */\n type FixedMonetaryAmount = {\n /**\n * Monetary amount. For example, `\"3.99\"`, or `\"-4.99\"` for a negative amount.\n */\n amount: string;\n /**\n * Formatted monetary amount. For example, `\"$3.99\"`.\n *\n * >**Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.\n */\n formattedAmount: string;\n };\n /**\n * Free text modifier settings.\n */\n type FreeTextSettings = {\n /**\n * Default amount to be added to the product's price.\n */\n defaultAddedPrice: string;\n /**\n * Maximum number of characters.\n */\n maxCharCount: number;\n /**\n * Minimum number of characters.\n */\n minCharCount: number;\n /**\n * Title of the text to be input by the customer.\n */\n title: string;\n };\n /**\n * Product info section.\n */\n type InfoSection = {\n /**\n * Info section unique name.\n *\n * >**Note:** Returned only when you pass `\"INFO_SECTION\"` to the `fields` array in Products API requests.\n */\n uniqueName: string;\n /**\n * Info section title.\n *\n * >**Note:** Returned only when you pass `\"INFO_SECTION\"` to the `fields` array in Products API requests.\n */\n title: string;\n /**\n * Product description using rich content.\n *\n * This field uses [Ricos document](https://dev.wix.com/docs/ricos/api-reference/ricos-document?apiView=SDK), a structured rich content data format.\n * For a quick start, visit the [playground](https://ricos.dev/), generate the content using the editor, and copy the resulting JSON object.\n *\n * See the child properties of this field in the [Ricos Document reference](https://dev.wix.com/docs/ricos/api-reference/ricos-document).\n * Learn more about [Rich Content](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-rich-content).\n *\n * >**Notes:**\n * > + Returned only when you pass `\"DESCRIPTION\"` to the `fields` array in Products API requests.\n * > + This API enables the following [Ricos plugins](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins):\n * > `indent`, `emoji`, `divider`, `codeBlock`, `file`, `gallery`, `giphy`, `image`, `table`, `link`, `textHighlight`, `textColor`\n */\n description: ProductPage.RichContent;\n /**\n * Info section ID.\n */\n _id: string;\n /**\n * Info section description in HTML.\n *\n * When provided on create/update, this string must be a valid HTML.\n * It will then be converted to rich content.\n * `plainDescription` is ignored when value is also passed to the `description` field.\n *\n * >**Note:** Returned only when you pass `\"INFO_SECTION_PLAIN_DESCRIPTION\"` to the `fields` array in Products API requests.\n */\n plainDescription: string;\n };\n /**\n * Product inventory information.\n */\n type Inventory = {\n /**\n * Current availability status.\n */\n availabilityStatus: ProductPage.InventoryAvailabilityStatus;\n /**\n * Preorder availability status.\n */\n preorderAvailability: ProductPage.ProductPreorderAvailability;\n /**\n * Current preorder status.\n */\n preorderStatus: ProductPage.PreorderStatus;\n };\n /**\n * Current availability status.\n */\n type InventoryAvailabilityStatus = {\n IN_STOCK: string;\n OUT_OF_STOCK: string;\n PARTIALLY_OUT_OF_STOCK: string;\n UNKNOWN_AVAILABILITY_STATUS: string;\n };\n /**\n * Variant inventory status.\n */\n type InventoryStatus = {\n /**\n * Whether the variant is in stock.\n */\n inStock: boolean;\n /**\n * Whether preorder is enabled for the variant.\n */\n optionId: boolean;\n };\n type Keyword = {\n /**\n * Keyword value.\n */\n term: string;\n /**\n * Whether the keyword is the main focus keyword.\n */\n isMain: boolean;\n /**\n * The source that added the keyword terms to the SEO settings.\n */\n origin: string;\n };\n type ListValue = {\n values: ProductPage.Value[];\n };\n /**\n * Measurement unit.\n */\n type MeasurementUnit = {\n CBM: string;\n CL: string;\n CM: string;\n FLOZ: string;\n FT: string;\n G: string;\n GAL: string;\n IN: string;\n KG: string;\n L: string;\n LB: string;\n M: string;\n MG: string;\n ML: string;\n MM: string;\n OZ: string;\n PT: string;\n QT: string;\n SQFT: string;\n SQM: string;\n UNSPECIFIED: string;\n YD: string;\n };\n /**\n * Product media items. For a detailed explanation of product media, see [About Product Media](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/about-product-media).\n */\n type Media = {\n /**\n * Main media (image, video, etc.) associated with this product. Automatically set to the first item in the media list.\n */\n main: ProductPage.ProductMedia;\n /**\n * All media items.\n *\n * >**Note:** Returned only when you pass `\"MEDIA_ITEMS_INFO\"` to the `fields` array in Products API requests.\n */\n itemsInfo: ProductPage.MediaItemsInfo;\n };\n /**\n * An object representing a media item.\n */\n type MediaItem = {\n /**\n * Media item ID.\n */\n id: string;\n /**\n * Media item title.\n */\n title: string;\n /**\n * Media item description. Descriptions over 100 characters are truncated.\n */\n description: string;\n /**\n * Media item type. Can be \"image\" or \"video.\"\n */\n type: string;\n /**\n * Media item source URL.\n */\n src: string;\n /**\n * Thumbnail URL for videos only.\n */\n thumbnail?: string;\n };\n /**\n * All media items.\n */\n type MediaItemsInfo = {\n /**\n * All media items associated with this product.\n *\n * The first item is automatically set as the product's main media.\n */\n items: ProductPage.ProductMedia[];\n };\n /**\n * Media type.\n */\n type MediaType = {\n /**\n * Image media type.\n */\n IMAGE: string;\n /**\n * Video media type.\n */\n VIDEO: string;\n UNKNOWN_MEDIA_TYPE: string;\n };\n /**\n * Choice settings.\n */\n type ModifierChoicesSettings = {\n /**\n * List of modifier choices.\n */\n choices: ProductPage.ConnectedModifierChoice;\n };\n /**\n * Modifier render type.\n */\n type ModifierRenderType = {\n /**\n * Free text.\n */\n FREE_TEXT: string;\n /**\n * Swatch choices.\n */\n SWATCH_CHOICES: string;\n /**\n * Text choices.\n */\n TEXT_CHOICES: string;\n /**\n * Not implemented.\n */\n UNKNOWN_MODIFIER_RENDER_TYPE: string;\n };\n type NullValue = {\n NULL_VALUE: string;\n };\n /**\n * List of choices.\n */\n type OptionChoice = {\n /**\n * Option and choice IDs. These match the IDs of the option and choice from the product's options field.\n */\n optionChoiceIds: ProductPage.OptionChoiceIds;\n /**\n * Option and choice names. This needs to be used in all requests `OptionChoice` is needed, and all `OptionChoiceNames` fields are required.\n *\n * >**Note:** Returned only when you pass `\"VARIANT_OPTION_CHOICE_NAMES\"` to the `fields` array in Products API requests.\n */\n optionChoiceNames: ProductPage.OptionChoiceNames;\n };\n /**\n * Option and choice IDs.\n */\n type OptionChoiceIds = {\n /**\n * Choice ID.\n */\n choiceId: string;\n /**\n * Option ID.\n *\n * >**Note:** Returned only when you pass `\"VARIANT_OPTION_CHOICE_NAMES\"` to the `fields` array in Products API requests.\n */\n optionId: string;\n };\n /**\n * Option and choice names.\n */\n type OptionChoiceNames = {\n /**\n * Choice name.\n */\n choiceName: string;\n /**\n * Option name.\n */\n optionName: string;\n /**\n * Render type of the option. Required when using `optionChoiceNames`. Must match the `optionRenderType` of the referenced option.\n */\n renderType: ProductPage.ProductOptionRenderType;\n };\n /**\n * Physical properties for physical products.\n */\n type PhysicalProperties = {\n /**\n * Delivery profile ID.\n */\n deliveryProfileId: string;\n /**\n * Fulfiller ID.\n */\n fulfillerId: string;\n /**\n * Price per unit settings.\n *\n * >**Note:** Use this field only when relevant. For example, for products that are sold by weight, volume, or length.\n */\n pricePerUnit: ProductPage.PricePerUnitSettings;\n /**\n * Product price per unit range. The minimum and maximum price per unit of all the variants.\n */\n pricePerUnitRange: ProductPage.PricePerUnitRange;\n /**\n * Product shipping weight range - Calculated from the lightest and heaviest variant shipping weights.\n */\n shippingWeightRange: ProductPage.WeightRange;\n /**\n * Weight measurement unit.\n *\n * >**Note:** Returned only when you pass `\"WEIGHT_MEASUREMENT_UNIT_INFO\"` to the `fields` array in Products API requests.\n */\n weightMeasurementUnitInfo: ProductPage.WeightMeasurementUnitInfo;\n };\n /**\n * Current preorder status.\n */\n type PreorderStatus = {\n DISABLED: string;\n ENABLED: string;\n PARTIALLY_ENABLED: string;\n UNKNOWN_PREORDER_STATUS: string;\n };\n /**\n * Variant price.\n */\n type PriceInfo = {\n /**\n * Variant's current selling price. Must be greater than or equal to 0.\n */\n actualPrice: ProductPage.FixedMonetaryAmount;\n /**\n * Original price before any discount, shown with a strikethrough in the UI of Wix sites.\n * Only set this if a discount applies. When set, it should be higher than `actualPrice` to reflect savings.\n */\n compareAtPrice: ProductPage.FixedMonetaryAmount;\n };\n /**\n * Price per unit info.\n */\n type PricePerUnit = {\n /**\n * Price per unit description.\n *\n * >**Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.\n */\n description: string;\n /**\n * Price per unit data for this variant. `measurementUnit` value must correspond to the measurement unit set on the product.\n */\n settings: ProductPage.PricePerUnitSettings;\n /**\n * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.\n * For example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$\n * (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).\n */\n value: string;\n };\n /**\n * Product price per unit range.\n */\n type PricePerUnitRange = {\n /**\n * Maximum price per unit across all variants.\n */\n maxValue: ProductPage.PricePerUnitRangePricePerUnit;\n /**\n * Minimum price per unit across all variants.\n */\n minValue: ProductPage.PricePerUnitRangePricePerUnit;\n };\n /**\n * Product price per unit range.\n */\n type PricePerUnitRangePricePerUnit = {\n /**\n * Price per unit info in the format of variant specific data / product setting, for example €4.00 / 1 Kg.\n *\n * >**Note:** This field is returned by the API only when you pass `fields: \"CURRENCY\"` in a request.\n */\n description: string;\n /**\n * Calculated value of price per unit.\n * Takes into account pricePerUnit settings of product and variants and price of variants.\n * For example if discounted price is 2$, product's price per unit setting is 1 Kg,\n * variant price per unit setting is 0.5 Kg then this value is 4$\n * (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).\n */\n value: string;\n };\n /**\n * Price per unit settings.\n */\n type PricePerUnitSettings = {\n /**\n * Measurement unit. For example, to define price per 100 grams, set this field to `\"G\"`.\n */\n measurementUnit: ProductPage.MeasurementUnit;\n /**\n * Quantity. For example, to define price per 100 grams, set this field to `100`.\n */\n quantity: number;\n };\n /**\n * Current selling price range.\n */\n type PriceRange = {\n /**\n * Maximum value.\n */\n maxValue: ProductPage.FixedMonetaryAmount;\n /**\n * Minimum value.\n */\n minValue: ProductPage.FixedMonetaryAmount;\n };\n /**\n * An object representing an additional info section for a store product.\n */\n type ProductAdditionalInfoSection = {\n /**\n * Section title.\n */\n title: string;\n /**\n * Section description.\n */\n description: string;\n };\n /**\n * List of all categories related to the product.\n */\n type ProductCategoriesInfo = {\n /**\n * A list of categories related to the product.\n */\n category: ProductPage.ProductCategory[];\n };\n /**\n * List of categories related to the product.\n */\n type ProductCategory = {\n /**\n * Category ID.\n */\n _id: string;\n /**\n * Index location of the product within the category, which can be utilized for sorting products in a specific category.\n * For detailed instructions on how to set this up, refer to\n * the [Add and arrange products in a category](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-a-category) sample flow.\n */\n index: number;\n };\n /**\n * An object representing a product variant's option choices.\n */\n type ProductChoices = {\n /**\n * Value of the choice. This key name is dependent on the\n * product option. For example, if a product has a size option, this\n * key value will be something like `\"Size\"` and its value will be something like\n * `\"Large\"`.\n *\n * `optionKey` is not case-sensitive. Therefore the values for the option keys \"`Size`\", \"`SIZE`\", and \"`size`\" are combined.\n */\n optionKey: string;\n };\n /**\n * An object representing a custom text field for a store product.\n */\n type ProductCustomTextFields = {\n /**\n * Product customization field title.\n */\n title: string;\n /**\n * Maximum length of product customization field in characters.\n */\n maxLength: string;\n };\n /**\n * An object representing a product discount.\n */\n type ProductDiscount = {\n /**\n * Discount type. Required.\n *\n * One of:\n *\n *\n *\n * - `\"AMOUNT\"`\n * - `\"PERCENT\"`\n * - `\"NONE\"`\n */\n type: string;\n /**\n * Discount value. The discount value cannot be greater than the price of the product or the variant.\n */\n value: string;\n };\n /**\n * Main media (image, video, etc.) associated with this product. Automatically set to the first item in the media list.\n */\n type ProductMedia = {\n /**\n * Image alt text.\n */\n altText: string;\n /**\n * Media display name.\n *\n * Overrides the default media name. Can be passed only when the media is set by a URL in this item's `url` field.\n */\n displayName: string;\n /**\n * Media type.\n */\n mediaType: ProductPage.MediaType;\n /**\n * Media thumbnail.\n *\n * >**Note:** Returned only when you pass `\"THUMBNAIL\"` to the `fields` array in Products API requests.\n */\n thumbnail: ProductPage.Thumbnail;\n /**\n * ID used to upload media to [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).\n */\n uploadId: string;\n /**\n * Set media by ID of an existing file in [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).\n */\n _id?: string;\n /**\n * Set media using an external media URL.\n */\n url?: string;\n /**\n * Image details. Populated when you provide a [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) file ID in this item's `_id` field..\n */\n image?: string;\n /**\n * Video details. Populated when you provide a [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) file ID in this item's `_id` field.\n */\n video?: string;\n };\n /**\n * An object representing an option for a store product.\n */\n type ProductOption = {\n /**\n * Option type. Either `\"color\"` or `\"drop_down\"`.\n */\n optionType: string;\n /**\n * Option name.\n */\n name: string;\n /**\n * Option choices.\n */\n choices: ProductPage.ProductOptionsChoice[];\n };\n /**\n * Option render type.\n */\n type ProductOptionRenderType = {\n /**\n * Swatch choices.\n */\n SWATCH_CHOICES: string;\n /**\n * Text choices.\n */\n TEXT_CHOICES: string;\n /**\n * Not implemented.\n */\n UNKNOWN_OPTION_RENDER_TYPE: string;\n };\n /**\n * An object representing all the available options for a store product, such as \"Size\" and \"Color.\"\n */\n type ProductOptions = {\n /**\n * Name of the option. This key name\n * is dependent on the options added to the product. For example, if a product has a size\n * option, this key will be something like `\"Size\"`.\n *\n * `optionKey` is not case-sensitive. Therefore the values for the option keys \"`Size`\", \"`SIZE`\", and \"`size`\" are combined.\n */\n optionKey: ProductPage.ProductOption;\n };\n /**\n * An object representing an option's choice for a store product, such as choice \"Small\" for the option \"Size.\"\n */\n type ProductOptionsChoice = {\n /**\n * Choice value.\n */\n value: number;\n /**\n * Choice description.\n */\n description: number;\n /**\n * Choice media.\n */\n media: ProductPage.ProductOptionsChoiceMedia;\n /**\n * Indicates whether the product with this choice is in stock.\n */\n inStock: boolean;\n /**\n * Indicates whether the product with this option is visible.\n */\n visible: boolean;\n };\n /**\n * An object representing the choice media.\n */\n type ProductOptionsChoiceMedia = {\n /**\n * Main choice media item (image or video thumbnail) URL.\n */\n mainMedia: string;\n /**\n * List of choice media items.\n */\n mediaItems: ProductPage.MediaItem;\n };\n /**\n * Preorder availability status.\n */\n type ProductPreorderAvailability = {\n ALL_VARIANTS: string;\n NO_VARIANTS: string;\n SOME_VARIANTS: string;\n UNKNOWN_PREORDER_AVAILABILITY_STATUS: string;\n };\n /**\n * An object representing a ribbon for a store product.\n */\n type ProductRibbon = {\n /**\n * Ribbon text.\n */\n text: string;\n };\n /**\n * Product type.\n */\n type ProductType = {\n /**\n * Digital product.\n */\n DIGITAL: string;\n /**\n * Physical product.\n */\n PHYSICAL: string;\n /**\n * Not implemented.\n */\n UNKNOWN_PRODUCT_TYPE: string;\n };\n /**\n * An object representing a product in a store.\n */\n type Productv1 = {\n /**\n * Product ID.\n */\n _id: string;\n /**\n * Date and time the product was last updated.\n */\n _updatedDate: Date;\n /**\n * Product name.\n */\n name: string;\n /**\n * Product description.\n */\n description: string;\n /**\n * Main product media item (image or video thumbnail) URL.\n */\n mainMedia: string;\n /**\n * List of product media items.\n */\n mediaItems: ProductPage.MediaItem;\n /**\n * Product stock keeping unit value. Must be unique.\n */\n sku: string;\n /**\n * Deprecated. Use `ribbon` instead.\n */\n ribbons: ProductPage.ProductRibbon[];\n /**\n * Product ribbon. Used to highlight relevant information about a product. For example, `\"Sale\"`, `\"New Arrival\"`, `\"Sold Out\"`.\n */\n ribbon: string;\n /**\n * Product currency.\n */\n currency: string;\n /**\n * Product price.\n * The price must be greater than its discount.\n * The product price is propagated to the product's newly-created variants. Product variants whose prices have been updated directly are not affected by the changes to the product price.\n */\n price: number;\n /**\n * Discounted product price.\n */\n discountedPrice: number;\n /**\n * Product price formatted with the currency.\n */\n formattedPrice: string;\n /**\n * Discounted product price formatted with the currency.\n */\n formattedDiscountedPrice: string;\n /**\n * Price per unit.\n */\n pricePerUnit: number;\n /**\n * Price per unit formatted with currency symbol.\n */\n formattedPricePerUnit: string;\n /**\n * Details of the product's price per unit.\n */\n pricePerUnitData: ProductPage.pricePerUnitData;\n /**\n * ID for the inventory item.\n */\n inventoryItemId: string;\n /**\n * Product discount.\n */\n discount: ProductPage.ProductDiscount;\n /**\n * Indicates whether inventory is tracked for the product.\n */\n trackInventory: boolean;\n /**\n * Indicates whether the product is in stock.\n */\n inStock: boolean;\n /**\n * Number of units currently in stock.\n */\n quantityInStock: number;\n /**\n * Additional product information sections.\n */\n additionalInfoSections: ProductPage.ProductAdditionalInfoSection[];\n /**\n * All the available options for a store product.\n */\n productOptions: ProductPage.ProductOptions;\n /**\n * Product page relative URL.\n */\n productPageUrl: string;\n /**\n * Indicates whether product variants are managed. Can be set to true only if the product has options. Once set to true, `manageVariants` can only be reset to false only if no variants exist. Use [`getProductVariants()`](https://www.wix.com/velo/reference/wix-stores.html#getProductVariants) to check if variants exist. You cannot set `manageVariants` to true if more than 300 variants are defined.\n */\n manageVariants: boolean;\n /**\n * List of product customization fields.\n */\n customTextFields: ProductPage.ProductCustomTextFields[];\n /**\n * Product type. Either `\"physical\"` or `\"digital\"`. When creating a product using the API, currently only `\"physical\"` is supported.\n */\n productType: string;\n /**\n * Product slug.\n */\n slug: string;\n /**\n * Product weight.\n */\n weight: number;\n /**\n * Product variants.\n */\n variants: ProductPage.VariantItem[];\n /**\n * Custom SEO data for the product. Learn more [about SEO](https://support.wix.com/en/search?term=seo).\n */\n seoData: ProductPage.SeoData;\n };\n /**\n * An object representing a product in a store.\n */\n type Productv3 = {\n /**\n * Date and time the product was created.\n */\n _createdDate: Date;\n /**\n * Product ID.\n */\n _id: string;\n /**\n * Date and time the product was updated.\n */\n _updatedDate: Date;\n /**\n * Revision number, which increments by 1 each time the product is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the product.\n *\n * Ignored when creating a product.\n */\n revision: string;\n /**\n * Product name. Translatable.\n */\n name: string;\n /**\n * Product slug.\n *\n * If not provided, the slug is autogenerated based on the product name.\n */\n slug: string;\n /**\n * URL to the site's product page.\n * >**Note:** Returned only when you pass `\"URL\"` to the `fields` array in Products API requests.\n */\n url: ProductPage.Url;\n /**\n * Product description using rich content.\n *\n * This field uses [Ricos document](https://dev.wix.com/docs/ricos/api-reference/ricos-document?apiView=SDK), a structured rich content data format.\n * For a quick start, visit the [playground](https://ricos.dev/), generate the content using the editor, and copy the resulting JSON object.\n *\n * See the child properties of this field in the [Ricos Document reference](https://dev.wix.com/docs/ricos/api-reference/ricos-document).\n * Learn more about [Rich Content](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-rich-content).\n *\n * >**Notes:**\n * > + Returned only when you pass `\"DESCRIPTION\"` to the `fields` array in Products API requests.\n * > + This API enables the following [Ricos plugins](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins):\n * > `indent`, `emoji`, `divider`, `codeBlock`, `file`, `gallery`, `giphy`, `image`, `table`, `link`, `textHighlight`, `textColor`\n */\n description: ProductPage.RichContent;\n /**\n * Product description in HTML.\n *\n * + When provided on create/update, this string must be valid HTML. It's then converted to rich content.\n * + `plainDescription` is ignored when a value is also passed to the `description` field.\n *\n * >**Note:** Returned only when you pass `\"PLAIN_DESCRIPTION\"` to the `fields` array in Products API requests.\n */\n plainDescription: string;\n /**\n * Whether the product is visible to site visitors.\n *\n * Default: `true`.\n */\n visible: boolean;\n /**\n * Whether the product is visible in POS (point of sale).\n *\n * Default: `true`.\n *\n * >**Note:** Always `false` for `productType: DIGITAL`.\n */\n visibleInPos: boolean;\n /**\n * Product media items. For a detailed explanation of product media, see [About Product Media](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/about-product-media).\n */\n media: ProductPage.Media;\n /**\n * Product SEO data.\n */\n seoData: ProductPage.SeoSchema;\n /**\n * [Tax group ID](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/tax-groups/introduction). Used to apply specific tax rates to products.\n */\n taxGroupId: string;\n /**\n * Product options, such as \"Size\" or \"Color\". Options define the ways a product can vary.\n *\n * When you provide options, you must also provide the corresponding variants. Each variant must have exactly one choice for each option. For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/about-product-options-and-variants).\n *\n * Options are stored as reusable [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) entities. Pass an existing customization's ID to reuse it, or define options inline and new customization entities are created automatically.\n */\n options: ProductPage.ConnectedOption[];\n /**\n * Product modifiers. Collect additional information from customers without creating variants.\n *\n * Unlike options, modifiers don't affect inventory or create additional variants. Use them for things like gift messages or engraving text. For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/about-product-options-and-variants).\n *\n * Modifiers are stored as reusable [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) entities. Pass an existing customization's ID to reuse it, or define modifiers inline and new customization entities are created automatically.\n */\n modifiers: ProductPage.ConnectedModifier[];\n /**\n * Product [brand](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/introduction).\n * + Pass `brand.name` to add a new brand while creating a product.\n * + Pass an existing brand's `_id` to assign that brand to the product.\n */\n brand: ProductPage.Brand;\n /**\n * Product [info section](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction).\n *\n * + Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product.\n * + Pass an existing info section's `_id` or `uniqueName` to assign that info section to the product.\n */\n infoSections: ProductPage.InfoSection[];\n /**\n * Product [ribbon](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/introduction).\n *\n * + Pass `ribbon.name` to add a new ribbon while creating a product.\n * + Pass an existing ribbon's `_id` or `name` to assign that ribbon to the product.\n */\n ribbon: ProductPage.Ribbon;\n /**\n * List of [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction) that directly contain this product.\n *\n * Updated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted.\n *\n * >**Note:** Returned only when you pass `\"DIRECT_CATEGORIES_INFO\"` to the `fields` array in Products API requests.\n */\n directCategoriesInfo: ProductPage.ProductCategoriesInfo;\n /**\n * List of [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction) that directly contain this product, as well as their parent categories.\n *\n * >**Note:** Returned only when you pass `\"ALL_CATEGORIES_INFO\"` to the `fields` array in Products API requests.\n */\n allCategoriesInfo: ProductPage.ProductCategoriesInfo;\n /**\n * The ID of the product's primary direct [category](https://dev.wix.com/docs/api-reference/business-management/categories/introduction), which defines the product's breadcrumbs path. For example, if the product's main category is \"T-Shirts\" (which is a subcategory of \"Clothing\"), the breadcrumbs path is \"Clothing > T-Shirts\".\n */\n mainCategoryId: string;\n /**\n * Product cost range - minimum and maximum costs of all product variants.\n *\n * >**Note:** Returned only when the following conditions are met:\n * > + You pass `\"MERCHANT_DATA\"` to the `fields` array in Products API requests.\n * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.\n */\n costRange: ProductPage.PriceRange;\n /**\n * Product inventory info.\n *\n * >**Note:** This field reflects the aggregated inventory status from the default location only.\n * > Use the [Inventory Items API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/introduction) to manage inventory for specific locations.\n * > Learn more about [inventory management](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-inventory-management).\n */\n inventory: ProductPage.Inventory;\n /**\n * Product type: `PHYSICAL` for tangible goods that require shipping, or `DIGITAL` for downloadable content.\n *\n * >**Note:** When passing `productType: PHYSICAL`, you must also pass `physicalProperties`. When passing `productType: DIGITAL`, you can optionally pass `digitalProperties` in each variant.\n */\n productType: ProductPage.ProductType;\n /**\n * A unique human-friendly identifier for the product.\n *\n * Unlike the auto-generated `_id`, the handle can be set when creating a product. This is useful when re-importing products from other systems, as it provides a stable identifier across platforms. If not provided during creation, one is automatically generated. Can't be changed after creation.\n */\n handle: string;\n /**\n * Currency used for the pricing of this product, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#list_of_ISO_4217_currency_codes) format.\n *\n * Defaults to the currency defined in the site settings, unless specified in the request's `x-wix-currency` header.\n *\n * >**Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.\n */\n currency: string;\n /**\n * Breadcrumbs of the `mainCategoryId`. Used to navigate to parent [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction).\n *\n * >**Note:** Returned only when you pass `\"BREADCRUMBS_INFO\"` to the `fields` array in Products API requests.\n */\n breadcrumbsInfo: ProductPage.BreadcrumbsInfo;\n /**\n * Minimum and maximum current selling prices across all product variants.\n */\n actualPriceRange: ProductPage.PriceRange;\n /**\n * Minimum and maximum compare-at prices (original prices before discounts) across all product variants. Used to show savings to customers.\n */\n compareAtPriceRange: ProductPage.PriceRange;\n /**\n * Product variants. Each variant represents a specific purchasable version of a product defined by option choices.\n *\n * Each variant must reference all product options via its `choices` array, using `optionChoiceNames` in requests. You must explicitly provide each variant when creating products with options.\n *\n * For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-product-options-and-variants).\n */\n variantsInfo: ProductPage.VariantsInfo;\n /**\n * Custom extended fields for the product object.\n *\n * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions)\n * must be configured in the app dashboard before they can be accessed with API calls.\n */\n extendedFields: ProductPage.ExtendedFields;\n /**\n * Product subscriptions.\n *\n * Subscription discounts are defined at the product level but apply to each variant's `actualPrice`.\n * This means the final subscription price varies per variant based on the variant's base price.\n */\n subscriptionDetails: ProductPage.SubscriptionDetails;\n /**\n * Total number of variants for the product.\n */\n variantSummary: ProductPage.VariantSummary;\n /**\n * Physical properties.\n *\n * Required when `productType: PHYSICAL`.\n */\n physicalProperties: ProductPage.PhysicalProperties;\n };\n /**\n * Variant revenue details.\n */\n type RevenueDetails = {\n /**\n * Item cost.\n */\n cost: ProductPage.FixedMonetaryAmount;\n /**\n * Profit. Calculated by reducing `cost` from `discountedPrice`.\n */\n profit: ProductPage.FixedMonetaryAmount;\n /**\n * Profit Margin. Calculated by dividing `profit` by `discountedPrice`. The result is rounded to 4 decimal places.\n */\n profitMargin: number;\n };\n /**\n * Product ribbon.\n */\n type Ribbon = {\n /**\n * Ribbon name.\n */\n name: string;\n /**\n * Ribbon ID.\n */\n _id: string;\n };\n /**\n * Product description using rich content.\n */\n type RichContent = {};\n /**\n * Digital file.\n */\n type SecuredMedia = {\n /**\n * Media ID in media manager.\n */\n _id: string;\n /**\n * Original file name.\n */\n fileName: string;\n /**\n * Original file size.\n */\n fileSize: string;\n /**\n * File type.\n */\n fileType: ProductPage.FileType;\n };\n /**\n * An object representing custom SEO data for the product.\n */\n type SeoData = {\n /**\n * SEO tag details.\n */\n tags: ProductPage.SeoTag[];\n };\n /**\n * Product SEO data.\n */\n type SeoSchema = {\n /**\n * SEO general settings.\n */\n settings: ProductPage.Settings;\n /**\n * SEO tag information.\n */\n tags: ProductPage.Tag[];\n };\n /**\n * An object representing the product's custom SEO tags.\n */\n type SeoTag = {\n /**\n * SEO tag type.\n * Supported values:\n *\n * + `\"title\"`\n * + `\"meta\"`\n * + `\"script\"`\n * + `\"link\"`\n */\n type: string;\n /**\n * The props property holds an object of `{\"key\": \"value\"}` pairs where the key is one of the SEO tag's properties (name, content, rel, href, etc.)\n * and the value is the value for that property. `{\"name\": \"description\", \"content\": \"The description itself.\"}`.\n */\n props: object;\n /**\n * Tag metadata. For example, `{\"height\": 300, \"width\": 240}`.\n */\n meta: object;\n /**\n * Tag inner content. For example, ` inner content `.\n */\n children: string;\n /**\n * Whether the tag is a custom tag.\n */\n custom: boolean;\n /**\n * Whether the tag is disabled.\n */\n disabled: boolean;\n };\n /**\n * SEO general settings.\n */\n type Settings = {\n /**\n * Whether the [automatic redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n *\n * Default: `false` (automatic redirect is enabled)\n */\n preventAutoRedirect: boolean;\n /**\n * User-selected keyword terms for a specific page.\n */\n keywords: ProductPage.Keyword[];\n };\n type Struct = {\n fields: ProductPage.Value[];\n };\n /**\n * Subscription.\n */\n type Subscription = {\n /**\n * Subscription ID.\n */\n _id: string;\n /**\n * Subscription description.\n */\n description: string;\n /**\n * Discount info (optional). For example, a $20 discount would be `amount: 20`, `type: AMOUNT`.\n */\n discount: ProductPage.SubscriptionDiscount;\n /**\n * Frequency of recurring payment.\n * For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.\n */\n frequency: ProductPage.SubscriptionFrequency;\n /**\n * Interval of recurring payment.\n * For example, if `frequency: MONTH`, `billingCycles: 3` and `interval: 2`; payment will be made every 2 months for a total of 6 months.\n *\n * Default: `1`\n */\n interval: number;\n /**\n * Subscription title.\n */\n title: string;\n /**\n * Whether the subscription is visible to site visitors.\n *\n * Defailt: `true`\n */\n visible: boolean;\n /**\n * Whether subscription is renewed automatically at the end of each period. Can't be `false`, instead set `billingCycles`.\n */\n autoRenewal?: boolean;\n /**\n * Number of billing cycles before subscription ends.\n */\n billingCycles?: number;\n };\n /**\n * Product subscriptions.\n */\n type SubscriptionDetails = {\n /**\n * Whether to allow one-time purchases in addition to subscription-based purchases.\n *\n * Default: `false`\n */\n allowOneTimePurchases: boolean;\n /**\n * Subscriptions.\n */\n subscriptions: ProductPage.Subscription[];\n };\n /**\n * Discount info.\n */\n type SubscriptionDiscount = {\n /**\n * Discount type.\n */\n type: ProductPage.DiscountType;\n /**\n * Amount to discount from the variant `discountedPrice`.\n */\n amountOff?: string;\n /**\n * Percentage to discount from variant `discountedPrice`.\n */\n percentOff?: number;\n };\n /**\n * Frequency of recurring payment.\n */\n type SubscriptionFrequency = {\n DAY: string;\n MONTH: string;\n UNDEFINED: string;\n WEEK: string;\n YEAR: string;\n };\n /**\n * Subscription prices.\n */\n type SubscriptionPrice = {\n /**\n * Subscription price calculated by applying subscription discount to the variant `price.actualPrice`.\n */\n price: ProductPage.FixedMonetaryAmount;\n /**\n * Price per unit info.\n */\n pricePerUnit: ProductPage.SubscriptionPricePerUnit;\n /**\n * Subscription ID.\n */\n subscriptionId: string;\n };\n /**\n * Price per unit info.\n */\n type SubscriptionPricePerUnit = {\n /**\n * Price per unit description.\n *\n * >**Note:** Returned only when you pass `\"CURRENCY\"` to the `fields` array in Products API requests.\n */\n description: string;\n /**\n * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price..\n */\n value: string;\n };\n /**\n * Subscription prices.\n */\n type SubscriptionPricesInfo = {\n /**\n * Subscription prices.\n */\n subscriptionPrices: ProductPage.SubscriptionPrice[];\n };\n /**\n * SEO tag information.\n */\n type Tag = {\n /**\n * SEO tag type.\n *\n * Supported values: `\"title\"`, `\"meta\"`, `\"script\"`, `\"link\"`.\n */\n type: string;\n /**\n * A `{\"key\": \"value\"}` pair object where each SEO tag property (\"name\", \"content\", \"rel\", \"href\") contains a value. For example, `{\"name\": \"description\", \"content\": \"The description itself.\"}`.\n */\n props: ProductPage.Struct;\n /**\n * SEO tag metadata. For example, `{\"height\": 300, \"width\": 240}`.\n */\n meta: ProductPage.Struct;\n /**\n * SEO tag inner content. For example, ` inner content `.\n */\n children: string;\n /**\n * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\n */\n custom: boolean;\n /**\n * Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines.\n */\n disabled: boolean;\n };\n /**\n * Media thumbnail.\n */\n type Thumbnail = {\n /**\n * Thumbnail url.\n */\n url: string;\n /**\n * Thumbnail height.\n */\n height: number;\n /**\n * Thumbnail width.\n */\n width: number;\n /**\n * Thumbnail alt text.\n */\n altText: string;\n };\n /**\n * URL to the site's product page.\n */\n type Url = {\n /**\n * The relative path for the page within the site. For example, `/product-page/a-product`.\n */\n relativePath: string;\n /**\n * The page's full URL. For example, `https://mysite.com/product-page/a-product`.\n */\n url: string;\n };\n type Value = {\n nullValue?: ProductPage.NullValue;\n numberValue?: number;\n stringValue?: string;\n boolValue?: boolean;\n structValue?: ProductPage.Struct;\n listValue?: ProductPage.ListValue[];\n };\n /**\n * Related variant.\n */\n type Variant = {\n /**\n * Variant ID.\n */\n _id: string;\n /**\n * Variant barcode.\n */\n barcode: string;\n /**\n * List of choices that define this variant. Each variant must have exactly one choice for each product option.\n *\n * Use `optionChoiceNames` in all requests where this field is required. For products without options, this array is empty, representing a single \"default variant\".\n *\n * For more information, see [About Product Options and Variants](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/about-product-options-and-variants).\n */\n choices: ProductPage.OptionChoice[];\n /**\n * Variant inventory status.\n */\n inventoryStatus: ProductPage.InventoryStatus;\n /**\n * Variant media.\n */\n media: ProductPage.ProductMedia;\n /**\n * Variant price.\n */\n price: ProductPage.PriceInfo;\n /**\n * Variant revenue details.\n *\n * >**Note:** Returned only when the following conditions are met:\n * > + You pass `\"MERCHANT_DATA\"` to the `fields` array in a Products API request.\n * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.\n */\n revenueDetails: ProductPage.RevenueDetails;\n /**\n * Variant SKU (stock keeping unit).\n */\n sku: string;\n /**\n * Subscription prices calculate by applying subscription discount to the variant `price.actualPrice`.\n *\n * >**Note:** Returned only when you pass `\"SUBSCRIPTION_PRICES_INFO\"` to the `fields` array in a Products API request.\n */\n subscriptionPricesInfo: ProductPage.SubscriptionPricesInfo;\n /**\n * Whether the variant is visible to site visitors.\n *\n * Default: `true`\n */\n visible: boolean;\n /**\n * Digital properties. Must be passed when `productType: DIGITAL`.\n */\n digitalProperties?: ProductPage.VariantDigitalProperties;\n /**\n * Physical properties. Must be passed when `productType: PHYSICAL`.\n */\n physicalProperties?: ProductPage.VariantPhysicalProperties;\n };\n /**\n * Digital properties.\n */\n type VariantDigitalProperties = {\n /**\n * Digital file which will be downloaded by the buyer after successful purchase.\n * Each variant can have a different digital file, allowing you to offer different content per variant.\n */\n digitalFile: ProductPage.SecuredMedia;\n };\n /**\n * An object representing variant information to use when creating or updating variants.\n */\n type VariantInfo = {\n /**\n * Variant currency.\n */\n currency: string;\n /**\n * Variant price. The variant price must be greater than its discount. If the variant price has been updated, changes to the product price do not affect the variant price.\n */\n price: number;\n /**\n * Discounted variant price.\n */\n discountedPrice: number;\n /**\n * Variant price formatted with the currency.\n */\n formattedPrice: string;\n /**\n * Discounted variant price formatted with the currency.\n */\n formattedDiscountedPrice: string;\n /**\n * Variant weight.\n */\n weight: number;\n /**\n * Variant stock keeping unit value.\n */\n sku: string;\n /**\n * Whether the variant is visible in the store.\n */\n visible: boolean;\n /**\n * Price per unit.\n */\n pricePerUnit: number;\n /**\n * Price per unit formatted with currency symbol.\n */\n formattedPricePerUnit: string;\n };\n /**\n * An object representing a product variant item.\n */\n type VariantItem = {\n /**\n * Unique variant ID.\n */\n _id: string;\n /**\n * The choices of the retrieved variant.\n */\n choices: ProductPage.ProductChoices;\n /**\n * Variant information.\n */\n variant: ProductPage.VariantInfo;\n };\n /**\n * Physical properties.\n */\n type VariantPhysicalProperties = {\n /**\n * Price per unit info, in order to show price per unit on the product page.\n * For example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese.\n * But on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.\n */\n pricePerUnit: ProductPage.PricePerUnit;\n /**\n * Variant shipping weight. `product.physicalProperties.shippingWeightRange` values are taken from here.\n */\n weight: number;\n };\n /**\n * Total number of product variants for the product.\n */\n type VariantSummary = {\n /**\n * Total number of variants for the product.\n */\n variantCount: number;\n };\n /**\n * Product variants information.\n */\n type VariantsInfo = {\n /**\n * List of related variants.\n */\n variants: ProductPage.Variant[];\n };\n /**\n * Weight measurement unit.\n */\n type WeightMeasurementUnitInfo = {\n /**\n * Weight measurement unit.\n */\n weightMeasurementUnit: ProductPage.WeightUnit;\n };\n /**\n * Product shipping weight range.\n */\n type WeightRange = {\n /**\n * Maximum weight across all variants associated with this product.\n */\n maxValue: number;\n /**\n * Minimum weight across all variants associated with this product.\n */\n minValue: number;\n };\n /**\n * Weight measurement unit.\n */\n type WeightUnit = {\n /**\n * Kilograms.\n */\n KG: string;\n /**\n * Pounds.\n */\n LB: string;\n /**\n * Weight unit can't be classified due to an error.\n */\n UNSPECIFIED_WEIGHT_UNIT: string;\n };\n /**\n * An object representing a product's price per unit data.\n */\n type pricePerUnitData = {\n /**\n * Product’s total weight, volume, or area. For example, if your product weighs 1 kilogram, the `totalQuantity` is `1`.\n */\n totalQuantity: number;\n /**\n * Total measurement unit of weight, volume, or area. For example, if your product weighs 1 kilogram, the `totalMeasurementUnit` is `\"KG\"`.\n *\n * Supported values:\n * `\"ML\"`, `\"CL\"`, `\"L\"`, `\"CBM\"`, `\"MG\"`, `\"G\"`, `\"KG\"`, `\"MM\"`, `\"CM\"`, `\"M\"`, `\"SQM\"`, `\"OZ\"`, `\"LB\"`, `\"FLOZ\"`, `\"PT\"`, `\"QT\"`, `\"GAL\"`, `\"IN\"`, `\"FT\"`, `\"YD\"`, `\"SQFT\"`.\n */\n totalMeasurementUnit: string;\n /**\n * Product’s base weight, volume, or area. For example, for a product weighing 1 kilogram, the `baseQuantity` could be `100` (grams).\n */\n baseQuantity: number;\n /**\n * Base measurement unit of weight, volume, or area. For example, if your product weighs 1 kilogram, and the `baseQuantity` is `100` grams, `baseMeasurementUnit` is `\"G\"`.\n *\n * Supported values:\n * `\"ML\"`, `\"CL\"`, `\"L\"`, `\"CBM\"`, `\"MG\"`, `\"G\"`, `\"KG\"`, `\"MM\"`, `\"CM\"`, `\"M\"`, `\"SQM\"`, `\"OZ\"`, `\"LB\"`, `\"FLOZ\"`, `\"PT\"`, `\"QT\"`, `\"GAL\"`, `\"IN\"`, `\"FT\"`, `\"YD\"`, `\"SQFT\"`.\n */\n baseMeasurementUnit: string;\n };\n /**\n * Handles events triggered when the **Add To Cart** button on the Product Page is clicked.\n */\n type addToCartEventHandler = (resume: Function, cancel: Function) => void;\n /**\n * Handles events triggered when the **Buy Now** button on the Product Page is clicked.\n */\n type buyNowEventHandler = (resume: Function, cancel: Function) => void;\n /**\n * Handles events triggred when a product option choice is selected.\n */\n type choiceSelectedEventHandler = (selectedChoices: any) => void;\n /**\n * Handles events triggred when a product's quantity is changed.\n */\n type quantityChangedEventHandler = (quantity: number) => void;\n }\n /**\n * A [progress bar](https://support.wix.com/en/article/cms-adding-and-setting-up-a-progress-bar) is an element for displaying the status of an ongoing process.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ProgressBar.html#)\n */\n namespace ProgressBar {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Provides a human-readable text description for the current value of an element with a range, such as a slider or progress bar. Use this property to give meaningful context to the value, especially when the numeric value alone may not be clear or sufficient for assistive technology users.\n */\n ariaValueText?: string;\n };\n }\n /**\n * Event that is fired when a quick action bar item is clicked.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.QuickActionBarItemClickedEvent.html#)\n */\n namespace QuickActionBarItemClickedEvent {\n /**\n * An object representing a quick action bar item.\n */\n type QuickActionBarItem = {\n /**\n * The quick action bar item type.\n *\n * One of:\n *\n * + `\"3dots\"`\n * + `\"3dotsvertical\"`\n * + `\"about\"`\n * + `\"add\"`\n * + `\"address\"`\n * + `\"arrowdown\"`\n * + `\"arrowup\"`\n * + `\"blog\"`\n * + `\"booking\"`\n * + `\"briefcase\"`\n * + `\"clock\"`\n * + `\"clothes\"`\n * + `\"cloud\"`\n * + `\"contactform\"`\n * + `\"creditcard\"`\n * + `\"crown\"`\n * + `\"currency\"`\n * + `\"earth\"`\n * + `\"ecom\"`\n * + `\"email\"`\n * + `\"facebook\"`\n * + `\"flag\"`\n * + `\"flickr\"`\n * + `\"freebutton\"`\n * + `\"gallery\"`\n * + `\"googleplus\"`\n * + `\"hamburgermenu\"`\n * + `\"heart\"`\n * + `\"home\"`\n * + `\"hot\"`\n * + `\"hotel\"`\n * + `\"hotsale\"`\n * + `\"icecream\"`\n * + `\"instagram\"`\n * + `\"lightning\"`\n * + `\"link\"`\n * + `\"linkedin\"`\n * + `\"music\"`\n * + `\"new\"`\n * + `\"page\"`\n * + `\"phone\"`\n * + `\"pinterest\"`\n * + `\"present\"`\n * + `\"register\"`\n * + `\"restaurant\"`\n * + `\"rocket\"`\n * + `\"sale\"`\n * + `\"search\"`\n * + `\"shoppingcart\"`\n * + `\"signup\"`\n * + `\"smile\"`\n * + `\"social\"`\n * + `\"speaker\"`\n * + `\"star\"`\n * + `\"ticket\"`\n * + `\"twitter\"`\n * + `\"vimeo\"`\n * + `\"vk\"`\n * + `\"yelp\"`\n * + `\"youtube\"`\n */\n itemType: string;\n /**\n * The quick action bar item label.\n */\n label: string;\n /**\n * The quick action bar item link.\n */\n link: string;\n };\n }\n /**\n * [Radio button groups](https://support.wix.com/en/article/content-manager-adding-and-setting-up-radio-buttons) are used for selecting one of a number of\n * options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RadioButtonGroup.html#)\n */\n namespace RadioButtonGroup {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * An object used by the `options` property that contains the attributes of a radio button item.\n */\n type Option = {\n /**\n * The value of the radio button option. This is what you use in code and is what is stored in your collections. Mandatory if `label` is not specified.\n */\n value?: string;\n /**\n * The label of the radio button option. This is what a user sees. Mandatory if `value` is not specified.\n */\n label?: string;\n };\n }\n /**\n * [Range sliders](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-range-slider)\n * allow site visitors to select a range of values within a given range.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RangeSlider.html#)\n */\n namespace RangeSlider {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * A [ratings display](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-ratings-display-element)\n * element allows you to display a value to your users\n * using icons.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsDisplay.html#)\n */\n namespace RatingsDisplay {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * A [ratings input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-ratings-input-element)\n * element allows you to capture a value from your users\n * using icons.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RatingsInput.html#)\n */\n namespace RatingsInput {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * Function that runs when custom validation is checked.\n */\n type RatingsInputValidator = (value: number, reject: Function) => void;\n }\n /**\n * A [rich text box](https://support.wix.com/article/content-manager-adding-and-setting-up-a-text-input)\n * is an input element for entering information in rich text format. It shouldn't be confused with the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction), which provides access to a rich content field in a collection and can include various media types.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.RichTextBox.html#)\n */\n namespace RichTextBox {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * A button used to initiate a site [search](https://support.wix.com/en/article/about-wix-site-search).\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SearchButton.html#)\n */\n namespace SearchButton {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(“#myElement”).accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(“#myElement”).accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of user interaction on your site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.\n */\n ariaExpanded?: boolean;\n /**\n * Indicates to assistive technology users whether the element is currently pressed. `ariaPressed` is only relevant for buttons that act as toggles or have a pressed/unpressed state. If `ariaPressed` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaPressed?: string;\n /**\n * Indicates to assistive technology users whether an element triggers an interactive popup such as a menu or dropdown. If `ariaHasPopup` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaHasPopup?: string;\n };\n }\n /**\n * [Selection tags](https://support.wix.com/en/article/adding-and-setting-up-selection-tags) are used for selecting one or more options.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SelectionTags.html#)\n */\n namespace SelectionTags {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * An object used by the [`options`](#options) property that contains the attributes of the selection tag item.\n */\n type Option = {\n /**\n * The value of the selection tag option. This is what you use in code and is what is stored in your collections.\n */\n value: string;\n /**\n * The label of the selection tag option. This is what a site visitor sees.\n */\n label: string;\n };\n /**\n * Function that runs when custom validation is checked.\n */\n type SelectionTagsValidator = (value: string[], reject: Function) => void;\n }\n /**\n * [Signature input](https://support.wix.com/en/article/wix-forms-adding-a-signature-field) lets site visitors enter signatures.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.SignatureInput.html#)\n */\n namespace SignatureInput {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * Function that runs when custom validation is checked.\n */\n type SignatureInputValidator = (value: string, reject: Function) => void;\n }\n /**\n * [Sliders](https://support.wix.com/en/article/adding-and-setting-up-a-slider) allow users to select a number from a given range.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slider.html#)\n */\n namespace Slider {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\n */\n lang?: string;\n };\n }\n /**\n * [Slideshows](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-slideshow) are playable containers for slides.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Slideshow.html#)\n */\n namespace Slideshow {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\n */\n lang?: string;\n };\n }\n /**\n * [Switches](https://support.wix.com/en/article/adding-and-setting-up-a-switch-element) are used for a single binary choice.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Switch.html#)\n */\n namespace Switch {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * A [table](https://support.wix.com/en/article/content-manager-displaying-collection-content-in-a-table) for displaying data.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Table.html#)\n */\n namespace Table {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n };\n /**\n * An object used by the `columns` property that\n * contains the properties that define a table column. Table columns do not\n * store any data.\n */\n type Column = {\n /**\n * The column ID.\n */\n id: string;\n /**\n * The location of the data displayed\n * in the column.\n *\n * When the table is populated by a connection to a dataset, the `dataPath`\n * value is a field ID from the collection that the dataset is connected to. The\n * `dataPath` can contain a [reference field](https://support.wix.com/en/article/about-reference-fields-in-database-collections)\n * by prefixing the field with the referenced collection name and a period. For example,\n * `\"dataPath\": \"writer.name\"`.\n *\n * When the table is populated by using the [`rows`](#rows) or\n * [`dataFetcher`](#dataFetcher) properties, the `dataPath` value is one of the\n * property keys from the table's row objects.\n */\n dataPath: string;\n /**\n * The column header label.\n */\n label: string;\n /**\n * The type of data in this column: `\"number\"`, `\"string\"`, `\"date\"`, `\"image\"`, `\"bool\"`, or `\"richText\"`.\n */\n type: string;\n /**\n * The pixel width of the column.\n */\n width?: number;\n /**\n * Whether the column is visible.\n */\n visible?: boolean;\n /**\n * The location of the links used when\n * the items in the column are clicked.\n *\n * When the table is populated by a connection to a dataset, the `linkPath`\n * value is a field ID from the collection that the dataset is connected to.\n * The collection field can be a [regular field](https://support.wix.com/en/article/about-database-collections#regular-fields)\n * that contains URLs, a [calculated field](https://support.wix.com/en/article/about-database-collections#calculated-fields), or a [reference field](https://support.wix.com/en/article/about-reference-fields-in-database-collections)\n * that contains relative links to dynamic pages.\n *\n * When the table is populated by using the [`rows`](#rows) or\n * [`dataFetcher`](#dataFetcher) properties, the `linkPath` value is one of the\n * property keys from the table's rows objects.\n * The property values associated with that key contain URLs or relative links.\n */\n linkPath?: string;\n };\n /**\n * An object used by the `pagination` property that\n * contains the pagination options which determine if and how the table\n * is paginated.\n */\n type PaginationOptions = {\n /**\n * The type of pagination.\n * One of:\n *\n * + `\"normal\"`: No pagination. The table is scrollable if there are more\n * rows than can be displayed at once. All data is fetched at once.\n * + `\"pagination\"`: The data is separated into pages which are navigatable\n * using paging buttons. New data is fetched when a user clicks on a\n * paging button.\n * + `\"virtual\"`: The data is separated into pages which are navigated by\n * scrolling. New data is fetched when user a user scrolls below the\n * displayed rows.\n */\n type: string;\n /**\n * The number of rows per page.\n */\n rowsPerPage: number;\n };\n }\n /**\n * A [tabs](https://support.wix.com/en/article/wix-editor-about-tabs) element is a container that holds multiple\n * [tabs]($w.Tab.html), displaying one at a time.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Tabs.html#)\n */\n namespace Tabs {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n };\n }\n /**\n * [Text](https://support.wix.com/en/article/wix-editor-adding-and-editing-text) provides functionality for text elements.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.Text.html#)\n */\n namespace Text {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Defines the role of the element, helping assistive technologies understand the element's purpose and how it should be interacted with. When set to `undefined` or `null`, the role is removed from the element and isn't read by assistive technologies. Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles).\n *\n * Supported values: `'alert'`, `'application'`, `'button'`, `'checkbox'`, `'complementary'`, `'group'`, `'heading'`, `'link'`, `'list'`, `'listBox'`, `'listItem'`, `'navigation'`, `'none'`, `'option'`, `'radio'`, `'radioGroup'`, `'range'`, `'region'`, `'tab'`, `'tabList'`, `'tabPanel'`, `'status'`, `null`, `undefined`.\n *\n * Default: `undefined`\n */\n role?: string;\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Adds extra text before or after a text element for screen readers and other assistive technologies. This property helps provide extra context to text elements on a site page. The added text doesn't affect a site visually but is read aloud by screen readers for those who rely on assistive technology. For example, you can add the prefix \"bold text\" to a bold text element because screen readers don't effectively communicate text styles such as bold, italicize, and strikethrough.\n */\n screenReader?: Text.ScreenReader;\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n /**\n * Defines a more specific description to help clarify the `role` of an element. This property is useful for non-interactive container element roles, such as `\"region\"` or `\"group\"`, and for enhancing the context of interactive elements like buttons. Use `ariaRoleDescription` carefully, as improper use can confuse visitors and affect their understanding of the element's purpose.\n */\n ariaRoleDescription?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n /**\n * Adds hidden text before or after a text element using the `screenReader.prefix` and `screenReader.suffix` properties. This helps screen readers better understand the content of your text element. For example, screen readers don't effectively communicate text styles such as strikethrough. Use `screenReader` to provide context for the styled text.\n */\n type ScreenReader = {\n /**\n * Extra text added before a text element.\n *\n * Max: 1000 characters\n */\n prefix?: string;\n /**\n * Extra text added after a text element.\n *\n * Max: 1000 characters\n */\n suffix?: string;\n };\n }\n /**\n * [Text box](https://support.wix.com/en/article/wix-editor-adding-and-editing-text) is an input element for capturing large amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextBox.html#)\n */\n namespace TextBox {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether an element's input value is invalid or if a required input field is empty. When `true`, assistive technologies alert site visitors that the element's input value doesn't meet the expected criteria or that the required field is empty. When `false`, the value entered is valid or the field isn't required. This helps assistive technology users identify and correct errors in form submissions.\n */\n ariaInvalid?: boolean;\n /**\n * Indicates to assistive technology users whether an input element has a required field or action. If `ariaRequired` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all. The `ariaRequired` property doesn't inform assistive technologies if the required input value is valid.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaRequired?: string;\n /**\n * Specifies how assistive technologies communicate updates made to an element's content. When set to `false`, assistive technologies announce only the updated content according to the value of `ariaRelevant`. When set to `true`, assistive technologies announce all content in the element, regardless of the `ariaRelevant` property. For example, if a container's content changes and `ariaAtomic` is `true`, assistive technologies announce all contents of the container, providing visitors with complete context for the update. This property only works when the element or one of its ancestors has `ariaLive` enabled.\n *\n * Default: `false`\n */\n ariaAtomic?: boolean;\n /**\n * Identifies the element that is controlled by visitor interactions with this element. This property helps assistive technologies convey which elements are affected by the controlling element. For example, a button element that opens a popup window when clicked controls the popup element.\n */\n ariaControls?: Element;\n /**\n * Sets or gets the error message of an input element by referencing another element by ID. This property informs those using assistive technologies about validation issues. Use `ariaErrorMessage` in conjunction with `ariaInvalid` to indicate that the input is invalid and to provide context for the error.\n *\n * Example: `$w(\"#myInputElement\").accessibility.ariaErrorMessage = $w(\"#inputErrorText\");`\n */\n ariaErrorMessage?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether an element triggers an interactive popup such as a menu or dropdown. If `ariaHasPopup` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaHasPopup?: string;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n };\n }\n /**\n * [Text input](https://support.wix.com/en/article/content-manager-adding-and-setting-up-a-text-input) is an element for capturing small amounts of text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextInput.html#)\n */\n namespace TextInput {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n /**\n * Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaLabelledBy = $w(\"#text1\");`\n */\n ariaLabelledBy?: Text | CollapsibleText;\n /**\n * Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label.\n *\n * Example: `$w(\"#myElement\").accessibility.ariaDescribedBy = $w(\"#text1\");`\n */\n ariaDescribedBy?: Text | CollapsibleText;\n /**\n * Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of site visitor interaction on a site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaExpanded?: boolean;\n /**\n * Indicates to assistive technology users whether an element's input value is invalid or if a required input field is empty. When `true`, assistive technologies alert site visitors that the element's input value doesn't meet the expected criteria or that the required field is empty. When `false`, the value entered is valid or the field isn't required. This helps assistive technology users identify and correct errors in form submissions.\n */\n ariaInvalid?: boolean;\n /**\n * Indicates to assistive technology users whether an element triggers an interactive popup such as a menu or dropdown. If `ariaHasPopup` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaHasPopup?: string;\n /**\n * Indicates to assistive technology users whether an input element has a required field or action. If `ariaRequired` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all. The `ariaRequired` property doesn't inform assistive technologies if the required input value is valid.\n *\n * Supported values: `'true'`, `'false'`\n */\n ariaRequired?: string;\n /**\n * Specifies the language of the element's content, enhancing pronunciation accuracy for screen readers and other assistive technologies.\n *\n * Setting the `lang` property improves multilingual support by ensuring that assistive technologies apply the correct linguistic rules and speech patterns. It also enables search engines to index the element's content accurately, resulting in better visibility and relevance in search results for better SEO optimization.\n *\n * The `lang` property's value must be a 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes). For example, `\"en\"` for english.\n */\n lang?: string;\n /**\n * Indicates to assistive technologies whether an element is currently updating or in a loading state, helping to convey the status of dynamic content to visitors. When set to `true`, this property informs assistive technologies that visitors shouldn't interact with the element until the update completes. After the update completes, set `ariaBusy` to `false` to allow assistive technologies to announce that the new content is now available.\n *\n * Default: `false`\n */\n ariaBusy?: boolean;\n /**\n * Sets or gets the error message of an input element by referencing another element by ID. This property informs those using assistive technologies about validation issues. Use `ariaErrorMessage` in conjunction with `ariaInvalid` to indicate that the input is invalid and to provide context for the error.\n *\n * Example: `$w(\"#myInputElement\").accessibility.ariaErrorMessage = $w(\"#inputErrorText\");`\n */\n ariaErrorMessage?: Text | CollapsibleText;\n /**\n * Sets or gets how to announce changes to an element for site visitors who rely on screen readers. This property allows you to manage the timing and urgency of notifications regarding updates, status changes, or errors for an element.\n *\n * Use `ariaLive` only when necessary, as excessive or unnecessary announcements can lead to confusion or overload for screen reader users.\n * If you don't set a value, the property defaults to the value set in the accessibility panel in the editor, or is otherwise `'off'`.\n *\n * Supported values:\n * - `'polite'`: Updates are announced at the next available opportunity without interrupting the current speech of the screen reader. Useful for non-urgent notifications or messages.\n * - `'assertive'`: Updates are announced immediately, interrupting any ongoing speech. Intended for urgent and critical alerts.\n * - `'off'`: No live announcements are made when the content of the element changes.\n */\n ariaLive?: string;\n /**\n * Identifies the element that this element logically owns, even if it isn't nested within the owning element in the page's layout. This property allows assistive technologies convey relationships between elements regardless of their layout. For example, a text input element can own a helper text element that provides additional information, even if the helper text appears elsewhere in the layout.\n */\n ariaOwns?: Element;\n /**\n * Specifies which types of dynamic content updates are communicated to visitors by assistive technologies. This property helps minimize unnecessary announcements by ensuring that only relevant changes are reported. It's only effective when set on an element, or its parent, that also has `ariaLive` enabled.\n *\n * Supported values:\n * - `'additions'`: Assistive technologies announce only newly added content.\n * - `'removals'`: Assistive technologies announce only removed content.\n * - `'text'`: Assistive technologies announce only changes to existing text content.\n * - `'all'`: Assistive technologies announce all types of updates, including additions, removals, and text changes.\n *\n * Default: `'additions'`\n */\n ariaRelevant?: string;\n };\n }\n /**\n * The TextMarquee element displays a line of text that moves horizontally.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMarquee.html#)\n */\n namespace TextMarquee {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Adds extra text before or after a text element for screen readers and other assistive technologies. This property helps provide extra context to text elements on a site page. The added text doesn't affect a site visually but is read aloud by screen readers for those who rely on assistive technology. For example, you can add the prefix \"bold text\" to a bold text element because screen readers don't effectively communicate text styles such as bold, italicize, and strikethrough.\n */\n screenReader?: TextMarquee.ScreenReader;\n };\n /**\n * Adds hidden text before or after a text element using the `screenReader.prefix` and `screenReader.suffix` properties. This helps screen readers better understand the content of your text element. For example, screen readers don't effectively communicate text styles such as bold and strikethrough. Use `screenReader` to provide context for the styled text.\n */\n type ScreenReader = {\n /**\n * Extra text added before a text element.\n *\n * Max: 1000 characters\n */\n prefix?: string;\n /**\n * Extra text added after a text element.\n *\n * Max: 1000 characters\n */\n suffix?: string;\n };\n }\n /**\n * The TextMask element is used for masking media inside text.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TextMask.html#)\n */\n namespace TextMask {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Indicates whether the element is visible to or hidden from site visitors who rely on assistive technologies. Use `ariaHidden` to hide decorative, redundant, or off-screen content from screen readers. When `true`, the element is hidden from assistive technologies but remains visible in the DOM. When `false`, the element is exposed to assistive technologies. If `ariaHidden` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies at all.\n */\n ariaHidden?: boolean;\n /**\n * Adds extra text before or after a text element for screen readers and other assistive technologies. This property helps provide extra context to text elements on a site page. The added text doesn't affect a site visually but is read aloud by screen readers for those who rely on assistive technology. For example, you can add the prefix \"bold text\" to a bold text element because screen readers don't effectively communicate text styles such as bold, italicize, and strikethrough.\n */\n screenReader?: TextMask.ScreenReader;\n };\n /**\n * Adds hidden text before or after a text element using the `screenReader.prefix` and `screenReader.suffix` properties. This helps screen readers better understand the content of your text element. For example, screen readers don't effectively communicate text styles such as bold and strikethrough. Use `screenReader` to provide context for the styled text.\n */\n type ScreenReader = {\n /**\n * Extra text added before a text element.\n *\n * Max: 1000 characters\n */\n prefix?: string;\n /**\n * Extra text added after a text element.\n *\n * Max: 1000 characters\n */\n suffix?: string;\n };\n }\n /**\n * A thank you page displayed when an order is created.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ThankYouPage.html#)\n */\n namespace ThankYouPage {\n /**\n * An object representing address information.\n */\n type Address = {\n /**\n * Address in readable format.\n */\n formatted: string;\n /**\n * City.\n */\n city?: string;\n /**\n * Country.\n */\n country?: string;\n /**\n * Main address information.\n */\n addressLine?: string;\n /**\n * Additional address information (apt, floor, etc.).\n */\n addressLine2?: string;\n /**\n * Alternative property for street name and number.\n */\n streetAddress?: ThankYouPage.StreetAddress;\n /**\n * Postal/zip code.\n */\n postalCode?: string;\n /**\n * Subdivision of a country, such as a state or province.\n */\n subdivision?: string;\n };\n /**\n * An object representing a coupon applied to the order.\n */\n type AppliedCoupon = {\n /**\n * Coupon ID.\n */\n couponId: string;\n /**\n * Coupon name.\n */\n name: string;\n /**\n * Coupon code.\n */\n code: string;\n };\n /**\n * An object representing an order's billing info.\n */\n type BillingInfo = {\n /**\n * Billing address.\n */\n address?: ThankYouPage.Address;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * VAT information.\n */\n vatId?: ThankYouPage.VatId;\n };\n /**\n * An object representing information about the buyer.\n */\n type BuyerInfo = {\n /**\n * Unique buyer's ID.\n */\n id: string;\n /**\n * Buyer's email address.\n */\n email: string;\n /**\n * Buyer's first name.\n */\n firstName: string;\n /**\n * Buyer's last name.\n */\n lastName: string;\n /**\n * Buyer's identity.\n * One of:\n *\n *\n * - `\"MEMBER\"`: A logged-in site member.\n * - `\"CONTACT\"`: A Wix contact.\n */\n identityType: string;\n /**\n * Buyer's phone number.\n */\n phone?: string;\n };\n /**\n * An object representing information about the sales channel that submitted this order.\n */\n type ChannelInfo = {\n /**\n * Order ID from an external system (e.g., eBay or Amazon).\n */\n externalOrderId?: string;\n /**\n * URL to the order in the external system (e.g., eBay or Amazon).\n */\n externalOrderUrl?: string;\n /**\n * Sales channel that submitted the order.\n * One of:\n *\n *\n * + `\"WEB\"`: Wix online store.\n * + `\"POS\"`: Point of sale.\n * + `\"EBAY\"`: eBay.\n * + `\"OTHER_PLATFORM\"`: Order imported from another system (e.g., Cart2Cart).\n * + `\"WIX_APP_STORE\"`: Order created via the Wix mobile app.\n */\n type: string;\n };\n /**\n * An object representing a custom field added by the customer during the checkout process.\n */\n type CustomField = {\n /**\n * Custom field's title.\n */\n title: string;\n /**\n * Title translated into the buyer's language.\n */\n translatedTitle: string;\n /**\n * Custom field's text.\n */\n value: string;\n };\n /**\n * An object representing a custom text field.\n */\n type CustomTextField = {\n /**\n * Field title.\n */\n title: string;\n /**\n * Field value.\n */\n value: string;\n };\n /**\n * An object representing a discount applied to the order.\n */\n type Discount = {\n appliedCoupon: ThankYouPage.AppliedCoupon;\n };\n /**\n * An object representing information about the identity of the order initiator.\n * Occasionally, the person that completes the order isn't the buyer. For example, this occurs when an order is created using a point of sale terminal.\n */\n type EnteredBy = {\n id: string;\n /**\n * Order was created by one of the following:\n *\n *\n * + `\"USER\"`: Wix user who performed a POS transaction on behalf of the buyer.\n * + `\"MEMBER\"`: Logged-in site member.\n * + `\"CONTACT\"`: A Wix contact.\n */\n identityType: string;\n };\n /**\n * An object representing an line item's price information.\n */\n type LineItemPriceData = {\n /**\n * Price of the item.\n */\n price: number;\n /**\n * Total price charged to the customer (per line item) after calculation of quantity and discount.\n */\n totalPrice: number;\n /**\n * Whether the price includes tax.\n */\n taxIncludedInPrice: boolean;\n };\n /**\n * An object representing a line item's primary media item.\n */\n type MediaItem = {\n /**\n * Image description for accessibility purposes.\n */\n altText?: string;\n /**\n * Unique media item ID.\n */\n id: string;\n /**\n * Media item external URL.\n */\n externalImageUrl?: string;\n /**\n * Media item source URL for media uploaded to Wix.\n */\n src: string;\n /**\n * Media item width.\n * One of:\n *\n *\n * - `\"IMAGE\"`: Image item.\n * - `\"UNSPECIFIED_MEDIA_TYPE_ITEM\"`: Media item type can't be classified due to an error.\n */\n type: string;\n };\n /**\n * An object representing a line item option.\n */\n type Option = {\n /**\n * Name of the product option.\n */\n option: string;\n /**\n * Selected option.\n */\n selection: string;\n };\n /**\n * An object representing an order.\n */\n type Order = {\n /**\n * Unique order ID.\n */\n _id: string;\n /**\n * Date and time the order was updated.\n */\n _updatedDate: Date;\n /**\n * The site's displayed language.\n */\n buyerLanguage: string;\n /**\n * The shopping cart's unique ID.\n */\n cartId?: string;\n /**\n * Channel information.\n */\n channelInfo: ThankYouPage.ChannelInfo;\n /**\n * Identity of the order's operator.\n */\n enteredBy: ThankYouPage.EnteredBy;\n /**\n * Billing information.\n */\n billingInfo?: ThankYouPage.BillingInfo;\n /**\n * Buyer information.\n */\n buyerInfo: ThankYouPage.BuyerInfo;\n /**\n * A note added by the buyer.\n */\n buyerNote?: string;\n /**\n * Date and time the order was created.\n */\n _dateCreated: Date;\n /**\n * Order currency.\n */\n currency: string;\n /**\n * Running order number.\n */\n number: number;\n /**\n * Shipping information.\n */\n shippingInfo?: ThankYouPage.OrderShippingInfo;\n /**\n * Order items.\n */\n lineItems: ThankYouPage.OrderLineItem[];\n /**\n * Order totals.\n */\n totals: ThankYouPage.Totals;\n /**\n * The unit in which the order's weight is measured. Either `\"KG\"` or `\"LB\"`.\n */\n weightUnit: string;\n /**\n * Information about a custom field.\n */\n customField?: ThankYouPage.CustomField;\n /**\n * Discount information.\n */\n discount?: ThankYouPage.Discount;\n };\n /**\n * An object representing a line item in an order.\n */\n type OrderLineItem = {\n /**\n * Custom text.\n */\n customTextFields?: ThankYouPage.CustomTextField[];\n /**\n * Line item product ID.\n */\n productId?: string;\n /**\n * Type of the line item.\n * One of:\n *\n *\n * - `\"DIGITAL\"`: Digital item.\n * - `\"PHYSICAL\"`: Physical item.\n * - `\"CUSTOM_AMOUNT_ITEM\"`: Item with a custom price.\n */\n lineItemType?: string;\n /**\n * Information about the line item's primary media item.\n */\n mediaItem: ThankYouPage.MediaItem;\n /**\n * Name of the line item.\n */\n name: string;\n /**\n * Notes about the line item.\n */\n notes?: string;\n /**\n * Line item options.\n */\n options: ThankYouPage.Option[];\n /**\n * Deprecated: see priceData.\n */\n price: number;\n /**\n * Line item quantity.\n */\n quantity: number;\n /**\n * Line item stock keeping unit.\n */\n sku: string;\n /**\n * Deprecated: see priceData.\n */\n totalPrice: number;\n /**\n * Line item weight.\n */\n weight: number;\n /**\n * Line item index.\n */\n index: number;\n /**\n * Line item's name, translated into the customer's language.\n */\n translatedName: string;\n /**\n * Line item's discount amount.\n */\n discount?: number;\n /**\n * Line item's total amount of tax applied.\n */\n tax?: number;\n /**\n * Price information.\n */\n priceData?: ThankYouPage.LineItemPriceData;\n /**\n * Tax group ID.\n */\n taxGroupId?: string;\n /**\n * Line item's fulfiller ID.\n */\n fulfillerId: string;\n /**\n * Line item's variant ID.\n */\n variantId: string;\n };\n /**\n * An object representing an order's shipping information.\n */\n type OrderShippingInfo = {\n /**\n * Expected date of delivery.\n */\n deliverByDate?: Date;\n /**\n * Delivery option name.\n */\n deliveryOption: string;\n /**\n * Estimated time until delivery.\n */\n estimatedDeliveryTime?: string;\n /**\n * Shipment details (empty if order was designated for pickup).\n */\n shipmentDetails?: ThankYouPage.ShipmentDetails;\n /**\n * Pickup details (empty if order was designated for delivery).\n */\n pickupDetails?: ThankYouPage.PickupDetails;\n /**\n * Shipping region.\n */\n shippingRegion?: string;\n };\n /**\n * An object representing an order's pickup details.\n */\n type PickupDetails = {\n /**\n * Pickup instructions.\n */\n pickupInstructions?: string;\n /**\n * Pickup address.\n */\n pickupAddress?: ThankYouPage.Address;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n };\n /**\n * An object representing an order's shipping details.\n */\n type ShipmentDetails = {\n /**\n * Shipping address.\n */\n address?: ThankYouPage.Address;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * VAT information.\n */\n vatId?: ThankYouPage.VatId;\n /**\n * Deprecated: see priceData.\n */\n tax?: number;\n /**\n * Deprecated: see priceData.\n */\n discount?: number;\n /**\n * Shipment price information.\n */\n priceData?: ThankYouPage.ShipmentPriceData;\n };\n /**\n * An object representing shipment price information.\n */\n type ShipmentPriceData = {\n /**\n * Price of the item.\n */\n price: number;\n /**\n * Whether the price includes tax.\n */\n taxIncludedInPrice: boolean;\n };\n /**\n * An object representing information about the street name and street number of an address.\n */\n type StreetAddress = {\n /**\n * Address street name.\n */\n name: string;\n /**\n * Address street number.\n */\n number: string;\n };\n /**\n * An object representing an order's totals.\n */\n type Totals = {\n /**\n * Total calculated discount amount.\n */\n discount?: number;\n /**\n * Total quantity of the the order's line items.\n */\n quantity: number;\n /**\n * Total shipping price, including tax.\n */\n shipping?: number;\n /**\n * Subtotal of all the order's line items, excluding tax.\n */\n subtotal: number;\n /**\n * Total amount of tax.\n */\n tax?: number;\n /**\n * Total price.\n */\n total: number;\n /**\n * Total weight of the order's items.\n */\n weight: number;\n };\n /**\n * An object representing value added tax (VAT) information.\n */\n type VatId = {\n /**\n * VAT number.\n */\n number: string;\n /**\n * VAT type. Either `\"CPF\"` or `\"CNPJ\"`.\n */\n type: string;\n };\n }\n /**\n * [Time picker](https://support.wix.com/en/article/time-picker-settings) is an input element for capturing the time of day.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.TimePicker.html#)\n */\n namespace TimePicker {\n /**\n * An object representing an available time slot for a time picker.\n */\n type TimeSlot = {\n /**\n * Start time for the time slot. The `startTime` must be earlier than the `endTime`, and\n * be in one of the following formats:\n * + `HH:MM` (hours and minutes)\n * + `HH:MM:SS` (hours, minutes, and seconds)\n * + `HH:MM:SS.mmm` (hours, minutes, seconds, and milliseconds)\n *\n * `HH` is a 2-digit value between 0-23.\n *\n * `MM` is a 2-digit value between 0-59.\n *\n * `SS` is a 2-digit value between 0-59. Seconds are rounded down to the nearest minute.\n *\n * `mmm` is a 3-digit value between 0-999. Milliseconds are rounded down to the nearest second.\n *\n *\n * The time picker's first input time option is the `startTime`.\n * This means that if the `startTime` is '10:00', the first input time option is '10:00'.\n */\n startTime: string;\n /**\n * End time for the time slot. The `endTime` must be later than the `startTime`, and\n * be in one of the following formats:\n * + `HH:MM` (hours and minutes)\n * + `HH:MM:SS` (hours, minutes, and seconds)\n * + `HH:MM:SS.mmm` (hours, minutes, seconds, and milliseconds)\n *\n * `HH` is a 2-digit value between 0-23.\n * > Note that '24:00' is a valid `endTime` in order for '23:59' to be an input time option.\n *\n * `MM` is a 2-digit value between 0-59.\n *\n * `SS` is a 2-digit value between 0-59. Seconds are rounded down to the nearest minute.\n *\n * `mmm` is a 3-digit value between 0-999. Milliseconds are rounded down to the nearest second.\n *\n *\n * The `endTime` is not included in the time picker's input time options. This means that if the `endTime`\n * is '11:00', the time picker's last input time option (assuming [`step`](#step) is '1'), is '10:59'.\n */\n endTime: string;\n };\n /**\n * Function that runs when custom validation is checked.\n */\n type TimePickerValidator = (value: string, reject: Function) => void;\n }\n /**\n * An [upload button](https://support.wix.com/en/article/content-manager-adding-and-setting-up-an-upload-button) enables site visitors to upload files to your site.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.UploadButton.html#)\n */\n namespace UploadButton {\n /**\n * The object used by the [`value`](#value) property that represents files ready for upload.\n */\n type File = {\n /**\n * File name.\n */\n name: string;\n /**\n * File size in bytes.\n */\n size: number;\n /**\n * `true` if the file is valid for upload to the Media Manager.\n */\n valid: boolean;\n /**\n * Message indicating why the file is invalid. Empty if the file is valid.\n */\n validationMessage: string;\n };\n /**\n * The error message object returned when the `uploadFiles()`'s Promise is rejected.\n */\n type UploadError = {\n /**\n * The error's code.\n */\n errorCode: string;\n /**\n * The error's description.\n */\n errorDescription: string;\n };\n /**\n * Object returned by the `startUpload()`'s Promise.\n */\n type UploadFile = {\n /**\n * Wix URL of the successfully uploaded file.\n */\n url: string;\n /**\n * Wix media ID of the uploaded file.\n */\n mediaId: string;\n /**\n * Title of the uploaded file.\n */\n title: string;\n /**\n * Width of an uploaded image or video file.\n */\n width: number;\n /**\n * Height of an uploaded image or video file.\n */\n height: number;\n /**\n * Duration (in milliseconds) of an uploaded audio file.\n */\n duration: number;\n };\n /**\n * An array of objects returned by the `uploadFiles()`'s Promise.\n */\n type UploadedFile = {\n /**\n * Width of an uploaded image or video file.\n */\n width: number;\n /**\n * Height of an uploaded image or video file.\n */\n height: number;\n /**\n * Duration (in milliseconds) of an uploaded audio file.\n */\n duration: number;\n /**\n * Wix media URL of the successfully uploaded file in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`.\n *\n * **Note:** This replaces the old `fileName` parameter. `fileName` will continue to work, but we recommend that you use the updated `fileUrl` parameter instead.\n */\n fileUrl: string;\n /**\n * **Deprecated**. Use the `fileUrl` property instead.\n *\n * Internal file name of the uploaded file, generated by the Media Manager. The name is the string located in the file's URL. Click [here](https://www.wix.com/velo/forum/tips-tutorials-examples/creating-a-url-for-a-media-file-or-the-truth-about-getfileurl) to learn more.\n */\n fileName: string;\n /**\n * Original name of the uploaded file.\n */\n originalFileName: string;\n };\n /**\n * Contains detailed information about the validity states of a file to upload.\n */\n type ValidityState = {\n /**\n * `true` if the file's custom validity message has been set to a non-empty string.\n */\n customError: boolean;\n /**\n * `true` if the file to upload meets all validations.\n */\n valid: boolean;\n /**\n * `true` if a file is required, and either no file has been selected, or a file has been selected but not uploaded.\n */\n fileNotUploaded: boolean;\n /**\n * `true` if a file has been selected but it is too large. Maximum allowed file sizes are listed [here](https://support.wix.com/en/article/supported-media-file-types-and-file-sizes).\n */\n fileSizeExceedsLimit: boolean;\n /**\n * `true` if a file has been selected but the file's type is not supported. Supported file types are listed [here](https://support.wix.com/en/article/supported-media-file-types-and-file-sizes).\n */\n fileTypeNotAllowed: boolean;\n /**\n * `true` if a file is required but no file has been selected.\n */\n valueMissing: boolean;\n /**\n * `true` if the text input element's value does not match its type when the type is email or url.\n */\n typeMismatch: boolean;\n /**\n * `true` if the element's value does not match its pattern validation.\n */\n patternMismatch: boolean;\n /**\n * `true` if the length of the element's value exceeds its `maxLength`.\n */\n tooLong: boolean;\n /**\n * `true` if the length of the element's value is smaller than its `minlength` property.\n */\n tooShort: boolean;\n /**\n * `true` if the element's value is less than the its [`min`]($w.TextInput.html#min) property.\n */\n rangeUnderflow: boolean;\n /**\n * `true` if the element's value is more than the its [`max`]($w.TextInput.html#max) property.\n */\n rangeOverflow: boolean;\n /**\n * `true` if a text input element's numeric value is defined as a whole number but a decimal number is entered.\n */\n stepMismatch: boolean;\n /**\n * `true` if the element's value cannot be converted to a value.\n */\n badInput: boolean;\n /**\n * `true` if the number of files selected exceeds the limit defined in the `fileLimit` property.\n */\n exceedsFileLimit: boolean;\n /**\n * `true` if the element's time value is not a valid time.\n */\n invalidTime: boolean;\n /**\n * `true` if the element's date value is not a valid date.\n */\n invalidDate: boolean;\n };\n }\n /**\n * Provides functionality for elements that can be validated.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ValidatableMixin.html#)\n */\n namespace ValidatableMixin {\n /**\n * Contains detailed information about the validity states of an element.\n */\n type ValidityState = {\n /**\n * `true` if the element's custom\n * validity message has been set to a non-empty string.\n */\n customError: boolean;\n /**\n * `true` if the element meets all\n * constraint validations.\n */\n valid: boolean;\n /**\n * `true` if the element's\n * `required` property is `true`, but\n * it does not contain a value.\n */\n valueMissing: boolean;\n /**\n * `true` if the text input element's value\n * does not match its type when the type is email or url.\n */\n typeMismatch: boolean;\n /**\n * `true` if the element's\n * value does not match its pattern validation.\n */\n patternMismatch: boolean;\n /**\n * `true` if the length of the\n * element's value exceeds its `maxLength`\n * property.\n */\n tooLong: boolean;\n /**\n * `true` if the length of the\n * element's value is smaller than its `minlength` property.\n */\n tooShort: boolean;\n /**\n * `true` if the element's\n * value is less than its [`min`]($w.TextInput.html#min) property.\n */\n rangeUnderflow: boolean;\n /**\n * `true` if the element's\n * value is more than its [`max`]($w.TextInput.html#max) property.\n */\n rangeOverflow: boolean;\n /**\n * `true` if the element is\n * an upload button that is required and a file has been selected but not\n * uploaded.\n */\n fileNotUploaded: boolean;\n /**\n * `true` if a text input\n * element's numeric value is defined as a whole number but a decimal\n * number is entered.\n */\n stepMismatch: boolean;\n /**\n * `true` if the element's value\n * cannot be converted to a value.\n */\n badInput: boolean;\n /**\n * `true` if the element's time value\n * is not a valid time.\n */\n invalidTime: boolean;\n /**\n * `true` if the element's date value\n * is not a valid date.\n */\n invalidDate: boolean;\n };\n }\n /**\n * [Vector images](https://support.wix.com/en/article/wix-editor-about-vector-art) are digital illustrations based on geometric shapes.\n * They maintain their high quality when resized.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.VectorImage.html#)\n */\n namespace VectorImage {\n /**\n * An object containing attributes to make your Wix elements more accessible.\n */\n type Accessibility = {\n /**\n * Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context.\n *\n * Max: 1000 characters\n */\n ariaLabel?: string;\n };\n }\n /**\n * The ViewChangeEvent is triggered when the month or year changes on a date picker or appointment field element.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.ViewChangeEvent.html#)\n */\n namespace ViewChangeEvent {\n /**\n * An object that contains information about the date picker or appointment field for which an event was triggered.\n */\n type ViewChangeEventOptions = {\n /**\n * Start date of the currently displayed month.\n */\n startDate: Date;\n /**\n * End date of the currently displayed month.\n */\n endDate: Date;\n /**\n * Result returned by the operation.\n */\n operationResult: any;\n };\n }\n /**\n * A `$w` element for enabling your site contacts and visitors to work with the Wix Forms app.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixForms.html#)\n */\n namespace WixForms {\n /**\n * Handles events fired when the Wix Form is about to be submitted.\n */\n type WixFormSubmitEventHandler = (event: WixFormSubmitEvent) => any | boolean;\n /**\n * Handles events fired when the Wix Form is not submitted due to error.\n */\n type WixFormSubmittedErrorEventHandler = (errorEvent: WixFormSubmittedErrorEvent) => void;\n /**\n * Handles events fired when the Wix Form is submitted.\n */\n type WixFormSubmittedEventHandler = (event: WixFormSubmittedEvent) => void;\n }\n /**\n * A `WixFormsV2` element displays customizable forms, collects all the info that a site visitor entered into the form fields, and lets you track all form submissions in the dashboard.\n * \t[Read more](https://www.wix.com/corvid/reference/$w.WixFormsV2.html#)\n */\n namespace WixFormsV2 {\n /**\n * An object containing information about the error.\n */\n type SubmissionError = {\n /**\n * Error code.\n */\n code: string;\n /**\n * Error message.\n */\n message: string;\n };\n /**\n * A callback for a form field value change.\n */\n type OnFieldValueChangeCallback = (formValues: any) => void;\n /**\n * A callback for a changed form step number.\n */\n type OnStepNumberChangeCallback = (currentStepNumber: number) => void;\n /**\n * A callback for a form submission.\n */\n type OnSubmitCallback = (formValues: any) => void;\n /**\n * A callback for a failed form submission.\n */\n type OnSubmitFailureCallback = (error: WixFormsV2.SubmissionError) => void;\n /**\n * A callback for a successful form submission.\n */\n type OnSubmitSuccessCallback = () => void;\n }\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/backend/$w.d.ts", "content": "declare namespace $w {\n type $w = () => void;\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/$widget.d.ts", "content": "/**\n * The `$widget` namespace contains functionality for working with your Blocks widget's API from within the widget code.\n * \t[Read more](https://www.wix.com/corvid/reference/$widget.html#)\n */\ndeclare module '$widget' {\n /**\n * Sets or gets the [widget's properties](https://support.wix.com/en/article/wix-blocks-widget-api-properties).\n * \t[Read more](https://www.wix.com/corvid/reference/$widget.html#props)\n */\n const props: any;\n /**\n * Fires an event that is defined in the Widget API.\n * \t[Read more](https://www.wix.com/corvid/reference/$widget.html#fireEvent)\n */\n function fireEvent(eventName: string, data: any): void;\n /**\n * Adds an event handler that runs when the value of a widget property is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/$widget.html#onPropsChanged)\n */\n function onPropsChanged(handler: onPropsChangedHandler): any;\n type onPropsChangedHandler = (oldProps: any, newProps: any) => void;\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/velo-action-spi.d.ts", "content": "/**\n * The Velo Action Service Plugin.\n * \t[Read more](https://www.wix.com/corvid/reference/velo-action-spi.html#)\n */\ndeclare module 'velo-action-spi' {\n /**\n * Runs your custom action when an automation is triggered.\n * \t[Read more](https://www.wix.com/corvid/reference/velo-action-spi.html#invoke)\n */\n function invoke(options: Options, context: Context): Promise;\n type Context = {\n /**\n * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code representing the currency used in the request sent from Wix. The response should be returned in the same currency.\n */\n currency: string;\n /**\n * The identity that describes the identity that triggered this request.\n */\n identity: Identity;\n /**\n * An array of languages in which the response should be returned. Languages are strings in concatenated [ISO 639-1: 2 Alpha language-code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) and [ISO 3166-1: 2 Alpha country-code](https://en.wikipedia.org/wiki/ISO_3166-1) format, such as \"en-US\".\n */\n languages: string[];\n /**\n * A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.\n */\n requestId: string;\n };\n type Identity = {\n /**\n * Type of identity that triggered the request. Possible values are:\n * + `UNKNOWN`\n * + `ANONYMOUS_VISITOR`\n * + `MEMBER`\n * + `WIX_USER`\n * + `APP`\n */\n identityType: string;\n /**\n * ID of a site visitor who has not logged in to the site. Only provided if `identityType` is `ANONYMOUS_VISITOR`.\n */\n anonymousVisitorId?: string;\n /**\n * ID of a site visitor who has logged in to the site. Only provided if `identityType` is `MEMBER`.\n */\n memberId?: string;\n /**\n * ID of a Wix user (site owner, contributor, etc.). Only provided if `identityType` is `WIX_USER`.\n */\n wixUserId?: string;\n /**\n * ID of an app. Only provided if `identityType` is `APP`.\n */\n appId?: string;\n };\n type Options = {\n /**\n * The payload object. Fields vary depending on the selected trigger.\n */\n payload: Object;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-application.d.ts", "content": "/**\n * The wix-application module contains functionality for getting information about a Blocks application that is installed on a site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-application.html#)\n */\ndeclare module 'wix-application' {\n /**\n * Gets the URL of the new page that was added by a Blocks app, when installed on a site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-application.html#getAppPageUrl)\n */\n function getAppPageUrl(pageId: string): Promise;\n /**\n * Gets the Wix Blocks App data as a decoded Json Web Token (JWT) object.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-application.html#getDecodedAppInstance)\n */\n function getDecodedAppInstance(): Promise;\n /**\n * Opens a popup that was added to a site by the Blocks app during the app installation process and optionally passes it data.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-application.html#openAppLightbox)\n */\n function openAppLightbox(lightboxId: string, data?: any): Promise;\n /**\n * An object with data about the installation of your app on a specific site.\n */\n type decodedAppInstance = {\n /**\n * The unique idenfitier of your app.\n */\n appDefId: string;\n /**\n * The ID of your app on this specific site.\n */\n instanceId: string;\n /**\n * The ID of plan that the site owner purchased. This property is included in the object only if the site owner purchased a plan or joined a free trial.\n */\n vendorProductId: string;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-auth.d.ts", "content": "/**\n * The wix-auth module contains functionality for working with permissions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-auth.html#)\n */\ndeclare module 'wix-auth' {\n /**\n * Creates a copy of a method that includes the elevated permissions required by the original method.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-auth.html#elevate)\n */\n function elevate any>(func: T): (...param: Parameters) => ReturnType;\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-billing-backend.d.ts", "content": "/**\n * The wix-billing-backend module contains functionality for working with\n * billing features, such as [price quotes](https://support.wix.com/en/article/wix-price-quotes-creating-and-sending-price-quotes-to-clients) and\n * [invoices](https://support.wix.com/en/article/about-wix-invoices).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.html#)\n */\ndeclare module 'wix-billing-backend' {\n /**\n * The wix-billing-backend module contains functionality for working with\n * [your site's invoices](https://support.wix.com/en/article/about-wix-invoices)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.html#invoices)\n */\n const invoices: Invoices;\n /**\n * The wix-billing-backend module contains functionality for working with\n * your site's [price quotes](https://support.wix.com/en/article/wix-price-quotes-creating-and-sending-price-quotes-to-clients)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.html#priceQuotes)\n */\n const priceQuotes: PriceQuotes;\n /**\n * Events that are fired by actions relating to billing.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#)\n */\n interface Events {\n /**\n * An event that fires when an invoice is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onInvoiceCreated)\n */\n onInvoiceCreated(event: Invoices.Invoice): void;\n /**\n * An event that fires when an invoice is overdue.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onInvoiceOverdue)\n */\n onInvoiceOverdue(event: Invoices.Invoice): void;\n /**\n * An event that fires when an invoice is paid.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onInvoicePaid)\n */\n onInvoicePaid(event: Invoices.Invoice): void;\n /**\n * An event that fires when an invoice is sent.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onInvoiceSent)\n */\n onInvoiceSent(event: Invoices.Invoice): void;\n /**\n * An event that fires when a price quote is accepted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onPriceQuoteAccepted)\n */\n onPriceQuoteAccepted(event: PriceQuotes.PriceQuote): void;\n /**\n * An event that fires when a price quote is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onPriceQuoteCreated)\n */\n onPriceQuoteCreated(event: PriceQuotes.PriceQuote): void;\n /**\n * An event that fires when a price quote has expired.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onPriceQuoteExpired)\n */\n onPriceQuoteExpired(event: PriceQuotes.PriceQuote): void;\n /**\n * An event that fires when a price quote is sent.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Events.html#onPriceQuoteSent)\n */\n onPriceQuoteSent(event: PriceQuotes.PriceQuote): void;\n }\n /**\n * The wix-billing-backend module contains functionality for working with\n * [your site's invoices](https://support.wix.com/en/article/about-wix-invoices)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#)\n */\n interface Invoices {\n /**\n * Adds a payment to the invoice and reports the payment to the payment provider.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#addPayment)\n */\n addPayment(id: Invoices.IdAndVersion, payment: Invoices.Payment): Promise;\n /**\n * Creates a new invoice.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#createInvoice)\n */\n createInvoice(invoiceFields: Invoices.InvoiceFields): Promise;\n /**\n * Creates a link that can be used by a customer to preview the invoice.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#createInvoicePreviewUrl)\n */\n createInvoicePreviewUrl(id: Invoices.IdAndVersion, options?: Invoices.AuthOptions): Promise;\n /**\n * Deletes an invoice by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#deleteInvoice)\n */\n deleteInvoice(id: string): Promise;\n /**\n * Gets an existing invoice by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#getInvoice)\n */\n getInvoice(id: string): Promise;\n /**\n * Sends an invoice preview link to a customer via email.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#sendInvoice)\n */\n sendInvoice(id: Invoices.IdAndVersion, emailInfo: Invoices.EmailInfo): Promise;\n /**\n * Update an existing invoice.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#updateInvoice)\n */\n updateInvoice(id: Invoices.IdAndVersion, invoiceFields: Invoices.InvoiceFields, fieldMask?: string[]): Promise;\n /**\n * Voids an invoice.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#voidInvoice)\n */\n voidInvoice(id: Invoices.IdAndVersion): Promise;\n }\n /**\n * The wix-billing-backend module contains functionality for working with\n * your site's [price quotes](https://support.wix.com/en/article/wix-price-quotes-creating-and-sending-price-quotes-to-clients)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#)\n */\n interface PriceQuotes {\n /**\n * Creates a new price quote.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#createPriceQuote)\n */\n createPriceQuote(priceQuoteInfo: PriceQuotes.PriceQuoteInfo): Promise;\n /**\n * Deletes a price quote by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#deletePriceQuote)\n */\n deletePriceQuote(id: string): Promise;\n /**\n * Gets an existing price quote by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#getPriceQuote)\n */\n getPriceQuote(id: string): Promise;\n /**\n * Sends a price quote preview link to a customer via email.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#sendPriceQuote)\n */\n sendPriceQuote(id: PriceQuotes.IdAndVersion, emailInfo: PriceQuotes.EmailInfo): Promise;\n /**\n * Updates an existing price quote.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#updatePriceQuote)\n */\n updatePriceQuote(id: PriceQuotes.IdAndVersion, priceQuoteInfo: PriceQuotes.PriceQuoteInfo, fieldMask?: string[]): Promise;\n }\n /**\n * The wix-billing-backend module contains functionality for working with\n * [your site's invoices](https://support.wix.com/en/article/about-wix-invoices)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.Invoices.html#)\n */\n namespace Invoices {\n /**\n * An object that contains address information.\n */\n type Address = {\n /**\n * Address line.\n */\n addressLine?: string;\n /**\n * Secondary address line.\n */\n addressLine2?: string;\n /**\n * Address subdivision.\n */\n subdivision?: string;\n /**\n * Address city.\n */\n city?: string;\n /**\n * Address postal code.\n */\n postalCode?: string;\n /**\n * Address street address.\n */\n streetAddress?: Invoices.StreetAddress;\n /**\n * Address country.\n */\n country?: string;\n /**\n * Address in human readable format.\n */\n formatted?: string;\n };\n type AuthOptions = {\n /**\n * Prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth: boolean;\n };\n /**\n * An object that contains calculated tax information.\n */\n type CalculatedTax = {\n /**\n * Tax name.\n */\n name: string;\n /**\n * Tax rate.\n */\n rate: number;\n /**\n * Total value of taxable goods.\n */\n taxable: number;\n /**\n * Total amount of tax applied.\n */\n taxed: number;\n /**\n * Tax code.\n */\n code: string;\n };\n /**\n * An object that contains customer information.\n */\n type Customer = {\n /**\n * Contact ID.\n */\n contactId: string;\n /**\n * Email address.\n */\n email: string;\n /**\n * Physical address.\n */\n address?: Invoices.Address;\n /**\n * Physical billing address.\n */\n billingAddress?: Invoices.Address;\n /**\n * Physical shipping address.\n */\n shippingAddress?: Invoices.Address;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * Company ID. Can be used to store company VAT ID.\n */\n companyId?: string;\n /**\n * Full name.\n */\n fullName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Last name.\n */\n lastName?: string;\n };\n /**\n * An object that contains discount information.\n */\n type Discount = {\n /**\n * Discount amount.\n */\n value: number;\n /**\n * Discount type.\n *\n * Either:\n *\n * + `\"Fixed\"`: A fixed amount is deducted.\n * + `\"Percentage\"`: A percentage of the total amount is deducted.\n */\n type: string;\n };\n /**\n * An object that contains information used to send an invoice to a customer.\n */\n type EmailInfo = {\n /**\n * Email subject.\n */\n subject: string;\n /**\n * Email body. Limited formatting in the email body can be\n * achieved using standard JavaScript string formatting.\n */\n body: string;\n };\n /**\n * An object that contains ID and version information.\n */\n type IdAndVersion = {\n /**\n * Invoice ID.\n */\n id: string;\n /**\n * Invoice version.\n */\n version: number;\n };\n /**\n * An object that represents an invoice.\n */\n type Invoice = {\n /**\n * ID and version of the invoice.\n */\n id: Invoices.IdAndVersion;\n /**\n * Status of the invoice.\n * One of:\n *\n * + `\"Draft\"`\n * + `\"Sent\"`\n * + `\"Processing\"`\n * + `\"Paid\"`\n * + `\"Overdue\"`\n * + `\"Void\"`\n * + `\"Deleted\"`\n * + `\"PartiallyPaid\"`\n * + `\"PartialAndOverdue\"`\n */\n status: string;\n /**\n * Number of the invoice, unique within your site.\n */\n number: string;\n /**\n * Title of the invoice.\n */\n title: string;\n /**\n * Currency code.\n */\n currency: string;\n /**\n * Locale information.\n */\n locale: Invoices.Locale;\n /**\n * Customer listed on the invoice.\n */\n customer: Invoices.Customer;\n /**\n * Line items listed on the invoice.\n */\n lineItems: Invoices.LineItem[];\n /**\n * Discount included in the invoice.\n */\n discount: Invoices.Discount;\n /**\n * List of payments already received from the customer.\n */\n payments: Invoices.Payment[];\n /**\n * List of taxes calculated based on the line items.\n */\n taxes: Invoices.CalculatedTax[];\n /**\n * Total values.\n */\n totals: Invoices.TotalPrice;\n /**\n * Invoice dynamic totals.\n */\n dynamicTotals: Invoices.InvoiceDynamicTotals;\n /**\n * Additional metadata included in the invoice.\n */\n metadata: Invoices.MetaData;\n /**\n * Invoice company ID.\n */\n companyId: string;\n /**\n * Whether the invoice was sent to the customer.\n */\n wasSent: boolean;\n /**\n * Dates associated with the invoice.\n */\n dates: Invoices.InvoiceDates;\n };\n /**\n * An object that contains date information for an invoice.\n */\n type InvoiceDates = {\n /**\n * Invoice issue date.\n */\n issueDate: Date;\n /**\n * Invoice due date.\n */\n dueDate: Date;\n };\n /**\n * An object that contains information about invoice totals that change when payments are received.\n */\n type InvoiceDynamicTotals = {\n /**\n * Amount paid.\n */\n paidAmount: number;\n /**\n * Balance amount.\n */\n balance: number;\n };\n /**\n * An object that contains information used when creating or updating an invoice.\n */\n type InvoiceFields = {\n /**\n * Invoice ID, as a UUID.\n */\n id?: string;\n /**\n * Title of the invoice.\n */\n title: string;\n /**\n * Customer listed on the invoice.\n */\n customer: Invoices.Customer;\n /**\n * Currency code.\n */\n currency: string;\n /**\n * Line items listed on the invoice.\n */\n lineItems: Invoices.LineItem[];\n /**\n * Discount included in the invoice.\n */\n discount?: Invoices.Discount;\n /**\n * Invoice payments.\n */\n payments: Invoices.Payment[];\n /**\n * Invoice metadata.\n */\n metadata?: Invoices.MetaData;\n /**\n * Dates associated with the invoice.\n */\n dates: Invoices.InvoiceDates;\n /**\n * Language displayed on the invoice.\n */\n locale?: Invoices.Locale;\n };\n /**\n * An object that contains itemized fee information.\n */\n type ItemizedFee = {\n /**\n * Item fee name.\n */\n name: string;\n /**\n * Item fee price.\n */\n price: number;\n };\n /**\n * An object that contains line item information.\n */\n type LineItem = {\n /**\n * Line item ID.\n */\n id: string;\n /**\n * Line item name.\n */\n name: string;\n /**\n * Line item description.\n */\n description: string;\n /**\n * Line item price.\n */\n price: number;\n /**\n * Line item quantity.\n */\n quantity: number;\n /**\n * Line item taxes.\n */\n taxes?: Invoices.LineItemTax[];\n };\n /**\n * An object that contains tax information for a line item.\n */\n type LineItemTax = {\n /**\n * Line item tax name.\n */\n name: string;\n /**\n * Line item tax rate.\n */\n rate: number;\n /**\n * Line item tax code.\n */\n code: string;\n };\n /**\n * An object that contains locale information.\n */\n type Locale = {\n /**\n * An [IETF language subtag](https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags).\n * Some common language subtags include:\n *\n * + `\"en\"`: English\n * + `\"es\"`: Spanish\n * + `\"de\"`: German\n * + `\"ja\"`: Japanese\n * + `\"fr\"`: French\n * + `\"it\"`: Italian\n */\n language: string;\n };\n /**\n * An object that contains metadata information.\n */\n type MetaData = {\n /**\n * Invoice notes.\n */\n notes?: string;\n /**\n * Legal terms.\n */\n legalTerms?: string;\n /**\n * URL to legal terms.\n */\n sourceUrl?: string;\n /**\n * Source that triggered the action. For example, `\"stores\"`.\n */\n source?: string;\n /**\n * ID of the trigger source. For example, an order ID.\n */\n sourceRefId?: string;\n };\n /**\n * An object that contains information about an invoice payment.\n */\n type Payment = {\n /**\n * Payment id.\n */\n id: string;\n /**\n * Payment type, describing how the payment was made.\n */\n type: string;\n /**\n * Payment amount.\n */\n amount: number;\n /**\n * Payment date.\n */\n date: Date;\n };\n /**\n * An object that contains response information.\n */\n type Response = {\n /**\n * ID and version information.\n */\n id: Invoices.IdAndVersion;\n };\n /**\n * An object that contains street address information.\n */\n type StreetAddress = {\n /**\n * Street address information.\n */\n value: string;\n /**\n * Street address type. Either `\"Number\"` or `\"Name\"`.\n */\n type: string;\n };\n /**\n * An object that contains price totals.\n */\n type TotalPrice = {\n /**\n * Discount amount.\n */\n discountAmount: number;\n /**\n * List of itemized fees.\n */\n fees: Invoices.ItemizedFee[];\n /**\n * Sum of line item tax amounts.\n */\n taxedAmount: number;\n /**\n * Subtotal of the line items without the tax included.\n */\n subtotal: number;\n /**\n * Total price of the itemized fees and taxes.\n */\n total: number;\n };\n }\n /**\n * The wix-billing-backend module contains functionality for working with\n * your site's [price quotes](https://support.wix.com/en/article/wix-price-quotes-creating-and-sending-price-quotes-to-clients)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-billing-backend.PriceQuotes.html#)\n */\n namespace PriceQuotes {\n /**\n * An object that contains address information.\n */\n type Address = {\n /**\n * Address line.\n */\n addressLine?: string;\n /**\n * Secondary address line.\n */\n addressLine2?: string;\n /**\n * Address subdivision.\n */\n subdivision?: string;\n /**\n * Address city.\n */\n city?: string;\n /**\n * Address postal code.\n */\n postalCode?: string;\n /**\n * Address street address.\n */\n streetAddress?: PriceQuotes.StreetAddress;\n /**\n * Address country.\n */\n country?: string;\n /**\n * Address in human readable format.\n */\n formatted?: string;\n };\n /**\n * An object that contains calculated tax information.\n */\n type CalculatedTax = {\n /**\n * Tax name.\n */\n name: string;\n /**\n * Tax rate.\n */\n rate: number;\n /**\n * Total value of taxable goods.\n */\n taxable: number;\n /**\n * Total amount of tax applied.\n */\n taxed: number;\n /**\n * Tax code.\n */\n code: string;\n };\n /**\n * An object that contains customer information.\n */\n type Customer = {\n /**\n * Contact ID.\n */\n contactId: string;\n /**\n * Email address.\n */\n email: string;\n /**\n * Physical address.\n */\n address?: PriceQuotes.Address;\n /**\n * Physical billing address.\n */\n billingAddress?: PriceQuotes.Address;\n /**\n * Physical shipping address.\n */\n shippingAddress?: PriceQuotes.Address;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * Company ID. Can be used to store company VAT ID.\n */\n companyId?: string;\n /**\n * Full name.\n */\n fullName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Last name.\n */\n lastName?: string;\n };\n /**\n * An object that contains discount information.\n */\n type Discount = {\n /**\n * Discount amount.\n */\n value: number;\n /**\n * Discount type.\n *\n * Either:\n *\n * + `\"Fixed\"`: A fixed amount is deducted.\n * + `\"Percentage\"`: A percentage of the total amount is deducted.\n */\n type: string;\n };\n /**\n * An object that contains information used to send a price quote to a customer.\n */\n type EmailInfo = {\n /**\n * Email subject.\n */\n subject: string;\n /**\n * Email body. Limited formatting in the email body can be\n * achieved using standard JavaScript string formatting.\n */\n body: string;\n };\n /**\n * An object that contains ID and version information.\n */\n type IdAndVersion = {\n /**\n * Price quote ID.\n */\n id: string;\n /**\n * Price quote version.\n */\n version: number;\n };\n /**\n * An object that contains itemized fee information.\n */\n type ItemizedFee = {\n /**\n * Item fee name.\n */\n name: string;\n /**\n * Item fee price.\n */\n price: number;\n };\n /**\n * An object that contains line item information.\n */\n type LineItem = {\n /**\n * Line item ID.\n */\n id: string;\n /**\n * Line item name.\n */\n name: string;\n /**\n * Line item description.\n */\n description: string;\n /**\n * Line item price.\n */\n price: number;\n /**\n * Line item quantity.\n */\n quantity: number;\n /**\n * Line item taxes.\n */\n taxes?: PriceQuotes.LineItemTax[];\n };\n /**\n * An object that contains tax information for a line item.\n */\n type LineItemTax = {\n /**\n * Line item tax name.\n */\n name: string;\n /**\n * Line item tax rate.\n */\n rate: number;\n /**\n * Line item tax code.\n */\n code: string;\n };\n /**\n * An object that contains locale information.\n */\n type Locale = {\n /**\n * An IETF language tag.\n * Some common language tags include:\n *\n * + `\"en-US\"`: English, United States\n * + `\"en-GB\"`: English, British\n * + `\"es-ES\"`: Spanish, Spain\n * + `\"de-DE\"`: German, Germany\n * + `\"ja-JP\"`: Japanese, Japan\n * + `\"fr-CH\"`: French, Switzerland\n * + `\"it-IT\"`: Italian, Italy\n */\n language: string;\n };\n /**\n * An object that contains metadata information.\n */\n type MetaData = {\n /**\n * Price quote notes.\n */\n notes?: string;\n /**\n * Legal terms.\n */\n legalTerms?: string;\n /**\n * URL to legal terms.\n */\n sourceUrl?: string;\n /**\n * Source that triggered the action. For example, `\"stores\"`.\n */\n source?: string;\n /**\n * ID of the trigger source. For example, an order ID.\n */\n sourceRefId?: string;\n };\n /**\n * An object that contains information about price quote payment terms.\n */\n type PaymentTerms = {\n /**\n * Price quote term type.\n * One of:\n *\n * + `\"DueOnReceipt\"`\n * + `\"NetPlus\"`\n * + `\"TimeStamp\"`\n * + `\"Other\"`\n */\n termType: string;\n /**\n * Term data. When `termType` is `\"NetPlus\"`,\n * `termData` contains a positive integer indicating how many days after the charge\n * payment is due.\n */\n termData?: string;\n };\n /**\n * An object that represents a price quote.\n */\n type PriceQuote = {\n /**\n * ID and version of the price quote.\n */\n id: PriceQuotes.IdAndVersion;\n /**\n * Status of the price quote.\n * One of:\n *\n * + `\"Draft\"`\n * + `\"Sent\"`\n * + `\"Processing\"`\n * + `\"Accepted\"`\n * + `\"Rejected\"`\n * + `\"Expired\"`\n * + `\"Void\"`\n * + `\"Deleted\"`\n * + `\"Invoiced\"`\n */\n status: string;\n /**\n * Number of the price quote, unique within your site.\n */\n number: string;\n /**\n * Title of the price quote.\n */\n title: string;\n /**\n * Currency code.\n */\n currency: string;\n /**\n * Locale information.\n */\n locale: PriceQuotes.Locale;\n /**\n * Customer listed on the price quote.\n */\n customer: PriceQuotes.Customer;\n /**\n * Line items listed on the price quote.\n */\n lineItems: PriceQuotes.LineItem[];\n /**\n * Discount included in the price quote.\n */\n discount: PriceQuotes.Discount;\n /**\n * Payment terms.\n */\n paymentTerms: PriceQuotes.PaymentTerms;\n /**\n * List of taxes calculated based on the line items.\n */\n taxes: PriceQuotes.CalculatedTax[];\n /**\n * Total values.\n */\n totals: PriceQuotes.TotalPrice;\n /**\n * Additional metadata included in the price quote.\n */\n metadata: PriceQuotes.MetaData;\n /**\n * Price quote company ID.\n */\n companyId: string;\n /**\n * Price quote invoice ID, when converting price quote to invoice.\n */\n invoiceId: string;\n /**\n * Dates associated with the price quote.\n */\n dates: PriceQuotes.PriceQuoteDates;\n };\n /**\n * An object that contains date information for a price quote.\n */\n type PriceQuoteDates = {\n /**\n * Date the price quote was issued.\n */\n issueDate: Date;\n /**\n * Date that the price quote is valid until.\n */\n validThroughDate: Date;\n /**\n * Date the price quote was accepted.\n */\n acceptanceDate?: Date;\n /**\n * Date the price quote was last seen.\n */\n lastSeenDate?: Date;\n };\n /**\n * An object that contains information used when creating or updating a price quote.\n */\n type PriceQuoteInfo = {\n /**\n * Price quote ID, as a UUID.\n */\n id?: string;\n /**\n * Title of the price quote.\n */\n title: string;\n /**\n * Customer listed on the price quote.\n */\n customer: PriceQuotes.Customer;\n /**\n * Currency code.\n */\n currency: string;\n /**\n * Line items listed on the price quote.\n */\n lineItems: PriceQuotes.LineItem[];\n /**\n * Discount included in the price quote.\n */\n discount?: PriceQuotes.Discount;\n /**\n * Payment terms.\n */\n paymentTerms: PriceQuotes.PaymentTerms;\n /**\n * Price quote metadata.\n */\n metadata?: PriceQuotes.MetaData;\n /**\n * Dates associated with the price quote.\n */\n dates: PriceQuotes.PriceQuoteDates;\n };\n /**\n * An object that contains response information.\n */\n type Response = {\n /**\n * ID and version information.\n */\n id: PriceQuotes.IdAndVersion;\n };\n /**\n * An object that contains street address information.\n */\n type StreetAddress = {\n /**\n * Street address information.\n */\n value: string;\n /**\n * Street address type. Either `\"Number\"` or `\"Name\"`.\n */\n type: string;\n };\n /**\n * An object that contains price totals.\n */\n type TotalPrice = {\n /**\n * Discount amount.\n */\n discountAmount: number;\n /**\n * List of itemized fees.\n */\n fees: PriceQuotes.ItemizedFee[];\n /**\n * Sum of line item tax amounts.\n */\n taxedAmount: number;\n /**\n * Subtotal of the line items without the tax included.\n */\n subtotal: number;\n /**\n * Total price of the itemized fees and taxes.\n */\n total: number;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-bookings-backend.d.ts", "content": "/**\n * The wix-bookings-backend module contains functionality for working with bookings from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.html#)\n */\ndeclare module 'wix-bookings-backend' {\n /**\n * The Bookings API provides functionality for updating and managing bookings created in the Wix Bookings app.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.html#bookings)\n */\n const bookings: Bookings;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.html#events)\n */\n const events: Events;\n /**\n * The Resources API provides functionality for creating and managing wix-bookings resources.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.html#resources)\n */\n const resources: Resources;\n /**\n * The Bookings API provides functionality for creating and managing wix-bookings sessions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.html#sessions)\n */\n const sessions: Sessions;\n /**\n * Custom [address](https://www.wix.com/velo/reference/$w/addressinput/value), used when location_type is `\"OWNER_CUSTOM\"`.\n */\n type Address = {\n /**\n * String containing the full address of this location.\n */\n formatted: string;\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine1?: string;\n /**\n * Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.\n */\n addressLine2: string;\n /**\n * Street name, number and apartment number.\n */\n streetAddress?: StreetAddress;\n /**\n * Coordinates of the physical address.\n */\n location: AddressLocation;\n /**\n * City name.\n */\n city: string;\n /**\n * Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\n */\n subdivision: string;\n /**\n * Country code.\n */\n country: string;\n /**\n * Zip/postal code.\n */\n postalCode: string;\n };\n /**\n * Coordinates of the physical address.\n */\n type AddressLocation = {\n /**\n * Address latitude.\n */\n latitude: number;\n /**\n * Address longitude.\n */\n longitude: number;\n };\n /**\n * Coordinates of the physical address.\n */\n type AddressLocationInfo = {\n /**\n * Address latitude.\n */\n latitude?: number;\n /**\n * Address longitude.\n */\n longitude?: number;\n };\n /**\n * Attendance information.\n */\n type AttendanceInfo = {\n /**\n * Whether the booked contact attended the session. Not available if the booking's status is `CREATED`.\n *\n * + `true`: The contact has checked in.\n * + `false`: The contact was a no-show.\n */\n attendanceStatus: boolean;\n /**\n * Number of attendees that attended the session. This can be greater than 1 when the booking is made for a group of people.\n */\n numberOfAttendees: number;\n };\n /**\n * The final price, currency, down payment, and amount received.\n */\n type Balance = {\n /**\n * Required payment amount, currency, and any down payment required.\n */\n finalPrice: Price;\n /**\n * Current total amount paid.\n */\n amountReceived: string;\n };\n /**\n * An object describing the entity that was booked.\n */\n type BookedEntity = {\n /**\n * Price options offered to book this session at the time of booking.\n */\n rate: Rate;\n /**\n * Location of the session.\n */\n location: Location;\n /**\n * List of tags for the booking.\n *\n * + `INDIVIDUAL`: The booked service is appointment-based.\n * + `GROUP`: The booked service is a class.\n * + `COURSE`: The booked service is course.\n */\n tags: string[];\n /**\n * ID of the booked schedule.\n */\n scheduleId: string;\n /**\n * Session title at the time of booking.\n */\n title: string;\n /**\n * Start and end time of the booked sessions.\n */\n singleSession?: SingleSession;\n /**\n * First start and last end time of the booked sessions.\n */\n setOfSessions?: SetOfSessions;\n /**\n * ID of the booked service.\n */\n serviceId: string;\n /**\n * Online conference information.\n */\n onlineConference?: OnlineConference;\n };\n type BookedResource = {\n /**\n * Booked resource ID.\n */\n _id: string;\n /**\n * Resource's name at the time of booking.\n */\n name: string;\n /**\n * Resource's email at the time of booking.\n */\n email: string;\n };\n type Booking = {\n /**\n * Booking ID.\n */\n _id: string;\n /**\n * An object describing the entity that was booked.\n */\n bookedEntity: BookedEntity;\n /**\n * List of booked resources. Currently, only one is supported. The booked resource would be the staff-member giving the session.\n */\n bookedResources: BookedResource[];\n /**\n * Form information submitted when booking. FormInfo contains contact details, participants, and other form fields, set up for the service.\n */\n formInfo?: Form;\n /**\n * Payment Details.\n */\n paymentDetails?: PaymentDetails;\n /**\n * Booking status.\n *\n * One of:\n * - `\"PENDING_CHECKOUT\"` The booking is waiting to be checked out.\n * - `\"CONFIRMED\"` The booking has beed approved by the owner.\n * - `\"CANCELED\"` The booking has been canceled.\n * - `\"PENDING\"` The booking has been created.\n * - `\"PENDING_APPROVAL\"` The booking is waiting for the owner to approve or decline.\n * - `\"DECLINED\"` The booking was declined by the owner.\n *\n */\n status: string;\n /**\n * Attendance information.\n */\n attendanceInfo: AttendanceInfo;\n /**\n * An object describing the platform and application that made the booking.\n */\n bookingSource: BookingSource;\n /**\n * External ID provided by the client app on creation.\n */\n externalUserId?: string;\n /**\n * Date and time the booking was created.\n */\n _createdDate: Date;\n };\n /**\n * An object describing the platform and application that made the booking.\n */\n type BookingSource = {\n /**\n * Platform from which a booking was created\n *\n * One of:\n * - `\"WEB\"` Desktop browser.\n * - `\"MOBILE_APP\"` Mobile application.\n *\n */\n platform: string;\n /**\n * Actor that created this booking.\n *\n * One of:\n * - `\"BUSINESS\"`\n * - `\"CUSTOMER\"`\n *\n */\n actor: string;\n /**\n * Wix site ID of the application that created this booking.\n */\n appDefId: string;\n /**\n * Name of the application that created this booking, as saved in Wix-dev-center at the time of booking.\n */\n appName: string;\n };\n /**\n * An object describing the business location.\n */\n type BusinessLocation = {\n /**\n * ID of the location.\n */\n _id: string;\n /**\n * Display name of the location.\n */\n name: string;\n /**\n * Free text describing the location.\n */\n description: string;\n /**\n * Status of the location. Default is `\"ACTIVE\"`.\n * One of:\n * + `\"ACTIVE\"`\n * + `\"IN_ACTIVE\"`\n */\n status: string;\n /**\n * Type of the location.\n * One of:\n * + `\"UNKNOWN\"`\n * + `\"BRANCH\"`\n * + `\"OFFICES\"`\n * + `\"RECEPTION\"`\n * + `\"HEADQUARTERS\"`\n */\n locationType: string;\n /**\n * Fax number.\n */\n fax: string;\n /**\n * Time zone.\n */\n timeZone: string;\n /**\n * Email address.\n */\n email: string;\n /**\n * Phone number.\n */\n phone: string;\n /**\n * Address.\n */\n address: Address;\n /**\n * Location revision, represents the number of changes to the location.\n */\n revision: string;\n /**\n * Whether the location is archived.\n * Archived locations can't be updated.\n */\n archived: boolean;\n /**\n * Whether this is the default location.\n * There can only be one default location per site. Changes to the default location are made on the **Site Properties** page of the dashboard.\n * The default location can't be deleted.\n */\n default: boolean;\n };\n /**\n * An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.\n */\n type CalendarDateTime = {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a timezone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's timezone.\n */\n timestamp: Date;\n /**\n * An object containing the local date and time for the business's timezone.\n */\n localDateTime: LocalDateTime;\n };\n /**\n * An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.\n */\n type CalendarDateTimeInfo = {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a timezone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's timezone.\n */\n timestamp?: Date;\n /**\n * An object containing the local date and time for the business's timezone.\n */\n localDateTime?: LocalDateTimeInfo;\n };\n /**\n * Contact details of the customer making the booking.\n */\n type ContactDetails = {\n /**\n * Contact's ID.\n */\n contactId: string;\n /**\n * Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field.\n */\n firstName: string;\n /**\n * Contact's last name.\n */\n lastName: string;\n /**\n * Contact's email, used to create a new contact or get existing one from the [CRM API](wix-crm-frontend/introduction).\n */\n email: string;\n /**\n * Contact's phone number.\n */\n phone: string;\n /**\n * Contact's time zone.\n */\n timeZone: string;\n /**\n * Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n countryCode: string;\n /**\n * Custom [address](https://www.wix.com/velo/reference/$w/addressinput/value), used when location_type is `\"OWNER_CUSTOM\"`.\n */\n address: Address;\n };\n /**\n * Coupon details, if a coupon was used to pay for the booking.\n */\n type CouponDetails = {\n /**\n * Coupon name.\n */\n couponName: string;\n /**\n * Coupon code.\n */\n couponCode: string;\n /**\n * Coupon discount amount.\n */\n couponDiscount: string;\n /**\n * Coupon ID.\n */\n couponId: string;\n };\n type CustomFormField = {\n /**\n * ID of the form field as defined in the form.\n */\n _id: string;\n /**\n * Value that was submitted for this field.\n */\n value: string;\n /**\n * Form field's label at the time of submission.\n */\n label: string;\n /**\n *\n * One of:\n * - `\"SHORT_TEXT\"`\n * - `\"LONG_TEXT\"`\n * - `\"CHECK_BOX\"`\n *\n */\n valueType: string;\n };\n type CustomFormFieldInfo = {\n /**\n * ID of the form field as defined in the form.\n */\n _id?: string;\n /**\n * Value that was submitted for this field.\n */\n value?: string;\n /**\n *\n * One of:\n * - `\"SHORT_TEXT\"`\n * - `\"LONG_TEXT\"`\n * - `\"CHECK_BOX\"`\n *\n */\n valueType?: string;\n };\n /**\n * Form information submitted when booking. FormInfo contains contact details, participants, and other form fields, set up for the service.\n */\n type Form = {\n /**\n * Contact details of the customer making the booking.\n */\n contactDetails?: ContactDetails;\n /**\n * List of rates and the number of participants for each rate.\n */\n paymentSelection: PaymentSelection[];\n /**\n * Additional custom fields submitted with the form.\n */\n additionalFields?: CustomFormField[];\n };\n type LinkedResourceScheduleInfo = {\n /**\n * Schedule ID.\n */\n scheduleId?: string;\n };\n /**\n * An object containing the local date and time for the business's timezone.\n */\n type LocalDateTime = {\n /**\n * Year. 4-digit format.\n */\n year: number;\n /**\n * Month number, from 1-12.\n */\n monthOfYear: number;\n /**\n * Day of the month, from 1-31.\n */\n dayOfMonth: number;\n /**\n * Hour of the day in 24-hour format, from 0-23.\n */\n hourOfDay: number;\n /**\n * Minute, from 0-59.\n */\n minutesOfHour: number;\n };\n /**\n * An object containing the local date and time for the business's timezone.\n */\n type LocalDateTimeInfo = {\n /**\n * Year. 4-digit format.\n */\n year?: number;\n /**\n * Month number, from 1-12.\n */\n monthOfYear?: number;\n /**\n * Day of the month, from 1-31.\n */\n dayOfMonth?: number;\n /**\n * Hour of the day in 24-hour format, from 0-23.\n */\n hourOfDay?: number;\n /**\n * Minute, from 0-59.\n */\n minutesOfHour?: number;\n };\n /**\n * The location of the session.\n */\n type Location = {\n /**\n * Location type.\n *\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n *\n */\n locationType: string;\n /**\n * An object describing the business location.\n * Valid when `locationType` is `\"OWNER_BUSINESS\"`. Defaults to the business's default location.\n */\n businessLocation: BusinessLocation;\n /**\n * Custom [address](https://www.wix.com/velo/reference/$w/addressinput/value), used when location_type is `\"OWNER_CUSTOM\"`.\n */\n customAddress: Address;\n };\n /**\n * Online conference information.\n */\n type OnlineConference = {\n /**\n * Participant url.\n */\n guestUrl: string;\n /**\n * Online conference provider identifier.\n */\n providerId: string;\n /**\n * Online conference password.\n */\n password: string;\n /**\n * Online conference description.\n */\n description: string;\n };\n /**\n * Authorization options.\n */\n type Options = {\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * Plan details.\n */\n type PaidPlan = {\n /**\n * Order ID when the Pricing Plan was purchased.\n */\n orderId: string;\n /**\n * Benefit ID.\n */\n benefitId: string;\n /**\n * ID of the pricing plan.\n */\n planId: string;\n };\n /**\n * Pricing plan details, if a pricing plan was used to pay for the booking.\n */\n type PaidPlanDetails = {\n /**\n * Plan details.\n */\n plan: PaidPlan;\n /**\n * Plan name.\n */\n planName: string;\n /**\n * Transaction ID created in the Pricing Plans service when the member redeemed a benefit to pay for this booking.\n */\n transactionId: string;\n };\n /**\n * Whether to notify the participants about the booking confirmation, and an optional custom message.\n */\n type ParticipantNotificationInfo = {\n /**\n * Whether to notify participants about the change.\n */\n notifyParticipants?: boolean;\n /**\n * Custom message to send to the participants.\n */\n message?: string;\n };\n /**\n * Payment Details.\n */\n type PaymentDetails = {\n /**\n * Checkout ID.\n */\n _id: string;\n /**\n * Final price, currency, down payment, and amount received.\n */\n balance: Balance;\n /**\n * Coupon details, if a coupon was used to pay for the booking.\n */\n couponDetails: CouponDetails;\n /**\n * Checkout current state.\n *\n * One of:\n * - `\"COMPLETE\"` Amount paid in full.\n * - `\"PENDING_CASHIER\"` An online payment is in progress and awaiting a response.\n * - `\"REJECTED\"` The checkout request was rejected by the online payment process.\n * - `\"READY\"` All online checkout requirements were met. For example, when the service uses pay in person, or a partial or down payment was paid online.\n * - `\"CANCELED\"` Checkout canceled.\n * - `\"REFUNDED\"` When using Pricing Plans, if the booking was canceled, it will be automatically refunded.\n * - `\"PENDING_MERCHANT\"` An online payment was made, but the owner has not set up the necessary details.\n * - `\"WIX_PAY_FAILURE\"` Online payment failure.\n * - `\"PENDING_MARK_AS_PAID\"` Offline transaction. The transaction will be complete when explicitly marked as paid.\n * - `\"PENDING_BUYER\"` The transaction started, but is waiting for confirmation on the buyer's side. This can be due to credit or fraud checking on the provider's side, a long bank transfer, or similar processes.\n *\n */\n state: string;\n /**\n * In case of wix-pay service, holds all payment history for a booking.\n */\n wixPayMultipleDetails: WixPayDetails[];\n /**\n * Pricing plan details, if a pricing plan was used to pay for the booking.\n */\n pricingPlanDetails: PaidPlanDetails;\n };\n type PaymentSelection = {\n /**\n * Label corresponding to the booking rate. Default is free/custom.\n */\n rateLabel: string;\n /**\n * Number of participants for this rate.\n */\n numberOfParticipants: number;\n };\n type PaymentSelectionInfo = {\n /**\n * Label corresponding to the booking rate. Default is free/custom.\n */\n rateLabel?: string;\n /**\n * Number of participants for this rate.\n */\n numberOfParticipants?: number;\n };\n /**\n * `key` of type string, `value` of type object\n */\n type Price = {\n /**\n * Required payment amount.\n */\n amount: string;\n /**\n * Currency in which the amount is quoted.\n */\n currency: string;\n /**\n * Amount of a down payment or deposit as part of the transaction.\n */\n downPayAmount: string;\n };\n /**\n * Price options offered to book this session at the time of booking.\n */\n type Rate = {\n /**\n * Set of key-value pairs.Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n */\n labeledPriceOptions: any;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n */\n priceText: string;\n };\n /**\n * Resource details.\n */\n type Resource = {\n /**\n * Resource ID.\n */\n _id: string;\n /**\n * Resource name.\n */\n name: string;\n /**\n * Resource email address.\n */\n email?: string;\n /**\n * Resource phone number.\n */\n phone?: string;\n /**\n * Resource description.\n */\n description?: string;\n /**\n * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.\n */\n tags?: string[];\n /**\n * List of IDs of schedules owned by this resource.\n */\n scheduleIds: string[];\n /**\n * Resource status.\n *\n * One of:\n * - `\"CREATED\"` Default status.\n * - `\"DELETED\"` The resource was deleted.\n * - `\"UPDATED\"` The resource was updated.\n *\n */\n status: string;\n };\n /**\n * First start and last end time of the booked sessions.\n */\n type SetOfSessions = {\n /**\n * Start time of the first session.\n */\n firstSessionStart: Date;\n /**\n * End time of the last session.\n */\n lastSessionEnd: Date;\n };\n /**\n * Start and end time of the booked sessions.\n */\n type SingleSession = {\n sessionId: string;\n /**\n * Start time of the session.\n */\n start: Date;\n /**\n * End time of the session.\n */\n end: Date;\n };\n /**\n * Street name, number and apartment number.\n */\n type StreetAddress = {\n /**\n * Street number.\n */\n number: string;\n /**\n * Street name.\n */\n name: string;\n /**\n * Apartment number.\n */\n apt: string;\n };\n /**\n * Street name, number and apartment number.\n */\n type StreetAddressInfo = {\n /**\n * Street number.\n */\n number?: string;\n /**\n * Street name.\n */\n name?: string;\n /**\n * Apartment number.\n */\n apt?: string;\n };\n type WixPayDetails = {\n /**\n * Wix Pay payment transaction ID.\n */\n txId: string;\n /**\n * Wix Pay payment order ID.\n */\n orderId: string;\n /**\n * Order amount sent to the Wix Pay system.\n */\n orderAmount: string;\n /**\n * Transaction status\n *\n * One of:\n * - `\"CREATED\"` The transaction has been started.\n * - `\"PENDING_MERCHANT\"` An online payment was made, but the owner has not set up the necessary details.\n * - `\"COMPLETE\"` The current part of the payment was completed.\n * - `\"FAILED\"` The Wix online payment system is unavailable or failed processing.\n * - `\"DECLINED\"` The payment was declined.\n * - `\"PENDING_MARK_AS_PAID\"` Offline transaction. The transaction will be complete when explicitly marked as paid.\n * - `\"CANCELED\"` The transaction was canceled.\n *\n */\n orderStatus: string;\n /**\n * Date and time that the order was approved.\n */\n orderApprovalTime: Date;\n /**\n * Payment vendor name. The company processing the payment, such as Pay Pal or a credit card company. `inPerson` is used for cash payments.\n */\n paymentVendorName: string;\n };\n /**\n * **Deprecated.**\n * The Bookings API provides functionality for updating and managing bookings created in the Wix Bookings app.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#)\n */\n interface Bookings {\n /**\n * **Deprecated.**\n * Cancel Booking has been replaced with the Bookings V2 [Cancel Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking?apiView=SDK) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#cancelBooking)\n */\n cancelBooking(bookingId: string, options: Bookings.CancelBookingOptions): Promise;\n /**\n * **Deprecated.**\n * Confirm Booking has been replaced with the Bookings V2 [Confirm Or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking?apiView=SDK) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#confirmBooking)\n */\n confirmBooking(bookingId: string, options: Bookings.ConfirmBookingOptions): Promise;\n /**\n * **Deprecated.**\n * Decline Booking has been replaced with the Bookings V2 [Confirm Or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking?apiView=SDK) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#declineBooking)\n */\n declineBooking(bookingId: string, options: Bookings.DeclineBookingOptions): Promise;\n /**\n * **Deprecated.**\n * Query Bookings has been replaced with the Bookings V2 [Query Bookings](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings?apiView=SDK) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#queryBookings)\n */\n queryBookings(): Bookings.BookingsQueryBuilder;\n /**\n * **Deprecated.**\n * Set Attendance has been replaced with the Bookings V2 [Set Attendance](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/attendance/set-attendance?apiView=SDK) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#setAttendance)\n */\n setAttendance(bookingId: string, attendanceInfo: Bookings.AttendanceInfo, options?: Options): Promise;\n /**\n * **Deprecated.**\n * Set Booking As Paid will be removed on June 30, 2026. When using an [eCommerce Checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/introduction?apiView=SDK), Bookings V2 automatically updates the booking status and paymentStatus from the [eCommerce Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/introduction?apiView=SDK). When using a custom checkout, call [Confirm Or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking?apiView=SDK) to update the payment status. Learn more from the [Bookings V2 end-to-end flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows?apiView=SDK).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#setBookingAsPaid)\n */\n setBookingAsPaid(bookingId: string, options?: Options): Promise;\n /**\n * **Deprecated.**\n * Update Customer Info will be removed on June 30, 2026. Bookings V2 integrates with the [Wix Forms API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/wix-forms-integration?apiView=SDK). You can call [Update Submission](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/update-submission?apiView=SDK) in the Forms API to update customer information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#updateCustomerInfo)\n */\n updateCustomerInfo(bookingId: string, formInfo: Bookings.FormInfo, options?: Options): Promise;\n }\n /**\n * **Deprecated.**\n * Events that are fired by actions related to Wix Bookings.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#)\n */\n interface Events {\n /**\n * **Deprecated.**\n * The onBookingCanceled event has been deprecated and will be removed on June 30, 2026. Use the Bookings V2 [Booking Canceled](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-canceled?apiView=SDK) SDK event instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#onBookingCanceled)\n */\n onBookingCanceled(event: Events.BookingEvent): void;\n /**\n * **Deprecated.**\n * The onBookingConfirmed event has been deprecated and will be removed on June 30, 2026. Use the Bookings V2 [Booking Confirmed](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-confirmed?apiView=SDK) SDK event instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#onBookingConfirmed)\n */\n onBookingConfirmed(event: Events.BookingEvent): void;\n /**\n * **Deprecated.**\n * The onBookingDeclined event has been deprecated and will be removed on June 30, 2026. Use the Bookings V2 [Booking Declined](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-declined?apiView=SDK) SDK event instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#onBookingDeclined)\n */\n onBookingDeclined(event: Events.BookingEvent): void;\n /**\n * **Deprecated.**\n * The onBookingRequestCreated event has been deprecated and will be removed on June 30, 2026. Use the Bookings V2 [Booking Created](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-created?apiView=SDK) SDK event instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#onBookingRequestCreated)\n */\n onBookingRequestCreated(event: Events.BookingEvent): void;\n /**\n * **Deprecated.**\n * The onBookingScheduleUpdated event has been deprecated and will be removed on June 30, 2026. Use the Bookings V2 [Booking Rescheduled](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-rescheduled?apiView=SDK), [Booking Canceled](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-canceled?apiView=SDK), and [Booking Updated](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-updated?apiView=SDK) SDK events instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#onBookingScheduleUpdated)\n */\n onBookingScheduleUpdated(event: Events.BookingEvent): void;\n /**\n * **Deprecated.**\n * The onBookingUpdated event has been deprecated and will be removed on June 30, 2026. Use the Bookings V2 [Booking Updated](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-updated?apiView=SDK) SDK event instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#onBookingUpdated)\n */\n onBookingUpdated(event: Events.BookingEvent): void;\n }\n /**\n * **Deprecated.**\n * The Bookings Resources API provides functionality for creating, managing, and querying resources.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#)\n */\n interface Resources {\n /**\n * **Deprecated.**\n * Create Resource has been replaced with the [Create Resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/create-resource) and [Create Staff Member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/create-staff-member) SDK methods and will be removed on March 31, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#createResource)\n */\n createResource(resourceInfo: Resources.ResourceInfo, scheduleInfo: Resources.ResourceScheduleInfo[], options?: Options): Promise;\n /**\n * **Deprecated.**\n * Delete Resource has been replaced with [Delete Resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/delete-resource) and [Delete Staff Member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/delete-staff-member) SDK methods and will be removed on March 31, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#deleteResource)\n */\n deleteResource(resourceId: string, options?: Options): Promise;\n /**\n * **Deprecated.**\n * Query Resource Catalog has been replaced with [Query Resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/query-resources) and [Query Staff Members](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/query-staff-members) SDK methods and will be removed on March 31, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#queryResourceCatalog)\n */\n queryResourceCatalog(): Resources.ResourceCatalogQueryBuilder;\n /**\n * **Deprecated.**\n * Update Resource has been replaced with [Update Resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/update-resource) and [Update Staff Member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/update-staff-member) SDK methods and will be removed on March 31, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#updateResource)\n */\n updateResource(id: string, resourceInfo: Resources.UpdateResourceInfo, options?: Options): Promise;\n /**\n * **Deprecated.**\n * Update Schedule has been replaced with [Update Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/update-schedule) and [Assign Working Hours Schedule](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/assign-working-hours-schedule) SDK methods and will be removed on March 31, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#updateResourceSchedule)\n */\n updateResourceSchedule(resourceId: string, scheduleId: string, scheduleInfo: Resources.ResourceScheduleInfo, options?: Options): Promise;\n }\n /**\n * **Deprecated.**\n * The Sessions API provides functionality for creating, managing, and querying sessions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#)\n */\n interface Sessions {\n /**\n * **Deprecated.**\n * Create Session has been replaced with the [Create Event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction?apiView=SDK) SDK method and will be removed on June 30, 2026. Note that Bookings V2 [Create Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/create-booking?apiView=SDK) automatically creates events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#createSession)\n */\n createSession(sessionInfo: Sessions.SessionInfo, options?: Options): Promise;\n /**\n * **Deprecated.**\n * Delete Session has been replaced with the [Cancel Event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/cancel-event?apiView=SDK) SDK method and will be removed on June 30, 2026. Note that Bookings V2 [Cancel Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking?apiView=SDK) automatically cancels events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#deleteSession)\n */\n deleteSession(sessionId: string, options?: Sessions.DeleteSessionOptions): Promise;\n /**\n * **Deprecated.**\n * Get Session has been replaced with the [Get Event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/get-event?apiView=SDK) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#getSession)\n */\n getSession(sessionId: string, options?: Options): Promise;\n /**\n * **Deprecated.**\n * Query Sessions has been replaced with the [Query Events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events) SDK method and will be removed on June 30, 2026.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#querySessions)\n */\n querySessions(): Sessions.SessionQueryBuilder;\n /**\n * **Deprecated.**\n * Update Session has been replaced with the [Update Event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction?apiView=SDK) SDK method and will be removed on June 30, 2026. Note that Bookings V2 [Reschedule Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/introduction?apiView=SDK) automatically updates events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#updateSession)\n */\n updateSession(sessionId: string, sessionInfo: Sessions.UpdateSessionInfo, options?: Options): Promise;\n }\n /**\n * **Deprecated.**\n * The Bookings API provides functionality for updating and managing bookings created in the Wix Bookings app.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.html#)\n */\n namespace Bookings {\n /**\n * Attendance information for the booking\n */\n type AttendanceInfo = {\n /**\n * Whether the booked contact attended the session. Not available if the booking's status is `CREATED`.\n *\n * + `true`: The contact has checked in.\n * + `false`: The contact was a no-show.\n */\n attended?: boolean;\n /**\n * Number of attendees that attended the session. This can be greater than 1 when the booking is made for a group of people.\n */\n numberOfAttendees?: number;\n };\n type CancelBookingOptions = {\n /**\n * Whether to notify the participants about the booking confirmation, and an optional custom message.\n */\n participantNotification?: ParticipantNotificationInfo;\n /**\n * Sets the cancel booking flow behavior.\n */\n flowControlSettings?: Bookings.FlowControlSettingsInfo;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n type CancelBookingResult = {\n /**\n * ID of the canceled booking.\n */\n bookingId: string;\n };\n type ConfirmBookingOptions = {\n /**\n * Whether to notify the participants about the booking confirmation, and an optional custom message.\n */\n participantNotification?: ParticipantNotificationInfo;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * Contact details of the customer making the booking.\n */\n type ContactDetails = {\n /**\n * Contact's ID.\n */\n contactId?: string;\n /**\n * Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field.\n */\n firstName?: string;\n /**\n * Contact's last name.\n */\n lastName?: string;\n /**\n * Contact's email, used to create a new contact or get existing one from the [CRM API](wix-crm-frontend/introduction).\n */\n email?: string;\n /**\n * Contact's phone number.\n */\n phone?: string;\n /**\n * Contact's time zone.\n */\n timeZone?: string;\n /**\n * Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n countryCode?: string;\n /**\n * Contact's full [address](https://www.wix.com/velo/reference/$w/addressinput/value).\n */\n address?: Bookings.OwnerAddress;\n };\n type DeclineBookingOptions = {\n /**\n * Whether to notify the participants about the booking confirmation, and an optional custom message.\n */\n participantNotification?: ParticipantNotificationInfo;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n type DeclineBookingResult = {\n /**\n * ID of the declined booking.\n */\n bookingId: string;\n };\n /**\n * Sets the cancel booking flow behavior.\n */\n type FlowControlSettingsInfo = {\n /**\n * Whether to ignore the service's cancellation policy.\n *\n *\n * Requires \"Manage Wix Bookings App\" and \"Manage Bookings' Calendar\" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).\n *\n */\n ignoreCancellationPolicy?: boolean;\n };\n /**\n * Updated form info and contact details\n */\n type FormInfo = {\n /**\n * List of rates and the number of participants for each rate.\n */\n paymentSelection?: PaymentSelectionInfo[];\n /**\n * Additional custom fields submitted with the form.\n */\n additionalFields?: CustomFormFieldInfo[];\n /**\n * Contact details of the customer making the booking.\n */\n contactDetails?: Bookings.ContactDetails;\n };\n /**\n * Contact full [address](https://www.wix.com/velo/reference/$w/addressinput/value).\n */\n type OwnerAddress = {\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine1?: string;\n /**\n * Street name, number and apartment number.\n */\n streetAddress?: StreetAddressInfo;\n /**\n * String containing the full address of this location.\n */\n formatted?: string;\n /**\n * Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.\n */\n addressLine2?: string;\n /**\n * Coordinates of the physical address.\n */\n location?: AddressLocationInfo;\n /**\n * City name.\n */\n city?: string;\n /**\n * Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\n */\n subdivision?: string;\n /**\n * Country code.\n */\n country?: string;\n /**\n * Zip/postal code.\n */\n postalCode?: string;\n };\n /**\n * Contains functionality for refining a Bookings query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#)\n */\n interface BookingsQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): Bookings.BookingsQueryBuilder;\n /**\n * Adds a sort to a query or sort, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): Bookings.BookingsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Bookings.BookingsQueryBuilder;\n /**\n * Returns the bookings that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#find)\n */\n find(options?: BookingsQueryBuilder.QueryOptions): Promise;\n /**\n * Refines a query to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#ge)\n */\n ge(propertyName: string, value: string | number | Date): Bookings.BookingsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#gt)\n */\n gt(propertyName: string, value: string | number | Date): Bookings.BookingsQueryBuilder;\n /**\n * Refines a query to match items whose specified property contains any of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, value: string[]): Bookings.BookingsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#le)\n */\n le(propertyName: string, value: string | number | Date): Bookings.BookingsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#limit)\n */\n limit(limit: number): Bookings.BookingsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#lt)\n */\n lt(propertyName: string, value: string | number | Date): Bookings.BookingsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#skip)\n */\n skip(skip: number): Bookings.BookingsQueryBuilder;\n }\n /**\n * The results of a bookings query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#)\n */\n interface BookingsQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns an array of bookings that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#items)\n */\n readonly items: Booking[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the BookingsQueryBuilder object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#query)\n */\n readonly query: Bookings.BookingsQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a Bookings query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryBuilder.html#)\n */\n namespace BookingsQueryBuilder {\n /**\n * Options to use when performing a query.\n */\n type QueryOptions = {\n /**\n * Prevents permission checks from running for the `find()` operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n }\n /**\n * The results of a bookings query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Bookings.BookingsQueryResult.html#)\n */\n namespace BookingsQueryResult {\n }\n }\n /**\n * **Deprecated.**\n * Events that are fired by actions related to Wix Bookings.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a booking event.\n */\n type BookingEvent = {\n /**\n * Action that triggered the event. Each event has its own set of possible trigger values.\n */\n trigger: string;\n /**\n * Booking object after the event was triggered.\n */\n booking: Booking;\n /**\n * Booking object before the event was triggered.\n */\n previousBooking: Booking;\n };\n }\n /**\n * **Deprecated.**\n * The Bookings Resources API provides functionality for creating, managing, and querying resources.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.html#)\n */\n namespace Resources {\n type LinkedSchedulesInfo = {\n /**\n * Schedule ID.\n */\n scheduleId: string;\n /**\n * Owner ID, of the linked schedule.\n */\n scheduleOwnerId: string;\n };\n /**\n * Resource details.\n */\n type ResourceInfo = {\n /**\n * Resource name.\n */\n name: string;\n /**\n * Resource email address.\n */\n email?: string;\n /**\n * Resource phone number.\n */\n phone?: string;\n /**\n * Resource description.\n */\n description?: string;\n /**\n * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.\n */\n tags?: string[];\n };\n /**\n * ResourceCatalog query results.\n */\n type ResourceQueryResults = {\n /**\n * Resource.\n */\n resource: Resource;\n /**\n * Resource's schedules.\n */\n schedules: Resources.ResourceSchedule[];\n /**\n * History of slugified resource names.\n */\n slugs: Resources.Slug[];\n };\n type ResourceSchedule = {\n /**\n * Schedule ID.\n */\n _id: string;\n /**\n * ID of the schedule's owner entity. This may be a resource ID or a service ID.\n */\n scheduleOwnerId: string;\n /**\n * An object describing how to calculate the schedule's availability.\n * An empty object indicates that the schedule is not available for booking.\n */\n availability: Resources.ResourceScheduleAvailability;\n };\n /**\n * An object describing how to calculate the schedule's availability.\n */\n type ResourceScheduleAvailability = {\n /**\n * Date and time the schedule starts to be available for booking.\n */\n start: Date;\n /**\n * Other schedules that impact the availability calculation. Relevant only when there are availability constraints.\n */\n linkedSchedules: LinkedResourceScheduleInfo[];\n };\n /**\n * An object describing how to calculate the schedule's availability.\n */\n type ResourceScheduleAvailabilityInfo = {\n /**\n * Date and time the schedule starts to be available for booking.\n */\n start?: Date;\n /**\n * Other schedules that impact the availability calculation. Relevant only when there are availability constraints.\n */\n linkedSchedules?: LinkedResourceScheduleInfo[];\n };\n type ResourceScheduleInfo = {\n /**\n * An object describing how to calculate the schedule's availability.\n * An empty object indicates that the schedule is not available for booking.\n */\n availability?: Resources.ResourceScheduleAvailability;\n };\n /**\n * Slugified resource name.\n */\n type Slug = {\n /**\n * Slugified resource name.\n */\n name: string;\n /**\n * Date and time the resource name was created.\n */\n _createdDate: Date;\n };\n /**\n * Resource details.\n */\n type UpdateResourceInfo = {\n /**\n * Resource name.\n */\n name?: string;\n /**\n * Resource email address.\n */\n email?: string;\n /**\n * Resource phone number.\n */\n phone?: string;\n /**\n * Resource description.\n */\n description?: string;\n /**\n * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.\n */\n tags?: string[];\n };\n /**\n * Contains functionality for refining a resource catalog query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#)\n */\n interface ResourceCatalogQueryBuilder {\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: string): Resources.ResourceCatalogQueryBuilder;\n /**\n * Returns the resource catalog items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#find)\n */\n find(options?: ResourceCatalogQueryBuilder.QueryOptions): Promise;\n /**\n * Refines a query to match items whose specified property contains any of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, value: string[]): Resources.ResourceCatalogQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#limit)\n */\n limit(limit: number): Resources.ResourceCatalogQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#skip)\n */\n skip(skip: number): Resources.ResourceCatalogQueryBuilder;\n }\n /**\n * The results of a resource catalog query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#)\n */\n interface ResourceCatalogQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns an array of resources, slugs, and schedules that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#items)\n */\n readonly items: Resources.ResourceQueryResults[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the ResourceCatalogQueryBuilder object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#query)\n */\n readonly query: Resources.ResourceCatalogQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a resource catalog query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryBuilder.html#)\n */\n namespace ResourceCatalogQueryBuilder {\n /**\n * Options to use when performing a query.\n */\n type QueryOptions = {\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n }\n /**\n * The results of a resource catalog query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Resources.ResourceCatalogQueryResult.html#)\n */\n namespace ResourceCatalogQueryResult {\n }\n }\n /**\n * **Deprecated.**\n * The Sessions API provides functionality for creating, managing, and querying sessions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.html#)\n */\n namespace Sessions {\n type DeleteSessionOptions = {\n /**\n * Whether to notify participants about the change, and an optional custom message.\n */\n participantNotification?: ParticipantNotificationInfo;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n type Session = {\n /**\n * Session ID.\n */\n _id: string;\n /**\n * ID of the schedule that the session belongs to.\n */\n scheduleId: string;\n /**\n * ID of the resource or service that the session's schedule belongs to.\n */\n scheduleOwnerId: string;\n /**\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags: string[];\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes: string;\n /**\n * Session status.\n *\n * One of:\n * - `\"CONFIRMED\"` Default value.\n * - `\"CANCELLED\"` The session was deleted.\n *\n */\n status: string;\n /**\n * ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.\n */\n recurringSessionId?: string;\n /**\n * Session type.\n *\n * One of:\n * - `\"EVENT\"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n * - `\"WORKING_HOURS\"` Placeholder for available time on a resource’s schedule.\n *\n */\n type: string;\n /**\n * String representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n *\n */\n recurrence?: string;\n /**\n * String representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\n * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.\n */\n instanceOfRecurrence?: string;\n /**\n * An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.\n */\n start: CalendarDateTime;\n /**\n * An object specifying the end date and time of the session. If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end: CalendarDateTime;\n };\n /**\n * Session.\n */\n type SessionInfo = {\n /**\n * ID of the schedule that the session belongs to.\n */\n scheduleId: string;\n /**\n * An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.\n */\n start: CalendarDateTimeInfo;\n /**\n * An object specifying the end date and time of the session. If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end: CalendarDateTimeInfo;\n /**\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags?: string[];\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * Session type.\n *\n * One of:\n * - `\"EVENT\"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n * - `\"WORKING_HOURS\"` Placeholder for available time on a resource’s schedule.\n *\n */\n type?: string;\n /**\n * String representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n *\n */\n recurrence?: string;\n };\n /**\n * Session.\n */\n type UpdateSessionInfo = {\n /**\n * An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.\n */\n start?: CalendarDateTimeInfo;\n /**\n * An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`.\n */\n end?: CalendarDateTimeInfo;\n /**\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags?: string[];\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * Session type.\n *\n * One of:\n * - `\"EVENT\"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n * - `\"WORKING_HOURS\"` Placeholder for available time on a resource’s schedule.\n *\n */\n type?: string;\n /**\n * String representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n *\n */\n recurrence?: string;\n };\n /**\n * Contains functionality for refining a session query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#)\n */\n interface SessionQueryBuilder {\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Sessions.SessionQueryBuilder;\n /**\n * Returns the bookings that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#find)\n */\n find(options?: SessionQueryBuilder.QueryOptions): Promise;\n /**\n * Refines a query to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#ge)\n */\n ge(propertyName: string, value: Date): Sessions.SessionQueryBuilder;\n /**\n * Refines a query to match items whose specified property contains any of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, value: string[]): Sessions.SessionQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#limit)\n */\n limit(limit: number): Sessions.SessionQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#lt)\n */\n lt(propertyName: string, value: Date): Sessions.SessionQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): Sessions.SessionQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#skip)\n */\n skip(skip: number): Sessions.SessionQueryBuilder;\n }\n /**\n * The results of a session query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#)\n */\n interface SessionQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns an array of sessions that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#items)\n */\n readonly items: Sessions.Session[];\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `SessionQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#query)\n */\n readonly query: Sessions.SessionQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a session query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryBuilder.html#)\n */\n namespace SessionQueryBuilder {\n /**\n * Options to use when performing a query.\n */\n type QueryOptions = {\n /**\n * When `true`, prevents permission checks from running for the `find()` operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n }\n /**\n * The results of a session query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-backend.Sessions.SessionQueryResult.html#)\n */\n namespace SessionQueryResult {\n }\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-bookings.v1.d.ts", "content": "/**\n * [Read more](https://www.wix.com/corvid/reference/wix-bookings.v1.html#)\n */\ndeclare module 'wix-bookings.v1' {\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.html#resources)\n */\n const resources: Resources;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.Resources.html#)\n */\n interface Resources {\n /**\n * Creates a resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.Resources.html#createResource)\n */\n createResource(resource: Resources.Resource, options: Resources.CreateResourceOptions): Promise;\n /**\n * Deletes a resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.Resources.html#deleteResource)\n */\n deleteResource(_id: string): Promise;\n /**\n * Updates a resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.Resources.html#updateResource)\n */\n updateResource(_id: string, resource: Resources.UpdateResource): Promise;\n /**\n * Updates a resource's schedule.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.Resources.html#updateSchedule)\n */\n updateSchedule(resourceId: string, schedule: Resources.Schedule): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-bookings-v1.Resources.html#)\n */\n namespace Resources {\n type Address = {\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine?: string;\n /**\n * Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.\n */\n addressLine2?: string;\n /**\n * City name.\n */\n city?: string;\n /**\n * Country code.\n */\n country?: string;\n /**\n * Country full name.\n */\n countryFullname?: string;\n /**\n * A string containing the full address of this location.\n */\n formattedAddress?: string;\n /**\n * Coordinates of the physical address.\n */\n geocode?: Resources.AddressLocation;\n /**\n * Free text to help find the address.\n */\n hint?: string;\n /**\n * Zip/postal code.\n */\n postalCode?: string;\n /**\n * Street name, number and apartment number.\n */\n streetAddress?: Resources.StreetAddress;\n /**\n * Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\n */\n subdivision?: string;\n /**\n * Multi-level subdivisions from top to bottom.\n */\n subdivisions?: Array;\n };\n type AddressLocation = {\n /**\n * Address latitude.\n */\n latitude?: number;\n /**\n * Address longitude.\n */\n longitude?: number;\n };\n type AddressStreetOneOf = {\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine?: string;\n /**\n * Street name, number and apartment number.\n */\n streetAddress?: Resources.StreetAddress;\n };\n type Availability = {\n /**\n * Constraints for calculating the schedule's availability.\n */\n constraints?: Resources.AvailabilityConstraints;\n /**\n * Date and time the schedule stops being available for booking. No value indicates no end time.\n */\n end?: Date;\n /**\n * Other schedules that impact the availability calculation. Relevant only when there are availability constraints.\n */\n linkedSchedules?: Array;\n /**\n * Date and time the schedule starts to be available for booking.\n */\n start?: Date;\n };\n type AvailabilityConstraints = {\n /**\n * A list of duration options for slots, in minutes. Minimum value for a duration is 1.\n * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.\n */\n slotDurations?: Array;\n /**\n * An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.\n */\n slotsSplitInterval?: Resources.SplitInterval;\n /**\n * Specify how to split the slots in intervals of minutes.\n * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).\n * Optional. The default is the first duration in slot_durations field.\n * Deprecated. Use the `split_slots_interval.value_in_minutes`.\n */\n splitInterval?: number;\n /**\n * The number of minutes between the `end` of one slot, and the `start` of the next.\n * Minimum value is 0, maximum value is 120.\n */\n timeBetweenSlots?: number;\n };\n type BatchCreateOptions = {\n /**\n * Optional. If provided, the resources field is ignored.\n */\n batchedResources?: Array;\n /**\n * List of resource entities to create.\n */\n resources?: Array;\n };\n type BatchCreateResourceRequest = {\n /**\n * Optional. If provided, the resources field is ignored.\n */\n batchedResources?: Array;\n /**\n * List of resource entities to create.\n */\n resources?: Array;\n };\n type BatchCreateResourceResponse = {\n /**\n * List of the created resources.\n */\n resources?: Array;\n };\n type BatchDeleteResourceRequest = {\n /**\n * List of resource IDs to delete.\n */\n ids: Array;\n };\n type BatchDeleteResourceResponse = {};\n type BatchRequest = {\n /**\n * Cancel multiple schedules.\n * The given schedules move to a CANCELLED status which means that all sessions up until\n * the cancellation point in time are kept, while removing all following sessions.\n */\n cancelRequests?: Array;\n /**\n * Create multiple schedules.\n */\n createRequests?: Array;\n /**\n * Update multiple schedules. Not Supported yet.\n */\n updateRequests?: Array;\n };\n type BatchResponse = {\n /**\n * Cancelled schedules.\n */\n cancelled?: Array;\n /**\n * Created schedules.\n */\n created?: Array;\n /**\n * Updated schedules.\n */\n updated?: Array;\n };\n type BusinessLocation = {\n /**\n * The ID of the business location. Has to be non-empty\n */\n locationId?: string;\n };\n type BusinessSchedule = {\n /**\n * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.\n */\n periods?: Array;\n /**\n * Exceptions to the business's regular hours. The business can be open or closed during the exception.\n */\n specialHourPeriod?: Array;\n };\n type CalendarConference = {\n /**\n * URL used by a guest to join the conference.\n */\n guestUrl?: string;\n /**\n * URL used by the host to start the conference.\n */\n hostUrl?: string;\n };\n type CancelScheduleRequest = {\n /**\n * Time to cancel the sessions from. Optional. If this field is empty, all of this schedule's sessions will be canceled.\n */\n from?: Date;\n /**\n * Deprecated, use participant_notification\n */\n notifyParticipants?: boolean;\n /**\n * Whether to notify participants about the change, and an optional custom message.\n */\n participantNotification?: Resources.ParticipantNotification;\n /**\n * Whether to preserve future sessions with reservations. Defaults to false.\n */\n preserveFutureSessionsWithParticipants?: boolean;\n /**\n * Schedule ID.\n */\n scheduleId?: string;\n };\n type ConferenceProvider = {\n /**\n * Conferencing provider ID\n */\n providerId?: string;\n };\n type CreateResourceOptions = {\n /**\n * List of schedules to be assigned for the created resource. Currently only a single schedule is allowed.\n * If provided, any schedules in the resource entity will be ignored.\n */\n schedules?: Array;\n };\n type CreateResourceRequest = {\n /**\n * Resource to create.\n */\n resource: Resources.Resource;\n /**\n * List of schedules to be assigned for the created resource. Currently only a single schedule is allowed.\n * If provided, any schedules in the resource entity will be ignored.\n */\n schedules?: Array;\n };\n type CreateResourceResponse = {\n /**\n * Created resource.\n */\n resource?: Resources.Resource;\n };\n type CreateScheduleRequest = {\n /**\n * Schedule.\n */\n schedule?: Resources.Schedule;\n };\n type CursorPaging = {\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string;\n /**\n * Number of items to load.\n */\n limit?: number;\n };\n type Cursors = {\n /**\n * Cursor pointing to next page in the list of results.\n */\n next?: string;\n /**\n * Cursor pointing to previous page in the list of results.\n */\n prev?: string;\n };\n type DeleteResourceRequest = {\n /**\n * ID of the resource to delete.\n */\n _id: string;\n };\n type DeleteResourceResponse = {\n /**\n * Deleted resource ID.\n */\n _id?: string;\n };\n type ExternalCalendarOverrides = {\n /**\n * Synced description of the external calendar event.\n */\n description?: string;\n /**\n * Synced title of the external calendar event.\n */\n title?: string;\n };\n type Frequency = {\n /**\n * The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52.\n */\n repetition?: number;\n };\n type Interval = {\n /**\n * The day the interval accrue. Optional. The default is the day of the recurring interval's start time.\n */\n daysOfWeek?: string;\n /**\n * The duration of the interval in minutes. Required. Part of the session end time calculation. minimum: 1, maximum: 86400.\n */\n duration?: number;\n /**\n * The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23.\n */\n hourOfDay?: number;\n /**\n * The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59.\n */\n minuteOfHour?: number;\n };\n type LinkResourceToUserRequest = {\n /**\n * The id of the resource to link.\n */\n resourceId: string;\n /**\n * The id of Wix user to link.\n */\n userId: string;\n };\n type LinkResourceToUserResponse = {\n /**\n * The updated resource.\n */\n resource?: Resources.Resource;\n };\n type LinkedSchedule = {\n /**\n * Schedule ID.\n */\n scheduleId?: string;\n /**\n * Owner ID, of the linked schedule.\n */\n scheduleOwnerId?: string;\n /**\n * Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `\"BUSY\"`.\n *\n * If set to `\"BUSY\"`, this schedule cannot have any available slots during the linked schedule's sessions.\n * If set to `\"FREE\"`, this schedule can have available slots during the linked schedule's sessions.\n *\n *\n *\n */\n transparency?: string;\n };\n type ListOptions = {\n query?: Resources.Query;\n };\n type ListResourcesRequest = {\n query?: Resources.Query;\n };\n type ListResourcesResponse = {\n metadata?: Resources.QueryMetaData;\n pagingMetadata?: Resources.PagingMetadataV2;\n /**\n * List of resources matching the query object.\n */\n resources?: Array;\n };\n type Location = {\n /**\n * Free text address used when locationType is `OWNER_CUSTOM`.\n */\n address?: string;\n /**\n * Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default.\n */\n customAddress?: Resources.Address;\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: string;\n };\n type LocationsAddress = {\n /**\n * City name.\n */\n city?: string;\n /**\n * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Full address of the location.\n */\n formatted?: string;\n /**\n * Geographic coordinates of location.\n */\n location?: Resources.LocationsAddressLocation;\n /**\n * Postal or zip code.\n */\n postalCode?: string;\n /**\n * Street address. Includes street name, number, and apartment number in separate fields.\n */\n streetAddress?: Resources.LocationsStreetAddress;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n };\n type LocationsAddressLocation = {\n /**\n * Latitude of the location. Must be between -90 and 90.\n */\n latitude?: number;\n /**\n * Longitude of the location. Must be between -180 and 180.\n */\n longitude?: number;\n };\n type LocationsLocation = {\n /**\n * Location ID.\n */\n _id?: string;\n /**\n * Address.\n */\n address?: Resources.LocationsAddress;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n */\n archived?: boolean;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: Resources.BusinessSchedule;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n */\n default?: boolean;\n /**\n * Location description.\n */\n description?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Fax number.\n */\n fax?: string;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n */\n locationType?: string;\n /**\n * Location name.\n */\n name?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status. `INACTIVE` is currently not supported.\n */\n status?: string;\n /**\n * Timezone in `America/New_York` format.\n */\n timeZone?: string;\n };\n type LocationsStreetAddress = {\n /**\n * Apartment number.\n */\n apt?: string;\n /**\n * Street name.\n */\n name?: string;\n /**\n * Street number.\n */\n number?: string;\n };\n type Paging = {\n /**\n * Number of items to load.\n */\n limit?: number;\n /**\n * Number of items to skip in the current sort order.\n */\n offset?: number;\n };\n type PagingMetadataV2 = {\n /**\n * Number of items returned in the response.\n */\n count?: number;\n /**\n * Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.\n */\n cursors?: Resources.Cursors;\n /**\n * Offset that was requested.\n */\n offset?: number;\n /**\n * Flag that indicates the server failed to calculate the `total` field.\n */\n tooManyToCount?: boolean;\n /**\n * Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.\n */\n total?: number;\n };\n type Participant = {\n /**\n * Participant ID. Currently represents the booking.id.\n */\n _id?: string;\n /**\n * Approval status for the participant.\n *\n *\n */\n approvalStatus?: string;\n /**\n * Contact ID.\n */\n contactId?: string;\n /**\n * Participant's email address.\n */\n email?: string;\n /**\n * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.\n */\n inherited?: boolean;\n /**\n * Participant's name.\n */\n name?: string;\n /**\n * Group or party size. The number of people attending. Defaults to 0. Maximum is 250.\n */\n partySize?: number;\n /**\n * Participant's phone number.\n */\n phone?: string;\n };\n type ParticipantNotification = {\n /**\n * Custom message to send to the participants about the changes to the booking.\n */\n message?: string;\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n };\n type Price = {\n /**\n * Required payment amount.\n */\n amount?: string;\n /**\n * Currency in which the amount is quoted.\n */\n currency?: string;\n /**\n * Amount of a down payment or deposit as part of the transaction.\n */\n downPayAmount?: string;\n };\n type Query = {\n /**\n * 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.\n */\n fields?: Array;\n /**\n * 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.\n */\n fieldsets?: Array;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: Resources.Paging;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Array;\n };\n type QueryMetaData = {\n items?: number;\n offset?: number;\n totalCount?: number;\n };\n type QueryResourcesOptions = {\n query?: Resources.QueryV2;\n };\n type QueryResourcesRequest = {\n query?: Resources.QueryV2;\n };\n type QueryResourcesResponse = {\n pagingMetadata?: Resources.PagingMetadataV2;\n /**\n * List of resources matching the query object.\n */\n resources?: Array;\n };\n type QueryV2 = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Resources.CursorPaging;\n /**\n * 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.\n */\n fields?: Array;\n /**\n * 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.\n */\n fieldsets?: Array;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Object;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: Resources.Paging;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Array;\n };\n type QueryV2PagingMethodOneOf = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Resources.CursorPaging;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: Resources.Paging;\n };\n type Rate = {\n /**\n * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n labeledPriceOptions?: Record;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n priceText?: string;\n };\n type RecurringInterval = {\n /**\n * The recurring interval identifier.\n */\n _id?: string;\n /**\n * Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval.\n */\n affectedSchedules?: Array;\n /**\n * The end time of the recurring interval. Optional. Empty value indicates that there is no end time.\n */\n end?: Date;\n /**\n * The frequency of the interval. Optional. The default is frequency with the default repetition.\n */\n frequency?: Resources.Frequency;\n /**\n * The interval rules. The day, hour and minutes the interval is recurring.\n */\n interval?: Resources.Interval;\n /**\n * The type of recurring interval.\n *\n */\n intervalType?: string;\n /**\n * The start time of the recurring interval. Required.\n */\n start?: Date;\n };\n type Resource = {\n /**\n * Resource ID.\n */\n _id?: string;\n /**\n * Resource description.\n */\n description?: string;\n /**\n * Resource email address.\n */\n email?: string;\n /**\n * Resource images.\n */\n images?: Array;\n /**\n * Resource name.\n */\n name?: string;\n /**\n * Resource phone number.\n */\n phone?: string;\n /**\n * List of IDs of schedules owned by this resource.\n */\n scheduleIds?: Array;\n /**\n * Resource status.\n *\n * One of:\n * - `\"CREATED\"` Default status.\n * - `\"DELETED\"` The resource was deleted.\n * - `\"UPDATED\"` The resource was updated.\n */\n status?: string;\n /**\n * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.\n */\n tags?: Array;\n /**\n * Wix user ID, if the resource is associated with the Wix user.\n * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.\n *\n */\n wixUserId?: string;\n };\n type ResourceNotification = {\n /**\n * Event type.\n */\n event?: string;\n /**\n * Updated resource entity.\n * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.\n */\n resource?: Resources.Resource;\n };\n type ResourceUpdateScheduleRequest = {\n /**\n * Fieldmask for schedule\n */\n fieldmask?: Array;\n /**\n * Resource ID to update.\n */\n resourceId: string;\n /**\n * Schedule to update.\n */\n schedule?: Resources.Schedule;\n };\n type Schedule = {\n /**\n * Schedule ID.\n */\n _id?: string;\n /**\n * A conference created for the schedule. This is used when a participant is added to a schedule.\n */\n calendarConference?: Resources.CalendarConference;\n /**\n * Maximum number of participants that can be added to the schedule's sessions. Must be at most `1` for schedule whose availability is affected by another schedule. For example, appointment schedules of the Wix Bookings app.\n */\n capacity?: number;\n /**\n * Schedule creation date.\n */\n created?: Date;\n /**\n * Fields which were inherited from the Business Info page under Settings in the Dashboard.\n */\n inheritedFields?: Array;\n /**\n * Default location for the schedule's sessions.\n */\n location?: Resources.Location;\n /**\n * *Partial list** of participants which are registered to sessions in this schedule.\n * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.\n * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n */\n participants?: Array;\n /**\n * ID of the schedule's owner entity. This may be a resource ID or a service ID.\n */\n scheduleOwnerId?: string;\n /**\n * Schedule status.\n *\n * One of:\n * - `\"CREATED\"`\n * - `\"CANCELLED\"`\n *\n * Default: `\"CREATED\"`\n */\n status?: string;\n /**\n * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.\n * The Wix Bookings app uses the following predefined tags to set schedule type: `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE\"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.\n */\n tags?: Array;\n /**\n * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.\n * Derived from the Wix Business time zone.\n */\n timeZone?: string;\n /**\n * Default title for the schedule's sessions. Maximum length: 6000 characters.\n */\n title?: string;\n /**\n * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.\n */\n totalNumberOfParticipants?: number;\n /**\n * Schedule last update date.\n */\n updated?: Date;\n /**\n * Schedule version number, updated each time the schedule is updated.\n */\n version?: number;\n };\n type Sorting = {\n /**\n * Name of the field to sort by.\n */\n fieldName?: string;\n /**\n * Sort order.\n */\n order?: string;\n };\n type SpecialHourPeriod = {\n /**\n * Additional info about the exception. For example, \"We close earlier on New Year's Eve.\"\n */\n comment?: string;\n /**\n * End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /**\n * Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n */\n startDate?: string;\n };\n type SplitInterval = {\n /**\n * Whether the slot duration is used as the split interval value.\n * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.\n */\n sameAsDuration?: boolean;\n /**\n * Number of minutes between available slots' start times when `same_as_duration` is `false`.\n */\n valueInMinutes?: number;\n };\n type StreetAddress = {\n /**\n * Apartment number.\n */\n apt?: string;\n /**\n * Street name.\n */\n name?: string;\n /**\n * Street number.\n */\n number?: string;\n };\n type Subdivision = {\n /**\n * Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\n */\n code?: string;\n /**\n * Subdivision full name.\n */\n name?: string;\n };\n type TimePeriod = {\n /**\n * Day of the week the period ends on.\n */\n closeDay?: string;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n /**\n * Day of the week the period starts on.\n */\n openDay?: string;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n };\n type UnLinkResourceFromOwnerRequest = {\n /**\n * The id of the resource to unlink.\n */\n resourceId: string;\n };\n type UnLinkResourceFromOwnerResponse = {\n /**\n * The updated resource.\n */\n resource?: Resources.Resource;\n };\n type UpdateResource = {\n /**\n * Resource ID.\n */\n _id?: string;\n /**\n * Resource description.\n */\n description?: string;\n /**\n * Resource email address.\n */\n email?: string;\n /**\n * Resource images.\n */\n images?: Array;\n /**\n * Resource name.\n */\n name?: string;\n /**\n * Resource phone number.\n */\n phone?: string;\n /**\n * List of IDs of schedules owned by this resource.\n */\n scheduleIds?: Array;\n /**\n * Resource status.\n *\n * One of:\n * - `\"CREATED\"` Default status.\n * - `\"DELETED\"` The resource was deleted.\n * - `\"UPDATED\"` The resource was updated.\n */\n status?: string;\n /**\n * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.\n */\n tags?: Array;\n /**\n * Wix user ID, if the resource is associated with the Wix user.\n * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.\n *\n */\n wixUserId?: string;\n };\n type UpdateResourceOptions = {};\n type UpdateResourceRequest = {\n /**\n * Field mask of fields to update.\n */\n fieldMask?: Array;\n /**\n * Resource to update.\n */\n resource?: Resources.Resource;\n };\n type UpdateResourceResponse = {\n /**\n * Updated resource.\n */\n resource?: Resources.Resource;\n /**\n * Updated schedules.\n */\n schedules?: Resources.BatchResponse;\n };\n type UpdateScheduleOptions = {};\n type UpdateScheduleRequest = {\n /**\n * Optional. Defaults to false. In case of updated intervals' start time, this field indicates whether to align those interval's time exceptions.\n */\n alignTimeExceptions?: boolean;\n /**\n * Field mask of fields to update.\n */\n fieldMask?: Array;\n /**\n * Deprecated, use participant_notification.\n */\n notifyParticipants?: boolean;\n /**\n * Whether to notify participants about the change, and an optional custom message.\n */\n participantNotification?: Resources.ParticipantNotification;\n /**\n * Schedule.\n */\n schedule?: Resources.Schedule;\n };\n type UpdateScheduleResponse = {\n /**\n * Updated schedule.\n */\n schedule?: Resources.Schedule;\n };\n type Version = {\n /**\n * Participants version number, updated each time the schedule participants are updated.\n */\n participantsVersion?: number;\n /**\n * Schedule version number, updated each time the schedule is updated.\n */\n scheduleVersion?: number;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-captcha-backend.d.ts", "content": "/**\n * The wix-captcha-backend module contains functionality for working with the reCAPTCHA element from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-captcha-backend.html#)\n */\ndeclare module 'wix-captcha-backend' {\n /**\n * Authorizes the CAPTCHA token.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-captcha-backend.html#authorize)\n */\n function authorize(token: string): Promise;\n /**\n * An object representing a CAPTCHA authorization error message.\n */\n type ErrorReport = {\n /**\n * Error message.\n */\n error: string;\n };\n /**\n * An object representing a CAPTCHA authorization success message.\n */\n type SuccessReport = {\n /**\n * Value is `true` when authorization is successful.\n */\n success: boolean;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-chat-backend.d.ts", "content": "/**\n * **Deprecated.**\n * \t[Read more](https://www.wix.com/corvid/reference/wix-chat-backend.html#)\n */\ndeclare module 'wix-chat-backend' {\n /**\n * **Deprecated.**\n * This method is deprecated and has been replaced with the equivalent [`sendMessage()`](https://dev.wix.com/docs/sdk/backend-modules/inbox/messages/send-message) method in the [Wix JavaScript SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-the-wix-java-script-sdk).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-chat-backend.html#sendMessage)\n */\n function sendMessage(messageInfo: MessageInfo): Promise;\n /**\n * An object representing a chat message to be sent.\n */\n type MessageInfo = {\n /**\n * The content of the message.\n */\n messageText: string;\n /**\n * The ID of the channel to send the message to. Currently only IDs of business channels are supported.\n */\n channelId: string;\n /**\n * An object representing additional contextual message information included in a chat message. The site visitor does not see the metadata.\n */\n metadata?: any;\n /**\n * Indicates whether the message is sent from the visitor to the business. If `sendAsVisitor` is `true`, the message is sent from the site visitor to the business. If `sendAsVisitor` is `undefined` or `false`, the message is sent from the business to the site visitor. The default is `undefined`.\n */\n sendAsVisitor?: boolean;\n };\n /**\n * **Deprecated.**\n * \t[Read more](https://www.wix.com/corvid/reference/wix-chat-backend.Events.html#)\n */\n interface Events {\n /**\n * **Deprecated.**\n * This event is deprecated. For site development and building apps with [Blocks](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-blocks/about-wix-blocks), use the following Velo Inbox Events instead:\n * - [`onMessageSentToBusiness()`](https://dev.wix.com/docs/velo/events-service-plugins/inbox/events/on-message-sent-to-business)\n * - [`onMessageSentToParticipant()`](https://dev.wix.com/docs/velo/events-service-plugins/inbox/events/on-message-sent-to-participant)\n *\n * Learn how to [migrate your wix-chat-backend events](https://dev.wix.com/docs/velo/apis/wix-chat-backend/migration-guide).\n *\n * An event that fires when a chat message is sent to or from the business.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-chat-backend.Events.html#onMessage)\n */\n onMessage(event: Events.SendMessageEvent): void;\n }\n /**\n * **Deprecated.**\n * \t[Read more](https://www.wix.com/corvid/reference/wix-chat-backend.Events.html#)\n */\n namespace Events {\n /**\n * The content of a chat message.\n */\n type MessagePayload = {\n /**\n * Text of the chat message.\n */\n text: string;\n };\n /**\n * An object representing a chat message that was sent.\n */\n type SendMessageEvent = {\n /**\n * ID of the channel on which the message was sent.\n */\n channelId: string;\n /**\n * Direction of the message.\n * One of the following:\n *\n * + `\"VisitorToBusiness\"`: From a site visitor to the business.\n * + `\"BusinessToVisitor\"`: From the business to a site visitor.\n */\n direction: string;\n /**\n * Type of message. Currently only `TEXT` is supported.\n */\n type: string;\n /**\n * First 250 characters of the chat message. Currently only text is included in the summary.\n */\n summary: string;\n /**\n * The sender's member ID. For a message sent from the site's business, the site owner's member ID.\n */\n participantId: string;\n /**\n * Date and time the message was sent.\n */\n createdAt: Date;\n /**\n * Content of the message.\n * Currently only content of type text is included in the `payload`.\n */\n payload: Events.MessagePayload;\n /**\n * An object representing additional contextual message information included in a chat message. The site visitor does not see the metadata.\n */\n metadata?: any;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-crm-backend.d.ts", "content": "/**\n * The wix-crm-backend module contains functionality for working with\n * [your site's contacts](https://support.wix.com/en/article/about-your-contact-list)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#)\n */\ndeclare module 'wix-crm-backend' {\n /**\n * The Contacts API is used to manage a site's contacts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#contacts)\n */\n const contacts: Contacts;\n /**\n * The Notifications API is used to send notifications to the site owner and contributors.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#notifications)\n */\n const notifications: Notifications;\n /**\n * **Deprecated.**\n * This submodule will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks](https://www.wix.com/velo/reference/wix-crm-v2/tasks/introduction).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#tasks)\n */\n const tasks: Tasks;\n /**\n * The Triggered Emails API is used to send triggered emails to your site's contacts and members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#triggeredEmails)\n */\n const triggeredEmails: TriggeredEmails;\n /**\n * * **Deprecated.**\n * The Workflows API will be discontinued in the upcoming months. Our team is\n * working to provide alternatives, and we'll provide timely updates before\n * implementing any changes. We understand that this transition might present challenges,\n * and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#workflows)\n */\n const workflows: Workflows;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-crm-backend.contacts.createContact()](/contacts/create-contact).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#createContact)\n */\n function createContact(contactInfo: ContactInfo): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-crm-backend.contacts.deleteContact()](wix-crm-backend/contacts/delete-contact).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#deleteContact)\n */\n function deleteContact(contactId: string, options: DeleteOptions): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-crm-backend.triggeredEmails.emailContact()](https://www.wix.com/velo/reference/wix-crm-backend/triggeredemails/emailcontact).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#emailContact)\n */\n function emailContact(emailId: string, toContact: string, options?: TriggeredEmails.TriggeredEmailOptions): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-crm-backend.contacts.getContact()](wix-crm-backend/contacts/get-contact).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#getContactById)\n */\n function getContactById(contactId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-crm-backend.contacts.updateContact()](wix-crm-backend/contacts/update-contact).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.html#updateContact)\n */\n function updateContact(contactId: string, contactInfo: ContactInfo): Promise;\n /**\n * An object that contains information about a site contact.\n */\n type ContactInfo = {\n /**\n * Contact's first name.\n */\n firstName?: string;\n /**\n * Contact's last name.\n */\n lastName?: string;\n /**\n * Contact's image source.\n */\n picture?: string;\n /**\n * List of contact's email addresses. When\n * creating a contact, if no phone number is\n * provided, at least one email address must be provided.\n */\n emails?: string[];\n /**\n * Email address the contact who is also\n * a member uses to log into the system.\n */\n loginEmail?: string;\n /**\n * List of contact's phone numbers. When\n * creating a contact, if no email is\n * provided, at least one phone number must be provided.\n */\n phones?: string[];\n /**\n * List of contact's labels. [Labels](https://support.wix.com/en/article/creating-contact-labels)\n * are used to organize contacts. When setting the `labels` property, you can\n * only list labels that already exist in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n */\n labels?: string[];\n /**\n * Any\n * number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n * are used to store additional information about your site's contacts. When\n * setting a custom field, use `key:value` pairs, where the key matches the display names\n * in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n * You can only set values for custom fields that already exist in the Contacts\n * application.\n */\n customFields?: string | number | Date;\n };\n /**\n * An object that contains contact deletion options.\n */\n type DeleteOptions = {\n /**\n * Whether to perform the deletion when the contact is also a member. Defaults to `false`.\n */\n deleteMembers: boolean;\n };\n /**\n * The Contacts API is used to manage a site's contacts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#)\n */\n interface Contacts {\n /**\n * Appends `contactInfo` to an existing contact or creates a new contact if it doesn't already exist.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#appendOrCreateContact)\n */\n appendOrCreateContact(contactInfo: Contacts.ContactInfo): Promise;\n /**\n * Creates a new contact.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#createContact)\n */\n createContact(contactInfo: Contacts.ContactInfo, options?: Contacts.Options): Promise;\n /**\n * Deletes a contact who is not a site member or contributor.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#deleteContact)\n */\n deleteContact(contactId: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Deletes an extended field.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#deleteExtendedField)\n */\n deleteExtendedField(key: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Deletes a label from the site and removes it from contacts it applies to.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#deleteLabel)\n */\n deleteLabel(key: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Retrieves a custom field with a given name, or creates one if it doesn't exist.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#findOrCreateExtendedField)\n */\n findOrCreateExtendedField(extendedFieldInfo: Contacts.ExtendedFieldInfo, options?: Contacts.AuthOptions): Promise;\n /**\n * Retrieves a label with a given name, or creates one if it doesn't exist.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#findOrCreateLabel)\n */\n findOrCreateLabel(displayName: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Retrieves a contact.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#getContact)\n */\n getContact(contactId: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Retrieves an extended field.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#getExtendedField)\n */\n getExtendedField(key: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Retrieves a label.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#getLabel)\n */\n getLabel(key: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Adds labels to a contact.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#labelContact)\n */\n labelContact(contactId: string, labelKeys: string[], options?: Contacts.AuthOptions): Promise;\n /**\n * Creates a query to retrieve a list of contacts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#queryContacts)\n */\n queryContacts(): Contacts.ContactsQueryBuilder;\n /**\n * Creates a query to retrieve a list of extended fields.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#queryExtendedFields)\n */\n queryExtendedFields(): Contacts.ExtendedFieldsQueryBuilder;\n /**\n * Creates a query to retrieve a list of labels.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#queryLabels)\n */\n queryLabels(): Contacts.LabelsQueryBuilder;\n /**\n * Renames an extended field.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#renameExtendedField)\n */\n renameExtendedField(key: string, displayName: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Renames a label.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#renameLabel)\n */\n renameLabel(key: string, displayName: string, options?: Contacts.AuthOptions): Promise;\n /**\n * Removes labels from a contact.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#unlabelContact)\n */\n unlabelContact(contactId: string, labelKeys: string[], options?: Contacts.AuthOptions): Promise;\n /**\n * Updates a contact's properties.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#updateContact)\n */\n updateContact(identifiers: Contacts.Identifiers, contactInfo: Contacts.ContactInfo, options?: Contacts.Options): Promise;\n }\n /**\n * Events that are fired by actions relating to site contacts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#)\n */\n interface Events {\n /**\n * **Deprecated.**\n * This event will continue to work until June 30, 2024.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onCardCreated)\n */\n onCardCreated(event: Events.CardCreatedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until June 30, 2024.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onCardMoved)\n */\n onCardMoved(event: Events.CardMovedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until June 30, 2024.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onCardRestored)\n */\n onCardRestored(event: Events.CardRestoredEvent): void;\n /**\n * An event that triggers when a new contact is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onContactCreated)\n */\n onContactCreated(event: Events.ContactCreatedEvent): void;\n /**\n * An event that triggers when a contact is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onContactDeleted)\n */\n onContactDeleted(event: Events.ContactDeletedEvent): void;\n /**\n * An event that triggers when one or more source contacts are merged into a target contact.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onContactMerged)\n */\n onContactMerged(event: Events.ContactMergedEvent): void;\n /**\n * An event that triggers when a contact is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onContactUpdated)\n */\n onContactUpdated(event: Events.ContactUpdatedEvent): void;\n /**\n * An event that triggers when a site visitor submits a Wix Form.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#onFormSubmit)\n */\n onFormSubmit(event: Events.FormSubmitEvent): void;\n }\n /**\n * The Notifications API is used to send notifications to the site owner and contributors.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Notifications.html#)\n */\n interface Notifications {\n /**\n * Sends a notification.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Notifications.html#notify)\n */\n notify(body: string, channels: string[], options?: Notifications.NotificationOptions): Promise;\n }\n /**\n * **Deprecated.**\n * The Tasks submodule will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks](https://www.wix.com/velo/reference/wix-crm-v2/tasks/introduction).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#)\n */\n interface Tasks {\n /**\n * **Deprecated.**\n * This function is deprecated but will continue to work.\n * To set a task as completed, see the [wix-crm.v2.Tasks.updateTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask) function.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#completeTask)\n */\n completeTask(taskId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks.createTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/createtask).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#createTask)\n */\n createTask(taskInfo: Tasks.TaskInfo): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks.getTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/gettask).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#getTask)\n */\n getTask(taskId: string): Promise;\n /**\n * This function will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks.deleteTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/deletetask).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#removeTask)\n */\n removeTask(taskId: string): Promise;\n /**\n * **Deprecated.**\n * This function is deprecated but will continue to work.\n * To reset a task, see the [wix-crm.v2.Tasks.updateTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask) function.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#resetTask)\n */\n resetTask(taskId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks.updateTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#updateTaskFields)\n */\n updateTaskFields(taskId: string, taskInfo: Tasks.TaskInfo): Promise;\n }\n /**\n * The Triggered Emails API is used to send triggered emails to your site's contacts and members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.TriggeredEmails.html#)\n */\n interface TriggeredEmails {\n /**\n * Sends a triggered email to a contact, unless that contact is marked as unsubscribed..\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.TriggeredEmails.html#emailContact)\n */\n emailContact(emailId: string, contactId: string, options?: TriggeredEmails.TriggeredEmailOptions): Promise;\n /**\n * Sends a triggered email to a site member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.TriggeredEmails.html#emailMember)\n */\n emailMember(emailId: string, memberId: string, options?: TriggeredEmails.TriggeredEmailOptions): Promise;\n }\n /**\n * **Deprecated.**\n * The Workflows API will be discontinued in the upcoming months. Our team is\n * working to provide alternatives, and we'll provide timely updates before\n * implementing any changes. We understand that this transition might present challenges,\n * and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#)\n */\n interface Workflows {\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#archiveCard)\n */\n archiveCard(cardId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#createCard)\n */\n createCard(workflowId: string, phaseId: string, card: Workflows.CreateCardRequest, position?: number): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#createPhase)\n */\n createPhase(workflowId: string, phaseInfo: Workflows.CreatePhaseRequest, position?: number): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#createWorkflow)\n */\n createWorkflow(workflowInfo: Workflows.CreateWorkflowRequest): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#deleteCard)\n */\n deleteCard(cardId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#deletePhase)\n */\n deletePhase(phaseId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#deleteWorkflow)\n */\n deleteWorkflow(workflowId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#getCard)\n */\n getCard(cardId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#getPhaseInfo)\n */\n getPhaseInfo(phaseId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#getWorkflowInfo)\n */\n getWorkflowInfo(workflowId: string): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#listCards)\n */\n listCards(workflowId: string, options: Workflows.ListCardOptions): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#listPhasesInfo)\n */\n listPhasesInfo(workflowId: string, options?: Workflows.ListOptions): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#listWorkflowsInfo)\n */\n listWorkflowsInfo(options?: Workflows.ListOptions): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#moveCard)\n */\n moveCard(cardId: string, options: Workflows.MoveCardOptions): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#movePhase)\n */\n movePhase(phaseId: string, options: Workflows.MovePhaseOptions): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#restoreCard)\n */\n restoreCard(cardId: string, options: Workflows.MoveCardOptions): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#updateCardFields)\n */\n updateCardFields(cardId: string, cardInfo: Workflows.UpdateCardRequest): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#updatePhaseFields)\n */\n updatePhaseFields(phaseId: string, phaseInfo: Workflows.UpdatePhaseRequest): Promise;\n /**\n * **Deprecated.**\n * This function is being discontinued in the upcoming months. We are working to provide alternatives,\n * and we'll provide timely updates before implementing any changes. We understand that this\n * transition might present challenges, and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#updateWorkflowFields)\n */\n updateWorkflowFields(workflowId: string, workflowInfo: Workflows.UpdateWorkflowRequest): Promise;\n }\n /**\n * The Contacts API is used to manage a site's contacts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.html#)\n */\n namespace Contacts {\n type Address = {\n /**\n * Street address ID.\n */\n _id: string;\n /**\n *\n *\n *\n * Address type.\n * `\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\n *\n * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"HOME\"`\n * - `\"WORK\"`\n * - `\"BILLING\"`\n * - `\"SHIPPING\"`\n *\n */\n tag: string;\n /**\n * Street address.\n */\n address: Contacts.AddressDetails;\n };\n /**\n * Street address.\n */\n type AddressDetails = {\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine1?: string;\n /**\n * Street address object, with number and name in separate fields.\n */\n streetAddress?: Contacts.StreetAddressInfo;\n /**\n * Human-readable address string.\n * If not provided, the value is generated from the available address data.\n */\n formatted?: string;\n /**\n * Free text providing more detailed address information,\n * such as apartment, suite, or floor.\n */\n addressLine2?: string;\n /**\n * Coordinates of the physical address.\n */\n location?: Contacts.AddressLocation;\n /**\n * City name.\n */\n city?: string;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an\n * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n /**\n * 2-letter country code in an\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Postal or zip code.\n */\n postalCode?: string;\n };\n type AddressInfo = {\n /**\n *\n *\n *\n * Address type.\n * `\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\n *\n * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"HOME\"`\n * - `\"WORK\"`\n * - `\"BILLING\"`\n * - `\"SHIPPING\"`\n *\n */\n tag: string;\n /**\n * Street address.\n */\n address: Contacts.AddressDetails;\n };\n /**\n * Coordinates of the physical address.\n */\n type AddressLocation = {\n /**\n * Address's latitude.\n */\n latitude?: number;\n /**\n * Address's longitude.\n */\n longitude?: number;\n };\n /**\n * Authorization options.\n */\n type AuthOptions = {\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * Contact.\n */\n type Contact = {\n /**\n * Contact ID.\n */\n _id: string;\n /**\n * Revision number, which increments by 1 each time the contact is updated.\n * To prevent conflicting changes,\n * the existing `revision` must be used when updating a contact.\n */\n revision: number;\n /**\n * Details about the contact's source.\n */\n source: Contacts.Source;\n /**\n * Date and time the contact was created.\n */\n _createdDate: Date;\n /**\n * Date and time the contact was last updated.\n */\n _updatedDate: Date;\n /**\n * Details about the contact's last action in the site.\n */\n lastActivity: Contacts.LastActivity;\n /**\n * Contact's primary phone and email.\n */\n primaryInfo?: Contacts.PrimaryInfo;\n /**\n * Contact's details.\n */\n info: Contacts.Info;\n };\n type ContactIdentification = {\n /**\n * ID of the contact that was found or created.\n */\n contactId: string;\n /**\n * Identity type of the returned contact.\n *\n *\n *\n *\n * One of:\n *\n * - `\"CONTACT\"`: The returned contact ID belongs to a new or existing contact.\n * - `\"MEMBER\"`: The returned contact ID belongs to the currently logged-in site member.\n * - `\"NOT_AUTHENTICATED_MEMBER\"`: The returned contact ID belongs to a site member who is not currently logged in.\n *\n */\n identityType: string;\n };\n /**\n * Contact's information.\n */\n type ContactInfo = {\n /**\n * Contact's first and last name.\n */\n name?: Contacts.Name;\n /**\n * Contact's company name.\n */\n company?: string;\n /**\n * Contact's job title.\n * Corresponds to the **Position** field in the Dashboard.\n */\n jobTitle?: string;\n /**\n * Contact's locale, formatted as an\n * [IETF BCP 47 language tag](https://tools.ietf.org/html/rfc5646).\n * Typically, this is a lowercase 2-letter language code,\n * followed by a hyphen,\n * followed by an uppercase 2-letter country code.\n *\n * For example, German from Germany is formatted as `de-DE`,\n * and U.S. English is formatted as `en-US`.\n */\n locale?: string;\n /**\n * Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\n *\n * For example, `\"2025-03-15\"` for March 15, 2025.\n */\n birthdate?: string;\n /**\n * **Deprecated.** Use `profilePicture` instead.\n */\n picture?: Contacts.Picture;\n /**\n * List of up to 50 email addresses.\n */\n emails?: Contacts.EmailInfo[];\n /**\n * List of up to 50 phone numbers.\n */\n phones?: Contacts.PhoneInfo[];\n /**\n * List of up to 50 addresses.\n */\n addresses?: Contacts.AddressInfo[];\n /**\n * List of contact label keys.\n * [Contact labels](https://support.wix.com/en/article/creating-contact-labels)\n * help categorize contacts.\n *\n *\n *\n *\n * Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with\n * `findOrCreateLabel()` or `queryLabels()` in the\n * Labels API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/labels/introduction) | [Velo](https://dev.wix.com/docs/velo/apis/wix-crm-v2/labels/introduction)).\n *\n */\n labelKeys?: string[];\n /**\n * Set of key-value pairs.\n *\n *\n *\n * Contact's extended fields allow you to store additional information about a site's contacts.\n *\n * To view or create extended fields, call `findOrCreateExtendedField()`, `getExtendedField()`, or `queryExtendedFields()` in the\n * Extended Fields API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/extended-fields/introduction) | [Velo](https://dev.wix.com/docs/velo/apis/wix-crm-v2/extended-fields/introduction)).\n *\n */\n extendedFields?: any;\n /**\n * Contact's profile picture URL.\n */\n profilePicture?: string;\n };\n /**\n * Contact's profile picture.\n */\n type ContactPicture = {\n /**\n * Image source. Can be either a Media Manager URL or external URL.\n */\n image: string;\n /**\n * Indicates whether the image is retrieved from Wix Media\n * or an external provider.\n *\n *\n *\n *\n * One of:\n *\n * - `\"EXTERNAL\"`: The image is retrieved from an external provider.\n * - `\"WIX_MEDIA\"`: The image is retrieved from Wix Media.\n *\n */\n imageProvider: string;\n };\n type Email = {\n /**\n * Email ID.\n */\n _id: string;\n /**\n * Email type.\n *\n *\n *\n *\n * `\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\n *\n * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"MAIN\"`\n * - `\"HOME\"`\n * - `\"WORK\"`\n *\n */\n tag: string;\n /**\n * Email address.\n */\n email: string;\n /**\n * Indicates whether this is the contact's primary email address.\n * When changing `primary` to `true` for an email,\n * the contact's other emails become `false`.\n */\n primary: boolean;\n };\n type EmailInfo = {\n /**\n * Email type.\n *\n *\n *\n *\n * `\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\n *\n * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"MAIN\"`\n * - `\"HOME\"`\n * - `\"WORK\"`\n *\n */\n tag?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Indicates whether this is the contact's primary email address.\n * When changing `primary` to `true` for an email,\n * the contact's other emails become `false`.\n */\n primary?: boolean;\n };\n /**\n * Extended field that was found or created.\n */\n type ExtendedField = {\n /**\n * Extended field ID.\n *\n * When accessing contact data,\n * extended field data is available at `extendedFields[key]`.\n * For example, if the key is \"custom.notes\",\n * the value can be accessed at `extendedFields[\"custom.notes\"]`.\n *\n * `key` is generated when the extended field is created\n * and cannot be modified, even if `displayName` changes.\n */\n key: string;\n /**\n * Extended field display name shown in the Contact List.\n */\n displayName: string;\n /**\n * Type of data the field holds.\n *\n *\n *\n *\n * One of:\n *\n * - `\"TEXT\"`: Accepts strings.\n * - `\"URL\"`: Accepts web addresses. Prepends `https://` if no protocol is included.\n * - `\"DATE\"`: Accepts dates formatted as `\"YYYY-MM-DD\"`.\n * - `\"NUMBER\"`: Accepts floats.\n *\n */\n dataType: string;\n /**\n *\n *\n *\n * Indicates whether the extended field is a\n * [system field or custom field](wix-crm-backend/contacts/introduction#about-extended-fields).\n *\n * One of:\n *\n * - `\"SYSTEM\"`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.\n * - `\"USER_DEFINED\"`: The field is a custom field and can be modified by 3rd-party apps or site contributors.\n *\n */\n fieldType: string;\n /**\n * Date and time the field was created.\n */\n _createdDate: Date;\n /**\n * Date and time the field was last updated.\n */\n _updatedDate: Date;\n /**\n *\n *\n *\n * Extended field [namespace](wix-crm-backend/contacts/introduction#the-namespace-and-key-properties-in-labels-and-extended-fields).\n *\n *\n * Extended fields created by site contributors or 3rd-party apps\n * are automatically assigned to the `custom` namespace.\n */\n namespace: string;\n /**\n * Field description, if the field is a system field.\n */\n description: string;\n };\n /**\n * Custom field to find or create.\n */\n type ExtendedFieldInfo = {\n /**\n * Display name to find or create.\n *\n * If an existing custom field is an exact match\n * for the specified `displayName`,\n * the existing field is returned.\n * If not, a new field is created and returned.\n */\n displayName: string;\n /**\n * Type of data the field holds.\n * Ignored if an existing field is an exact match\n * for the specified display name.\n *\n *\n *\n *\n * One of:\n *\n * - `\"TEXT\"`: Accepts strings.\n * - `\"URL\"`: Accepts web addresses. Prepends `https://` if no protocol is included.\n * - `\"DATE\"`: Accepts dates formatted as `\"YYYY-MM-DD\"`.\n * - `\"NUMBER\"`: Accepts floats.\n *\n */\n dataType?: string;\n };\n /**\n * List of extended fields.\n */\n type ExtendedFieldList = {\n /**\n * List of extended fields.\n */\n items: Contacts.ExtendedField[];\n /**\n * Metadata for the page of results.\n */\n pagingMetadata: Contacts.PagingMetadata;\n };\n /**\n * Extended field that was found or created.\n */\n type FoundOrCreatedExtendedField = {\n /**\n * Extended field that was found or created.\n */\n extendedField: Contacts.ExtendedField;\n /**\n * Indicates whether the extended field was just created or already existed.\n *\n * If the field was just created, returns `true`.\n * If it already existed, returns `false`.\n */\n newExtendedField: boolean;\n };\n /**\n * Label that was found or created.\n */\n type FoundOrCreatedLabel = {\n /**\n * Label that was found or created.\n */\n label: Contacts.Label;\n /**\n * Indicates whether the label was just created or already existed.\n *\n * If the label was just created, returns `true`.\n * If it already existed, returns `false`.\n */\n newLabel: boolean;\n };\n type Identifiers = {\n /**\n * ID of the contact to update.\n */\n contactId: string;\n /**\n * Revision number.\n * When updating, include the existing `revision`\n * to prevent conflicting updates.\n */\n revision: number;\n };\n /**\n * Contact's details.\n */\n type Info = {\n /**\n * Contact's first and last name.\n */\n name?: Contacts.Name;\n /**\n * Contact's company name.\n */\n company?: string;\n /**\n * Contact's job title.\n * Corresponds to the **Position** field in the Dashboard.\n */\n jobTitle?: string;\n /**\n * Contact's locale, formatted as an\n * [IETF BCP 47 language tag](https://tools.ietf.org/html/rfc5646).\n * Typically, this is a lowercase 2-letter language code,\n * followed by a hyphen,\n * followed by an uppercase 2-letter country code.\n *\n * For example, German from Germany is formatted as `de-DE`,\n * and U.S. English is formatted as `en-US`.\n */\n locale?: string;\n /**\n * Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\n *\n * For example, `\"2025-03-15\"` for March 15, 2025.\n */\n birthdate?: string;\n /**\n * **Deprecated.** Use `profilePicture` instead.\n */\n picture: Contacts.Picture;\n /**\n * List of up to 50 email addresses.\n */\n emails?: Contacts.Email[];\n /**\n * List of up to 50 phone numbers.\n */\n phones?: Contacts.Phone[];\n /**\n * List of up to 50 addresses.\n */\n addresses?: Contacts.Address[];\n /**\n * List of contact label keys.\n * [Contact labels](https://support.wix.com/en/article/creating-contact-labels)\n * help categorize contacts.\n *\n *\n *\n *\n * Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with\n * `findOrCreateLabel()` or `queryLabels()` in the\n * Labels API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/labels/introduction) | [Velo](https://dev.wix.com/docs/velo/apis/wix-crm-v2/labels/introduction)).\n *\n */\n labelKeys?: string[];\n /**\n * Set of key-value pairs.\n *\n *\n *\n * Contact's extended fields allow you to store additional information about a site's contacts.\n *\n * To view or create extended fields, call `findOrCreateExtendedField()`, `getExtendedField()`, or `queryExtendedFields()` in the\n * Extended Fields API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/extended-fields/introduction) | [Velo](https://dev.wix.com/docs/velo/apis/wix-crm-v2/extended-fields/introduction)).\n *\n */\n extendedFields: any;\n /**\n * Contact's profile picture URL.\n */\n profilePicture?: string;\n };\n /**\n * Label that was found or created.\n */\n type Label = {\n /**\n * Label key.\n *\n * `key` is generated when the label is created\n * and cannot be modified, even if `displayName` changes.\n */\n key: string;\n /**\n * Label display name shown in the Dashboard.\n */\n displayName: string;\n /**\n * Label type.\n *\n *\n *\n *\n * One of:\n *\n * - `\"SYSTEM\"`: The label is a predefined system label for the Contact List.\n * - `\"USER_DEFINED\"`: The label was created by a site contributor or app.\n * - `\"WIX_APP_DEFINED\"`: The label was created by a Wix app.\n *\n */\n labelType: string;\n /**\n * Date and time the label was created.\n */\n _createdDate: Date;\n /**\n * Date and time the label was last updated.\n */\n _updatedDate: Date;\n /**\n *\n *\n *\n * Label [namespace](wix-crm-backend/contacts/introduction#the-namespace-and-key-properties-in-labels-and-extended-fields).\n *\n *\n * Labels created by site contributors or 3rd-party apps\n * are automatically assigned to the `custom` namespace.\n */\n namespace: string;\n };\n /**\n * List of labels.\n */\n type LabelList = {\n /**\n * List of labels.\n */\n items: Contacts.Label[];\n /**\n * Metadata for the page of results.\n */\n pagingMetadata: Contacts.PagingMetadata;\n };\n /**\n * Details about the contact's last action in the site.\n */\n type LastActivity = {\n /**\n * Date and time of the last action.\n */\n activityDate: Date;\n /**\n * Contact's last action in the site.\n *\n *\n *\n *\n * Some possible values:\n * `\"GENERAL\"`, `\"CONTACT_CREATED\"`, `\"MEMBER_LOGIN\"`, `\"MEMBER_REGISTER\"`,\n * `\"MEMBER_STATUS_CHANGED\"`, `\"FORM_SUBMITTED\"`, `\"INBOX_FORM_SUBMITTED\"`,\n * `\"INBOX_PAYMENT_REQUEST_PAID\"`, `\"INBOX_MESSAGE_TO_CUSTOMER\"`,\n * `\"INBOX_MESSAGE_FROM_CUSTOMER\"`, `\"NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED\"`,\n * `\"NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE\"`, `\"ECOM_PURCHASE\"`,\n * `\"ECOM_CART_ABANDON\"`, `\"ECOM_CHECKOUT_BUYER\"`, `\"BOOKINGS_APPOINTMENT\"`,\n * `\"HOTELS_RESERVATION\"`, `\"HOTELS_PURCHASE\"`, `\"HOTELS_CONFIRMATION\"`,\n * `\"HOTELS_CANCEL\"`, `\"VIDEO_PURCHASE\"`, `\"VIDEO_RENT\"`,\n * `\"CASHIER_BUTTON_PURCHASE\"`, `\"ARENA_NEW_LEAD\"`, `\"EVENTS_RSVP\"`,\n * `\"INVOICE_PAY\"`, `\"INVOICE_OVERDUE\"`, `\"PRICE_QUOTE_ACCEPT\"`,\n * `\"PRICE_QUOTE_EXPIRE\"`, `\"RESTAURANTS_ORDER\"`, `\"RESTAURANTS_RESERVATION\"`,\n * `\"SHOUTOUT_OPEN\"`, `\"SHOUTOUT_CLICK\"`, `\"CONTACT_MERGED\"`.\n *\n */\n activityType: string;\n };\n /**\n * Paging options.\n */\n type ListOptions = {\n /**\n * Number of items to return.\n *\n * Defaults to `100`.\n */\n limit?: number;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n skip?: number;\n /**\n * Sorting options.\n */\n sort?: Contacts.SortingOptions;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * Contact's first and last name.\n */\n type Name = {\n /**\n * Contact's first name.\n */\n first?: string;\n /**\n * Contact's last name.\n */\n last?: string;\n };\n /**\n * Contact creation options.\n */\n type Options = {\n /**\n * Controls whether the call will succeed\n * if the new contact information contains an email already used by another contact.\n *\n * If set to `true`,\n * the call will succeed even if an email address is used by another contact.\n * If set to `false`,\n * the call will fail if an email address is used by another contact.\n *\n * Defaults to `false`.\n */\n allowDuplicates?: boolean;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * Metadata for the page of results.\n */\n type PagingMetadata = {\n /**\n * Number of items returned.\n */\n length: number;\n /**\n * Number of items that matched the query.\n */\n totalCount: number;\n /**\n * Indicates if `total` calculation timed out before the response was sent.\n * Typically this happens if there is a large set of results.\n */\n tooManyToCount: boolean;\n };\n type Phone = {\n /**\n * Phone ID.\n */\n _id: string;\n /**\n * Phone type.\n *\n *\n *\n *\n * `\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\n *\n * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"MAIN\"`\n * - `\"HOME\"`\n * - `\"MOBILE\"`\n * - `\"WORK\"`\n * - `\"FAX\"`\n *\n */\n tag: string;\n /**\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.\n */\n countryCode?: string;\n /**\n * Phone number.\n */\n phone: string;\n /**\n * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)\n * phone number.\n * Automatically generated using `phone` and `countryCode`,\n * as long as both of those values are valid.\n */\n e164Phone?: string;\n /**\n * Whether this is the contact's primary phone number.\n * When changing `primary` to `true` for a phone,\n * the contact's other phones become `false`.\n */\n primary: boolean;\n };\n type PhoneInfo = {\n /**\n * Phone type.\n *\n *\n *\n *\n * `\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\n *\n * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"MAIN\"`\n * - `\"HOME\"`\n * - `\"MOBILE\"`\n * - `\"WORK\"`\n * - `\"FAX\"`\n *\n */\n tag?: string;\n /**\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.\n */\n countryCode?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Whether this is the contact's primary phone number.\n * When changing `primary` to `true` for a phone,\n * the contact's other phones become `false`.\n */\n primary?: boolean;\n };\n /**\n * todo\n */\n type Picture = {\n /**\n * **Deprecated.** Use `profilePicture` instead.\n */\n image?: string;\n /**\n * **Deprecated.**\n */\n imageProvider?: string;\n };\n /**\n * Contact's primary phone and email.\n */\n type PrimaryInfo = {\n /**\n * Primary email address.\n *\n *\n *\n *\n * This property reflects the email address in `contactInfo.emails`\n * where `primary` is `true`.\n *\n */\n email?: string;\n /**\n * Primary phone number.\n *\n *\n *\n *\n * This property reflects the phone number in `contactInfo.phones`\n * where `primary` is `true`.\n *\n */\n phone?: string;\n };\n /**\n * Sorting options.\n */\n type SortingOptions = {\n /**\n * Name of the field to sort by.\n */\n fieldName?: string;\n /**\n * Sort order.\n *\n *\n *\n *\n * One of:\n *\n * - `\"ASC\"`: Ascending order\n * - `\"DESC\"`: Descending order\n *\n * Defaults to `\"ASC\"`.\n *\n */\n order?: string;\n };\n /**\n * Details about the contact's source.\n */\n type Source = {\n /**\n * Source type.\n *\n *\n * Some possible values:\n * `\"OTHER\"`, `\"ADMIN\"`, `\"WIX_APP\"`, `\"IMPORT\"`, `\"THIRD_PARTY\"`,\n * `\"WIX_BOOKINGS\"`, `\"WIX_CHAT\"`, `\"WIX_EMAIL_MARKETING\"`, `\"WIX_EVENTS\"`,\n * `\"WIX_FORMS\"`, `\"WIX_GROUPS\"`, `\"WIX_HOTELS\"`, `\"WIX_MARKET_PLACE\"`,\n * `\"WIX_MUSIC\"`, `\"WIX_RESTAURANTS\"`, `\"WIX_SITE_MEMBERS\"`, `\"WIX_STORES\"`.\n *\n */\n sourceType: string;\n /**\n * App ID, if the contact was created by an app.\n */\n appId: string;\n };\n /**\n * Street address object, with number and name in separate fields.\n */\n type StreetAddress = {\n /**\n * Street number.\n */\n number: string;\n /**\n * Street name.\n */\n name: string;\n };\n /**\n * Street address object, with number and name in separate fields.\n */\n type StreetAddressInfo = {\n /**\n * Street number.\n */\n number?: string;\n /**\n * Street name.\n */\n name?: string;\n };\n /**\n * Contains functionality for refining a contacts query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#)\n */\n interface ContactsQueryBuilder {\n /**\n * Adds an `and` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#and)\n */\n and(query: Contacts.ContactsQueryBuilder): Contacts.ContactsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is within a specified range.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#between)\n */\n between(propertyName: string, rangeStart: Date, rangeEnd: Date): Contacts.ContactsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Contacts.ContactsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#find)\n */\n find(options?: Contacts.AuthOptions): Promise;\n /**\n * Refines a query to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#ge)\n */\n ge(propertyName: string, value: Date): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#gt)\n */\n gt(propertyName: string, value: Date): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value contains all of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#hasAll)\n */\n hasAll(propertyName: string, values: string[]): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, values: string[]): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#le)\n */\n le(propertyName: string, value: Date): Contacts.ContactsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#limit)\n */\n limit(limit: string): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#lt)\n */\n lt(propertyName: string, value: Date): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): Contacts.ContactsQueryBuilder;\n /**\n * Adds an `not` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#not)\n */\n not(query: Contacts.ContactsQueryBuilder): Contacts.ContactsQueryBuilder;\n /**\n * Adds an `or` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#or)\n */\n or(query: Contacts.ContactsQueryBuilder): Contacts.ContactsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#skip)\n */\n skip(skip: string): Contacts.ContactsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value starts with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#startsWith)\n */\n startsWith(propertyName: string, value: string): Contacts.ContactsQueryBuilder;\n }\n /**\n * The results of a contacts query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#)\n */\n interface ContactsQueryResult {\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#items)\n */\n readonly items: Contacts.Contact[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `ContactsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#query)\n */\n readonly query: Contacts.ContactsQueryBuilder;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining an extended fields query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#)\n */\n interface ExtendedFieldsQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): Contacts.ExtendedFieldsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): Contacts.ExtendedFieldsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#find)\n */\n find(options?: Contacts.AuthOptions): Promise;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#limit)\n */\n limit(limit: string): Contacts.ExtendedFieldsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#skip)\n */\n skip(skip: string): Contacts.ExtendedFieldsQueryBuilder;\n }\n /**\n * The results of a contacts query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#)\n */\n interface ExtendedFieldsQueryResult {\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#items)\n */\n readonly items: Contacts.ExtendedField[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `ExtendedFieldsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#query)\n */\n readonly query: Contacts.ExtendedFieldsQueryBuilder;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a labels query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#)\n */\n interface LabelsQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): Contacts.LabelsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): Contacts.LabelsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#find)\n */\n find(options?: Contacts.AuthOptions): Promise;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#limit)\n */\n limit(limit: string): Contacts.LabelsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#skip)\n */\n skip(skip: string): Contacts.LabelsQueryBuilder;\n }\n /**\n * The results of a contacts query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#)\n */\n interface LabelsQueryResult {\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#items)\n */\n readonly items: Contacts.Label[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `LabelsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#query)\n */\n readonly query: Contacts.LabelsQueryBuilder;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a contacts query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryBuilder.html#)\n */\n namespace ContactsQueryBuilder {\n }\n /**\n * The results of a contacts query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ContactsQueryResult.html#)\n */\n namespace ContactsQueryResult {\n }\n /**\n * Contains functionality for refining an extended fields query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryBuilder.html#)\n */\n namespace ExtendedFieldsQueryBuilder {\n }\n /**\n * The results of a contacts query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.ExtendedFieldsQueryResult.html#)\n */\n namespace ExtendedFieldsQueryResult {\n }\n /**\n * Contains functionality for refining a labels query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryBuilder.html#)\n */\n namespace LabelsQueryBuilder {\n }\n /**\n * The results of a contacts query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Contacts.LabelsQueryResult.html#)\n */\n namespace LabelsQueryResult {\n }\n }\n /**\n * Events that are fired by actions relating to site contacts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a created card.\n */\n type CardCreatedEvent = {\n /**\n * ID of the card's workflow.\n */\n workflowId: string;\n /**\n * Name of the card's workflow.\n */\n workflowName: string;\n /**\n * ID of the card's phase.\n */\n phaseId: string;\n /**\n * Name of the card's phase.\n */\n phaseName: string;\n /**\n * The card that was created.\n */\n card: Workflows.Card;\n };\n /**\n * An object representing a moved card.\n */\n type CardMovedEvent = {\n /**\n * ID of the card's workflow.\n */\n workflowId: string;\n /**\n * Name of the card's workflow.\n */\n workflowName: string;\n /**\n * ID of the card's new phase.\n */\n newPhaseId: string;\n /**\n * Name of the card's new phase.\n */\n newPhaseName: string;\n /**\n * ID of the card's old phase.\n */\n previousPhaseId: string;\n /**\n * Name of the card's old phase.\n */\n previousPhaseName: string;\n /**\n * The card that was moved.\n */\n card: Workflows.Card;\n };\n /**\n * An object representing a moved card.\n */\n type CardRestoredEvent = {\n /**\n * ID of the workflow the card was restored to.\n */\n workflowId: string;\n /**\n * Name of the workflow the card was restored to.\n */\n workflowName: string;\n /**\n * ID of the phase the card was restored to.\n */\n phaseId: string;\n /**\n * Name of the phase the card was restored to.\n */\n phaseName: string;\n /**\n * The card that was restored.\n */\n card: Workflows.Card;\n };\n type ContactCreatedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Created contact.\n */\n entity: Contacts.Contact;\n };\n type ContactDeletedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.UpdateAndDeleteMetadata;\n };\n type ContactMergedData = {\n /**\n * IDs of the source contacts.\n */\n sourceContactIds: string[];\n /**\n * ID of the target contact.\n */\n targetContactId: string;\n /**\n * Updated target contact.\n */\n targetContact: Contacts.Contact;\n };\n type ContactMergedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Information about the source and target contacts.\n */\n data: Events.ContactMergedData;\n };\n type ContactUpdatedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.UpdateAndDeleteMetadata;\n /**\n * Updated contact.\n */\n entity: Contacts.Contact;\n };\n /**\n * Event metadata.\n */\n type EventMetadata = {\n /**\n * Event ID.\n */\n id: string;\n /**\n * Contact ID associated with the event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)).\n * For advanced users.\n */\n triggeredByAnonymizeRequest?: boolean;\n };\n /**\n * An object representing an attachment to a Wix Form.\n */\n type FormAttachment = {\n /**\n * Name of the attachment.\n */\n name: string;\n /**\n * Type of attachment.\n * One of:\n *\n * + `\"UNDEFINED\"`\n * + `\"DOCUMENT\"`\n * + `\"IMAGE\"`\n * + `\"VIDEO\"`\n */\n type: string;\n /**\n * URL of the attachment.\n */\n url: string;\n };\n /**\n * An object representing a Wix Form field.\n */\n type FormField = {\n /**\n * Name of the field.\n */\n fieldName: string;\n /**\n * Value of the field.\n */\n fieldValue: string;\n };\n /**\n * An object representing a Wix Form.\n */\n type FormSubmitEvent = {\n /**\n * Contact ID of the site visitor submitting the Wix Form.\n */\n contactId: string;\n /**\n * Name of the Wix Form.\n */\n formName: string;\n /**\n * Date and time that the Wix Form was submitted.\n */\n submissionTime: Date;\n /**\n * Data submitted in the Wix Form. The object contains `key:value` pairs where the key is the field name and the value is the contents of the field.\n */\n submissionData: Events.FormField[];\n /**\n * The Wix Form's attachments.\n */\n attachments: Events.FormAttachment[];\n };\n /**\n * Event metadata.\n */\n type UpdateAndDeleteMetadata = {\n /**\n * Event ID.\n */\n id: string;\n /**\n * Contact ID associated with the event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * If present and set to `\"merge\"`,\n * indicates the event was triggered by a merge.\n *\n * See [`onContactMerged()`](#onContactMerged) for information on handling\n * merge events.\n */\n originatedFrom?: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)).\n * For advanced users.\n */\n triggeredByAnonymizeRequest?: boolean;\n };\n }\n /**\n * The Notifications API is used to send notifications to the site owner and contributors.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Notifications.html#)\n */\n namespace Notifications {\n /**\n * An object containing information about where to navigate when a notification is clicked.\n */\n type ActionTarget = {\n /**\n * URL to navigate to when the `actionTitle` text is clicked.\n */\n url?: string;\n };\n /**\n * An object representing notification options.\n */\n type NotificationOptions = {\n /**\n * Notification title. Only displayed on mobile and browser notifications. Max length: 512 characters.\n */\n title?: string;\n /**\n * Call to action text to be clicked on. When clicked, navigates to the `actionTarget` URL. Max length: 512 characters.\n */\n actionTitle?: string;\n /**\n * Where to navigate to when the `actionTitle` text is clicked.\n */\n actionTarget?: Notifications.ActionTarget;\n /**\n * Contributor that will receive the notifications, based on their assigned roles.\n * One of:\n *\n * + `\"All_Contributors\"`: All site contributors, including the site owner.\n * + `\"Owner\"`: Only the site owner.\n */\n recipients?: Notifications.SiteContributors;\n };\n /**\n * An object containing information about which contributors will receive a notification.\n */\n type SiteContributors = {\n /**\n * Roles to receive the notification.\n * One of:\n *\n * + `\"All_Contributors\"`: All site contributors (default).\n * + `\"Owner\"`: Only the site owner.\n */\n role?: string;\n };\n }\n /**\n * **Deprecated.**\n * The Tasks submodule will continue to work, but a newer version is\n * available at [wix-crm.v2.Tasks](https://www.wix.com/velo/reference/wix-crm-v2/tasks/introduction).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Tasks.html#)\n */\n namespace Tasks {\n /**\n * An object representing a task.\n */\n type Task = {\n /**\n * Unique task identifier.\n */\n _id: string;\n /**\n * Task title.\n */\n title: string;\n /**\n * Date the task is due.\n */\n dueDate: Date;\n /**\n * Unique identifier of the site contact\n * that this task is linked to.\n */\n contactId: string;\n /**\n * Indicates whether the task has been\n * completed.\n */\n isCompleted: boolean;\n /**\n * Running task version number. Each time an\n * action is performed on a task its version number is incremented.\n */\n version: number;\n /**\n * Type of the task's creator. `\"USER\"`\n * if the task was created using the site's dashboard. `\"APP\"` if the task was\n * created using the [`createTask()`](#createTask) function or if it was created\n * by an app installed on the site.\n */\n creatorType: string;\n /**\n * When `creatorType` is `\"USER\"`, the unique\n * identifier of the user that created the task in the dashboard. Otherwise, `userId` is not\n * present.\n */\n userId?: string;\n /**\n * When `creatorType` is `\"APP\"`, the unique\n * identifier of the application that created the task. Otherwise, `applicationId` is not\n * present.\n */\n applicationId?: string;\n };\n /**\n * An object representing information for creating or updating a task.\n */\n type TaskInfo = {\n /**\n * Task title.\n */\n title?: string;\n /**\n * Date the task is due.\n */\n dueDate?: Date;\n /**\n * Unique identifier of the site contact\n * that this task is linked to.\n */\n contactId?: string;\n };\n }\n /**\n * The Triggered Emails API is used to send triggered emails to your site's contacts and members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.TriggeredEmails.html#)\n */\n namespace TriggeredEmails {\n type TriggeredEmailOptions = {\n /**\n * An object with `key:value` pairs. Each\n * `key` is a variable in the email template created in Triggered Emails, and its\n * corresponding `value` is the value to insert into the template in place of the\n * variable. The values must be strings.\n *\n * Example: `{ firstName: 'John', lastName: 'Doe' }`\n */\n variables: any;\n };\n }\n /**\n * **Deprecated.**\n * The Workflows API will be discontinued in the upcoming months. Our team is\n * working to provide alternatives, and we'll provide timely updates before\n * implementing any changes. We understand that this transition might present challenges,\n * and we appreciate your patience and understanding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-crm-backend.Workflows.html#)\n */\n namespace Workflows {\n /**\n * An object containing card information.\n */\n type Card = {\n /**\n * Unique card identifier.\n */\n id: string;\n /**\n * Name of the card.\n */\n name?: string;\n /**\n * Source that created the card.\n *\n * Some possible values:\n *\n * + `\"Contacts\"`\n * + `\"Velo\"`\n * + `\"Inbox\"`\n * + `\"Invoices\"`\n * + `\"Marketplace\"`\n * + `\"Price Quotes\"`\n * + `\"Wix Forms\"`\n */\n source: string;\n /**\n * ID of the contact associated with the card.\n */\n contactId: string;\n /**\n * Date the card was created.\n */\n createdDate: Date;\n /**\n * Date the card was last updated.\n */\n updatedDate: Date;\n /**\n * ID of the phase which contains the card.\n */\n phaseId: string;\n };\n /**\n * An object containing a list of cards and pagination info.\n */\n type CardList = {\n /**\n * List of cards matching the list options.\n */\n items: Workflows.Card[];\n /**\n * Number of items in the current results page.\n */\n length: number;\n /**\n * Total number of cards in the specified workflow and phase.\n */\n totalCount: number;\n /**\n * Number of items returned per page with the current list options.\n */\n pageSize: number;\n /**\n * Total number of results pages.\n */\n totalPages: number;\n /**\n * Index of the current page. Indices are zero-based.\n */\n currentPage: number;\n };\n type CreateCardRequest = {\n /**\n * Name of the card.\n */\n name?: string;\n /**\n * ID of the contact associated with the card.\n */\n contactId: string;\n };\n type CreatePhaseRequest = {\n /**\n * Name of the phase.\n */\n name: string;\n };\n type CreateWorkflowRequest = {\n /**\n * Name of the workflow.\n */\n name: string;\n /**\n * Workflow description.\n */\n description?: string;\n };\n /**\n * An object contains ListCards request data.\n */\n type ListCardOptions = {\n /**\n * ID of phase to retrieve cards from. If omitted, will retrieve cards from all phases. Not to be used with `fetchOnlyArchived`.\n */\n phaseId?: string;\n /**\n * Whether to retrieve only archived cards. Not to be used with `phaseId`.\n */\n fetchOnlyArchived?: boolean;\n /**\n * Maximum number of cards to retrieve. Defaults to `50`.\n */\n limit?: number;\n /**\n * Number of cards to skip before the retrieved items. Defaults to `0`.\n */\n skip?: number;\n /**\n * Ordering options.\n */\n order?: Workflows.OrderOptions;\n };\n /**\n * An object containing options used when requesting a list of workflows or phases.\n */\n type ListOptions = {\n /**\n * Maximum number of items to retrieve. Defaults to `50` for phases and `100` for workflows.\n */\n limit?: number;\n /**\n * Number of items to skip before the retrieved items. Defaults to `0`.\n */\n skip?: number;\n /**\n * Ordering options.\n */\n order?: Workflows.OrderOptions;\n };\n /**\n * An object containing information used when moving a card.\n */\n type MoveCardOptions = {\n /**\n * ID of the phase to move the card to. If omitted, the card remains in the same phase.\n */\n newPhaseId?: string;\n /**\n * Position within the phase to move the card to. If omitted, the card is moved to the top of the phase.\n */\n newPosition?: number;\n };\n /**\n * An object containing information used when moving a phase.\n */\n type MovePhaseOptions = {\n /**\n * ID of the workflow to move the phase to.\n */\n workflowId: string;\n /**\n * Position within the workflow to move the phase to.\n */\n newPosition: number;\n };\n /**\n * An object containing sort order options.\n */\n type OrderOptions = {\n /**\n * Field to sort on.\n */\n field?: string;\n /**\n * Order of sort. Either `\"asc\"` or `\"desc\"` (defaults to `\"asc\"`).\n */\n sort?: string;\n };\n /**\n * An object containing phase information.\n */\n type Phase = {\n /**\n * Unique phase identifier.\n */\n id: string;\n /**\n * Name of the phase.\n */\n name: string;\n };\n /**\n * An object containing a list of phases and pagination info.\n */\n type PhaseList = {\n /**\n * List of phases matching the list options.\n */\n items: Workflows.Phase[];\n /**\n * Number of items in the current results page.\n */\n length: number;\n /**\n * Total number of phases in the specified workflow.\n */\n totalCount: number;\n /**\n * Number of items returned per page with the current list options.\n */\n pageSize: number;\n /**\n * Total number of results pages.\n */\n totalPages: number;\n /**\n * Index of the current page. Indices are zero-based.\n */\n currentPage: number;\n };\n type UpdateCardRequest = {\n /**\n * Name of the card.\n */\n name?: string;\n /**\n * Source that created the card.\n *\n * Some possible values:\n *\n * + `\"Contacts\"`\n * + `\"Velo\"`\n * + `\"Inbox\"`\n * + `\"Invoices\"`\n * + `\"Marketplace\"`\n * + `\"Price Quotes\"`\n * + `\"Wix Forms\"`\n */\n source: string;\n /**\n * ID of the contact associated with the card.\n */\n contactId: string;\n /**\n * ID of the phase which contains the card.\n */\n phaseId: string;\n };\n type UpdatePhaseRequest = {\n /**\n * Name of the phase.\n */\n name: string;\n };\n type UpdateWorkflowRequest = {\n /**\n * Name of the workflow.\n */\n name?: string;\n /**\n * Workflow description.\n */\n description?: string;\n };\n /**\n * An object representing a workflow.\n */\n type Workflow = {\n /**\n * Workflow information.\n */\n workflowInfo: Workflows.WorkflowInfo;\n /**\n * ID of the win phase.\n */\n winPhaseId: string;\n };\n /**\n * An object containing information about a workflow.\n */\n type WorkflowInfo = {\n /**\n * Unique workflow identifier.\n */\n id: string;\n /**\n * Name of the workflow.\n */\n name: string;\n /**\n * Workflow description.\n */\n description?: string;\n /**\n * Date the workflow was created.\n */\n createdDate?: Date;\n };\n /**\n * An object containing a list of workflows and pagination info.\n */\n type WorkflowList = {\n /**\n * List of workflows matching the list options.\n */\n items: Workflows.WorkflowInfo[];\n /**\n * Number of items in the current results page.\n */\n length: number;\n /**\n * Total number of workflows in the site.\n */\n totalCount: number;\n /**\n * Number of items returned per page with the current list options.\n */\n pageSize: number;\n /**\n * Total number of results pages.\n */\n totalPages: number;\n /**\n * Index of the current page. Indices are zero-based.\n */\n currentPage: number;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-data.d.ts", "content": "/**\n * The wix-data module contains functionality for working with data in collections.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#)\n */\ndeclare module 'wix-data' {\n /**\n * Creates an aggregation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#aggregate)\n */\n function aggregate(collectionId: string): WixDataAggregate;\n /**\n * Adds a number of items to a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#bulkInsert)\n */\n function bulkInsert(collectionId: string, items: any[], options?: WixDataOptions): Promise;\n /**\n * Removes a number of items from a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#bulkRemove)\n */\n function bulkRemove(collectionId: string, itemIds: string[], options?: WixDataOptions): Promise;\n /**\n * Inserts or updates a number of items in a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#bulkSave)\n */\n function bulkSave(collectionId: string, items: any[], options?: WixDataOptions): Promise;\n /**\n * Updates a number of items in a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#bulkUpdate)\n */\n function bulkUpdate(collectionId: string, items: any[], options?: WixDataOptions): Promise;\n /**\n * Creates a filter to be used with datasets and aggregations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#filter)\n */\n function filter(): WixDataFilter;\n /**\n * Retrieves an item from a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#get)\n */\n function get(collectionId: string, itemId: string, options?: WixDataOptions): Promise;\n /**\n * Adds an item to a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#insert)\n */\n function insert(collectionId: string, item: any, options?: WixDataOptions): Promise;\n /**\n * Inserts a reference in the specified property.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#insertReference)\n */\n function insertReference(collectionId: string, propertyName: string, referringItem: any | string, referencedItem: any | string | any[] | string[], options?: WixDataOptions): Promise;\n /**\n * Checks if a reference to the referenced item exists in the specified\n * property of the referring item.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#isReferenced)\n */\n function isReferenced(collectionId: string, propertyName: string, referringItem: any | string, referencedItem: any | string, options?: WixDataOptions): Promise;\n /**\n * Creates a query for retrieving items from a database collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#query)\n */\n function query(collectionId: string): WixDataQuery;\n /**\n * Gets the full items referenced in the specified property.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#queryReferenced)\n */\n function queryReferenced(collectionId: string, item: any | string, propertyName: string, options?: WixDataQueryReferencedOptions): Promise;\n /**\n * Removes an item from a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#remove)\n */\n function remove(collectionId: string, itemId: string, options?: WixDataOptions): Promise;\n /**\n * Removes a reference from the specified property.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#removeReference)\n */\n function removeReference(collectionId: string, propertyName: string, referringItem: any | string, referencedItem: any | string | any[] | string[], options?: WixDataOptions): Promise;\n /**\n * Replaces current references with references in the specified property.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#replaceReferences)\n */\n function replaceReferences(collectionId: string, propertyName: string, referringItem: any | string, referencedItem: any | string | any[] | string[], options?: WixDataOptions): Promise;\n /**\n * Inserts or updates an item in a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#save)\n */\n function save(collectionId: string, item: any, options?: WixDataOptions): Promise;\n /**\n * Creates a sort to be used with the dataset `setSort()` function.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#sort)\n */\n function sort(): WixDataSort;\n /**\n * Removes all items from a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#truncate)\n */\n function truncate(collectionId: string, options?: WixDataOptions): Promise;\n /**\n * Updates an item in a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.html#update)\n */\n function update(collectionId: string, item: any, options?: WixDataOptions): Promise;\n /**\n * An object returned by the `bulkRemove()` function.\n */\n type WixDataBulkRemoveResult = {\n /**\n * The number of removed items.\n */\n removed: number;\n /**\n * The number of skipped items.\n */\n skipped: number;\n /**\n * List of IDs of removed items.\n */\n removedItemIds: string[];\n /**\n * List of errors.\n */\n errors: Error[];\n };\n /**\n * An object returned by Wix Data bulk operations.\n */\n type WixDataBulkResult = {\n /**\n * The number of inserted items.\n */\n inserted: number;\n /**\n * The number of updated items.\n */\n updated: number;\n /**\n * The number of skipped items.\n */\n skipped: number;\n /**\n * List of IDs of inserted items.\n */\n insertedItemIds: string[];\n /**\n * List of IDs of updated items.\n */\n updatedItemIds: string[];\n /**\n * List of errors.\n */\n errors: Error[];\n };\n /**\n * An object that you pass as the `options` parameter that modifies how an operation is performed.\n */\n type WixDataOptions = {\n /**\n * Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation. Defaults to `false`. Can only be used in backend code.\n */\n suppressAuth?: boolean;\n /**\n * Prevents [hooks](https://support.wix.com/en/article/wix-code-how-to-use-data-hooks) from running for the operation. Can only be used in backend code.\n */\n suppressHooks?: boolean;\n /**\n * Optional filters specific to querying [Wix Stores Products Collection Fields](https://support.wix.com/en/article/velo-wix-stores-products-collection-fields).\n */\n appOptions?: WixStoresProductQuery;\n /**\n * When `true`, reads data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * See [Wix Data and Eventual Consistency](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_wix-data-and-eventual-consistency) for more information.\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n };\n /**\n * An object that you pass as the `options` parameter that modifies how an operation is performed.\n */\n type WixDataQueryOptions = {\n /**\n * Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation. Defaults to `false`. Can only be used in backend code.\n */\n suppressAuth?: boolean;\n /**\n * Prevents [hooks](https://support.wix.com/en/article/wix-code-how-to-use-data-hooks) from running for the operation. Can only be used in backend code.\n */\n suppressHooks?: boolean;\n /**\n * When `true`, reads data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * See [Wix Data and Eventual Consistency](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_wix-data-and-eventual-consistency) for more information.\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n /**\n * When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query.\n * This speeds up the query.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n /**\n * Optional filters specific to querying [Wix Stores Products Collection Fields](https://support.wix.com/en/article/velo-wix-stores-products-collection-fields).\n */\n appOptions?: WixStoresProductQuery;\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n * If not provided, result text is not translated.\n */\n language?: string;\n };\n /**\n * An object for controlling the order of returned referenced items.\n */\n type WixDataQueryReferencedOptions = {\n /**\n * Order of the returned referenced items. Sorted by the date each item was referenced.\n *\n * Supported values:\n * - `'asc'`: Ascending\n * - `'desc'`: Descending\n */\n order?: string;\n /**\n * Prevents [permission](https://support.wix.com/en/article/about-collection-permissions) checks from running for the operation. Defaults to `false`. Can only be used in backend code.\n */\n suppressAuth?: boolean;\n /**\n * When `true`, reads data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * See [Wix Data and Eventual Consistency](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_wix-data-and-eventual-consistency) for more information.\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n /**\n * When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query.\n * This speeds up the query.\n *\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n /**\n * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n * > **Note:** The `_id` system field is always returned.\n */\n fields?: string[];\n };\n /**\n * An object that you pass as the `options.appOptions` parameter that allows for Wix Stores/Products query specificity.\n */\n type WixStoresProductQuery = {\n /**\n * Whether to include product variants in the query. Default is `false`.\n */\n includeVariants?: boolean;\n /**\n * Whether to include [hidden products](https://support.wix.com/en/article/wix-stores-changing-the-visibility-of-a-product) in the query. Default is `false`.\n */\n includeHiddenProducts?: boolean;\n };\n /**\n * Hooks that can be added to wix-data operations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#)\n */\n interface Hooks {\n /**\n * A hook triggered after an aggregation operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterAggregate)\n */\n afterAggregate(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered after a `count()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterCount)\n */\n afterCount(count: number, context: Hooks.HookContext): Promise & number;\n /**\n * A hook triggered after a distinct query operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterDistinct)\n */\n afterDistinct(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered after a `get()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterGet)\n */\n afterGet(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered after an `insert()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterInsert)\n */\n afterInsert(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered after a `find` operation, for each of the items in the query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterQuery)\n */\n afterQuery(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered after a `remove()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterRemove)\n */\n afterRemove(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered after an `update()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#afterUpdate)\n */\n afterUpdate(item: any, context: Hooks.UpdateHookContext): Promise & any;\n /**\n * A hook triggered before an aggregation operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeAggregate)\n */\n beforeAggregate(aggregate: WixDataAggregate, context: Hooks.HookContext): Promise & WixDataAggregate;\n /**\n * A hook that is triggered before a `count()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeCount)\n */\n beforeCount(query: WixDataQuery, context: Hooks.HookContext): Promise & WixDataQuery;\n /**\n * A hook triggered before a distinct query operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeDistinct)\n */\n beforeDistinct(distinctQuery: WixDataDistinct, context: Hooks.HookContext): Promise & WixDataDistinct;\n /**\n * A hook that is triggered before a `get()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeGet)\n */\n beforeGet(itemId: string, context: Hooks.HookContext): Promise & string;\n /**\n * A hook that is triggered before an `insert()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeInsert)\n */\n beforeInsert(item: any, context: Hooks.HookContext): Promise & any;\n /**\n * A hook that is triggered before a `find()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeQuery)\n */\n beforeQuery(query: WixDataQuery, context: Hooks.HookContext): Promise & WixDataQuery;\n /**\n * A hook that is called before a `remove()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeRemove)\n */\n beforeRemove(itemId: string, context: Hooks.UpdateHookContext): Promise & string;\n /**\n * A hook that is triggered before an `update()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#beforeUpdate)\n */\n beforeUpdate(item: any, context: Hooks.UpdateHookContext): Promise & any;\n /**\n * A hook that is triggered on any error or rejected Promise from any of the wix-data operations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#onFailure)\n */\n onFailure(error: Error, context: Hooks.HookContext): Promise;\n }\n /**\n * Provides functionality for performing aggregations on collection data.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#)\n */\n interface WixDataAggregate {\n /**\n * Adds a sort to an aggregation, sorting by the items or groups by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#ascending)\n */\n ascending(...propertyName: string[]): WixDataAggregate;\n /**\n * Refines a `WixDataAggregate` to only contain the average value from each aggregation group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#avg)\n */\n avg(propertyName: string, projectedName?: string): WixDataAggregate;\n /**\n * Refines a `WixDataAggregate` to contain the item count of each group in the aggregation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#count)\n */\n count(): WixDataAggregate;\n /**\n * Adds a sort to an aggregation, sorting by the items or groups by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#descending)\n */\n descending(...propertyName: string[]): WixDataAggregate;\n /**\n * Filters out items from being used in an aggregation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#filter)\n */\n filter(filter: WixDataFilter): WixDataAggregate;\n /**\n * Groups items together in an aggregation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#group)\n */\n group(...propertyName: string[]): WixDataAggregate;\n /**\n * Filters out groups from being returned from an aggregation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#having)\n */\n having(filter: WixDataFilter): WixDataAggregate;\n /**\n * Limits the number of items or groups the aggregation returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#limit)\n */\n limit(limit: number): WixDataAggregate;\n /**\n * Refines a `WixDataAggregate` to only contain the maximum value from each aggregation group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#max)\n */\n max(propertyName: string, projectedName?: string): WixDataAggregate;\n /**\n * Refines a `WixDataAggregate` to only contain the minimum value from each aggregation group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#min)\n */\n min(propertyName: string, projectedName?: string): WixDataAggregate;\n /**\n * Runs the aggregation and returns the results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#run)\n */\n run(options?: WixDataAggregate.RunOptions): Promise;\n /**\n * Sets the number of items or groups to skip before returning aggregation results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#skip)\n */\n skip(skip: number): WixDataAggregate;\n /**\n * Refines a `WixDataAggregate` to contain the sum from each aggregation group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#sum)\n */\n sum(propertyName: string, projectedName?: string): WixDataAggregate;\n }\n /**\n * The results of an aggregation, containing the aggregated values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregateResult.html#)\n */\n interface WixDataAggregateResult {\n /**\n * Gets the aggregated values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregateResult.html#items)\n */\n readonly items: any[];\n /**\n * Returns the number of values in the aggregate results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregateResult.html#length)\n */\n readonly length: number;\n /**\n * Indicates if the aggregation has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregateResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Retrieves the next page of aggregate results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregateResult.html#next)\n */\n next(): Promise;\n }\n /**\n * Provides functionality for refining a distinct data query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#)\n */\n interface WixDataDistinct extends WixDataFilter {\n /**\n * Sorts the results of the distinct query in ascending order by the distinct property.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#ascending)\n */\n ascending(): WixDataDistinct;\n /**\n * Sorts the results of the distinct query by the distinct property in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#descending)\n */\n descending(): WixDataDistinct;\n /**\n * Sets the filter used to refine the distinct query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#filter)\n */\n filter(filter: WixDataFilter): WixDataDistinct;\n /**\n * Returns the filter used to refine the distinct query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#getFilter)\n */\n getFilter(): WixDataFilter;\n /**\n * Returns the name of the property used to define the distinct query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#getPropertyName)\n */\n getPropertyName(): string;\n /**\n * Whether the results of the distinct query are sorted by the distinct property in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#isAscending)\n */\n isAscending(): boolean;\n /**\n * Whether the results of the distinct query are sorted by the distinct property in descending order\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#isDescending)\n */\n isDescending(): boolean;\n /**\n * Limits the number of items the distinct query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#limit)\n */\n limit(limit: number): WixDataDistinct;\n /**\n * Specifies the property name by which to return distinct values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#propertyName)\n */\n propertyName(newPropertyName: string): WixDataDistinct;\n /**\n * Skips the specified number of items before returning the distinct query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataDistinct.html#skip)\n */\n skip(skip: number): WixDataDistinct;\n }\n /**\n * Provides functionality for refining a filter.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#)\n */\n interface WixDataFilter {\n /**\n * Adds an `and` condition to the query or filter.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#and)\n */\n and(query: WixDataQuery): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value is within a specified range.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#between)\n */\n between(propertyName: string, rangeStart: string | number | Date, rangeEnd: string | number | Date): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value contains a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#contains)\n */\n contains(propertyName: string, string: string): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value ends with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#endsWith)\n */\n endsWith(propertyName: string, string: string): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#eq)\n */\n eq(propertyName: string, value: any): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#ge)\n */\n ge(propertyName: string, value: string | number | Date): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#gt)\n */\n gt(propertyName: string, value: string | number | Date): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property values equals all of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#hasAll)\n */\n hasAll(propertyName: string, value: string | number | Date | any[]): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value equals any of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#hasSome)\n */\n hasSome(propertyName: string, value: string | number | Date | any[]): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property does not exist or does not have any value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#isEmpty)\n */\n isEmpty(propertyName: string): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property has any value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#isNotEmpty)\n */\n isNotEmpty(propertyName: string): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#le)\n */\n le(propertyName: string, value: string | number | Date): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#lt)\n */\n lt(propertyName: string, value: string | number | Date): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#ne)\n */\n ne(propertyName: string, value: any): WixDataQuery;\n /**\n * Adds a `not` condition to the query or filter.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#not)\n */\n not(query: WixDataQuery): WixDataQuery;\n /**\n * Adds an `or` condition to the query or filter.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#or)\n */\n or(query: WixDataQuery): WixDataQuery;\n /**\n * Refines a query or filter to match items whose specified property value starts with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataFilter.html#startsWith)\n */\n startsWith(propertyName: string, string: string): WixDataQuery;\n }\n /**\n * Contains functionality for refining a data query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#)\n */\n interface WixDataQuery extends WixDataFilter {\n /**\n * Adds a sort to a query or sort, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#ascending)\n */\n ascending(...propertyName: string[]): WixDataQuery;\n /**\n * Returns the number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#count)\n */\n count(options?: WixDataOptions): Promise;\n /**\n * Adds a sort to a query or sort, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#descending)\n */\n descending(...propertyName: string[]): WixDataQuery;\n /**\n * Returns the distinct values that match the query, without duplicates.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#distinct)\n */\n distinct(propertyName: string, options?: WixDataQueryOptions): Promise;\n /**\n * Lists the fields to return in a query's results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#fields)\n */\n fields(...propertyName: string[]): WixDataQuery;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#find)\n */\n find(options?: WixDataQueryOptions): Promise;\n /**\n * Includes referenced items for the specified properties in a query's results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#include)\n */\n include(...propertyName: string[]): WixDataQuery;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#limit)\n */\n limit(limit: number): WixDataQuery;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQuery.html#skip)\n */\n skip(skip: number): WixDataQuery;\n }\n /**\n * The results of a data reference query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#)\n */\n interface WixDataQueryReferencedResult {\n /**\n * Returns the items that match the reference query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#items)\n */\n readonly items: any[];\n /**\n * Returns the total number of items that match the reference query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Indicates if the reference query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if the reference query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of reference query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of reference query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryReferencedResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * The results of a data query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#)\n */\n interface WixDataQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#items)\n */\n readonly items: any[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Indicates if referenced items have been trimmed from the results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#partialIncludes)\n */\n readonly partialIncludes: boolean;\n /**\n * Returns the query used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#query)\n */\n readonly query: WixDataQuery;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Provides functionality for sorting a query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataSort.html#)\n */\n interface WixDataSort {\n /**\n * Adds a sort to a query or sort, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataSort.html#ascending)\n */\n ascending(...propertyName: string[]): WixDataQuery;\n /**\n * Adds a sort to a query or sort, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataSort.html#descending)\n */\n descending(...propertyName: string[]): WixDataQuery;\n }\n /**\n * Hooks that can be added to wix-data operations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.Hooks.html#)\n */\n namespace Hooks {\n /**\n * An object that contains contextual information about the hook being called.\n */\n type HookContext = {\n /**\n * ID of the collection affected by the hook.\n */\n collectionName: string;\n /**\n * ID of the user currently logged in to the site. If no user is logged in, this property might be `null`.\n */\n userId: string;\n /**\n * User's permissions role: `anonymous`, `siteMember`, or `siteOwner`.\n */\n userRole: string;\n };\n /**\n * An object that contains contextual information when calling the `beforeUpdate()`, `beforeRemove()`, or `afterUpdate()` hooks.\n */\n type UpdateHookContext = {\n /**\n * ID of the collection affected by the hook.\n */\n collectionName: string;\n /**\n * ID of the user currently logged in to the site. If no user is logged in, this property might be `null`.\n */\n userId: string;\n /**\n * User's permissions role: `anonymous`, `siteMember`, or `siteOwner`.\n */\n userRole: string;\n /**\n * Item currently stored in the collection, before it is updated or deleted.\n */\n currentItem: any;\n };\n }\n /**\n * Provides functionality for performing aggregations on collection data.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data.WixDataAggregate.html#)\n */\n namespace WixDataAggregate {\n /**\n * Options to use when running an aggregation.\n */\n type RunOptions = {\n /**\n * When `true`, prevents permission checks from running for the `run()` operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n /**\n * When `true`, reads data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * See [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n * If not provided, result text is not translated.\n */\n language?: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-data-hooks.d.ts", "content": "/**\n * Hooks that can be added to wix-data operations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#)\n */\ndeclare module 'wix-data-hooks' {\n import wixData from 'wix-data';\n /**\n * A hook triggered after an aggregation operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterAggregate)\n */\n function afterAggregate(item: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered after a `count()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterCount)\n */\n function afterCount(count: number, context: HookContext): Promise & number;\n /**\n * A hook triggered after a distinct query operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterDistinct)\n */\n function afterDistinct(value: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered after a `get()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterGet)\n */\n function afterGet(item: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered after an `insert()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterInsert)\n */\n function afterInsert(item: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered after a `find` operation, for each of the items in the query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterQuery)\n */\n function afterQuery(item: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered after a `remove()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterRemove)\n */\n function afterRemove(item: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered after an `update()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#afterUpdate)\n */\n function afterUpdate(item: any, context: UpdateHookContext): Promise & any;\n /**\n * A hook triggered before an aggregation operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeAggregate)\n */\n function beforeAggregate(aggregate: wixData.WixDataAggregate, context: HookContext): Promise & wixData.WixDataAggregate;\n /**\n * A hook that is triggered before a `count()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeCount)\n */\n function beforeCount(query: wixData.WixDataQuery, context: HookContext): Promise & wixData.WixDataQuery;\n /**\n * A hook triggered before a distinct query operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeDistinct)\n */\n function beforeDistinct(distinct: wixData.WixDataDistinct, context: HookContext): Promise & wixData.WixDataDistinct;\n /**\n * A hook that is triggered before a `get()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeGet)\n */\n function beforeGet(itemId: string, context: HookContext): Promise & string;\n /**\n * A hook that is triggered before an `insert()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeInsert)\n */\n function beforeInsert(item: any, context: HookContext): Promise & any;\n /**\n * A hook that is triggered before a `find()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeQuery)\n */\n function beforeQuery(query: wixData.WixDataQuery, context: HookContext): Promise & wixData.WixDataQuery;\n /**\n * A hook that is called before a `remove()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeRemove)\n */\n function beforeRemove(itemId: string, context: UpdateHookContext): Promise & string;\n /**\n * A hook that is triggered before an `update()` operation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#beforeUpdate)\n */\n function beforeUpdate(item: any, context: UpdateHookContext): Promise & any;\n /**\n * A hook that is triggered on any error or rejected Promise from any of the wix-data operations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-data-hooks.html#onFailure)\n */\n function onFailure(error: Error, context: HookContext): Promise;\n /**\n * An object that contains contextual information about the hook being called.\n */\n type HookContext = {\n /**\n * The ID of the collection the hook affects.\n */\n collectionName: string;\n /**\n * The current site user ID. If no user is logged in to the site it may be null.\n */\n userId: string;\n /**\n * The permissions role of the current user. Possibilities are: `anonymous`, `siteMember`, and `siteOwner`.\n */\n userRole: string;\n };\n /**\n * An object that contains contextual information when calling the `beforeUpdate()`, `beforeRemove()`, or `afterUpdate()` hooks.\n */\n type UpdateHookContext = {\n /**\n * The ID of the collection the hook affects.\n */\n collectionName: string;\n /**\n * The current site user ID. If no user is logged in to the site it may be null.\n */\n userId: string;\n /**\n * The permissions role of the current user. Possibilities are: `anonymous`, `siteMember`, and `siteOwner`.\n */\n userRole: string;\n /**\n * The item stored in the database collection before an update or delete operation.\n */\n currentItem: any;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-editor.d.ts", "content": "/**\n * The wix-editor module contains functionality for working with the site editor from a [Blocks Panel](https://support.wix.com/en/article/creating-custom-panels-for-your-widgets-action-bar-buttons) code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#)\n */\ndeclare module 'wix-editor' {\n /**\n * Gets the viewport currently selected in the Editor.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#getCurrentViewport)\n */\n function getCurrentViewport(): Promise;\n /**\n * Gets the `wix-editor` module scoped of an [inner (nested) widget](https://support.wix.com/en/article/wix-blocks-creating-and-managing-widgets-within-widgets).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#getScopedWixEditor)\n */\n function getScopedWixEditor(Selector: string): Promise;\n /**\n * Checks if an element is removed from the widget.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#isRemoved)\n */\n function isRemoved(selector: string): Promise;\n /**\n * Gets a list of all removed widget elements.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#listRemovedElements)\n */\n function listRemovedElements(): Promise;\n /**\n * Opens the [Dashboard](https://support.wix.com/en/article/about-your-wix-dashboard) for the current site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#openDashboardPanel)\n */\n function openDashboardPanel(options: DashboardOptions): Promise;\n /**\n * Removes a widget element from the stage.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#removeElement)\n */\n function removeElement(selector: string): Promise;\n /**\n * Restores (shows) a widget element on the stage.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-editor.html#restoreElement)\n */\n function restoreElement(selector: string): Promise;\n /**\n * An object representing the Dashboard parameters.\n */\n type DashboardOptions = {\n /**\n * The relative URL to open in the Business Manager.\n */\n url: string;\n };\n /**\n * An object representing the current viewport.\n */\n type Viewport = {\n /**\n * Type of viewport (`DESKTOP`, `MOBILE`, or `TABLET`)\n */\n type: string;\n /**\n * object representing the current viewport's range.\n */\n An: viewportRange;\n };\n /**\n * An object representing the current viewport's range.\n */\n type viewportRange = {\n /**\n * Minimum range in pixels for the current viewport.\n */\n minWidth: number;\n /**\n * Maximum range in pixels for the current viewport.\n */\n maxWidth: number;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-events-backend.d.ts", "content": "/**\n * The wix-events-backend module contains functionality for working with\n * your site's [Wix events](https://support.wix.com/en/article/about-wix-events).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.html#)\n */\ndeclare module 'wix-events-backend' {\n /**\n * The Events API provides functionality for updating and managing events created in the Wix Events app or using this Wix Events API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.html#wixEvents)\n */\n const wixEvents: WixEvents;\n /**\n * Backend events that are fired from Wix events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#)\n */\n interface Events {\n /**\n * A backend event that fires when a Wix event is canceled.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventCanceled)\n */\n onEventCanceled(event: Events.CanceledEvent): void;\n /**\n * A backend event that fires when a Wix event is created or copied.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventCreated)\n */\n onEventCreated(event: Events.CreatedEvent): void;\n /**\n * A backend event that fires when a Wix event is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventDeleted)\n */\n onEventDeleted(event: Events.DeletedEvent): void;\n /**\n * A backend event that fires when a Wix event ends.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventEnded)\n */\n onEventEnded(event: Events.EndedEvent): void;\n /**\n * A backend event that fires when a Wix event's reminders are sent.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventReminder)\n */\n onEventReminder(event: Events.EventReminder): void;\n /**\n * A backend event that fires when a Wix event starts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventStarted)\n */\n onEventStarted(event: Events.StartedEvent): void;\n /**\n * A backend event that fires when an existing Wix event is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onEventUpdated)\n */\n onEventUpdated(event: Events.UpdatedEvent): void;\n /**\n * A backend event that fires when a ticket order is confirmed.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onOrderConfirmed)\n */\n onOrderConfirmed(event: Events.OrderConfirmedEvent): void;\n /**\n * A backend event that fires when a ticket order is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onOrderDeleted)\n */\n onOrderDeleted(event: Events.OrderDeletedEvent): void;\n /**\n * A backend event that fires when a ticket order is initiated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onOrderInitiated)\n */\n onOrderInitiated(event: Events.OrderInitiatedEvent): void;\n /**\n * A backend event that fires when a ticket order is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onOrderUpdated)\n */\n onOrderUpdated(event: Events.OrderUpdatedEvent): void;\n /**\n * A backend event that fires when a ticket reservation is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onReservationCreated)\n */\n onReservationCreated(event: Events.ReservationCreatedEvent): void;\n /**\n * A backend event that fires when a ticket reservation is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onReservationUpdated)\n */\n onReservationUpdated(event: Events.ReservationUpdatedEvent): void;\n /**\n * A backend event that fires when a guest registers to a Wix event.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onRsvpCreated)\n */\n onRsvpCreated(event: Events.RsvpCreatedEvent): void;\n /**\n * A backend event that fires when an RSVP is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onRsvpDeleted)\n */\n onRsvpDeleted(event: Events.RsvpDeletedEvent): void;\n /**\n * A backend event that fires when an RSVP is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onRsvpUpdated)\n */\n onRsvpUpdated(event: Events.RsvpUpdatedEvent): void;\n /**\n * A backend event that fires when a ticket definition is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onTicketDefinitionCreated)\n */\n onTicketDefinitionCreated(event: Events.TicketDefinitionCreatedEvent): void;\n /**\n * A backend event that fires when a ticket definition is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onTicketDefinitionDeleted)\n */\n onTicketDefinitionDeleted(event: Events.TicketDefinitionDeletedEvent): void;\n /**\n * A backend event that fires when a ticket definition is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onTicketDefinitionUpdated)\n */\n onTicketDefinitionUpdated(event: Events.TicketDefinitionUpdatedEvent): void;\n /**\n * A backend event that fires when a Wix event is canceled.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#onWixEventCanceled)\n */\n onWixEventCanceled(event: Events.CanceledWixEvent): void;\n }\n /**\n * The Wix Events API provides functionality for creating, updating, and managing Wix events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#)\n */\n interface WixEvents {\n /**\n * Cancels a Wix event and closes its registration.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#cancelEvent)\n */\n cancelEvent(eventId: string): Promise;\n /**\n * Copies a Wix event.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#copyEvent)\n */\n copyEvent(eventId: string): Promise;\n /**\n * Creates a Wix event.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#createEvent)\n */\n createEvent(eventInfo: WixEvents.WixEventInfo, options: WixEvents.WixEventInfoOptions): Promise;\n /**\n * Deletes a Wix event.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#deleteEvent)\n */\n deleteEvent(eventId: string): Promise;\n /**\n * Retrieves a Wix event by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#getEvent)\n */\n getEvent(eventId: string): Promise;\n /**\n * Creates a query to retrieve a list of Wix events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#queryEvents)\n */\n queryEvents(): WixEvents.EventsQueryBuilder;\n /**\n * Updates a Wix event.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#updateEvent)\n */\n updateEvent(eventId: string, eventInfo: WixEvents.WixEventUpdateInfo, options: WixEvents.WixEventInfoOptions): Promise;\n }\n /**\n * Backend events that are fired from Wix events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a Wix event that was canceled.\n */\n type CanceledEvent = {\n /**\n * Time the event was canceled.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Event title.\n */\n title: string;\n };\n /**\n * An object representing a Wix event that was canceled.\n */\n type CanceledWixEvent = {\n /**\n * Time the event was canceled.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Event title.\n */\n title: string;\n };\n /**\n * An object representing guest check-in.\n */\n type CheckIn = {\n /**\n * Time guest was checked-in.\n */\n created: Date;\n };\n /**\n * An object representing the Wix event that was created or copied.\n */\n type CreatedEvent = {\n /**\n * Time the event was created/copied.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Event title.\n */\n title: string;\n /**\n * Event location.\n */\n location: Events.Location;\n /**\n * Event's schedule configuration.\n */\n scheduleConfig: Events.ScheduleConfiguration;\n /**\n * ID of the user who created/copied the event.\n */\n userId: string;\n };\n /**\n * An object representing a Wix event that was deleted.\n */\n type DeletedEvent = {\n /**\n * Time the event was deleted.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Event title.\n */\n title: string;\n };\n /**\n * An object representing an applied discount.\n */\n type Discount = {\n /**\n * Discount amount.\n */\n amount: Events.Money;\n /**\n * Amount after discount.\n */\n afterDiscount: Events.Money;\n /**\n * Discount items.\n */\n discounts: Events.DiscountItem[];\n };\n /**\n * An object representing a coupon discount.\n */\n type DiscountCoupon = {\n /**\n * Coupon name.\n */\n name: string;\n /**\n * Coupon code.\n */\n code: string;\n /**\n * Coupon ID.\n */\n couponId: string;\n };\n /**\n * An object representing an applied discount of specific type.\n */\n type DiscountItem = {\n /**\n * Discount amount.\n */\n amount: Events.Money;\n /**\n * Discount coupon.\n */\n coupon?: Events.DiscountCoupon;\n /**\n * Pricing plan discount.\n */\n paidPlan?: Events.PricingPlanDiscount;\n };\n /**\n * An object representing the event that has ended.\n */\n type EndedEvent = {\n /**\n * Time the event ended.\n */\n timestamp: Date;\n /**\n * The ID of the event.\n */\n eventId: string;\n };\n /**\n * An object representing the Wix event that reminders have been sent for.\n */\n type EventReminder = {\n /**\n * Time the reminder was sent.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Event location.\n */\n location: Events.Location;\n /**\n * Event's schedule configuration.\n */\n scheduleConfig: Events.ScheduleConfiguration;\n /**\n * Event title.\n */\n title: string;\n /**\n * ID of the user who created the event.\n */\n userId: string;\n /**\n * The time between now and the event start.\n */\n startsIn: Events.TimeDuration;\n };\n /**\n * An object representing an applied fee.\n */\n type Fee = {\n /**\n * Fee name. Value is `\"WIX_FEE\"`: Wix service fee applied to the item.\n */\n name: string;\n /**\n * Fee calculation method.\n * One of:\n *\n * + `\"FEE_ADDED\"`: Fee is added to the ticket price at checkout.\n * + `\"FEE_INCLUDED\"`: Seller absorbs the fee. It is deducted from the ticket price.\n */\n type: string;\n /**\n * Rate percentage. Possible values are between `\"0.01\"` and `\"100\"`, using up to 2 decimal places.\n */\n rate: string;\n /**\n * Total amount of fee charges.\n */\n amount: Events.Money;\n };\n /**\n * An object representing a submitted guest form.\n */\n type FormResponse = {\n /**\n * Values that were entered in the guest form.\n */\n inputValues: Events.InputValue[];\n };\n /**\n * An object representing a guest of a Wix event's RSVP.\n */\n type Guest = {\n /**\n * Index of the guest in the RSVP guest list. Indices are zero-based.\n */\n index: number;\n /**\n * Guest ID, which is unique within the RSVP.\n */\n id: number;\n /**\n * Full name of the guest.\n */\n fullName: string;\n };\n /**\n * An object representing a guest form input value.\n */\n type InputValue = {\n /**\n * Name of the form input.\n */\n inputName: string;\n /**\n * Value of the form input, when there is just one value.\n */\n value: string;\n /**\n * Values of the form input, when there are multiple values.\n */\n values: string[];\n };\n /**\n * An object representing an order invoice.\n */\n type Invoice = {\n /**\n * Invoice items.\n */\n items: Events.InvoiceItem[];\n /**\n * Invoice applied discount.\n */\n discount?: Events.Discount;\n /**\n * Invoice applied tax.\n */\n tax?: Events.Tax;\n /**\n * Invoice applied fee charges.\n */\n fees: Events.Fee[];\n /**\n * Invoice total amount before discount, tax, and fees.\n */\n subTotal: Events.Money;\n /**\n * Invoice total amount after discount, tax, and fees.\n * Grand total is calculated in the following manner:\n *\n * 1. Total price of all items in the cart.\n * 2. Discount is subtracted from the cart (if applicable).\n * 3. Tax is added (if applicable).\n * 4. Wix service fee is added.\n */\n grandTotal: Events.Money;\n /**\n * Total revenue with taxes, excluding fees. Payment provider fees are not deducted.\n */\n revenue: Events.Money;\n };\n /**\n * An object representing an order invoice item.\n */\n type InvoiceItem = {\n /**\n * Invoice item ID.\n */\n id: string;\n /**\n * Invoice item quantity.\n */\n quantity: number;\n /**\n * Invoice item name.\n */\n name: string;\n /**\n * Invoice item price.\n */\n price: Events.Money;\n /**\n * Invoice item total.\n */\n total: Events.Money;\n /**\n * Invoice item applied discount.\n */\n discount?: Events.Discount;\n /**\n * Invoice item applied tax.\n */\n tax?: Events.Tax;\n /**\n * Invoice item applied fee charges.\n */\n fees: Events.Fee[];\n };\n /**\n * An object representing the Wix event location.\n */\n type Location = {\n /**\n * Location name. Maximum allowed characters is 50.\n */\n name: string;\n /**\n * The location's map coordinates.\n */\n coordinates: Events.MapCoordinates;\n /**\n * Single line address representation of the location.\n */\n address: string;\n /**\n * Type of location.\n * One of:\n *\n * + `\"VENUE\"`: Event is hosted in the venue.\n * + `\"ONLINE\"`: Event is hosted online.\n */\n type: string;\n };\n /**\n * An object representing an event location's coordinates.\n */\n type MapCoordinates = {\n /**\n * Latitude.\n */\n lat: number;\n /**\n * Longitude.\n */\n lng: number;\n };\n /**\n * An object representing money.\n */\n type Money = {\n /**\n * Decimal amount.\n */\n amount: string;\n /**\n * Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, `USD`).\n */\n currency: string;\n };\n /**\n * An object representing the confirmed order.\n */\n type OrderConfirmedEvent = {\n /**\n * Time order was confirmed.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Unique order number.\n */\n orderNumber: string;\n /**\n * Contact ID associated with this order.\n */\n contactId?: string;\n /**\n * Member ID associated with this order.\n */\n memberId?: string;\n /**\n * Time order was created.\n */\n created: Date;\n /**\n * Buyer first name.\n */\n firstName: string;\n /**\n * Buyer last name.\n */\n lastName: string;\n /**\n * Buyer email.\n */\n email: string;\n /**\n * Checkout form response.\n */\n checkoutForm: Events.FormResponse;\n /**\n * Order status.\n * One of:\n *\n * + `\"FREE\"`: Order is confirmed, no payment required.\n * + `\"PENDING\"`: Order was paid, but the payment provider suspended the payment. Eventually changes to `\"PAID\"`.\n * + `\"PAID\"`: Order paid using the payment provider.\n * + `\"OFFLINE_PENDING\"`: Order confirmed, but has to be paid offline and status needs to be manually updated to `\"PAID\"`.\n * + `\"INITIATED\"`: Order is awaiting payment.\n */\n status: string;\n /**\n * Payment method used. For example, \"payPal\" or \"creditCard\".\n */\n method: string;\n /**\n * Order invoice.\n */\n invoice: Events.Invoice;\n /**\n * Tickets generated after payment.\n */\n tickets: Events.Ticket[];\n };\n /**\n * An object representing the deleted ticket order.\n */\n type OrderDeletedEvent = {\n /**\n * Time order was deleted.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Unique order number.\n */\n orderNumber: string;\n /**\n * Contact ID associated with this order.\n */\n contactId?: string;\n /**\n * Member ID associated with this order.\n */\n memberId?: string;\n /**\n * Whether the order was anonymized by a GDPR delete.\n */\n anonymized: boolean;\n /**\n * Order type.\n * One of:\n *\n * + `\"UNASSIGNED_TICKETS\"`: Buyer form is used for all tickets.\n * + `\"ASSIGNED_TICKETS\"`: Each order ticket has its own form.\n */\n orderType: string;\n };\n /**\n * An object representing the initiated order.\n */\n type OrderInitiatedEvent = {\n /**\n * Time order was initiated.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Unique order number.\n */\n orderNumber: string;\n /**\n * Contact ID associated with this order.\n */\n contactId?: string;\n /**\n * Member ID associated with this order.\n */\n memberId?: string;\n /**\n * Buyer first name.\n */\n firstName: string;\n /**\n * Buyer last name.\n */\n lastName: string;\n /**\n * Buyer email.\n */\n email: string;\n /**\n * Checkout form response.\n */\n checkoutForm: Events.FormResponse;\n /**\n * Order status.\n * One of:\n *\n * + `\"FREE\"`: Order is confirmed, no payment required.\n * + `\"PENDING\"`: Order was paid, but the payment provider suspended the payment. Eventually changes to `\"PAID\"`.\n * + `\"PAID\"`: Order paid using the payment provider.\n * + `\"OFFLINE_PENDING\"`: Order confirmed, but has to be paid offline and status needs to be manually updated to `\"PAID\"`.\n * + `\"INITIATED\"`: Order is awaiting payment.\n */\n status: string;\n /**\n * Order invoice.\n */\n invoice: Events.Invoice;\n };\n /**\n * An object representing the updated order.\n */\n type OrderUpdatedEvent = {\n /**\n * Time order was updated.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Unique order number.\n */\n orderNumber: string;\n /**\n * Contact ID associated with this order.\n */\n contactId?: string;\n /**\n * Member ID associated with this order.\n */\n memberId?: string;\n /**\n * Time order was created.\n */\n created: Date;\n /**\n * Buyer first name.\n */\n firstName: string;\n /**\n * Buyer last name.\n */\n lastName: string;\n /**\n * Buyer email.\n */\n email: string;\n /**\n * Checkout form response.\n */\n checkoutForm: Events.FormResponse;\n /**\n * Whether the order is confirmed An order gets confirmed\n * when the payment gateway processes the payment and the funds reach the merchant's account.\n */\n confirmed: boolean;\n /**\n * Order status.\n * One of:\n *\n * + `\"FREE\"`: Order is confirmed, no payment required.\n * + `\"PENDING\"`: Order was paid, but the payment provider suspended the payment. Eventually changes to `\"PAID\"`.\n * + `\"PAID\"`: Order paid using the payment provider.\n * + `\"OFFLINE_PENDING\"`: Order confirmed, but has to be paid offline and status needs to be manually updated to `\"PAID\"`.\n * + `\"INITIATED\"`: Order is awaiting payment.\n */\n status: string;\n /**\n * Payment method used. For example, \"payPal\" or \"creditCard\".\n */\n method: string;\n /**\n * Whether the order is archived.\n */\n archived: boolean;\n /**\n * Tickets generated after payment.\n */\n tickets: Events.Ticket[];\n };\n /**\n * An object representing a fixed rate discount.\n */\n type PercentDiscount = {\n /**\n * Discount rate percentage. Possible values are between `\"0.01\"` and `\"100\"`, using up to 2 decimal places.\n */\n rate: string;\n /**\n * Number of discounted items.\n */\n quantityDiscounted: number;\n };\n /**\n * An object representing a pricing plan discount.\n */\n type PricingPlanDiscount = {\n /**\n * Pricing plan name.\n */\n name: string;\n /**\n * Percentage applied discount.\n */\n percentDiscount?: Events.PercentDiscount;\n };\n /**\n * An object representing the created ticket reservation.\n */\n type ReservationCreatedEvent = {\n /**\n * Time tickets were reserved.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Reservation ID. Can be used to retrieve an invoice.\n */\n reservationId: string;\n /**\n * Time reservation expires.\n */\n expires: Date;\n /**\n * Reservation status.\n * One of:\n *\n * + `\"RESERVATION_PENDING\"`: Reservation is pending confirmation. It will expire after expiration due time.\n * + `\"RESERVATION_CONFIRMED\"`: Reservation was confirmed and will not expire.\n * + `\"RESERVATION_CANCELED\"`: Reservation was canceled because of non payment.\n * + `\"RESERVATION_CANCELED_MANUALLY\"`: Reservation was canceled manually by the buyer.\n */\n status: string;\n };\n /**\n * An object representing the updated reservation.\n */\n type ReservationUpdatedEvent = {\n /**\n * Time tickets were reserved.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Reservation ID. Can be used to retrieve an invoice.\n */\n reservationId: string;\n /**\n * Reservation status.\n * One of:\n *\n * + `\"RESERVATION_PENDING\"`: Reservation is pending confirmation. It will expire after expiration due time.\n * + `\"RESERVATION_CONFIRMED\"`: Reservation was confirmed and will not expire.\n * + `\"RESERVATION_CANCELED\"`: Reservation was canceled because of non payment.\n * + `\"RESERVATION_CANCELED_MANUALLY\"`: Reservation was canceled manually by the buyer.\n */\n status: string;\n };\n /**\n * An object representing the created RSVP.\n */\n type RsvpCreatedEvent = {\n /**\n * Time the RSVP was created.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * RSVP ID.\n */\n rsvpId: string;\n /**\n * Contact ID associated with the RSVP.\n */\n contactId: string;\n /**\n * Member ID associated with the RSVP.\n */\n memberId?: string;\n /**\n * RSVP response status.\n * One of:\n *\n * + `\"YES\"`: Guest is attending.\n * + `\"NO\"`: Guest is not attending.\n * + `\"WAITING\"`: Guest added to the wait list.\n */\n status: string;\n /**\n * Guest first name.\n */\n firstName: string;\n /**\n * Guest last name.\n */\n lastName: string;\n /**\n * Guest email address.\n */\n email: string;\n /**\n * RSVP form response.\n */\n rsvpForm: Events.FormResponse;\n /**\n * List of guests.\n */\n guests: Events.Guest[];\n };\n /**\n * An object representing the deleted RSVP.\n */\n type RsvpDeletedEvent = {\n /**\n * Time RSVP was deleted.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * RSVP ID.\n */\n rsvpId: string;\n /**\n * Contact ID associated with this RSVP.\n */\n contactId: string;\n /**\n * Member ID associated with this RSVP.\n */\n memberId?: string;\n /**\n * Whether the RSVP was anonymized as a result of a GDPR delete.\n */\n anonymized: boolean;\n };\n /**\n * An object representing the updated RSVP.\n */\n type RsvpUpdatedEvent = {\n /**\n * Time the RSVP was updated.\n */\n timestamp: Date;\n /**\n * Time the RSVP was created.\n */\n created: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * RSVP ID.\n */\n rsvpId: string;\n /**\n * Contact ID associated with this RSVP.\n */\n contactId: string;\n /**\n * Member ID associated with this RSVP.\n */\n memberId?: string;\n /**\n * RSVP response status.\n * One of:\n *\n * + `\"YES\"`: Guest is attending.\n * + `\"NO\"`: Guest is not attending.\n * + `\"WAITING\"`: Guest added to the wait list.\n */\n status: string;\n /**\n * Guest first name.\n */\n firstName: string;\n /**\n * Guest last name.\n */\n lastName: string;\n /**\n * Guest email.\n */\n email: string;\n /**\n * RSVP form response.\n */\n rsvpForm: Events.FormResponse;\n /**\n * List of guests.\n */\n guests: Events.Guest[];\n };\n /**\n * An object representing an event's schedule configuration.\n */\n type ScheduleConfiguration = {\n /**\n * Whether the event's schedule is to be determined later.\n *\n * If an event's time is not yet decided, the TBD message is displayed instead of the\n * start date and end date.\n *\n * When `scheduleTbd` is `true`, `startDate`, `endDate`, and `timeZoneId` are not required.\n */\n scheduleTbd: boolean;\n /**\n * Schedule TBD message.\n */\n scheduleTbdMessage?: string;\n /**\n * Event start date.\n */\n startDate?: Date;\n /**\n * Event end date.\n */\n endDate?: Date;\n /**\n * ID of the time zone for the Wix event in [tz database format](https://en.wikipedia.org/wiki/Tz_database), such as `EST`, or `America/Los_Angeles`. Optional for TBD events.\n */\n timeZoneId?: string;\n };\n /**\n * An object representing the event that has started.\n */\n type StartedEvent = {\n /**\n * Time the event started.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n };\n /**\n * An object representing an applied tax.\n */\n type Tax = {\n /**\n * Tax type.\n * One of:\n *\n * + `\"INCLUDED\"`: Tax is included in the ticket price.\n * + `\"ADDED\"`: Tax is added to the order at checkout.\n */\n type: string;\n /**\n * Tax name.\n */\n name: string;\n /**\n * Rate percentage. Possible values are between `\"0.01\"` and `\"100\"`, using up to 2 decimal places.\n */\n rate: string;\n /**\n * Taxable amount.\n */\n taxable: Events.Money;\n /**\n * Total tax amount.\n */\n amount: Events.Money;\n };\n /**\n * An object representing a generated ticket.\n */\n type Ticket = {\n /**\n * Unique ticket number.\n */\n ticketNumber: string;\n /**\n * Ticket definition ID.\n */\n ticketDefinitionId: string;\n /**\n * Ticket check-in.\n */\n checkIn: Events.CheckIn;\n /**\n * Whether the ticket is archived.\n */\n archived: boolean;\n /**\n * Whether the ticket is confirmed.\n */\n confirmed: boolean;\n /**\n * Guest first name.\n */\n firstName?: string;\n /**\n * Guest last name.\n */\n lastName?: string;\n /**\n * Guest email address.\n */\n email?: string;\n /**\n * Contact ID associated with this ticket.\n */\n contactId?: string;\n /**\n * Member ID associated with this ticket.\n */\n memberId?: string;\n /**\n * Ticket form response. Only assigned tickets contain a separate form.\n */\n form?: Events.FormResponse;\n };\n /**\n * An object representing the created ticket definition.\n */\n type TicketDefinitionCreatedEvent = {\n /**\n * Time ticket definition was created.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Ticket definition ID.\n */\n ticketDefinitionId: string;\n };\n /**\n * An object representing the deleted ticket definition.\n */\n type TicketDefinitionDeletedEvent = {\n /**\n * Time ticket definition was deleted.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Ticket definition ID.\n */\n ticketDefinitionId: string;\n };\n /**\n * An object representing the updated ticket definition.\n */\n type TicketDefinitionUpdatedEvent = {\n /**\n * Time ticket definition was updated.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Ticket definition ID.\n */\n ticketDefinitionId: string;\n };\n /**\n * An object representing a time duration.\n */\n type TimeDuration = {\n /**\n * Number of days in the time duration.\n */\n days: number;\n /**\n * Number of hours in the time duration.\n */\n hours: number;\n /**\n * Number of minutes in the time duration.\n */\n minutes: number;\n };\n /**\n * An object representing the Wix event that was updated.\n */\n type UpdatedEvent = {\n /**\n * Time the event was updated.\n */\n timestamp: Date;\n /**\n * Event ID.\n */\n eventId: string;\n /**\n * Event title.\n */\n title: string;\n /**\n * Event location.\n */\n location: Events.Location;\n /**\n * Event's schedule configuration.\n */\n scheduleConfig: Events.ScheduleConfiguration;\n /**\n * Whether the schedule configuration was updated.\n */\n scheduleConfigUpdated: boolean;\n };\n }\n /**\n * The Wix Events API provides functionality for creating, updating, and managing Wix events.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.html#)\n */\n namespace WixEvents {\n /**\n * An object representing additional labels for form fields.\n */\n type AdditionalLabel = {\n /**\n * Field name.\n */\n name: string;\n /**\n * Field label.\n */\n label: string;\n };\n /**\n * An object representing a street address for the Wix event.\n */\n type Address = {\n /**\n * Main address line (usually street and number) as free text. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events.\n */\n addressLine1?: string;\n /**\n * Street address object, with number and name in separate fields. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events.\n */\n streetAddress?: WixEvents.StreetAddress;\n /**\n * Human-readable address string. If not provided, the value is generated from the available address data. If provided, the value is parsed and used to populate other address properties.\n */\n formatted: string;\n /**\n * Free text providing more detailed address information, such as apartment, suite, or floor.\n */\n addressLine2: string;\n /**\n * Coordinates of the physical address.\n */\n location: WixEvents.AddressLocation;\n /**\n * City name.\n */\n city: string;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision: string;\n /**\n * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country: string;\n /**\n * Postal or zip code.\n */\n postalCode: string;\n };\n /**\n * An object for updating a street address.\n */\n type AddressInfo = {\n /**\n * Main address line (usually street and number) as free text. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events.\n */\n addressLine1?: string;\n /**\n * Street address object, with number and name in separate fields. For non-TBD events, either `addressLine1` or `streetAddress` must be entered. Optional for TBD events.\n */\n streetAddress?: WixEvents.StreetAddressInfo;\n /**\n * Human-readable address string. If not provided, the value is generated from the available address data. If provided, the value is parsed and used to populate other address properties.\n */\n formatted?: string;\n /**\n * Free text providing more detailed address information, such as apartment, suite, or floor.\n */\n addressLine2?: string;\n /**\n * Coordinates of the physical address.\n */\n location?: WixEvents.AddressLocationInfo;\n /**\n * City name.\n */\n city?: string;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n /**\n * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Postal or zip code.\n */\n postalCode?: string;\n };\n /**\n * An object representing coordinates of the physical address of the Wix event.\n */\n type AddressLocation = {\n /**\n * Address's latitude.\n */\n latitude: number;\n /**\n * Address's longitude.\n */\n longitude: number;\n };\n /**\n * An object for updating coordinates of the physical address of the Wix event.\n */\n type AddressLocationInfo = {\n /**\n * Address's latitude.\n */\n latitude?: number;\n /**\n * Address's longitude.\n */\n longitude?: number;\n };\n /**\n * An object representing the links (URLs) that guests can click to add the Wix event to their calendars.\n */\n type CalendarLinks = {\n /**\n * A URL that guests can use to add the Wix event to their Google calendars.\n */\n google: string;\n /**\n * A URL that guests can use to download ICS calendar files in order to add the Wix event to their calendars.\n */\n ics: string;\n };\n /**\n * An object representing messages on the form for purchasing tickets.\n */\n type CheckoutFormMessages = {\n /**\n * Title for the form for purchasing tickets.\n */\n title: string;\n /**\n * Button label text that directs guests to check out the form when purchasing tickets.\n */\n checkoutLabel: string;\n };\n /**\n * An object representing the ID of a Wix event that was deleted.\n */\n type DeletedWixEvent = {\n /**\n * Deleted event ID.\n */\n _id: string;\n };\n /**\n * An object representing the corresponding registration form for the Wix event.\n */\n type Form = {\n /**\n * A block of fields to group together on the form. For example, you might create a block for first name and last name. These blocks are also called input groups.\n */\n InputGroups: WixEvents.InputGroup[];\n /**\n * Messages you can customize for the form.\n */\n messages: WixEvents.FormMessages;\n };\n /**\n * An object representing a set of configured form messages.\n */\n type FormMessages = {\n /**\n * RSVP form messages.\n */\n rsvp: WixEvents.RsvpFormMessages;\n /**\n * Checkout form messages.\n */\n checkout: WixEvents.CheckoutFormMessages;\n /**\n * Messages to display when event registration is closed.\n */\n registrationClosed: WixEvents.RegistrationClosedMessages;\n };\n /**\n * An object representing the guest list settings for the Wix event.\n */\n type GuestListSettings = {\n /**\n * Whether guests can see other guests attending the Wix event. Defaults to `true`.\n */\n public: boolean;\n };\n /**\n * An object for updating guest list settings for the Wix event.\n */\n type GuestListSettingsInfo = {\n /**\n * Whether guests can see other guests attending the Wix event. Defaults to `true`.\n */\n public?: boolean;\n };\n /**\n * An object representing a field on a form. The field may or may not be included in an `InputGroup` block. Text-type fields can contain one or more values.\n */\n type InputField = {\n /**\n * Field name.\n */\n name: string;\n /**\n * Main field label.\n */\n label: string;\n /**\n * Additional labels for multi-valued fields, such as `ADDRESS` fields.\n */\n additionalLabels: WixEvents.AdditionalLabel[];\n /**\n * Pre-defined text choices for fields, such as the options listed in a dropdown.\n */\n options: string[];\n /**\n * Whether the field is mandatory.\n */\n required: boolean;\n /**\n * Maximum number of characters allowed for the `TEXT` fields.\n */\n maxLength: number;\n /**\n * Type of the field. The type determines the format of the field.\n * This property is used to validate the values entered on the form when submitting. Defaults to `\"TEXT\"`.\n * One of:\n * + `\"TEXT\"`\n * + `\"NUMBER\"`\n * + `\"TEXT_ARRAY\"`\n * + `\"DATE_TIME\"`\n * + `\"ADDRESS\"`\n */\n type: string;\n /**\n * The maximum number of values allowed for `TEXT_ARRAY` fields.\n */\n maxSize: number;\n };\n /**\n * An object representing a block of fields that tend to be grouped together on a form. The block of fields is also called an input group.\n */\n type InputGroup = {\n /**\n * The type of the block of fields. Every field in the block must be of the same type.\n * One of:\n * + `\"INPUT\"`\n * + `\"TEXTAREA\"`\n * + `\"DROPDOWN\"`\n * + `\"RADIO\"`\n * + `\"CHECKBOX\"`\n * + `\"NAME\"`\n * + `\"GUEST_CONTROL\"`. This control corresponds to the `Additional Guests` option when customizing the registration form in the Dashboard. The fields for this block include specifying how many guests, adding text for a comment, and whether the guest name is required.\n * + `\"ADDRESS_SHORT\"`. This control corresponds to the `Single Line` address option when customizing the registration form in the Dashboard, and the `Address.Location.Address.formatted` property in this API.\n * + `\"ADDRESS_FULL\"`. This control corresponds to the `Full Address` address option when customizing the registration form in the Dashboard, and the set of individual address properties (excluding `Address.Location.Address.formatted`) in this API.\n * + `\"DATE\"`\n */\n type: string;\n /**\n * Whether the fields in the input group are mandatory (such as name and email). When `true`, you can change only the label for the fields in the block.\n */\n system: boolean;\n /**\n * Fields in the block. Also called child input fields.\n */\n inputs: WixEvents.InputField[];\n /**\n * Fields in the input group are sorted by this value in ascending order.\n */\n orderIndex: number;\n /**\n * Unique ID for the input group.\n */\n _id: string;\n };\n /**\n * An object representing a Wix event location.\n */\n type Location = {\n /**\n * Location name. `name` is required for TBD events (events whose time is yet \"to be determined\").\n */\n name: string;\n /**\n * Street address for the Wix event.\n *\n * The `address` property contains the full [address](https://www.wix.com/velo/reference/$w/addressinput/value) of the Wix event. The address is derived from the [`formatted`](#formatted) property.\n *\n * The `address` is required for non-TBD events. (TBD events are events whose time is yet \"to be determined.\")\n */\n address: WixEvents.Address;\n /**\n * Location type. Defaults to `\"VENUE\"`.\n * One of:\n * + `\"VENUE\"`. The event is being held at a physical location.\n * + `\"ONLINE\"`. The event is being held at a virtual online location, such as with online conferencing.\n */\n type: string;\n };\n /**\n * An object for updating a Wix event's location.\n */\n type LocationInfo = {\n /**\n * Location name. `name` is required for TBD events (events whose time is yet \"to be determined\").\n */\n name?: string;\n /**\n * Full [address](https://www.wix.com/velo/reference/$w/addressinput/value).\n * The `address` is required for non-TBD events. (TBD events are events whose time is yet \"to be determined.\")\n * You can specify the `address` for non-TBD events in the following ways:\n * + By entering the `address.formatted` property, which the API then uses to populate the other address properties.\n * + By entering the individual `address` properties including the `address.addressLine1` property and, if needed, the `address.addressLine2`property. (Do not specify `address.streetAddress`.) The API uses this data to populate the `address.formatted` property.\n * + By entering the individual `address` properties including `address.streetAddress`. (Do not specify `address.addressLine1`.) The API uses this data to populate the `address.formatted` property.\n */\n address?: WixEvents.AddressInfo;\n /**\n * Location type. Defaults to `\"VENUE\"`.\n * One of:\n * + `\"VENUE\"`. The event is being held at a physical location.\n * + `\"ONLINE\"`. The event is being held at a virtual online location, such as with online conferencing.\n */\n type?: string;\n };\n /**\n * An object representing money and its default monetary format.\n */\n type Money = {\n /**\n * Monetary amount represented as a decimal string with a period as the decimal separator (for example, 3.99).\n */\n value: string;\n /**\n * Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, `USD`).\n */\n currency: string;\n };\n /**\n * An object representing online conferencing details for the Wix event.\n */\n type OnlineConferencing = {\n /**\n * Whether online conferencing is enabled. Not supported for Wix events that are TBDs (events whose time is not yet determined).\n * When enabled, links to join the conference are generated and provided to guests in an email when the guest registers.\n */\n enabled: boolean;\n /**\n * ID of the online conferencing provider.\n */\n providerId: string;\n /**\n * Online conference type. Defaults to `\"MEETING\"`.\n * One of:\n * + `\"MEETING\"`\n * + `\"WEBINAR\"`\n */\n conferenceType: string;\n /**\n * Session details for the Wix event.\n */\n session: WixEvents.Session;\n };\n /**\n * An object for updating online conferencing settings for a Wix event.\n */\n type OnlineConferencingInfo = {\n /**\n * Whether online conferencing is enabled. Not supported for Wix events that are TBDs (events whose time is not yet determined).\n * When enabled, links to join the conference are generated and provided to guests in an email when the guest registers.\n */\n enabled?: boolean;\n /**\n * ID of the online conferencing provider.\n */\n providerId?: string;\n /**\n * Online conference type. Defaults to `\"MEETING\"`.\n * One of:\n * + `\"MEETING\"`\n * + `\"WEBINAR\"`\n */\n conferenceType?: string;\n };\n /**\n * Options to use when performing a query or query count.\n */\n type QueryOptions = {\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * An object representing registration details for the Wix event.\n */\n type Registration = {\n /**\n * Registration URL if registration for the Wix event managed externally. Guests go to this URL to register.\n */\n externalRegistrationUrl: string;\n /**\n * Who can register for the Wix event. Defaults to `\"MEMBER\"`.\n * One of:\n * + `\"MEMBER\"`. Only logged-in guests can register.\n * + `\"VISITOR_OR_MEMBER\"`. Everyone can register, whether they are logged-in to the site or not.\n */\n restrictedTo: string;\n /**\n * Initial event type, set when creating the Wix event.\n * One of:\n * + `\"RSVP\"`. The event is created as an RSVP-type event.\n * + `\"TICKETS\"`. The event is created as a ticketed-type event.\n */\n initialType: string;\n /**\n * Read-only type of the Wix event. After initial event creation, the type can change, for example, if event registration is not necessary (`NO_REGISTRATION`) or if event registration is set to be managed externally (`EXTERNAL`).\n * + `\"RSVP\"`. The event was initially created as an RSVP-type event.\n * + `\"TICKETS\"`. The event was initially created as a ticketed-type event.\n * + `\"EXTERNAL\"`. Registration is managed externally, on a different site. Setting the `externalRegistrationUrl` property updates the `type` to this status.\n * + `\"NO_REGISTRATION\"`. There is no need to register for this site. Setting the `registrationDisabled` property updates the `type` to this status.\n */\n type: string;\n /**\n * Wix event registration status.\n * One of:\n * + `\"CLOSED\"`. The event was closed (for example, if the maximum number of attendees was reached) or cancelled. Guests cannot register.\n * + `\"CLOSED_MANUALLY\"`. Event registration was closed manually by the event manager. Guests cannot register.\n * + `\"OPEN_RSVP\"`. Guests can register for the RSVP-type Wix event.\n * + `\"OPEN_RSVP_WAITLIST\"`. Guests can register for the RSVP-type Wix event, but are waitlisted.\n * + `\"OPEN_TICKETS\"`. Guests can register for the ticketed-type Wix event.\n * + `\"OPEN_EXTERNAL\"`. Guests can register externally for the Wix event--not using Wix Events.\n */\n status: string;\n /**\n * Registration details for an RSVP event.\n */\n rsvp: WixEvents.Rsvp;\n /**\n * Registration details for a ticketed event.\n */\n tickets: WixEvents.Tickets;\n };\n /**\n * An object representing messages to display when Wix event registration is closed.\n */\n type RegistrationClosedMessages = {\n /**\n * Message displayed when event registration is closed.\n */\n message: string;\n /**\n * Button label text that directs guests to take other actions, such as a clicking a link to see other Wix events that they can register for.\n */\n exploreEventsLabel: string;\n };\n /**\n * An object representing RSVP registration settings for a Wix event.\n */\n type Rsvp = {\n /**\n * Whether the Wix event accepts `NO` RSVPs in addition to `YES` RSVPs. Defaults to `\"YES_ONLY\"`.\n * One of:\n * + `\"YES_ONLY\"`\n * + `\"YES_AND_NO\"`\n */\n rsvpStatusOptions: string;\n /**\n * Maximum number of guests allowed to register to the Wix event. If a guest adds additional guests to the same RSVP, the additional guests are also included when calculating the `limit`.\n */\n limit: number;\n /**\n * Whether to open a waitlist when the guest `limit` for the Wix event is reached. Waitlisted guests are assigned a `WAITING` status.\n */\n waitlist: boolean;\n };\n /**\n * An object representing RSVP form messages.\n */\n type RsvpFormMessages = {\n /**\n * Button label text displayed next to where the guest RSVPs `YES`.\n */\n rsvpYes: string;\n /**\n * Button label text displayed next to where the guest RSVPs `NO`.\n */\n rsvpNo: string;\n /**\n * Messages to display when the RSVP is `YES`.\n */\n yesMessages: WixEvents.RsvpFormPositive;\n /**\n * Messages to display when the RSVP is `YES`, even if the guest is placed on the waitlist. Wait-listed guests receive the same messages as guests who are not on the waitlist.\n */\n waitingMessages: WixEvents.RsvpFormPositive;\n /**\n * Messages to display when the RSVP is `NO`.\n */\n noMessages: WixEvents.RsvpFormNegative;\n /**\n * Button label text that directs guests to submit the RSVP form.\n */\n submitRsvpLabel: string;\n };\n /**\n * An object representing a messages to display when the RSVP is `NO`.\n */\n type RsvpFormNegative = {\n /**\n * Form title for negative RSVPs.\n */\n title: string;\n /**\n * Confirmation message title.\n */\n confirmationTitle: string;\n /**\n * Button label text that suggests guests share the Wix event link with others who might want to attend.\n */\n shareLabel: string;\n };\n /**\n * An object representing a messages to display when the RSVP is `YES`.\n */\n type RsvpFormPositive = {\n /**\n * Form title for positive RSVPs.\n */\n title: string;\n /**\n * Confirmation message title.\n */\n confirmationTitle: string;\n /**\n * Confirmation message text.\n */\n confirmationMessage: string;\n /**\n * Button label text that suggests guests add the Wix event to their calendar using the link.\n */\n addToCalendarLabel: string;\n /**\n * Button label text that suggests guests share the Wix event link with others who might want to attend.\n */\n shareLabel: string;\n };\n /**\n * An object for updating RSVP registration settings for a Wix event.\n */\n type RsvpInfo = {\n /**\n * Whether the Wix event accepts `NO` rsvps in addition to `YES` rsvps. Defaults to `\"YES_ONLY\"`.\n * One of:\n * + `\"YES_ONLY\"`\n * + `\"YES_AND_NO\"`\n */\n rsvpStatusOptions?: string;\n /**\n * Maximum number of guests allowed to register to the Wix event. If a guest adds additional guests to the same RSVP, the additional guests are also included when calculating the `limit`.\n */\n limit?: number;\n /**\n * Whether to open a waitlist when the guest `limit` for the Wix event is reached. Waitlisted guests are assigned a `WAITING` status.\n */\n waitlist?: boolean;\n };\n /**\n * An object representing RSVP summary data for the Wix event.\n */\n type RsvpSummary = {\n /**\n * Total number of RSVPs received.\n */\n totalRsvps: number;\n /**\n * Number of accepted RSVPs.\n */\n yesCount: number;\n /**\n * Number of rejected RSVPs.\n */\n noCount: number;\n /**\n * Number of RSVPs in the waitlist.\n */\n waitlistCount: number;\n };\n /**\n * An object representing scheduling settings for a Wix event.\n */\n type Scheduling = {\n /**\n * Whether the event's time is to be determined later. If `true`, the Wix event's schedule is defined as TBD (\"to be determined\").\n * Because the Wix event's start and end dates are not yet defined, a message, set in `tbdMessage`, is displayed instead.\n * `startDate`, `endDate`, and `timeZoneId` are optional for TBD events.\n */\n tbd: boolean;\n /**\n * A message to display for events whose `tbd` property is `true`.\n */\n tbdMessage: string;\n /**\n * Start date and time for the Wix event. Optional for TBD events.\n */\n startDate: Date;\n /**\n * End date and time for the Wix event. Optional for TBD events.\n */\n endDate: Date;\n /**\n * ID of the time zone for the Wix event in [tz database](https://en.wikipedia.org/wiki/Tz_database) format, such as `EST`, or `America/Los_Angeles`. Optional for TBD events.\n */\n timeZoneId: string;\n /**\n * Whether the time zone is displayed in the formatted schedule.\n */\n showTimeZone: boolean;\n /**\n * Formatted schedule representation.\n */\n formatted: string;\n /**\n * Formatted start date of the event (empty for TBD events).\n */\n startDateFormatted: string;\n /**\n * Formatted start time of the event (empty for TBD events).\n */\n startTimeFormatted: string;\n /**\n * Whether the end date is hidden in the formatted schedule.\n */\n hideEndDate: boolean;\n };\n /**\n * An object for updating scheduling settings for a Wix event.\n */\n type SchedulingInfo = {\n /**\n * Whether the event's time is to be determined later. If `true`, the Wix event's schedule is defined as TBD (\"to be determined\").\n * Because the Wix event's start and end dates are not yet defined, a message, set in `tbdMessage`, is displayed instead.\n * `startDate`, `endDate`, and `timeZoneId` are optional for TBD events.\n */\n tbd?: boolean;\n /**\n * A message to display for events whose `tbd` property is `true`.\n */\n tbdMessage?: string;\n /**\n * Start date and time for the Wix event. Optional for TBD (\"to be determined\") events.\n */\n startDate?: Date;\n /**\n * End date and time for the Wix event. Optional for TBD (\"to be determined\") events.\n */\n endDate?: Date;\n /**\n * ID of the time zone for the Wix event in [tz database format](https://en.wikipedia.org/wiki/Tz_database), such as `EST`, or `America/Los_Angeles`. Optional for TBD events.\n */\n timeZoneId?: string;\n /**\n * Whether the time zone is displayed in the formatted schedule.\n */\n showTimeZone?: boolean;\n /**\n * Whether the end date is hidden in the formatted schedule.\n */\n hideEndDate?: boolean;\n };\n /**\n * An object representing a Wix event session, including links and passwords.\n */\n type Session = {\n /**\n * Link for the event host to use to start the online conference session.\n */\n hostLink: string;\n /**\n * Link for the guests to use to join the online conference session.\n */\n guestLink: string;\n /**\n * The password required to join the online conference session (when relevant). Requiring a password is dependent on the online conferencing provider. For example, Zoom provides passwords for its meetings while LiveVideo does not.\n */\n password: string;\n };\n /**\n * An object representing the site URL for the Wix event, including its base URL and path.\n */\n type SiteUrl = {\n /**\n * Base URL.\n * + Premium sites: The domain,for example, `https://domain.com`.\n * + Free sites: The site URL, for example, `https://user_name.wixsite.com/mysite`.\n * > **Note**: The above URL examples are for a published site. When previewing your site, you receive the Editor URL.\n */\n baseUrl: string;\n /**\n * The path to Wix event page, for example, `/my-events/weekly-meetup-2` for both Premium and free sites.\n */\n path: string;\n };\n /**\n * An object representing the Wix event's street address, with number and name in separate fields.\n */\n type StreetAddress = {\n /**\n * Street number.\n */\n number: string;\n /**\n * Street name.\n */\n name: string;\n };\n /**\n * An object for updating the Wix event's street address, with number and name in separate fields.\n */\n type StreetAddressInfo = {\n /**\n * Street number.\n */\n number?: string;\n /**\n * Street name.\n */\n name?: string;\n };\n /**\n * An object representing summary data and statistics for Wix event sales, excluding data pertaining to archived orders.\n */\n type Summaries = {\n /**\n * Summary data for RSVP sales.\n */\n rsvp: WixEvents.RsvpSummary;\n /**\n * Summary data for revenue and tickets sold.\n */\n tickets: WixEvents.TicketsSummary;\n };\n /**\n * An object for updating tax settings for the Wix event.\n */\n type TaxSettingInfo = {\n /**\n * When the tax is applied. Defaults to `\"INCLUDED\"`.\n * One of:\n * + `\"INCLUDED\"`. Tax is built-in to the price.\n * + `\"ADDED_AT_CHECKOUT\"`. Tax is added when the guest checks out.\n */\n type?: string;\n /**\n * Tax name.\n */\n name?: string;\n /**\n * Tax rate, such as `21.55`.\n */\n rate?: string;\n };\n /**\n * An object representing tax settings for the Wix event.\n */\n type TaxSettings = {\n /**\n * When the tax is applied. Defaults to `\"INCLUDED\"`.\n * One of:\n * + `\"INCLUDED\"`. Tax is built-in to the price.\n * + `\"ADDED_AT_CHECKOUT\"`. Tax is added when the guest checks out.\n */\n type: string;\n /**\n * Tax name.\n */\n name: string;\n /**\n * Tax rate, such as `21.55`.\n */\n rate: string;\n };\n /**\n * An object representing tickets settings for the Wix event.\n */\n type Tickets = {\n /**\n * Currency used for event ordering and transactions.\n */\n currency: string;\n /**\n * When ordering, whether each ticket in the order needs its own order form or if one form covers multiple tickets.\n */\n formAssignedPerTicket: boolean;\n /**\n * Tax settings.\n */\n tax: WixEvents.TaxSettings;\n /**\n * Price of the lowest-priced ticket.\n */\n lowestTicketPrice: WixEvents.Money;\n /**\n * Price of the lowest-priced ticket.\n */\n highestTicketPrice: WixEvents.Money;\n /**\n * Formatted price of the lowest-priced ticket.\n */\n lowestTicketPriceFormatted: string;\n /**\n * Formatted price of the highest-priced ticket.\n */\n highestTicketPriceFormatted: string;\n };\n /**\n * An object for updating tickets settings for the Wix event.\n */\n type TicketsInfo = {\n /**\n * When ordering, whether each ticket in the order needs its own order form or if one form covers multiple tickets.\n */\n formAssignedPerTicket?: boolean;\n /**\n * Tax settings.\n */\n tax?: WixEvents.TaxSettingInfo;\n };\n /**\n * An object representing a summary of the Wix event's revenue and tickets sold.\n */\n type TicketsSummary = {\n /**\n * Total number of tickets sold.\n */\n totalTickets: number;\n /**\n * Total revenue, including taxes and excluding fees. Payment provider fees are not deducted.\n */\n revenue: WixEvents.Money;\n /**\n * Whether currency cannot be changed. The currency is locked after the first order for the event has been created and is set to the currency of that first order.\n */\n currencyLocked: boolean;\n /**\n * Total number of orders placed for the Wix event.\n */\n totalOrders: number;\n /**\n * Total sales balance for confirmed transactions.\n */\n totalSales: WixEvents.Money;\n };\n /**\n * An object representing a Wix event.\n */\n type WixEvent = {\n /**\n * Wix event ID.\n */\n _id: string;\n /**\n * Wix event location details.\n */\n location: WixEvents.Location;\n /**\n * Wix event scheduling details.\n */\n scheduling: WixEvents.Scheduling;\n /**\n * Wix event title.\n */\n title: string;\n /**\n * Wix event description.\n */\n description: string;\n /**\n * Rich-text (HTML) content for the \"About Event\" section.\n */\n about: string;\n /**\n * The location of an image that represents the Wix event. This image is printed on the ticket (PDF format). The image file must be an image file from the Media Manager.\n *\n * The URL format is:\n * `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n */\n mainImage: string;\n /**\n * URL-friendly version of the Wix event title. Unique across all Wix events in the same site.\n */\n slug: string;\n /**\n * [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the Wix event. Use to translate content on forms, and so on.\n */\n language: string;\n /**\n * Date the Wix event was created.\n */\n _createdDate: Date;\n /**\n * Date the Wix event was updated.\n */\n _updatedDate: Date;\n /**\n * Wix event status. Defaults to `\"SCHEDULED\"`.\n * One of:\n * + `\"SCHEDULED\"`. The upcoming Wix event is scheduled but has not yet started.\n * + `\"STARTED\"`. The Wix event has started and is in progress.\n * + `\"ENDED\"`. The Wix event has ended.\n * + `\"CANCELED\"`. The Wix event has been canceled.\n */\n status: string;\n /**\n * Registration details for the Wix event.\n */\n registration: WixEvents.Registration;\n /**\n * \"Add to calendar\" URLs.\n */\n calendarLinks: WixEvents.CalendarLinks;\n /**\n * Event page URL components.\n */\n eventUrl: WixEvents.SiteUrl;\n /**\n * Registration form for the site guest to fill out with their contact details, and other information, as relevant.\n */\n form: WixEvents.Form;\n /**\n * Summaries of Wix event sales.\n */\n summary: WixEvents.Summaries;\n /**\n * Guest list settings for the Wix event.\n */\n guestList: WixEvents.GuestListSettings;\n /**\n * ID of the creator of the Wix event. If the creator is not logged in when creating the event, the `createdBy` property is empty.\n */\n createdBy: string;\n /**\n * Online conferencing details for the Wix event.\n */\n videoConferencing: WixEvents.OnlineConferencing;\n /**\n * The \"Filter by:\" drop-down option for filtering contacts by this event\n * in the Dashboard's [Contact List page](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F8f93447d-7521-4aa1-8c64-4d5a4f025d3f%2Fcontacts%2F%3FreferralInfo%3Dsidebar).\n * This read-only property is automatically populated to comprise a \"custom\" prefix, the title of the event, and other suffixes added for uniqueness. Note that even if\n * the title of an event is updated, the `assignedContactsLabel` does not change.\n */\n assignedContactsLabel: string;\n };\n /**\n * An object for creating a Wix event.\n */\n type WixEventInfo = {\n /**\n * Wix event title.\n */\n title?: string;\n /**\n * Wix event description.\n */\n description?: string;\n /**\n * The location of an image that represents the Wix event. This image is printed on the ticket (PDF format). The image file must be an image file from the Media Manager.\n *\n * The URL format is:\n * `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n */\n mainImage?: string;\n /**\n * Wix event registration settings.\n */\n registration?: WixEvents.WixEventRegistrationInfo;\n /**\n * Wix event guest list settings.\n */\n guestList?: WixEvents.GuestListSettingsInfo;\n /**\n * Rich-text (HTML) content for the \"About Event\" section.\n */\n about?: string;\n /**\n * Wix event online conferencing settings.\n */\n videoConferencing?: WixEvents.OnlineConferencingInfo;\n /**\n * Wix event location settings.\n * `location.address` is required for non-TBD events.\n * `location.name` is required for TBD events.\n * (TBD events are events whose times are yet \"to be determined.\")\n */\n location: WixEvents.LocationInfo;\n /**\n * Wix event scheduling settings.\n */\n scheduling: WixEvents.SchedulingInfo;\n };\n /**\n * An object for updating registration options for a Wix event.\n */\n type WixEventInfoOptions = {\n /**\n * Content language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * Used for translating tickets' PDF labels, registration forms, automatic emails, and so on.\n * Supported languages: `ar`, `bg`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`, `hi`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `uk`, `zh`.\n * Defaults to `en`.\n */\n language?: string;\n };\n /**\n * An object for updating registration settings for the Wix event.\n */\n type WixEventRegistrationInfo = {\n /**\n * Registration URL, if registration for the Wix event is managed externally. Guests go to this URL to register. Setting this property changes the read-only `registration.type` property to `EXTERNAL`.\n */\n externalRegistrationUrl?: string;\n /**\n * Whether to temporarily suspend (pause) registration. For example, you might want to pause registration temporarily if you need to change venues to allow for more attendees.\n */\n registrationPaused?: boolean;\n /**\n * Who can register to the Wix event. Defaults to `\"MEMBER\"`.\n * One of:\n * + `\"MEMBER\"`. Only logged-in guests can register.\n * + `\"VISITOR_OR_MEMBER\"`. Everyone can register, whether they are logged-in to the site or not.\n */\n restrictedTo?: string;\n /**\n * Whether to disable registration. For example, you might want to disable registration if you will not have enough supplies on-hand for more attendees. Setting to `true` changes the read-only `registration.type` property to `NO_REGISTRATION`.\n */\n registrationDisabled?: boolean;\n /**\n * Registration settings for the RSVP Wix event.\n */\n rsvp?: WixEvents.RsvpInfo;\n /**\n * Event type. Only RSVP and TICKETS are allowed when creating an event (`initialType`), however after initial event\n * creation the `type` can be changed to other values.\n * One of:\n * + `\"RSVP\"`. The Wix event is an RSVP event. It cannot be changed to a ticketed event.\n * + `\"TICKETS\"`. The Wix event is a ticketed event. It cannot be changed to an RSVP event.\n * + `\"EXTERNAL\"`. If you created a guest list before setting up external registration, the current guest list remains but is likely to be\n * incomplete. So when sending out messages to the Wix-managed guest list, not all\n * guests will receive them. Messages should be sent from the external registration system\n * to the complete guest list.\n * You can change the value back at any point if you no longer want the event to be managed externally.\n * + `\"NO_REGISTRATION\"`. No registration is necessary for the event.\n */\n type?: string;\n /**\n * Registration settings for the ticketed Wix event.\n */\n tickets?: WixEvents.TicketsInfo;\n };\n /**\n * An object for updating a Wix event.\n */\n type WixEventUpdateInfo = {\n /**\n * Wix event title.\n */\n title?: string;\n /**\n * Wix event description.\n */\n description?: string;\n /**\n * Wix event location settings.\n * Address is required for non-TBD events.\n * Location name is required for TBD events.\n * (TBD events are events whose times are yet \"to be determined.\")\n */\n location?: WixEvents.LocationInfo;\n /**\n * Wix event scheduling settings.\n */\n scheduling?: WixEvents.SchedulingInfo;\n /**\n * The location of an image that represents the Wix event. This image is printed on the ticket (PDF format). The image file must be an image file from the Media Manager.\n *\n * The URL format is:\n * `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n */\n mainImage?: string;\n /**\n * Wix event registration settings.\n */\n registration?: WixEvents.WixEventRegistrationInfo;\n /**\n * Wix event guest list settings.\n */\n guestList?: WixEvents.GuestListSettingsInfo;\n /**\n * Rich-text (HTML) content for the \"About Event\" section.\n */\n about?: string;\n /**\n * Wix event online conferencing settings.\n */\n videoConferencing?: WixEvents.OnlineConferencingInfo;\n };\n /**\n * Contains functionality for refining a Wix events query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#)\n */\n interface EventsQueryBuilder {\n /**\n * Adds an `and` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#and)\n */\n and(query: WixEvents.EventsQueryBuilder): WixEvents.EventsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value contains a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#contains)\n */\n contains(propertyName: string, value: string): WixEvents.EventsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): WixEvents.EventsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#find)\n */\n find(options?: WixEvents.QueryOptions): Promise;\n /**\n * Refines a query to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#ge)\n */\n ge(propertyName: string, value: string | number | Date): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#gt)\n */\n gt(propertyName: string, value: string | number | Date): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, values: string[]): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#le)\n */\n le(propertyName: string, value: string | number | Date): WixEvents.EventsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#limit)\n */\n limit(limit: string): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#lt)\n */\n lt(propertyName: string, value: string | number | Date): WixEvents.EventsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): WixEvents.EventsQueryBuilder;\n /**\n * Adds an `not` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#not)\n */\n not(query: WixEvents.EventsQueryBuilder): WixEvents.EventsQueryBuilder;\n /**\n * Adds an `or` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#or)\n */\n or(query: WixEvents.EventsQueryBuilder): WixEvents.EventsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#skip)\n */\n skip(skip: string): WixEvents.EventsQueryBuilder;\n }\n /**\n * The results of a Wix events query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#)\n */\n interface EventsQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#items)\n */\n readonly items: WixEvents.WixEvent[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Contains functionality for refining a Wix events query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#query)\n */\n readonly query: WixEvents.EventsQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a Wix events query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryBuilder.html#)\n */\n namespace EventsQueryBuilder {\n }\n /**\n * The results of a Wix events query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-events-backend.WixEvents.EventsQueryResult.html#)\n */\n namespace EventsQueryResult {\n }\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-forum-backend.d.ts", "content": "/**\n * The wix-forum-backend module contains functionality for working with\n * your site's [forum](https://support.wix.com/en/article/wix-forum-about-wix-forum).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.html#)\n */\ndeclare module 'wix-forum-backend' {\n /**\n * Events that are fired from a Wix Forum.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#)\n */\n interface Events {\n /**\n * A backend event that fires when a new forum category is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCategoryCreated)\n */\n onCategoryCreated(event: Events.CreatedCategory): void;\n /**\n * A backend event that fires when a forum category is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCategoryDeleted)\n */\n onCategoryDeleted(event: Events.DeletedCategory): void;\n /**\n * A backend event that fires when a forum category is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCategoryUpdated)\n */\n onCategoryUpdated(event: Events.UpdatedCategory): void;\n /**\n * A backend event that fires when a new forum comment is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentCreated)\n */\n onCommentCreated(event: Events.CreatedComment): void;\n /**\n * A backend event that fires when a forum comment is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentDeleted)\n */\n onCommentDeleted(event: Events.DeletedComment): void;\n /**\n * A backend event that fires when a forum comment is downvoted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentDownvoted)\n */\n onCommentDownvoted(event: Events.DownvotedComment): void;\n /**\n * A backend event that fires when a forum comment is liked.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentLiked)\n */\n onCommentLiked(event: Events.LikedComment): void;\n /**\n * A backend event that fires when a forum comment is marked as best.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentMarkedAsBest)\n */\n onCommentMarkedAsBest(event: Events.MarkedAsBestComment): void;\n /**\n * A backend event that fires when a forum comment is reported.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentReported)\n */\n onCommentReported(event: Events.ReportedComment): void;\n /**\n * A backend event that fires when a forum comment is unliked.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentUnliked)\n */\n onCommentUnliked(event: Events.UnlikedComment): void;\n /**\n * A backend event that fires when a forum comment is unmarked as best.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentUnmarkedAsBest)\n */\n onCommentUnmarkedAsBest(event: Events.UnmarkedAsBestComment): void;\n /**\n * A backend event that fires when a vote is removed from a forum comment.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentUnvoted)\n */\n onCommentUnvoted(event: Events.UnvotedComment): void;\n /**\n * A backend event that fires when a forum comment is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentUpdated)\n */\n onCommentUpdated(event: Events.UpdatedComment): void;\n /**\n * A backend event that fires when a forum comment is upvoted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onCommentUpvoted)\n */\n onCommentUpvoted(event: Events.UpvotedComment): void;\n /**\n * A backend event that fires when a forum post is closed.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostClosed)\n */\n onPostClosed(event: Events.ClosedPost): void;\n /**\n * A backend event that fires when a new forum post is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostCreated)\n */\n onPostCreated(event: Events.CreatedPost): void;\n /**\n * A backend event that fires when a forum post is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostDeleted)\n */\n onPostDeleted(event: Events.DeletedPost): void;\n /**\n * A backend event that fires when a forum post is liked.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostLiked)\n */\n onPostLiked(event: Events.LikedPost): void;\n /**\n * A backend event that fires when a forum post is moved.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostMoved)\n */\n onPostMoved(event: Events.MovedPost): void;\n /**\n * A backend event that fires when a forum post is opened.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostOpened)\n */\n onPostOpened(event: Events.OpenedPost): void;\n /**\n * A backend event that fires when a forum post is pinned.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostPinned)\n */\n onPostPinned(event: Events.PinnedPost): void;\n /**\n * A backend event that fires when a forum post is reported.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostReported)\n */\n onPostReported(event: Events.ReportedPost): void;\n /**\n * A backend event that fires when a forum post is unliked.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostUnliked)\n */\n onPostUnliked(event: Events.UnlikedPost): void;\n /**\n * A backend event that fires when a forum post is unpinned.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostUnpinned)\n */\n onPostUnpinned(event: Events.UnpinnedPost): void;\n /**\n * A backend event that fires when a forum post is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#onPostUpdated)\n */\n onPostUpdated(event: Events.UpdatedPost): void;\n }\n /**\n * Events that are fired from a Wix Forum.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-forum-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a forum category.\n */\n type Category = {\n /**\n * Category ID.\n */\n _id: string;\n /**\n * Category name. Appears on the forum home page and in the navigation menu.\n */\n name: string;\n /**\n * Category header title. Appears in the category page header.\n */\n headerTitle: string;\n /**\n * Short description of the category.\n */\n description: string;\n /**\n * Type of header background.\n * One of the following:\n *\n * + `\"IMAGE\"`: Category header background is an image.\n * + `\"COLOR\"`: Category header background is a color.\n *\n *\n * The default value is `\"COLOR\"`.\n */\n headerType: string;\n /**\n * Category header background [image source](https://www.wix.com/velo/reference/$w/image/src). Applicable only if `headerType` is an image.\n */\n headerImage: string;\n /**\n * Forum category header image overlay color. Applicable only when `headerType` is `\"IMAGE\"`.\n */\n headerImageOverlayColor: Events.Color;\n /**\n * Forum category header background color.\n */\n headerBackgroundColor: Events.Color;\n /**\n * Forum category header text color.\n */\n headerTextColor: Events.Color;\n /**\n * Position in the list of categories on the forum home page. `0` indicates the first category.\n */\n rank: number;\n /**\n * Relative URL of the category page.\n */\n pageUrl: string;\n /**\n * URL-friendly name of the category that is unique across the forum.\n */\n slug: string;\n /**\n * Number of posts in the category.\n */\n postCount: number;\n /**\n * Total views of all posts in the category.\n */\n postViewCount: number;\n /**\n * Only admins and moderators can post in this category.\n */\n writeProtected: boolean;\n /**\n * Date and time the category was created.\n */\n _createdDate: Date;\n /**\n * Date and time the category was last updated.\n */\n _updatedDate: Date;\n /**\n * Type of category.\n * One of the following:\n *\n *\n * + `\"DISCUSSION\"`: Conversational discussion with other members.\n * + `\"QUESTION\"`: Specific question with answers from the community.\n */\n categoryType: string;\n };\n /**\n * An object representing a post that was closed.\n */\n type ClosedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a color used in a forum header.\n */\n type Color = {\n /**\n * Hexadecimal rgb color value.\n */\n color: string;\n /**\n * Opacity percentage as a decimal between 0 and 1.\n */\n opacity: number;\n };\n /**\n * An object representing a forum comment.\n */\n type Comment = {\n /**\n * Comment ID.\n */\n _id: string;\n /**\n * ID of the post commented on.\n */\n postId: string;\n /**\n * ID of the comment author.\n */\n _ownerId: string;\n /**\n * Plain text of the comment.\n */\n plainContent: string;\n /**\n * Number of replies to the comment.\n */\n replyCount: number;\n /**\n * Number of likes the comment received.\n */\n likeCount: number;\n /**\n * Number of upvotes the comment received. Only applicable to comments on posts with a `postType` value of `\"QUESTION\"`.\n */\n upvoteCount: number;\n /**\n * Number of downvotes the comment received. Only applicable to comments on posts with a `postType` value of `\"QUESTION\"`.\n */\n downvoteCount: number;\n /**\n * Number of upvotes subtracted by the number of downvotes. May be a negative number. Only applicable to comments on posts with a `postType` value of `\"QUESTION\"`.\n */\n score: number;\n /**\n * Date and time the comment was created.\n */\n _createdDate: Date;\n /**\n * Date and time the comment was last edited.\n */\n _editedDate: Date;\n /**\n * Date and time of the last activity performed on the comment.\n */\n _lastActivityDate: Date;\n /**\n * Relative URL of the post page containing the comment.\n */\n pageUrl: string;\n };\n /**\n * An object representing a category that was created.\n */\n type CreatedCategory = {\n /**\n * Category ID.\n */\n categoryId: string;\n /**\n * Forum category that was created.\n */\n category: Events.Category;\n };\n /**\n * An object representing a comment that was created.\n */\n type CreatedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n /**\n * Forum comment that was created.\n */\n comment: Events.Comment;\n };\n /**\n * An object representing a post that was created.\n */\n type CreatedPost = {\n /**\n * Post ID.\n */\n postId: string;\n /**\n * Forum post that was created.\n */\n post: Events.Post;\n };\n /**\n * An object representing a category that was deleted.\n */\n type DeletedCategory = {\n /**\n * Category ID.\n */\n categoryId: string;\n };\n /**\n * An object representing a comment that was deleted.\n */\n type DeletedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a post that was deleted.\n */\n type DeletedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a comment that was downvoted.\n */\n type DownvotedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a comment that was liked.\n */\n type LikedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a post that was liked.\n */\n type LikedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a comment that was marked as best.\n */\n type MarkedAsBestComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a post that was moved to a different category.\n */\n type MovedPost = {\n /**\n * Post ID.\n */\n postId: string;\n /**\n * ID of the category the post moved from.\n */\n previousCategoryId: string;\n /**\n * ID of the category the post moved to.\n */\n currentCategoryId: string;\n };\n /**\n * An object representing a post that was opened.\n */\n type OpenedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a post that was pinned.\n */\n type PinnedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a forum post.\n */\n type Post = {\n /**\n * Post ID.\n */\n _id: string;\n /**\n * ID of the post author.\n */\n _ownerId: string;\n /**\n * ID of the category the post belongs to.\n */\n categoryId: string;\n /**\n * Post title.\n */\n title: string;\n /**\n * Plain text of the post.\n */\n plainContent: string;\n /**\n * Whether the post is pinned. Only forum admins can pin and unpin posts.\n */\n pinned: boolean;\n /**\n * Whether comments are disabled for the post (the post was closed).\n */\n commentingDisabled: boolean;\n /**\n * Number of comments on the post.\n */\n commentCount: number;\n /**\n * Number of likes the post received.\n */\n likeCount: number;\n /**\n * Number of times the post was viewed.\n */\n viewCount: number;\n /**\n * Date and time the post was created.\n */\n _createdDate: Date;\n /**\n * Date and time the post was last edited.\n */\n _editedDate: Date;\n /**\n * Date and time of the last activity performed on the post.\n */\n _lastActivityDate: Date;\n /**\n * Relative URL of the post page.\n */\n pageUrl: string;\n /**\n * URL-friendly name of the post that is unique across the forum.\n */\n slug: string;\n /**\n * Type of post.\n * One of the following:\n *\n *\n * + `\"DISCUSSION\"`: Conversational discussion with other members.\n * + `\"QUESTION\"`: Specific question with answers from the community.\n */\n postType: string;\n /**\n * ID of comment marked as best answer to the post question. Applicable only for posts with a `postType` of `\"QUESTION\"`.\n */\n bestAnswerCommentId: string;\n };\n /**\n * An object representing a comment that was reported.\n */\n type ReportedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n /**\n * Type of report.\n * One of the following:\n *\n *\n * + `\"OFFENSIVE_CONTENT\"`: Content that is offensive.\n * + `\"OFFENSIVE_MEDIA\"`: Media content that is offensive.\n * + `\"SPAM\"`: Comments with unrelated or unwanted information.\n */\n reportType: string;\n };\n /**\n * An object representing a post that was reported.\n */\n type ReportedPost = {\n /**\n * Post ID.\n */\n postId: string;\n /**\n * Type of report.\n * One of the following:\n *\n *\n * + `\"OFFENSIVE_CONTENT\"`: Content that is offensive.\n * + `\"OFFENSIVE_MEDIA\"`: Media content that is offensive.\n * + `\"SPAM\"`: Posts with unrelated or unwanted information.\n */\n reportType: string;\n };\n /**\n * An object representing a comment that was unliked.\n */\n type UnlikedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a post that was unliked.\n */\n type UnlikedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a comment that was marked as best.\n */\n type UnmarkedAsBestComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a post that was unpinned.\n */\n type UnpinnedPost = {\n /**\n * Post ID.\n */\n postId: string;\n };\n /**\n * An object representing a comment that was unvoted.\n */\n type UnvotedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n /**\n * An object representing a category that was updated.\n */\n type UpdatedCategory = {\n /**\n * Category ID.\n */\n categoryId: string;\n /**\n * Forum category that was updated.\n */\n category: Events.Category;\n };\n /**\n * An object representing a comment that was updated.\n */\n type UpdatedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n /**\n * Forum comment that was updated.\n */\n comment: Events.Comment;\n };\n /**\n * An object representing a post that was updated.\n */\n type UpdatedPost = {\n /**\n * Post ID.\n */\n postId: string;\n /**\n * Forum post that was updated.\n */\n post: Events.Post;\n };\n /**\n * An object representing a comment that was upvoted.\n */\n type UpvotedComment = {\n /**\n * Comment ID.\n */\n commentId: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-groups-backend.d.ts", "content": "/**\n * The wix-groups-backend module contains functionality for managing groups on your site from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.html#)\n */\ndeclare module 'wix-groups-backend' {\n /**\n * The CreateRequests API provides functionality for managing requests to create a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.html#createRequests)\n */\n const createRequests: CreateRequests;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-groups-backend.html#groups)\n */\n const groups: Groups;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-groups-backend.html#joinRequests)\n */\n const joinRequests: JoinRequests;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-groups-backend.html#members)\n */\n const members: Members;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-groups-backend.html#roles)\n */\n const roles: Roles;\n /**\n * Group cover image.\n */\n type CoverImage = {\n /**\n * **Deprecated**. Use the `imageUrl` property instead.\n *\n * Group cover image. Only site admins or group admins can upload a group cover image.\n */\n image?: Image;\n /**\n * Position of the group cover image relative to the uploaded image.\n */\n position?: Position;\n /**\n * The group cover image's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`. Note that the URL contains the image's width and height.\n *\n * **Note:** This replaces the old `image` property. `image` will continue to work, but we recommend that you use the updated `imageUrl` property instead.\n */\n imageUrl?: string;\n };\n /**\n * Group cover image.\n */\n type CoverImageOptions = {\n /**\n * **Deprecated**. Use the `imageUrl` property instead.\n *\n * Group cover image. Only site admins or group admins can upload a group cover image.\n */\n image?: ImageOptions;\n /**\n * Position of the top left corner of the group cover image relative to the uploaded image.\n */\n position?: PositionOptions;\n /**\n * The group cover image's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`. Note that the URL contains the image's width and height.\n *\n * **Note:** This replaces the old `image` property. `image` will continue to work, but we recommend that you use the updated `imageUrl` property instead.\n */\n imageUrl?: string;\n };\n type Group = {\n /**\n * Group ID.\n */\n _id: string;\n /**\n * Group name.\n */\n name: string;\n /**\n * Part of a group's URL, for example, `'https:/example.com/groups/{my-group-slug}'`. Generally based on the group name, but for secret groups it is\n * an autogenerated string of characters, for example, `'https:/example.com/groups/{5D3yTX}'`. It is case-sensitive.\n */\n slug: string;\n /**\n * Group description.\n */\n description: string;\n /**\n * Group privacy level.\n * One of:\n * + `PUBLIC`: Site visitors can see the group and its content in the list of groups. Site members can join the group.\n * + `PRIVATE`: Site visitors can see the group in the list of groups, but only group members can see its content. Site members can request to join the group.\n * + `SECRET`: Only group members can see the group and its content in the list of groups. Site members can only join if invited by group admins, or other group members.\n */\n privacyStatus: string;\n /**\n * Group cover image.\n */\n coverImage?: CoverImage;\n /**\n * What group members are called. For example, 'Coworkers', 'Friends', or 'Students'.\n */\n memberTitle?: string;\n /**\n * Number of members in the group.\n */\n memberCount: number;\n /**\n * Group settings.\n */\n settings: GroupSettings;\n /**\n * Date and time the group was last active. For example, a post or comment.\n */\n lastActivityDate: Date;\n /**\n * Date and time the group was created.\n */\n _createdDate: Date;\n /**\n * Date and time the group was last updated.\n */\n _updatedDate: Date;\n /**\n * Site member ID of the group creator. Defaults to group creator.\n */\n owner: string;\n };\n /**\n * Group settings.\n */\n type GroupSettings = {\n /**\n * Whether group members can send an email inviting others to join the group. When `false`, only site admins and group admins can invite others to join the group. Defaults to `false`.\n */\n membersCanInvite: boolean;\n /**\n * Whether group members can approve or reject requests to join a group. When `false`, only site admins and group admins can approve or reject requests to join the group. Defaults to `false`.\n */\n membersCanApprove: boolean;\n /**\n * Whether to create a daily group post welcoming new members. Defaults to `true`.\n */\n welcomeMemberPostEnabled: boolean;\n /**\n * Whether to create a group post when group details are changed. Defaults to `true`.\n */\n groupUpdatePostEnabled: boolean;\n /**\n * Whether group members can view the list of members in the group. Defaults to `true`.\n */\n showMemberList: boolean;\n };\n /**\n * Group settings.\n */\n type GroupSettingsOptions = {\n /**\n * Whether group members can send an email inviting others to join the group. When `false`, only site admins and group admins can invite others to join the group. Defaults to `false`.\n */\n membersCanInvite?: boolean;\n /**\n * Whether group members can approve or reject requests to join a group. When `false`, only site admins and group admins can approve or reject requests to join the group. Defaults to `false`.\n */\n membersCanApprove?: boolean;\n /**\n * Whether to create a daily group post welcoming new members. Defaults to `true`.\n */\n welcomeMemberPostEnabled?: boolean;\n /**\n * Whether to create a group post when group details are changed. Defaults to `true`.\n */\n groupUpdatePostEnabled?: boolean;\n /**\n * Whether group members can view the list of members in the group. Defaults to `true`.\n */\n showMemberList?: boolean;\n };\n /**\n * Group cover image. Only site admins or group admins can upload a group cover image.\n */\n type Image = {\n /**\n * **Deprecated**.\n *\n * Group cover image's file URL.\n */\n mediaId?: string;\n /**\n * **Deprecated**.\n *\n * Group cover image width.\n */\n width?: number;\n /**\n * **Deprecated**.\n *\n * Group cover image height.\n */\n height?: number;\n };\n /**\n * Group cover image. Only site admins or group admins can upload a group cover image.\n */\n type ImageOptions = {\n /**\n * **Deprecated**.\n *\n * Group cover image's file URL.\n */\n mediaId?: string;\n /**\n * **Deprecated**.\n *\n * Group cover image width.\n */\n width?: number;\n /**\n * **Deprecated**.\n *\n * Group cover image height.\n */\n height?: number;\n };\n type Metadata = {\n /**\n * Number of items in the current results page.\n */\n length?: number;\n /**\n * Total number of items that match the query.\n */\n totalCount?: number;\n /**\n * Flag indicating that the server failed to calculate the 'total' field.\n */\n tooManyToCount?: boolean;\n };\n type Options = {\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n };\n /**\n * Position of the top left corner of the group cover image relative to the uploaded image.\n */\n type Position = {\n /**\n * Horizontal coordinate.\n */\n x?: number;\n /**\n * Vertical coordinate.\n */\n y?: number;\n };\n /**\n * Position of the top left corner of the group cover image relative to the uploaded image.\n */\n type PositionOptions = {\n /**\n * Horizontal coordinate.\n */\n x?: number;\n /**\n * Vertical coordinate.\n */\n y?: number;\n };\n /**\n * Group member role. When membership status is not `JOINED`, this is empty.\n */\n type Role = {\n /**\n * Group member role.\n * One of:\n * - `\"MEMBER\"`: Group member.\n * - `\"ADMIN\"`: Group admin.\n */\n role: string;\n };\n /**\n * The CreateRequests API provides functionality for managing requests to create a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.html#)\n */\n interface CreateRequests {\n /**\n * Approves requests to create a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.html#approveCreateRequests)\n */\n approveCreateRequests(createRequestIds: string[], options?: Options): Promise;\n /**\n * Lists requests to create a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.html#listCreateRequests)\n */\n listCreateRequests(paging?: CreateRequests.Paging, options?: Options): Promise;\n /**\n * Creates a query to retrieve a list of create requests.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.html#queryCreateRequests)\n */\n queryCreateRequests(): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Rejects requests to create a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.html#rejectCreateRequests)\n */\n rejectCreateRequests(rejections: CreateRequests.RejectCreateRequest[], options?: Options): Promise;\n }\n /**\n * The Groups API provides functionality for managing groups, including creating, deleting, updating, and querying groups.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#)\n */\n interface Groups {\n /**\n * Creates a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#createGroup)\n */\n createGroup(groupInfo: Groups.GroupInfo, options?: Options): Promise;\n /**\n * Deletes a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#deleteGroup)\n */\n deleteGroup(groupId: string, options?: Options): Promise;\n /**\n * Gets a group by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#getGroup)\n */\n getGroup(groupId: string, options?: Options): Promise;\n /**\n * Gets a group by slug.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#getGroupBySlug)\n */\n getGroupBySlug(slug: string, options?: Options): Promise;\n /**\n * Lists groups.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#listGroups)\n */\n listGroups(paging?: Groups.Paging, options?: Options): Promise;\n /**\n * Creates a query to retrieve a list of groups.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#queryGroups)\n */\n queryGroups(): Groups.GroupsQueryBuilder;\n /**\n * Updates a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#updateGroup)\n */\n updateGroup(groupId: string, groupInfo: Groups.GroupInfoUpdate, options?: Options): Promise;\n }\n /**\n * The JoinRequests API provides functionality for managing requests to join a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.html#)\n */\n interface JoinRequests {\n /**\n * Approves requests to join a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.html#approveJoinRequests)\n */\n approveJoinRequests(identifiers: JoinRequests.Identifiers, options?: Options): Promise;\n /**\n * Lists requests to join a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.html#listJoinRequests)\n */\n listJoinRequests(groupId: string, paging?: JoinRequests.Paging, options?: Options): Promise;\n /**\n * Creates a query to retrieve a list of join requests.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.html#queryJoinRequests)\n */\n queryJoinRequests(): JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Rejects requests to join a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.html#rejectJoinRequests)\n */\n rejectJoinRequests(groupId: string, rejections: JoinRequests.Rejection[], options?: Options): Promise;\n }\n /**\n * The Members API provides functionality for managing group members, inluding adding, removing, and querying group members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#)\n */\n interface Members {\n /**\n * Adds site members to a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#addGroupMembers)\n */\n addGroupMembers(identifiers: Members.IdentifiersAddGroupMembers, options?: Options): Promise;\n /**\n * Lists all members of a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#listGroupMembers)\n */\n listGroupMembers(groupId: string, paging?: Members.Paging, options?: Options): Promise;\n /**\n * Lists all group memberships of a site member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#listMemberships)\n */\n listMemberships(memberId: string, paging?: Members.PagingMemberships, options?: Options): Promise;\n /**\n * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#queryGroupMembers)\n */\n queryGroupMembers(): Members.GroupMembersQueryBuilder;\n /**\n * Retrieves a list of up to 100 memberships, given the provided paging, sorting and filtering.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#queryMemberships)\n */\n queryMemberships(): Members.GroupMembersQueryBuilder;\n /**\n * Removes members from a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#removeGroupMembers)\n */\n removeGroupMembers(identifiers: Members.IdentifiersRemoveGroupMembers, options?: Options): Promise;\n }\n /**\n * The Roles API provides functionality for assigning and unassigning a role to a group member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Roles.html#)\n */\n interface Roles {\n /**\n * Assigns a role to group members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Roles.html#assignRole)\n */\n assignRole(identifiers: Roles.Identifiers, role: string, options?: Options): Promise;\n /**\n * Unassigns a role from group members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Roles.html#unassignRole)\n */\n unassignRole(identifiers: Roles.Identifiers, role: string, options?: Options): Promise;\n }\n /**\n * The CreateRequests API provides functionality for managing requests to create a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.html#)\n */\n namespace CreateRequests {\n type CreateRequest = {\n /**\n * ID of the request to create a group. Same as group ID.\n */\n _id: string;\n /**\n * Status of the request to create a group.\n * One of:\n * + `\"PENDING\"`\n * + `\"APPROVED\"`\n * + `\"REJECTED\"`\n */\n status: string;\n /**\n * Reason the request to create a group was rejected.\n */\n rejectionReason?: string;\n /**\n * Group requested to create.\n */\n group: Group;\n };\n type ListCreateRequests = {\n /**\n * Requests to create a group.\n */\n createRequests: CreateRequests.CreateRequest[];\n /**\n * Paging information.\n */\n metadata: Metadata;\n };\n type Paging = {\n /**\n * Maximum number of create requests to retrieve. Defaults to 1,000.\n */\n limit?: number;\n /**\n * Number of create requests to skip in the list.\n */\n skip?: number;\n };\n type RejectCreateRequest = {\n /**\n * ID of the create request to reject.\n */\n createRequestId: string;\n /**\n * Reason the request to create a group was rejected. Max 1,000 characters. This text is displayed to the creator of the rejected request.\n */\n reason?: string;\n };\n /**\n * Contains functionality for refining a CreateRequests query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#)\n */\n interface CreateRequestsQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#find)\n */\n find(options?: Options): Promise;\n /**\n * Refines a query to match items whose specified property value contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, values: string[]): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#limit)\n */\n limit(limit: string): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Adds an `or` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#or)\n */\n or(query: CreateRequests.CreateRequestsQueryBuilder): CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#skip)\n */\n skip(skip: string): CreateRequests.CreateRequestsQueryBuilder;\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#)\n */\n interface CreateRequestsQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#items)\n */\n readonly items: CreateRequests.CreateRequest[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `CreateRequestsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#query)\n */\n readonly query: CreateRequests.CreateRequestsQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a CreateRequests query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder.html#)\n */\n namespace CreateRequestsQueryBuilder {\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.CreateRequests.CreateRequestsQueryResult.html#)\n */\n namespace CreateRequestsQueryResult {\n }\n }\n /**\n * The Groups API provides functionality for managing groups, including creating, deleting, updating, and querying groups.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.html#)\n */\n namespace Groups {\n type GroupInfo = {\n /**\n * Group name.\n */\n name: string;\n /**\n * Group description.\n */\n description?: string;\n /**\n * Group privacy level.\n * One of:\n * + `PUBLIC`: Site visitors can see the group and its content in the list of groups. Site members can join the group.\n * + `PRIVATE`: Site visitors can see the group in the list of groups, but only group members can see its content. Site members can request to join the group.\n * + `SECRET`: Only group members can see the group and its content in the list of groups. Site members can only join if invited by group admins, or other group members.\n */\n privacyStatus?: string;\n /**\n * Group cover image.\n */\n coverImage?: CoverImage;\n /**\n * What group members are called. For example, 'Coworkers', 'Friends', or 'Students'.\n */\n memberTitle?: string;\n /**\n * Group settings.\n */\n settings?: GroupSettings;\n /**\n * Site member ID of the group creator. Defaults to group creator. Required if using suppressAuth.\n */\n owner?: string;\n };\n /**\n * Group to update.\n */\n type GroupInfoUpdate = {\n /**\n * Group name.\n */\n name?: string;\n /**\n * Group description.\n */\n description?: string;\n /**\n * Group privacy level.\n * One of:\n * + `PUBLIC`: Site visitors can see the group and its content in the list of groups. Site members can join the group.\n * + `PRIVATE`: Site visitors can see the group in the list of groups, but only group members can see its content. Site members can request to join the group.\n * + `SECRET`: Only group members can see the group and its content in the list of groups. Site members can only join if invited by group admins, or other group members.\n */\n privacyStatus?: string;\n /**\n * Group cover image.\n */\n coverImage?: CoverImageOptions;\n /**\n * What group members are called. For example, 'Coworkers', 'Friends', or 'Students'.\n */\n memberTitle?: string;\n /**\n * Group settings.\n */\n settings?: GroupSettingsOptions;\n /**\n * Site member ID of the group creator.\n */\n owner?: string;\n };\n type ListGroups = {\n /**\n * List of groups.\n */\n groups: Group[];\n /**\n * Paging information.\n */\n metadata: Metadata;\n };\n type Paging = {\n /**\n * Maximum number of groups to retrieve. Defaults to 1,000.\n */\n limit?: number;\n /**\n * Number of groups to skip in the list.\n */\n skip?: number;\n };\n /**\n * Contains functionality for refining a Groups query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#)\n */\n interface GroupsQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): Groups.GroupsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value contains a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#contains)\n */\n contains(propertyName: string, value: string): Groups.GroupsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): Groups.GroupsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value ends with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#endsWith)\n */\n endsWith(propertyName: string, value: string): Groups.GroupsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Groups.GroupsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#find)\n */\n find(options?: Options): Promise;\n /**\n * Refines a query to match items whose specified property value contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, values: string[]): Groups.GroupsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#limit)\n */\n limit(limit: string): Groups.GroupsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): Groups.GroupsQueryBuilder;\n /**\n * Adds an `or` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#or)\n */\n or(query: Groups.GroupsQueryBuilder): Groups.GroupsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#skip)\n */\n skip(skip: string): Groups.GroupsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value starts with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#startsWith)\n */\n startsWith(propertyName: string, value: string): Groups.GroupsQueryBuilder;\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#)\n */\n interface GroupsQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#items)\n */\n readonly items: Group[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `GroupsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#query)\n */\n readonly query: Groups.GroupsQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a Groups query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryBuilder.html#)\n */\n namespace GroupsQueryBuilder {\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Groups.GroupsQueryResult.html#)\n */\n namespace GroupsQueryResult {\n }\n }\n /**\n * The JoinRequests API provides functionality for managing requests to join a group.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.html#)\n */\n namespace JoinRequests {\n type Identifiers = {\n /**\n * ID of the group requested to join.\n */\n groupId: string;\n /**\n * IDs of the site members to approve.\n */\n memberIds: string[];\n };\n type JoinRequest = {\n /**\n * Site member ID of the requester.\n */\n memberId: string;\n /**\n * Date the site member requested to join the group.\n */\n _createdDate: Date;\n /**\n * Status of the request to join a group.\n * One of:\n * - `\"PENDING\"`\n * - `\"APPROVED\"`\n * - `\"REJECTED\"`\n */\n status: string;\n /**\n * Reason the request to join a group was rejected.\n */\n rejectionReason?: string;\n };\n type ListJoinRequests = {\n /**\n * Requests to join a group.\n */\n joinRequests: JoinRequests.JoinRequest[];\n /**\n * Paging information.\n */\n metadata: Metadata;\n };\n type Paging = {\n /**\n * Maximum number of join requests to retrieve. Defaults to 100.\n */\n limit?: number;\n /**\n * Number of join requests to skip in the list.\n */\n skip?: number;\n };\n type Rejection = {\n /**\n * ID of the site member to reject.\n */\n memberId: string;\n /**\n * Reason the request to join a group was rejected. Text written by the request reviewer that is displayed when the group is rejected (max 1,000 characters).\n */\n reason: string;\n };\n /**\n * Contains functionality for refining a JoinRequests query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#)\n */\n interface JoinRequestsQueryBuilder {\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#find)\n */\n find(options?: Options): Promise;\n /**\n * Refines a query to match items whose specified property value contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, values: string[]): JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#limit)\n */\n limit(limit: string): JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Adds an `or` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#or)\n */\n or(query: JoinRequests.JoinRequestsQueryBuilder): JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#skip)\n */\n skip(skip: string): JoinRequests.JoinRequestsQueryBuilder;\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#)\n */\n interface JoinRequestsQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#items)\n */\n readonly items: JoinRequests.JoinRequest[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `JoinRequestsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#query)\n */\n readonly query: JoinRequests.JoinRequestsQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a JoinRequests query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder.html#)\n */\n namespace JoinRequestsQueryBuilder {\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.JoinRequests.JoinRequestsQueryResult.html#)\n */\n namespace JoinRequestsQueryResult {\n }\n }\n /**\n * The Members API provides functionality for managing group members, inluding adding, removing, and querying group members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.html#)\n */\n namespace Members {\n type GroupMember = {\n /**\n * Group member role.\n * One of:\n * - `\"MEMBER\"`: Group member.\n * - `\"ADMIN\"`: Group admins.\n */\n role: string;\n /**\n * Site member ID of group member.\n */\n memberId: string;\n /**\n * Date and time the group member joined the group.\n */\n joinedDate: Date;\n };\n type IdentifiersAddGroupMembers = {\n /**\n * ID of the group.\n */\n groupId: string;\n /**\n * IDs of the site members to add to the group.\n */\n memberIds: string[];\n };\n type IdentifiersRemoveGroupMembers = {\n /**\n * ID of the group.\n */\n groupId: string;\n /**\n * IDs of the site members to remove from the group.\n */\n memberIds: string[];\n };\n type ListGroupMembers = {\n /**\n * Group members.\n */\n members: Members.GroupMember[];\n /**\n * Paging information.\n */\n metadata: Metadata;\n };\n type ListMemberships = {\n /**\n * Site member's memberships.\n */\n memberships: Members.Membership[];\n /**\n * Paging information.\n */\n metadata: Metadata;\n };\n type Membership = {\n /**\n * Group ID.\n */\n groupId: string;\n /**\n * Group membership status.\n * One of:\n * - `\"JOINED\"`\n * - `\"PENDING\"`\n */\n status: string;\n /**\n * Group member role.\n * One of:\n * - `\"MEMBER\"`: Group member.\n * - `\"ADMIN\"`: Group admins.\n */\n role: string;\n };\n type Paging = {\n /**\n * Maximum number of group members to retrieve. Defaults to 100.\n */\n limit?: number;\n /**\n * Number of group members to skip in the list.\n */\n skip?: number;\n };\n type PagingMemberships = {\n /**\n * Maximum number of memberships to retrieve. Defaults to 100.\n */\n limit?: number;\n /**\n * Number of memberships to skip in the list.\n */\n skip?: number;\n };\n /**\n * Contains functionality for refining a Members query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#)\n */\n interface GroupMembersQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): Members.GroupMembersQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): Members.GroupMembersQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Members.GroupMembersQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#find)\n */\n find(options?: Options): Promise;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#limit)\n */\n limit(limit: string): Members.GroupMembersQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): Members.GroupMembersQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#skip)\n */\n skip(skip: string): Members.GroupMembersQueryBuilder;\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#)\n */\n interface GroupMembersQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#items)\n */\n readonly items: Members.GroupMember[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `GroupMembersQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#query)\n */\n readonly query: Members.GroupMembersQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a Memberships query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#)\n */\n interface MembershipsQueryBuilder {\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Members.MembershipsQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#find)\n */\n find(options?: Options): Promise;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#limit)\n */\n limit(limit: string): Members.MembershipsQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): Members.MembershipsQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#skip)\n */\n skip(skip: string): Members.MembershipsQueryBuilder;\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#)\n */\n interface MembershipsQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#items)\n */\n readonly items: Members.Membership[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the `MembershipsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#query)\n */\n readonly query: Members.MembershipsQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * Contains functionality for refining a Members query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryBuilder.html#)\n */\n namespace GroupMembersQueryBuilder {\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.GroupMembersQueryResult.html#)\n */\n namespace GroupMembersQueryResult {\n }\n /**\n * Contains functionality for refining a Memberships query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryBuilder.html#)\n */\n namespace MembershipsQueryBuilder {\n }\n /**\n * The results of a create request query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Members.MembershipsQueryResult.html#)\n */\n namespace MembershipsQueryResult {\n }\n }\n /**\n * The Roles API provides functionality for assigning and unassigning a role to a group member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-groups-backend.Roles.html#)\n */\n namespace Roles {\n type Identifiers = {\n /**\n * ID of the group.\n */\n groupId: string;\n /**\n * IDs of the site members.\n */\n memberIds: string[];\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-marketing-backend.d.ts", "content": "/**\n * The wix-marketing-backend module contains functionality for working with your\n * site's marketing tools from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.html#)\n */\ndeclare module 'wix-marketing-backend' {\n /**\n * The Coupons API is used to manage your site's coupons.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.html#coupons)\n */\n const coupons: Coupons;\n /**\n * The Coupons API is used to manage your site's coupons.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Coupons.html#)\n */\n interface Coupons {\n /**\n * Creates a new coupon.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Coupons.html#createCoupon)\n */\n createCoupon(couponInfo: Coupons.CouponInfo): Promise;\n /**\n * Deletes an existing coupon.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Coupons.html#deleteCoupon)\n */\n deleteCoupon(couponId: string): Promise;\n /**\n * Updates the specified fields of an existing coupon.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Coupons.html#updateCouponFields)\n */\n updateCouponFields(couponId: string, couponInfo: Coupons.CouponInfo): Promise;\n }\n /**\n * Events that are triggered by actions related to Wix Marketing.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Events.html#)\n */\n interface Events {\n /**\n * An event that is triggered when a coupon is used.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Events.html#onCouponApplied)\n */\n onCouponApplied(event: Events.CouponAppliedEvent): void;\n /**\n * An event that is triggered when a coupon is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Events.html#onCouponCreated)\n */\n onCouponCreated(event: Events.CouponEvent): void;\n /**\n * An event that is triggered when a coupon is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Events.html#onCouponDeleted)\n */\n onCouponDeleted(event: Events.CouponDeletedEvent): void;\n /**\n * An event that is triggered when a coupon is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Events.html#onCouponUpdated)\n */\n onCouponUpdated(event: Events.CouponEvent): void;\n }\n /**\n * The Coupons API is used to manage your site's coupons.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Coupons.html#)\n */\n namespace Coupons {\n /**\n * An object representing coupon information.\n */\n type Coupon = {\n /**\n * Coupon ID.\n */\n _id: string;\n /**\n * Name of coupon.\n */\n name: string;\n /**\n * Coupon code. Must be unique for all coupons in your site. Maximum 20 characters.\n */\n code: string;\n /**\n * Coupon valid from this date and time.\n */\n startTime: Date;\n /**\n * Coupon expires at this date and time.\n */\n expirationTime?: Date;\n /**\n * Maximum number of times a coupon can be used. Note that multiple purchases by the same customer or purchases by different customers are both counted toward usage limit.\n */\n usageLimit?: number;\n /**\n * Indicates whether the coupon is currently [active](https://support.wix.com/en/article/activating-and-deactivating-coupons-in-wix-stores).\n */\n active?: boolean;\n /**\n * Scope of the coupon. When no scope is defined, the coupon applies to all items in all `namespaces` in the site.\n */\n scope?: Coupons.CouponScope;\n /**\n * Coupon creation date.\n */\n _dateCreated: string;\n /**\n * Whether the coupon is expired.\n */\n expired?: boolean;\n /**\n * Coupon display data in the dashboard. Returned if the coupon is only valid for a specific product/booking/event.\n */\n displayData?: Coupons.DisplayData;\n /**\n * Coupon type. For example, \"PercentOff\", \"FreeShipping\", etc.\n */\n type: string;\n /**\n * Maximum number of times the coupon can be used **per customer**. Not supported by Wix Bookings.\n */\n limitPerCustomer?: number;\n /**\n * Indicates whether the coupon is limited to 1 discount per order. If true and a customer pays for multiple items the coupon applies to, only the lowest priced item is discounted. Coupons with a `bookings` `namespace` are always limited to one item.\n */\n limitedToOneItem?: boolean;\n /**\n * The coupon is only applicable when the order subtotal is over this amount.\n */\n minimumSubtotal?: number;\n /**\n * Coupon type: Fixed price discount.\n */\n moneyOffAmount?: number;\n /**\n * Coupon type: Discount as a percentage.\n */\n percentOffRate?: number;\n /**\n * Coupon type: Specific sale price. Currently only supported for coupons with a `stores` `namespace`.\n */\n fixedPriceAmount?: number;\n /**\n * Coupon type: Free products when making a purchase. `buyXGetY` is an object that specifies `x` and `y` in the following scenario: if a visitor purchases x number of products, they receive y number of products for free. Currently only supported for coupons with a `stores` `namespace`.\n */\n buyXGetY?: Coupons.CouponTypeBuyXGetY;\n /**\n * Coupon type: Free shipping. If true, the coupon applies to all items in all `namespaces` in the site.\n */\n freeShipping?: boolean;\n /**\n * ID of the app that created the coupon. Empty if created by the site owner.\n */\n appId?: string;\n /**\n * How many times the coupon was used.\n */\n numberOfUsages: number;\n };\n type CouponId = {\n /**\n * ID of the new coupon.\n */\n id: string;\n };\n /**\n * An object representing information for creating or updating a coupon.\n */\n type CouponInfo = {\n /**\n * Name of coupon.\n */\n name: string;\n /**\n * Coupon code. Must be unique for all coupons in your site. Maximum 20 characters.\n */\n code: string;\n /**\n * Coupon valid from this date and time.\n */\n startTime: Date;\n /**\n * Coupon expires at this date and time.\n */\n expirationTime?: Date;\n /**\n * Maximum number of times a coupon can be used. Note that multiple purchases by the same customer or purchases by different customers are both counted toward usage limit.\n */\n usageLimit?: number;\n /**\n * Indicates whether the coupon is limited to 1 discount per order. If true and a customer pays for multiple items the coupon applies to, only the lowest priced item is discounted. Coupons with a `bookings` `namespace` are always limited to one item.\n */\n limitedToOneItem?: boolean;\n /**\n * Indicates whether the coupon is currently [active](https://support.wix.com/en/article/activating-and-deactivating-coupons-in-wix-stores).\n */\n active?: boolean;\n /**\n * The coupon is only applicable when the order subtotal is over this amount.\n */\n minimumSubtotal?: number;\n /**\n * Scope of the coupon. When no scope is defined, the coupon applies to all items in all `namespaces` in the site.\n */\n scope?: Coupons.CouponScope;\n /**\n * Coupon type: Fixed price discount.\n */\n moneyOffAmount?: number;\n /**\n * Coupon type: Discount as a percentage.\n */\n percentOffRate?: number;\n /**\n * Coupon type: Specific sale price. Currently only supported for coupons with a `stores` `namespace`.\n */\n fixedPriceAmount?: number;\n /**\n * Coupon type: Free products when making a purchase. `buyXGetY` is an object that specifies `x` and `y` in the following scenario: if a visitor purchases x number of products, they receive y number of products for free. Currently only supported for coupons with a `stores` `namespace`.\n */\n buyXGetY?: Coupons.CouponTypeBuyXGetY;\n /**\n * Coupon type: Free shipping. If true, the coupon applies to all items in all `namespaces` in the site.\n */\n freeShipping?: boolean;\n /**\n * Maximum number of times the coupon can be used **per customer**. Not supported by Wix Bookings.\n */\n limitPerCustomer?: number;\n /**\n * Whether the coupon applies to subscription products.\n *\n * If set to `true`, the discount will apply to all billing cycles.\n */\n appliesToSubscriptions?: boolean;\n };\n /**\n * An object containing the scope of a coupon.\n */\n type CouponScope = {\n /**\n * Wix application for which the coupon is applicable.\n * One of the following:\n *\n * + `\"stores\"`\n * + `\"bookings\"`\n * + `\"events\"`\n * + `\"pricingPlans\"`\n */\n namespace: string;\n /**\n * Group within a `namespace` for which the coupon is applicable. If no group is specified, the coupon applies to all items in the namespace. `group` is required in some cases. See the table in [`createCoupon()`](#createCoupon) for a list of currently supported groups for each namespace.\n */\n group?: Coupons.ScopeGroup;\n };\n /**\n * An object defining the number of purchases required and the number of free items received for a \"Buy X Get Y\" coupon type.\n */\n type CouponTypeBuyXGetY = {\n /**\n * Number of purchased items required to receive free items.\n */\n x: number;\n /**\n * Number of items received for free if required number of items were purchased.\n */\n y: number;\n };\n /**\n * An object representing display data for the product associated with the coupon.\n */\n type DisplayData = {\n /**\n * Display name.\n */\n name: string;\n /**\n * Formatted price for display.\n */\n formattedPrice: string;\n /**\n * Media ID for the product associated with the coupon.\n */\n mediaItem: string;\n };\n /**\n * An object specifying the group within a `CouponScope`\n * `namespace` for which the coupon is applicable.\n */\n type ScopeGroup = {\n /**\n * Name of the group.\n */\n name: string;\n /**\n * ID of the specific item in the group for which the coupon is applicable. If no `entityId` is specified, the coupon applies to all items in the group. In some cases when a group is specified, an `entityId` is required. See the table in [`createCoupon()`](#createCoupon) for a list of currently supported entities for each namespace and group.\n */\n entityId?: string;\n };\n }\n /**\n * Events that are triggered by actions related to Wix Marketing.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-marketing-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a custom coupon event.\n */\n type CouponAppliedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.Metadata;\n /**\n * Event data.\n */\n data: Events.Data;\n };\n /**\n * An object representing a custom coupon event.\n */\n type CouponDeletedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.Metadata;\n };\n /**\n * An object representing a coupon event.\n */\n type CouponEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.Metadata;\n /**\n * Coupon information.\n */\n entity: Coupons.Coupon;\n };\n /**\n * An object representing a custom event's data.\n */\n type Data = {\n /**\n * Applied coupon information.\n */\n coupon: Coupons.Coupon;\n /**\n * ID of the entity that the coupon was applied to (orderId, bookingId, etc.).\n */\n wixAppOrderId: string;\n /**\n * ID of the Wix app that applied the coupon.\n * + Wix Stores: `215238eb-22a5-4c36-9e7b-e7c08025e04e`\n * + Wix Bookings: `13d21c63-b5ec-5912-8397-c3a5ddb27a97`\n * + Wix Events: `140603ad-af8d-84a5-2c80-a0f60cb47351`\n */\n wixAppId: string;\n };\n /**\n * An object representing a coupon.\n */\n type Metadata = {\n /**\n * Event ID.\n */\n id: string;\n /**\n * Coupon ID associated with this event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Whether this event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.\n */\n triggeredByAnonymizeRequest: boolean;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-media-backend.d.ts", "content": "/**\n * The `wix-media-backend` module contains functionality for working with\n * media from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.html#)\n */\ndeclare module 'wix-media-backend' {\n /**\n * The `mediaManager` module contains functionality for working with\n * the media that is stored in your site's [Media Manager](https://support.wix.com/en/article/about-the-media-manager-568956).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.html#mediaManager)\n */\n const mediaManager: MediaManager;\n /**\n * Events triggered by the Wix Media API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.Events.html#)\n */\n interface Events {\n /**\n * An event that triggers when an audio file has completed transcoding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.Events.html#onAudioTranscoded)\n */\n onAudioTranscoded(event: Events.FileEvent): void;\n /**\n * An event that triggers when a file has completed uploading.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.Events.html#onFileUploaded)\n */\n onFileUploaded(event: Events.FileEvent): void;\n /**\n * An event that triggers when a video file has completed transcoding.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.Events.html#onVideoTranscoded)\n */\n onVideoTranscoded(event: Events.FileEvent): void;\n }\n /**\n * The `mediaManager` module contains functionality for working with\n * the media that is stored in your site's [Media Manager](https://support.wix.com/en/article/about-the-media-manager-568956).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#)\n */\n interface MediaManager {\n /**\n * Returns a download URL for downloading files from the Media Manager.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#downloadFiles)\n */\n downloadFiles(fileUrls: string[]): Promise;\n /**\n * Returns a download URL for downloading a folder from the Media Manager.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#downloadFolder)\n */\n downloadFolder(folderId: string): Promise;\n /**\n * Gets a temporary download URL with a token for a specified file in the Media Manager.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#getDownloadUrl)\n */\n getDownloadUrl(fileUrl: string, expirationTime?: number, downloadedFileName?: string, expiredTokenRedirectUrl?: string): Promise;\n /**\n * Gets a file's information from the Media Manager by `fileUrl`.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#getFileInfo)\n */\n getFileInfo(fileUrl: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available. Use the [`getDownloadUrl`](https://www.wix.com/velo/reference/wix-media-backend/mediamanager-obj/getdownloadurl) function instead.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#getFileUrl)\n */\n getFileUrl(fileUrl: string): Promise;\n /**\n * Gets a folder's information from the Media Manager by `folderId`.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#getFolderInfo)\n */\n getFolderInfo(folderId: string): Promise;\n /**\n * Gets an upload URL for uploading a file to the media manager.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#getUploadUrl)\n */\n getUploadUrl(path: string, options: MediaManager.UploadOptions): Promise;\n /**\n * Gets a video file's playback URL from the Media Manager.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#getVideoPlaybackUrl)\n */\n getVideoPlaybackUrl(fileUrl: string, format: string): Promise;\n /**\n * Imports a file to the Media Manager from a URL.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#importFile)\n */\n importFile(path: string, url: string, options: MediaManager.UploadOptions): Promise;\n /**\n * Gets a list of files from the Media Manager by `parentFolderId` (or root).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#listFiles)\n */\n listFiles(filters?: MediaManager.FileFilterOptions, sorting?: MediaManager.SortingOptions, paging?: MediaManager.PagingOptions): Promise;\n /**\n * Gets a list of folders from the Media Manager by `parentFolderId` (or root).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#listFolders)\n */\n listFolders(filters?: MediaManager.FolderFilterOptions, sorting?: MediaManager.SortingOptions, paging?: MediaManager.PagingOptions): Promise;\n /**\n * Moves single or multiple files to the Media Manager's trash.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#moveFilesToTrash)\n */\n moveFilesToTrash(fileUrls: string[]): Promise;\n /**\n * Moves single or multiple folders, including their files and sub-folders, to the Media Manager's trash.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#moveFoldersToTrash)\n */\n moveFoldersToTrash(folderIds: string[]): Promise;\n /**\n * Uploads a file to the Media Manager from a [buffer](https://nodejs.org/api/buffer.html#buffer_static_method_buffer_from_string_encoding).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#upload)\n */\n upload(path: string, fileContent: Buffer, fileName: string, options: MediaManager.UploadOptions): Promise;\n }\n /**\n * Events triggered by the Wix Media API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing an uploaded file and upload context.\n */\n type FileEvent = {\n /**\n * Information about the uploaded file.\n */\n fileInfo: MediaManager.FileInfo;\n /**\n * An object of `key:value` string pairs that was sent\n * when the file was uploaded.\n */\n context: any;\n };\n }\n /**\n * The `mediaManager` module contains functionality for working with\n * the media that is stored in your site's [Media Manager](https://support.wix.com/en/article/about-the-media-manager-568956).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-media-backend.MediaManager.html#)\n */\n namespace MediaManager {\n /**\n * An object containing information about the file that was listed.\n */\n type File = {\n /**\n * **Deprecated**. Use the `fileUrl` property instead.\n *\n * The `fileName` property is the internal name (unique identifier) which is generated when a file is uploaded by the Media Manager, returned from the [`importFile()`](#importFile), or [`upload()`](#upload) functions. The name is the string located in the file's URL. Click [here](https://support.wix.com/en/article/wix-media-retrieving-the-url-of-a-file-in-the-media-manager) to learn more. Use this name when calling the [`getFileInfo()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/media-manager/get-file-info), [`getFileUrl()`](#getFileUrl),\n * and [`getVideoPlaybackUrl()`](#getVideoPlaybackUrl) functions.\n */\n fileName: string;\n /**\n * The file's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`.\n */\n fileUrl: string;\n /**\n * File hash.\n */\n hash: string;\n /**\n * Size of the listed file in bytes.\n */\n sizeInBytes: number;\n /**\n * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of\n * the listed file.\n */\n mimeType: string;\n /**\n * Media type of the listed file.\n * One of:\n *\n * + `\"audio\"`\n * + `\"document\"`\n * + `\"image\"`\n * + `\"shape\"`\n * + `\"video\"`\n */\n mediaType: string;\n /**\n * Whether the link to the listed file is\n * public or private. Private links require a token to be used.\n */\n isPrivate: boolean;\n /**\n * ID of the file's parent folder.\n */\n parentFolderId: string;\n /**\n * Original name of the uploaded file. This is the display name\n * that appears in the Media Manager.\n */\n originalFileName: string;\n /**\n * URL of the file's icon.\n */\n iconUrl: string;\n /**\n * List of labels assigned to the file by the Media Manager.\n */\n labels: string[];\n /**\n * Media height.\n */\n height: string;\n /**\n * Media width.\n */\n width: string;\n /**\n * Date the file was created.\n */\n _createdDate: Date;\n /**\n * Date the file was updated.\n */\n _updatedDate: Date;\n };\n /**\n * File filter options.\n */\n type FileFilterOptions = {\n /**\n * ID of the parent folder of the files to list.\n */\n parentFolderId?: string;\n /**\n * Media type of the files to list. Leave blank to list files of all media types.\n * One of:\n *\n * + `\"audio\"`\n * + `\"document\"`\n * + `\"image\"`\n * + `\"shape\"`\n * + `\"video\"`\n */\n mediaType?: string;\n /**\n * Whether the link to the files you want to list is public or private. Leave blank to include both public and private files.\n */\n isPrivate?: boolean;\n };\n /**\n * An object containing information about the file that was uploaded.\n */\n type FileInfo = {\n /**\n * **Deprecated**. Use the `fileUrl` property instead.\n *\n * The `fileName` property is the internal name (unique identifier) which is generated when a file is uploaded by the Media Manager, returned from the [`importFile()`](#importFile), or [`upload()`](#upload) functions. The name is the string located in the file's URL. Click [here](https://support.wix.com/en/article/wix-media-retrieving-the-url-of-a-file-in-the-media-manager) to learn more. Use this name when calling the [`getFileInfo()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/media-manager/get-file-info), [`getFileUrl()`](#getFileUrl),\n * and [`getVideoPlaybackUrl()`](#getVideoPlaybackUrl) functions.\n */\n fileName: string;\n /**\n * The file's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`.\n */\n fileUrl: string;\n /**\n * File hash.\n */\n hash: string;\n /**\n * Size of the uploaded file in bytes.\n */\n sizeInBytes: number;\n /**\n * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of\n * the uploaded file.\n */\n mimeType: string;\n /**\n * Type of the file that was uploaded.\n * One of:\n *\n * + `\"audio\"`\n * + `\"document\"`\n * + `\"image\"`\n * + `\"shape\"`\n * + `\"video\"`\n */\n mediaType: string;\n /**\n * Whether the link to the uploaded file is\n * public or private. Private links require a token to be used.\n */\n isPrivate: boolean;\n /**\n * ID of the file's parent folder.\n */\n parentFolderId: string;\n /**\n * Original name of the uploaded file. This is the display name\n * that appears in the Media Manager.\n */\n originalFileName: string;\n /**\n * Status of the file that was uploaded.\n * One of:\n *\n * + `\"IN-DOWNLOAD-QUEUE\"`\n * + `\"IN-QUEUE\"`\n * + `\"READY\"`\n */\n opStatus: string;\n /**\n * URL where the file was uploaded from.\n */\n sourceURL: string;\n /**\n * URL of the file's icon.\n */\n iconUrl: string;\n /**\n * List of labels assigned to the file by the Media Manager.\n */\n labels: string[];\n /**\n * Media height.\n */\n height: string;\n /**\n * Media width.\n */\n width: string;\n /**\n * Date the file was created.\n */\n _createdDate: Date;\n /**\n * Date the file was updated.\n */\n _updatedDate: Date;\n };\n /**\n * Folder filter options.\n */\n type FolderFilterOptions = {\n /**\n * ID of the parent folder of the folders to list.\n */\n parentFolderId?: string;\n };\n /**\n * An object containing information about the folder.\n */\n type FolderInfo = {\n /**\n * ID of the folder. Internal name (unique identifier) which is generated when a folder is created by the Media Manager. Use this ID when calling the [`listFiles()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/media-manager/list-files), and [`listFolders()`](#listFolders) functions.\n */\n folderId: string;\n /**\n * Name of the folder.\n */\n folderName: string;\n /**\n * ID of the folder's parent folder. Use this ID when calling the [`listFiles()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/media-manager/list-files), and [`listFolders()`](#listFolders) functions.\n */\n parentFolderId: string;\n /**\n * Date the folder was created.\n */\n _createdDate: Date;\n /**\n * Date the folder was updated.\n */\n _updatedDate: Date;\n };\n /**\n * An object containing information about the media options of a file to upload.\n */\n type MediaOptions = {\n /**\n * Type of file to upload.\n * One of:\n *\n * + `\"audio\"`\n * + `\"document\"`\n * + `\"image\"`\n * + `\"shape\"`\n * + `\"video\"`\n */\n mediaType?: string;\n /**\n * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of\n * the file to import. The specified value must match the actual mime type of\n * the file's content.\n */\n mimeType?: string;\n };\n /**\n * An object containing information about the metadata options of a file to upload.\n */\n type MetadataOptions = {\n /**\n * Whether the link to the uploaded file will\n * be public or private. Private links require a token to be used. Defaults to\n * `false`.\n */\n isPrivate?: boolean;\n /**\n * Indicates if the file was uploaded by a\n * site visitor. When `true`, the uploaded files are:\n * + Stored in the Visitor Uploads folder of the Media Manager (`visitor-uploads`). See the `path` property for more details.\n * + Tagged in the Media Manager as added by a visitor.\n * Defaults to `true`.\n */\n isVisitorUpload?: boolean;\n /**\n * An object of `key:value` string pairs containing information that is passed to the [`onFileUploaded()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/on-file-uploaded), [`onAudioTranscoded()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/on-audio-transcoded), or [`onVideoTranscoded()`](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/events/on-video-transcoded) events. See [Importing and Uploading Files](https://dev.wix.com/docs/velo/api-reference/wix-media-backend/importing-and-uploading-files) to learn more.\n * back in the [`onFileUploaded()`](wix-media-backend.Events.html#onFileUploaded)\n * event.\n */\n context?: any;\n /**\n * In this case the fileName is the name you would like your file to appear as in the Media Manager.\n */\n fileName?: string;\n };\n /**\n * Paging options.\n */\n type PagingOptions = {\n /**\n * Amount of records to retrieve. Defaults to 20.\n */\n limit?: number;\n /**\n * Number of records to skip.\n */\n skip?: number;\n };\n /**\n * Sorting options. **Note:** When sorting by '`originalFileName`', folders and file names that begin with capital letters come before lowercase in '`asc`' order.\n */\n type SortingOptions = {\n /**\n * Direction of sort: `\"asc\"` or `\"desc\"`. Defaults to `\"asc\"`.\n */\n order?: string;\n /**\n * Field to sort by: `\"originalFileName\"` or `\"_updatedDate\"`. Defaults to `\"_updatedDate\"`.\n */\n field?: string;\n };\n /**\n * An object containing information about the options of a file to upload.\n */\n type UploadOptions = {\n /**\n * Media options of the file to upload.\n */\n mediaOptions?: MediaManager.MediaOptions;\n /**\n * Metadata options of the file to upload.\n */\n metadataOptions?: MediaManager.MetadataOptions;\n };\n /**\n * An object containing information about an upload URL.\n */\n type UploadUrl = {\n /**\n * The URL used for sending a POST or PUT request to upload a file to the Media Manager.\n */\n uploadUrl: string;\n /**\n * **Deprecated.** Use the `uploadUrl` property instead.\n *\n * The token to use with the file POST.\n *\n * **Note:** The `uploadToken` property returns empty, as the token is now included in the upload URL. The `uploadToken` property will continue to work, but we recommend that you use the updated `uploadUrl` parameter instead.\n */\n uploadToken: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-members-backend.d.ts", "content": "/**\n * The wix-members-backend module contains functionality\n * for working with your site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.html#)\n */\ndeclare module 'wix-members-backend' {\n /**\n * The Authentication API contains functionality for authenticating users from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.html#authentication)\n */\n const authentication: Authentication;\n /**\n * The Authorization API contains functionality for working with\n * [member roles](https://support.wix.com/en/site-members/setting-your-members-permissions)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.html#authorization)\n */\n const authorization: Authorization;\n /**\n * The Badges API contains functionality for working with [member badges](https://support.wix.com/en/article/about-member-badges) from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.html#badges)\n */\n const badges: Badges;\n /**\n * The CurrentMember API contains functionality for viewing and managing site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.html#currentMember)\n */\n const currentMember: CurrentMember;\n /**\n * The Members API contains functionality for viewing and managing site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.html#members)\n */\n const members: Members;\n type AuthOptions = {\n /**\n * Prevents permission checks from running for the operation.\n */\n suppressAuth: boolean;\n };\n /**\n * The Authentication API contains functionality for authenticating users from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#)\n */\n interface Authentication {\n /**\n * Approves a pending member using an email address.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#approveByEmail)\n */\n approveByEmail(email: string): Promise;\n /**\n * Approves a pending member using an approval token.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#approveByToken)\n */\n approveByToken(token: string): Promise;\n /**\n * Blocks a member from logging in to the site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#blockByEmail)\n */\n blockByEmail(email: string): Promise;\n /**\n * Changes a member's login email address.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#changeLoginEmail)\n */\n changeLoginEmail(memberId: string, newEmail: string): Promise;\n /**\n * Creates a session token for a member authenticated by a 3rd party.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#generateSessionToken)\n */\n generateSessionToken(email: string): Promise;\n /**\n * Logs a registered member in with an email and password.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#login)\n */\n login(email: string, password: string): Promise;\n /**\n * Registers a new site member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#register)\n */\n register(email: string, password: string, options?: Authentication.RegistrationOptions): Promise;\n /**\n * Sends a site member an email with a link to set or reset their password.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#sendSetPasswordEmail)\n */\n sendSetPasswordEmail(email: string, options?: Authentication.SetPasswordEmailOptions): Promise;\n }\n /**\n * The Authorization API contains functionality for working with\n * [member roles](https://support.wix.com/en/site-members/setting-your-members-permissions)\n * from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authorization.html#)\n */\n interface Authorization {\n /**\n * Assigns a role to a member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authorization.html#assignRole)\n */\n assignRole(roleId: string, memberId: string, options?: AuthOptions): Promise;\n /**\n * Removes a role from a member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authorization.html#removeRole)\n */\n removeRole(roleId: string, memberId: string, options?: AuthOptions): Promise;\n }\n /**\n * The Badges API contains functionality for working with [member badges](https://support.wix.com/en/article/about-member-badges) from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#)\n */\n interface Badges {\n /**\n * Assigns a badge to site members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#assignMembers)\n */\n assignMembers(badgeId: string, memberIds: string[]): Promise;\n /**\n * Creates a badge.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#createBadge)\n */\n createBadge(badgeInfo: Badges.BadgeInfo): Promise;\n /**\n * Deletes a badge.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#deleteBadge)\n */\n deleteBadge(badgeId: string): Promise;\n /**\n * Lists the badges assigned to each of the specified site members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#listMemberBadges)\n */\n listMemberBadges(memberIds: string[]): Promise;\n /**\n * Lists the IDs of all members assigned to a badge.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#listMembers)\n */\n listMembers(badgeId: string): Promise;\n /**\n * Removes site members from an assigned badge.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#removeMembers)\n */\n removeMembers(badgeId: string, memberIds: string[]): Promise;\n /**\n * Updates a badge.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#updateBadge)\n */\n updateBadge(badgeId: string, badgeInfo: Badges.BadgeInfo): Promise;\n }\n /**\n * The CurrentMember API contains functionality for viewing and managing site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#)\n */\n interface CurrentMember {\n /**\n * Retrieves the currently logged-in member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#getMember)\n */\n getMember(options?: Members.FieldsetOptions): Promise;\n /**\n * Retrieves the member's roles.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#getRoles)\n */\n getRoles(): Promise;\n /**\n * Removes the currently logged-in member from the site community and sets their profile to private.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#makeProfilePrivate)\n */\n makeProfilePrivate(): Promise;\n /**\n * Joins the currently logged-in member to the site community and sets their profile to public.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#makeProfilePublic)\n */\n makeProfilePublic(): Promise;\n /**\n * Changes the currently logged-in member's slug.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#updateSlug)\n */\n updateSlug(slug: string): Promise;\n }\n /**\n * Events that are triggered by actions on a site's members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Events.html#)\n */\n interface Events {\n /**\n * **Deprecated.**\n * This event will continue to work, but a newer version is available at\n * [onMemberCreated()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/events/on-member-created).\n *\n * An event that is triggered when a site member is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Events.html#onMemberCreated)\n */\n onMemberCreated(event: Events.CreatedMemberEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work, but a newer version is available at\n * [onMemberDeleted()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/events/on-member-deleted).\n *\n * An event that is triggered when a site member is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Events.html#onMemberDeleted)\n */\n onMemberDeleted(event: Events.DeletedMemberEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work, but a newer version is available at\n * [onMemberUpdated()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/events/on-member-updated).\n *\n * An event that is triggered when a site member's information is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Events.html#onMemberUpdated)\n */\n onMemberUpdated(event: Events.UpdatedMemberEvent): void;\n }\n /**\n * **Deprecated.**\n * The Members API contains functionality for viewing and managing site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#)\n */\n interface Members {\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [deleteMember()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/members/delete-member).\n *\n * Deletes a member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#deleteMember)\n */\n deleteMember(id: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [deleteMemberAddresses()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/members/delete-member-addresses).\n *\n * Deletes a member's street addresses.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#deleteMemberAddresses)\n */\n deleteMemberAddresses(id: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [deleteMemberEmails()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/members/delete-member-emails).\n *\n * Deletes a member's street addresses.\n * Clears a member's email addresses.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#deleteMemberEmails)\n */\n deleteMemberEmails(id: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [deleteMemberPhones()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/members/delete-member-phones).\n *\n * Clears a member's phone numbers.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#deleteMemberPhones)\n */\n deleteMemberPhones(id: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [getMember()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/members/get-member).\n *\n * Retrieves a member by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#getMember)\n */\n getMember(id: string, options?: Members.FieldsetOptions): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [updateMember()](https://dev.wix.com/docs/velo/api-reference/wix-members-v2/members/update-member).\n *\n * Updates a member's properties.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#updateMember)\n */\n updateMember(id: string, member: Members.MemberInfo): Promise;\n }\n /**\n * The Authentication API contains functionality for authenticating users from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Authentication.html#)\n */\n namespace Authentication {\n /**\n * An object that contains information about a site contact.\n */\n type ContactInfo = {\n /**\n * Contact's first name.\n */\n firstName?: string;\n /**\n * Contact's last name.\n */\n lastName?: string;\n /**\n * Contact's image source URL.\n */\n picture?: string;\n /**\n * List of contact's email addresses.\n * When creating a contact, if no phone number is\n * provided, at least 1 email address must be provided.\n */\n emails?: string[];\n /**\n * List of contact's phone numbers.\n * When creating a contact, if no email is\n * provided, at least 1 phone number must be provided.\n */\n phones?: string[];\n /**\n * List of contact's labels. [Labels](https://support.wix.com/en/article/creating-contact-labels)\n * are used to organize contacts. When setting the `labels` property, you can\n * only list labels that already exist in your site's [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).\n */\n labels?: string[];\n /**\n * Contact's language.\n */\n language?: string;\n /**\n * Any number of custom fields. [Custom fields](https://www.wix.com/velo/reference/wix-members-backend/custom-fields)\n * are used to store additional information about your site's contacts.\n *\n * >**Note:** `customFields` is not the name of a field in the `contactInfo` object. Here, it represents any custom fields that you've chosen to implement.\n */\n customFields?: string | number | Date;\n };\n /**\n * An object that contains information about a site registration.\n */\n type RegistrationOptions = {\n /**\n * Contact information.\n */\n contactInfo?: Authentication.ContactInfo;\n /**\n * Sets the [privacy status](https://support.wix.com/en/article/member-privacy-settings-for-groups) of a new member upon registration.\n * One of:\n *\n * - `\"PUBLIC\"`: Sets the new member status to public. A member whose status is public is a member of the site's community.\n * - `\"PRIVATE\"`: Sets the new member status to private. A member whose status is private is not a member of the site's community.\n *\n * Defaults to `\"PRIVATE\"`.\n */\n privacyStatus?: string;\n };\n type RegistrationResult = {\n /**\n * Registration status.\n *\n * One of:\n *\n * - `\"PENDING\"`: The member must be approved before they can log in to the site.\n * - `\"ACTIVE\"`: The member is approved and can log in to the site.\n */\n status: string;\n /**\n * Token for logging in the current visitor\n * as a site member with the\n * [`applySessionToken()`](wix-members-frontend/authentication/applySessionToken)\n * function from wix-members-frontend.\n *\n * `sessionToken` is only returned when approval is automatic and the returned `status` is `\"ACTIVE\"`. See [Automatic vs. Manual Approval](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/new-members#manual-vs-automatic-approval).\n */\n sessionToken?: string;\n /**\n * Token for approving the member\n * with the [`approveByToken()`](wix-members-backend/authentication/approveByToken)\n * function. `approvalToken` is safe to pass via email or from page code to\n * backend code.\n *\n * `approvalToken` is only returned when manual approval is required and the returned `status` is `\"PENDING\"`. See [Automatic vs. Manual Approval](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/new-members#manual-vs-automatic-approval).\n */\n approvalToken?: string;\n /**\n * The registered member.\n */\n member: Members.Member;\n };\n type SetPasswordEmailOptions = {\n /**\n * Whether to hide the \"ignore this email\" message.\n *\n * If `false`, the email tells the member\n * they can safely ignore\n * if they did not request the password change.\n *\n * Defaults to `false`.\n */\n hideIgnoreMessage?: boolean;\n };\n }\n /**\n * The Badges API contains functionality for working with [member badges](https://support.wix.com/en/article/about-member-badges) from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Badges.html#)\n */\n namespace Badges {\n /**\n * An object representing a member badge.\n */\n type Badge = {\n /**\n * Badge ID.\n */\n _id: string;\n /**\n * Badge title.\n */\n title: string;\n /**\n * Badge's unique URL as used in a dynamic page.\n */\n slug: string;\n /**\n * Badge description.\n */\n description: string;\n /**\n * Badge background color as a hexadecimal RGB color value.\n *\n * Defaults to `\"#796EFF\"` (purple).\n */\n backgroundColor: string;\n /**\n * Badge text color as a hexadecimal RGB color value.\n *\n * Defaults to `\"#FFFFFF\"` (white).\n */\n textColor: string;\n /**\n * Badge icon as an SVG image. One of:\n *\n * - An external web URL in the following format: `http(s)://`.\n * - The [source URL](wix-media-backend.mediaManager.html#getFileUrl) for a Wix Media Manager file.\n * Wix Media Manager file names in a `wix:image://...` format are not supported.\n */\n icon: string;\n /**\n * ID of the role that badge members are assigned to.\n */\n roleId: string;\n /**\n * Date and time the badge was created.\n */\n _createdDate: Date;\n /**\n * Date and time the badge was last updated.\n */\n _updatedDate: Date;\n };\n /**\n * Information to use when creating or updating a badge.\n */\n type BadgeInfo = {\n /**\n * Badge title.\n */\n title: string;\n /**\n * Badge description.\n */\n description?: string;\n /**\n * Badge background color as a hexadecimal RGB color value.\n *\n * Defaults to `\"#796EFF\"` (purple).\n */\n backgroundColor?: string;\n /**\n * Badge text color as a hexadecimal RGB color value.\n *\n * Defaults to `\"#FFFFFF\"` (white).\n */\n textColor?: string;\n /**\n * Badge icon as an SVG image. One of:\n *\n * - An external web URL in the following format: `http(s)://`.\n * - The [source URL](wix-media-backend.mediaManager.html#getFileUrl) for a Wix Media Manager file.\n * Wix Media Manager file names in a `wix:image://...` format are not supported.\n */\n icon?: string;\n };\n /**\n * An object representing the badges associated with a member.\n */\n type MemberBadges = {\n /**\n * Member ID.\n */\n memberId: string;\n /**\n * List of badge IDs assigned to the member.\n */\n badgeIds: string[];\n };\n }\n /**\n * The CurrentMember API contains functionality for viewing and managing site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.CurrentMember.html#)\n */\n namespace CurrentMember {\n type Role = {\n /**\n * Role ID.\n */\n _id: string;\n /**\n * Role name as defined in the site's\n * [Member Permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/roles)\n * page or one of `\"Admin\"` or `\"Member\"`.\n */\n title: string;\n /**\n * Role description, if defined in the site's dashboard.\n */\n description?: string;\n /**\n * Role color, as defined in the site's\n * [Member Permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/roles)\n * page.\n *\n * One of:\n *\n * - `\"DARK_BLUE\"`\n * - `\"LIGHT_BLUE\"`\n * - `\"TEAL\"`\n * - `\"LIGHT_GREEN\"`\n * - `\"YELLOW\"`\n * - `\"ORANGE\"`\n * - `\"RED\"`\n * - `\"VIOLET\"`\n * - `\"PURPLE\"`\n */\n color: string;\n /**\n * Date and time the role was created.\n */\n _createdDate?: Date;\n };\n }\n /**\n * Events that are triggered by actions on a site's members.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing the site member that was created.\n */\n type CreatedMemberEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Information about the created member.\n */\n entity: Members.Member;\n };\n /**\n * An object representing the site member deletion event.\n */\n type DeletedMemberEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n };\n /**\n * Event metadata.\n */\n type EventMetadata = {\n /**\n * Event ID.\n */\n id: string;\n /**\n * Member ID associated with this event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.\n */\n triggeredByAnonymizeRequest?: boolean;\n };\n /**\n * An object representing the site member whose information was updated.\n */\n type UpdatedMemberEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Information about the updated member.\n */\n entity: Members.Member;\n };\n }\n /**\n * **Deprecated.**\n * The Members API contains functionality for viewing and managing site members from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-members-backend.Members.html#)\n */\n namespace Members {\n type Address = {\n /**\n * Street address ID.\n */\n _id?: string;\n /**\n * Street address object, with number and name in separate fields.\n */\n streetAddress?: Members.StreetAddress;\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine?: string;\n /**\n * Free text providing more detailed address information,\n * such as apartment, suite, or floor.\n */\n addressLine2?: string;\n /**\n * City name.\n */\n city?: string;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an\n * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n /**\n * 2-letter country code in an\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Postal code.\n */\n postalCode?: string;\n };\n type AddressInfo = {\n /**\n * Street address object, with number and name in separate fields.\n */\n streetAddress?: Members.StreetAddressInfo;\n /**\n * Main address line, usually street and number, as free text.\n */\n addressLine?: string;\n /**\n * Free text providing more detailed address information,\n * such as apartment, suite, or floor.\n */\n addressLine2?: string;\n /**\n * City name.\n */\n city?: string;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an\n * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n /**\n * 2-letter country code in an\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Postal code.\n */\n postalCode?: string;\n };\n /**\n * Member's contact information. Contact information is stored in the\n */\n type ContactDetails = {\n /**\n * Contact's first name.\n */\n firstName?: string;\n /**\n * Contact's last name.\n */\n lastName?: string;\n /**\n * List of phone numbers.\n */\n phones: string[];\n /**\n * List of email addresses.\n */\n emails: string[];\n /**\n * List of street addresses.\n */\n addresses: Members.Address[];\n /**\n * Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\n *\n * For example, `\"2025-03-15\"` for March 15, 2025.\n */\n birthdate?: string;\n /**\n * Contact's company name.\n */\n company?: string;\n /**\n * Contact's job title.\n */\n jobTitle?: string;\n /**\n * Custom fields,\n * [structured as key:object pairs](wix-members-backend/introduction#data-structure).\n * Custom field IDs are defined in the\n * [Contacts Extended Fields API](wix-crm-backend/contacts).\n * The paired object contains the `name` and `value` properties,\n * where `name` is the display name and `value` is the value stored for the member.\n *\n * Only custom fields\n * [added to the member profile in the Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmembers-account)\n * are available through the Members API.\n * Empty fields are not returned.\n *\n * When updating a member, `name` is ignored.\n */\n customFields: object;\n };\n /**\n * Member's contact information. Contact information is stored in the\n * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n *\n *\n */\n type ContactInfo = {\n /**\n * Contact's first name.\n */\n firstName?: string;\n /**\n * Contact's last name.\n */\n lastName?: string;\n /**\n * List of phone numbers.\n */\n phones?: string[];\n /**\n * List of email addresses.\n */\n emails?: string[];\n /**\n * List of street addresses.\n */\n addresses?: Members.AddressInfo[];\n /**\n * Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\n *\n * For example, `\"2025-03-15\"` for March 15, 2025.\n */\n birthdate?: string;\n /**\n * Contact's company name.\n */\n company?: string;\n /**\n * Contact's job title.\n */\n jobTitle?: string;\n /**\n * Custom fields,\n * [structured as key:object pairs](wix-members-frontend/introduction#data-structure).\n * Custom field IDs are defined in the\n * [Contacts Extended Fields API](wix-crm-backend/contacts).\n * The paired object contains the `name` and `value` properties,\n * where `name` is the display name and `value` is the value stored for the member.\n *\n * Only custom fields\n * [added to the member profile in the Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmembers-account)\n * are available through the Members API.\n * Empty fields are not returned.\n *\n * When updating a member, `name` is ignored.\n */\n customFields?: any;\n };\n type FieldsetOptions = {\n /**\n * Predefined sets of fields to return.\n * When multiple fieldsets are provided, the union of all the included fields is returned.\n *\n * Predefined fieldsets are one of:\n *\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `_id` and all fields under `profile`. With this fieldset, `profile.status`, `profile.privacyStatus`, and `profile.activityStatus` are returned as `\"UNKNOWN\"`.\n *\n * Defaults to `[ \"PUBLIC\" ]`.\n */\n fieldsets: string[];\n };\n /**\n * Member's profile photo.\n */\n type Image = {\n /**\n * **Deprecated.** Wix Media image ID,\n * set when the member selects an image from Wix Media.\n */\n _id: string;\n /**\n * Image URL.\n */\n url: string;\n /**\n * Original image width.\n */\n height: number;\n /**\n * Original image height.\n */\n width: number;\n /**\n * X-axis offset.\n *\n * Defaults to `0`.\n */\n offsetX: number;\n /**\n * Y-axis offset.\n *\n * Defaults to `0`.\n */\n offsetY: number;\n };\n /**\n * Updated member.\n */\n type Member = {\n /**\n * Member ID.\n */\n _id: string;\n /**\n * Email used by the member to log in to the site.\n */\n loginEmail?: string;\n /**\n * Member site access status.\n *\n *\n *\n * One of:\n *\n * - `\"PENDING\"`: Member created and is waiting for approval by site owner.\n * - `\"APPROVED\"`: Member can log in to the site.\n * - `\"OFFLINE\"`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.\n * - `\"BLOCKED\"`: Member is blocked and cannot log in to the site.\n * - `\"UNKNOWN\"`: Insufficient permissions to get the status.\n *\n */\n status: string;\n /**\n * Contact ID.\n */\n contactId: string;\n /**\n * Member privacy status.\n *\n *\n *\n *\n * One of:\n *\n * - `\"PUBLIC\"`: Member is visible to everyone.\n * - `\"PRIVATE\"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n * - `\"UNKNOWN\"`: Insufficient permissions to get the status.\n *\n */\n privacyStatus: string;\n /**\n * Member activity status.\n *\n *\n *\n *\n * One of:\n *\n * - `\"ACTIVE\"`: Member can write forum posts and blog comments.\n * - `\"MUTED\"`: Member cannot write forum posts or blog comments.\n * - `\"UNKNOWN\"`: Insufficient permissions to get the status.\n *\n */\n activityStatus: string;\n /**\n * Date and time when the member was created.\n */\n _createdDate: Date;\n /**\n * Date and time when the member was updated.\n */\n _updatedDate: Date;\n /**\n * Date and time when the member last logged in to the site.\n */\n lastLoginDate?: Date;\n /**\n * Member's contact information. Contact information is stored in the\n * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n *\n *\n */\n contactDetails?: Members.ContactDetails;\n /**\n * Profile display info.\n */\n profile: Members.Profile;\n };\n /**\n * Member details to update.\n */\n type MemberInfo = {\n /**\n * Member's contact information. Contact information is stored in the\n * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n *\n *\n */\n contactDetails?: Members.ContactInfo;\n /**\n * Profile display info.\n */\n profile?: Members.ProfileInfo;\n };\n /**\n * Profile display info.\n */\n type Profile = {\n /**\n * Name that identifies the member to other members.\n * Displayed on the member's profile page\n * and interactions in the forum or blog.\n */\n nickname: string;\n /**\n * Slug that determines the member's profile page URL.\n */\n slug: string;\n /**\n * Member's profile photo.\n */\n profilePhoto?: Members.Image;\n /**\n * Member's profile photo.\n */\n coverPhoto?: Members.Image;\n /**\n * Member title.\n *\n *\n */\n title?: string;\n };\n /**\n * Member's profile photo.\n */\n type ProfileImageInfo = {\n /**\n * Wix Media image ID,\n * set when the member selects an image from Wix Media.\n */\n _id?: string;\n /**\n * Image URL.\n */\n url?: string;\n /**\n * Original image width.\n */\n height?: number;\n /**\n * Original image height.\n */\n width?: number;\n /**\n * X-axis offset.\n *\n * Defaults to `0`.\n */\n offsetX?: number;\n /**\n * Y-axis offset.\n *\n * Defaults to `0`.\n */\n offsetY?: number;\n };\n /**\n * Profile display info.\n */\n type ProfileInfo = {\n /**\n * Name that identifies the member to other members.\n * Displayed on the member's profile page\n * and interactions in the forum or blog.\n */\n nickname?: string;\n /**\n * Member's profile photo.\n */\n profilePhoto?: Members.ProfileImageInfo;\n /**\n * Member's profile photo.\n */\n coverPhoto?: Members.ProfileImageInfo;\n /**\n * Member title.\n *\n *\n */\n title?: string;\n };\n /**\n * Street address object, with number and name in separate fields.\n */\n type StreetAddress = {\n /**\n * Street number.\n */\n number: string;\n /**\n * Street name.\n */\n name: string;\n };\n /**\n * Street address object, with number and name in separate fields.\n */\n type StreetAddressInfo = {\n /**\n * Street number.\n */\n number?: string;\n /**\n * Street name.\n */\n name?: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-notifications.v2.d.ts", "content": "/**\n * [Read more](https://www.wix.com/corvid/reference/wix-notifications.v2.html#)\n */\ndeclare module 'wix-notifications.v2' {\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-notifications-v2.html#notifications)\n */\n const notifications: Notifications;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-notifications-v2.Notifications.html#)\n */\n interface Notifications {\n /**\n * Sends a notification.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-notifications-v2.Notifications.html#notify)\n */\n notify(body: string, channels: Array, options: Notifications.NotifyOptions): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-notifications-v2.Notifications.html#)\n */\n namespace Notifications {\n type Empty = {};\n type NotifyOptions = {\n /**\n * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, \"Click this!\".\n *\n * Max: 512 characters\n */\n action?: string;\n /**\n * URL of Dashboard page to navigate to when the `action` text is clicked.\n */\n targetDashboardPage?: string;\n /**\n * URL to navigate to when the `action` text is clicked.\n */\n targetUrl?: string;\n /**\n * Notification title. Only displayed on mobile and browser notifications.\n *\n * Max: 512 characters\n */\n title?: string;\n /**\n * List of contacts to notify.\n */\n toContacts?: Notifications.ToContacts;\n /**\n * List of site contributors to notify.\n */\n toSiteContributors?: Notifications.ToSiteContributors;\n /**\n * Notify contacts who are subscribed to specific topics.\n */\n toTopicsSubscribers?: Notifications.ToTopicsSubscribers;\n };\n type PublicNotifyRequest = {\n /**\n * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, \"Click this!\".\n *\n * Max: 512 characters\n */\n action?: string;\n /**\n * Contents of the notification.\n *\n * Max: 512 characters\n */\n body?: string;\n /**\n * The channels to send the notification on. One or more of:\n *\n * - `\"Mobile\"`: Sends the notification to the Wix App.\n * - `\"Dashboard\"`: Sends the notification to the contributor's Wix Dashboard.\n * - `\"Browser\"`: Sends the notification to the contributor's browser.\n */\n channels?: Array;\n /**\n * URL of Dashboard page to navigate to when the `action` text is clicked.\n */\n targetDashboardPage?: string;\n /**\n * URL to navigate to when the `action` text is clicked.\n */\n targetUrl?: string;\n /**\n * Notification title. Only displayed on mobile and browser notifications.\n *\n * Max: 512 characters\n */\n title?: string;\n /**\n * List of contacts to notify.\n */\n toContacts?: Notifications.ToContacts;\n /**\n * List of site contributors to notify.\n */\n toSiteContributors?: Notifications.ToSiteContributors;\n /**\n * Notify contacts who are subscribed to specific topics.\n */\n toTopicsSubscribers?: Notifications.ToTopicsSubscribers;\n };\n type PublicNotifyRequestActionTargetOneOf = {\n /**\n * URL of Dashboard page to navigate to when the `action` text is clicked.\n */\n targetDashboardPage?: string;\n /**\n * URL to navigate to when the `action` text is clicked.\n */\n targetUrl?: string;\n };\n type PublicNotifyRequestRecipientsFilterOneOf = {\n /**\n * List of contacts to notify.\n */\n toContacts?: Notifications.ToContacts;\n /**\n * List of site contributors to notify.\n */\n toSiteContributors?: Notifications.ToSiteContributors;\n /**\n * Notify contacts who are subscribed to specific topics.\n */\n toTopicsSubscribers?: Notifications.ToTopicsSubscribers;\n };\n type Public_notification = {\n /**\n * id\n */\n _id?: string;\n };\n type ToContacts = {\n /**\n * List of contact IDs.\n */\n contactIds?: Array;\n };\n type ToSiteContributors = {\n /**\n * Roles to receive the notification. One of:\n *\n * - `\"All_Contributors\"`: All site contributors (default).\n * - `\"Owner\"`: Only the site owner.\n */\n withRole?: string;\n };\n type ToTopicsSubscribers = {\n /**\n * List of contact IDs to exclude from notification.\n */\n excludedContactIds?: Array;\n /**\n * List of topics.\n */\n topics?: Array;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-paid-plans-backend.d.ts", "content": "/**\n * **Deprecated.**\n * The wix-paid-plans-backend module will continue to work, but a newer version is available at [wix-pricing-plans-backend](https://www.wix.com/velo/reference/wix-pricing-plans-backend).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-paid-plans-backend.html#)\n */\ndeclare module 'wix-paid-plans-backend' {\n /**\n * **Deprecated.**\n * The Wix paid plan events will continue to work, but a newer version is available at [wix-pricing-plans-backend](https://www.wix.com/velo/reference/wix-pricing-plans-backend/events).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-paid-plans-backend.Events.html#)\n */\n interface Events {\n /**\n * **Deprecated.**\n * This event will continue to work, but a newer version is available at [`wix-pricing-plans-backend.events.onPlanPurchased()`](wix-pricing-plans-backend/events/onplanpurchased).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-paid-plans-backend.Events.html#onPlanPurchased)\n */\n onPlanPurchased(event: Events.PlanPurchasedEvent): void;\n }\n /**\n * **Deprecated.**\n * The Wix paid plan events will continue to work, but a newer version is available at [wix-pricing-plans-backend](https://www.wix.com/velo/reference/wix-pricing-plans-backend/events).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-paid-plans-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a new pricing plan order (subscription).\n */\n type Order = {\n /**\n * Order ID of the purchase of the plan, auto-generated when an order is created.\n */\n id: string;\n /**\n * Status of the payment for the plan. Can be `PAID`, `REFUNDED`, `FAILED`, `UNPAID`, and `PAYMENT_STATUS_UNDEFINED`.\n */\n paymentStatus: string;\n /**\n * Date and time until which the plan is valid.\n */\n validUntil: Date;\n /**\n * Object containing the price of the plan.\n */\n price: Events.Price;\n /**\n * If the plan is cancelled, the reason why. One of:\n *\n * + `OWNER_CANCELED`: The owner cancelled.\n * + `PAYMENT_PROVIDER_CANCELED`: The payment provider cancelled.\n * + `PAYMENT_FAILED`: The payment failed.\n * + `UOU_CANCELED`: The site member cancelled.\n * + `CANCELLATION_REASON_UNDEFINED`: The reason is undefined.\n */\n cancellationReason: string;\n /**\n * If the plan is cancelled, the cause of the cancellation. One of:\n *\n * + `\"UNDEFINED\"`: Cancellation initiator undefined.\n * + `\"OWNER\"`: Order (subscription) was canceled by site owner.\n * + `\"MEMBER\"`: Order (subscription) was canceled by member.\n * + `\"PAYMENT_FAILURE\"`: Subscription was canceled because of payment failure.\n * + `\"SETUP_FAILURE\"`: Subscription was canceled because of payment setup failure.\n */\n cancellationInitiator: string;\n /**\n * Date and time from which the plan is valid.\n */\n validFrom: Date;\n /**\n * Name of the plan.\n */\n planName: string;\n /**\n * ID of the plan for Wix Pay. If plan is free, this ID is blank.\n */\n wixPayOrderId: string;\n /**\n * If the plan is recurring. If true, the price is deducted weekly, monthly, or yearly.\n */\n recurring: boolean;\n /**\n * Date and time the order was created.\n */\n dateCreated: Date;\n /**\n * Status of the order. Can be `ACTIVE`, `PENDING`, `CANCELED`, `EXPIRED`, `PENDING_CANCELLATION`, and `ORDER_STATUS_UNDEFINED`.\n */\n status: string;\n /**\n * Description of the plan.\n */\n planDescription: string;\n /**\n * ID for the member who purchased the plan.\n */\n memberId: string;\n /**\n * How the plan was purchased, either `ONLINE` pr `OFFLINE`.\n */\n orderType: string;\n /**\n * ID of the plan.\n */\n planId: string;\n /**\n * Object containing properties about how long the plan is valid.\n */\n validFor: Events.ValidFor;\n /**\n * How many trial days were given to the subscriber of the plan. Available only for orders whose plans are recurring, meaning plans whose pricing model is `subscription`.\n */\n freeTrialDays?: number;\n /**\n * Role assigned after purchasing the plan.\n */\n roleId: string;\n };\n /**\n * An object representing the period for which a plan is valid.\n */\n type Period = {\n /**\n * The number of units until the plan expires.\n */\n amount: number;\n /**\n * Time period for billing the plan, such as `MONTH`.\n */\n unit: string;\n };\n /**\n * An object representing a new pricing plan purchase.\n */\n type PlanPurchasedEvent = {\n /**\n * Object containing the details about the plan's order.\n */\n order: Events.Order;\n };\n /**\n * An object representing the price of a purchased plan.\n */\n type Price = {\n /**\n * Payment currency. A three-letter\n * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n */\n currency: string;\n /**\n * The cost of the plan.\n */\n amount: number;\n };\n /**\n * An object representing how long a plan is valid.\n */\n type ValidFor = {\n /**\n * If true, the plan does not expire.\n */\n forever: boolean;\n /**\n * Object containing the period for which the plan is valid.\n */\n period: Events.Period;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-pay-backend.d.ts", "content": "/**\n * The wix-pay-backend module contains functionality for working with\n * payments from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.html#)\n */\ndeclare module 'wix-pay-backend' {\n /**\n * Contains functionality for displaying prices in your store in different currencies, getting exchange rates, and converting between currencies.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.html#currencies)\n */\n const currencies: Currencies;\n /**\n * Creates a new payment.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.html#createPayment)\n */\n function createPayment(paymentInfo: PaymentInfo): Promise;\n /**\n * An object representing a payment.\n */\n type Payment = {\n /**\n * Payment ID.\n */\n id: string;\n /**\n * Payment total amount.\n */\n amount: number;\n /**\n * Payment currency. A three-letter\n * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n */\n currency: string;\n /**\n * Payment items.\n */\n items: PaymentItem[];\n /**\n * An object representing information about the user.\n */\n userInfo: PaymentUserInfo;\n };\n /**\n * An object representing information for creating a payment.\n */\n type PaymentInfo = {\n /**\n * Total payment amount. Must equal\n * the sum of the `price` properties in the `items` list while taking the\n * `quantity` into account.\n */\n amount: number;\n /**\n * Payment currency. A three-letter\n * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Defaults to\n * the currency defined by the site's [Regional Settings](https://support.wix.com/en/article/changing-your-sites-regional-settings).\n */\n currency?: string;\n /**\n * List of payment items.\n */\n items: PaymentItem[];\n /**\n * An object representing information about the user. It will be used to prefill\n * the user info form during the payment process.\n */\n userInfo?: PaymentUserInfo;\n };\n /**\n * An object representing a payment item.\n */\n type PaymentItem = {\n /**\n * Payment item name.\n */\n name: string;\n /**\n * Payment item price.\n */\n price: number;\n /**\n * Payment item quantity.\n */\n quantity?: number;\n };\n /**\n * An object representing information about the user.\n */\n type PaymentUserInfo = {\n /**\n * User's first name. Value is `null` if\n * there is no first name information.\n */\n firstName: string;\n /**\n * User's last name. Value is `null` if\n * there is no last name information.\n */\n lastName: string;\n /**\n * User's phone number. Value is `null` if\n * there is no phone number information.\n */\n phone: string;\n /**\n * User's email address. Value is `null` if\n * there is no email address information.\n */\n email: string;\n /**\n * User's country code. A three-letter\n * [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) country code. Value\n * is `null` if there is no country information.\n */\n countryCode: string;\n };\n /**\n * The Currencies API contains functionality for displaying prices in your store in different currencies, getting exchange rates, and converting between currencies.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.html#)\n */\n interface Currencies {\n /**\n * Gets conversion rates and converts amounts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.html#currencyConverter)\n */\n readonly currencyConverter: Currencies.CurrencyConverter;\n /**\n * Gets and sets currencies that you want to support on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.html#siteSettings)\n */\n readonly siteSettings: Currencies.SiteSettings;\n /**\n * Gets the list of all currencies for which Wix supports conversion.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.html#getAllCurrencies)\n */\n getAllCurrencies(): Promise;\n }\n /**\n * Events fired by payments created using the Pay API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Events.html#)\n */\n interface Events {\n /**\n * An event that fires when a payment's transaction status is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Events.html#onPaymentUpdate)\n */\n onPaymentUpdate(event: Events.PaymentUpdateEvent): void;\n }\n /**\n * The Currencies API contains functionality for displaying prices in your store in different currencies, getting exchange rates, and converting between currencies.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.html#)\n */\n namespace Currencies {\n /**\n * An object representing a currency.\n */\n type Currency = {\n /**\n * A 3-letter\n * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n */\n code: string;\n /**\n * A currency symbol.\n */\n symbol: string;\n };\n /**\n * An object for retrieving conversion rates and converting amounts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.CurrencyConverter.html#)\n */\n interface CurrencyConverter {\n /**\n * Converts an array of one or more amounts from one currency to another.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.CurrencyConverter.html#convertAmounts)\n */\n convertAmounts(options: CurrencyConverter.ConvertAmountsOptions): Promise;\n /**\n * Gets a currency conversion rate.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.CurrencyConverter.html#getConversionRate)\n */\n getConversionRate(sourceCurrency: string, targetCurrency: string): Promise;\n }\n /**\n * Site-related currency settings.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.SiteSettings.html#)\n */\n interface SiteSettings {\n /**\n * Gets the list of supported currencies that you set for your site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.SiteSettings.html#getCurrencies)\n */\n getCurrencies(): Promise;\n /**\n * Sets the list of currencies that the site will support.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.SiteSettings.html#setCurrencies)\n */\n setCurrencies(options: SiteSettings.CurrencyCode[]): Promise;\n }\n /**\n * An object for retrieving conversion rates and converting amounts.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.CurrencyConverter.html#)\n */\n namespace CurrencyConverter {\n /**\n * An object representing a currency conversion rate.\n */\n type ConversionRate = {\n /**\n * The conversion rate between the source and target currencies.\n */\n rate: number;\n /**\n * The date and time when the rate was set.\n */\n timestamp: Date;\n };\n /**\n * An object representing the currencies and amounts to be converted.\n */\n type ConvertAmountsOptions = {\n /**\n * Amounts to convert.\n */\n amounts: number[];\n /**\n * Currency to convert from. The `from` currency code used must exist in the array returned by the [`getAllCurrencies()`](wix-pay-backend/currencies/get-all-currencies) function.\n */\n from: string;\n /**\n * Currency to convert to. The `to` currency code used must exist in the array returned by the [`getAllCurrencies()`](wix-pay-backend.Currencies.html#getAllCurrencies) function.\n *\n * > **Note:** The `from` and `to` currency codes used must exist in the array returned by the [`getAllCurrencies()`](wix-pay-backend.Currencies.html#getAllCurrencies) function.\n */\n to: string;\n };\n /**\n * An object representing the results of a currency conversion.\n */\n type ConvertedAmounts = {\n /**\n * Array of converted amounts.\n */\n amounts: number[];\n /**\n * The date and time when the currency exchange rate was set.\n */\n timestamp: Date;\n };\n }\n /**\n * Site-related currency settings.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Currencies.SiteSettings.html#)\n */\n namespace SiteSettings {\n /**\n * An object representing an ISO currency code.\n */\n type CurrencyCode = {\n /**\n * A 3-letter\n * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n */\n code: string;\n };\n }\n }\n /**\n * Events fired by payments created using the Pay API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pay-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a payment update.\n */\n type PaymentUpdateEvent = {\n /**\n * The payment's information.\n */\n payment: Payment;\n /**\n * Payment status.\n * One of:\n *\n * + `\"Successful\"`\n * + `\"Pending\"`\n * + `\"Failed\"`\n * + `\"Chargeback\"`\n * + `\"Refunded\"`\n * + `\"Offline\"`\n * + `\"PartiallyRefunded\"`\n * + `\"Cancelled\"`\n * + `\"Undefined\"`\n */\n status: string;\n /**\n * ID of the [transaction](https://dev.wix.com/docs/rest/business-management/payments/cashier/payments/transaction/transaction-object) that caused this payment to update.\n */\n transactionId: string;\n /**\n * User information.\n */\n userInfo: PaymentUserInfo;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-payment-provider-backend.d.ts", "content": "/**\n * The wix-payment-provider-backend module contains functionality for reporting transaction and refund events processed by third-party payment providers.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-payment-provider-backend.html#)\n */\ndeclare module 'wix-payment-provider-backend' {\n /**\n * Updates the status of a transaction or refund.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-payment-provider-backend.html#submitEvent)\n */\n function submitEvent(submitEventRequest: SubmitEventRequest): Promise;\n type Event = {\n /**\n * Updated details of a transaction.\n */\n transaction?: TransactionDetails;\n /**\n * Updated details of a refund.\n */\n refund?: RefundDetails;\n };\n type RefundDetails = {\n /**\n * Wix transaction ID.\n */\n wixTransactionId?: string;\n /**\n * Payment provider refund ID.\n */\n pluginRefundId?: string;\n /**\n * Wix [reason code](/payment-provider-spi/reason-codes).\n */\n reasonCode?: number;\n /**\n * Refunded amount.\n */\n amount?: string;\n /**\n * Wix refund ID for refunds created through a site's dashboard.\n */\n wixRefundId?: string;\n /**\n * Payment provider error code.\n */\n errorCode?: string;\n /**\n * Detailed payment provider error description.\n */\n errorMessage?: string;\n };\n type SubmitEventRequest = {\n /**\n * The updated information about the transaction or refund.\n */\n event: Event;\n };\n /**\n * Transaction event type.\n */\n type TransactionDetails = {\n /**\n * Wix transaction ID.\n */\n wixTransactionId?: string;\n /**\n * Payment Provider transaction ID.\n */\n pluginTransactionId?: string;\n /**\n * Wix [reason code](/payment-provider-spi/reason-codes).\n */\n reasonCode?: number;\n /**\n * Payment provider error code.\n */\n errorCode?: string;\n /**\n * Detailed payment provider error description.\n */\n errorMessage?: string;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-pricing-plans-backend.d.ts", "content": "/**\n * The wix-pricing-plans-backend module contains functionality for managing your\n * site's pricing plans from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#)\n */\ndeclare module 'wix-pricing-plans-backend' {\n /**\n * The Pricing Plans Checkout API provides functionality for ordering and checking out pricing plan orders created in the Wix Pricing Plans app or using this Wix Pricing Plans API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#checkout)\n */\n const checkout: Checkout;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#events)\n */\n const events: Events;\n /**\n * The Pricing Plan Orders API provides functionality for managing pricing plan orders created in the Wix Pricing Plans app or using this Wix Pricing Plans API.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#orders)\n */\n const orders: Orders;\n /**\n * Archives a single pricing plan.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#archivePlan)\n */\n function archivePlan(id: string): Promise;\n /**\n * **Deprecated.** This function has been deprecated. Changes the display order of the pricing plans on the site page and in the Dashboard.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#arrangePlans)\n */\n function arrangePlans(ids: string[]): Promise;\n /**\n * Sets all pricing plans as not primary.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#clearPrimary)\n */\n function clearPrimary(): Promise;\n /**\n * Creates a pricing plan.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#createPlan)\n */\n function createPlan(planInfo: CreatePlanInfo): Promise;\n /**\n * Gets an existing pricing plan by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#getPlan)\n */\n function getPlan(id: string): Promise;\n /**\n * Gets statistics about the pricing plans.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#getPlanStats)\n */\n function getPlanStats(): Promise;\n /**\n * Lists public pricing plans.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#listPublicPlans)\n */\n function listPublicPlans(planIds?: string[], options?: ListPublicPlanOptions): Promise;\n /**\n * Marks a pricing plan as the primary pricing plan.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#makePlanPrimary)\n */\n function makePlanPrimary(id: string): Promise;\n /**\n * Creates a query to retrieve a list of public pricing plans.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#queryPublicPlans)\n */\n function queryPublicPlans(): Promise;\n /**\n * Sets visibility for non-archived pricing plans. Public plans are plans that are set to visible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#setPlanVisibility)\n */\n function setPlanVisibility(id: string, visible: boolean): Promise;\n /**\n * Updates a pricing plan.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.html#updatePlan)\n */\n function updatePlan(planInfo: UpdatePlanInfo): Promise;\n type CreatePlanInfo = {\n /**\n * Plan name.\n */\n name: string;\n /**\n * Plan price, payment schedule, and expiration.\n */\n pricing: PricingInfo;\n /**\n * Plan description.\n */\n description?: string;\n /**\n * List of text strings that promote the pricing plan (for example, \"Plenty of parking\" or \"Free gift on your birthday\").\n */\n perks?: string[];\n /**\n * Whether the plan is public (visible to site visitors). Defaults to `true`.\n */\n public?: boolean;\n /**\n * Whether the same buyer can purchase the plan multiple times. `1` means the buyer can only purchase the plan once. An empty value or `0` means no limitation. Defaults to empty.\n */\n maxPurchasesPerBuyer?: number;\n /**\n * Whether the buyer can start the plan at a later date. Defaults to `false`.\n */\n allowFutureStartDate?: boolean;\n /**\n * Whether the buyer is allowed to cancel their plan. Defaults to `true`. If `true`, calling the [`cancelOrder()`](wix-paid-plans/cancelOrder) function returns an error.\n */\n buyerCanCancel?: boolean;\n /**\n * Any terms and conditions that apply to the plan. This information is displayed during checkout.\n */\n termsAndConditions?: string;\n };\n /**\n * Length of one payment cycle, for example, 3 months to have quarterly payments.\n */\n type Duration = {\n /**\n * Number of days, months, weeks, or years.\n */\n count: number;\n /**\n * Days, months, weeks, or years.\n * One of:\n * + `\"DAY\"`\n * + `\"WEEK\"`\n * + `\"MONTH\"`\n * + `\"YEAR\"`\n */\n unit: string;\n };\n /**\n * Length of one payment cycle, for example, 3 months to have quarterly payments.\n */\n type DurationInfo = {\n /**\n * Number of days, months, weeks, or years.\n */\n count?: number;\n /**\n * Days, months, weeks, or years.\n * One of:\n * + `\"DAY\"`\n * + `\"WEEK\"`\n * + `\"MONTH\"`\n * + `\"YEAR\"`\n */\n unit?: string;\n };\n type ListPublicPlanOptions = {\n /**\n * Number of public pricing plans to list. Defaults to 50.\n */\n limit?: number;\n /**\n * Number of public pricing plans to skip. Defaults to 0.\n */\n skip?: number;\n };\n /**\n * Amount for a single payment. For subscriptions, this is the amount to pay for each single payment cycle and it is required. Otherwise, the single payment for the entire plan.\n */\n type Money = {\n /**\n * Monetary amount. Decimal string with a period as a decimal separator (for example, 3.99). Cannot be negative.\n */\n value: string;\n /**\n * Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, USD).\n */\n currency: string;\n };\n /**\n * Amount for a single payment. For subscriptions, this is the amount to pay for each single payment cycle and it is required. Otherwise, the single payment for the entire plan.\n */\n type MoneyInfo = {\n /**\n * Monetary amount. Decimal string with a period as a decimal separator (for example, 3.99). Cannot be negative.\n */\n value?: string;\n /**\n * Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, USD).\n */\n currency?: string;\n };\n type Options = {\n /**\n * Whether to suppress permission checks from running for the operation.\n *\n * Default: `false`\n */\n suppressAuth?: boolean;\n };\n /**\n * A text string promoting the pricing plan (for example, \"Plenty of parking\" or \"Free gift on your birthday\").\n */\n type Perk = {\n /**\n * Text listing one perk of this plan.\n */\n value: string;\n };\n /**\n * List of text strings that promote the pricing plan (for example, \"Plenty of parking\" or \"Free gift on your birthday\").\n */\n type Perks = {\n /**\n * A list of strings promoting the pricing plan.\n */\n value?: Perk[];\n };\n type Plan = {\n /**\n * Plan ID.\n */\n _id: string;\n /**\n * Plan name.\n */\n name: string;\n /**\n * Plan description.\n */\n description: string;\n /**\n * List of text strings that promote the pricing plan (for example, \"Plenty of parking\" or \"Free gift on your birthday\").\n */\n perks: string[];\n /**\n * Plan price, payment schedule, and expiration.\n */\n pricing: Pricing;\n /**\n * Whether the plan is public (visible to site visitors).\n */\n public: boolean;\n /**\n * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.\n */\n archived: boolean;\n /**\n * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon. Defaults to `false`.\n */\n primary: boolean;\n /**\n * Whether the plan has any orders (including pending and unpaid orders).\n */\n hasOrders: boolean;\n /**\n * Date plan was created.\n */\n _createdDate: Date;\n /**\n * Date plan was last updated.\n */\n _updatedDate: Date;\n /**\n * URL-friendly version of the plan name. Unique across all plans in the same site.\n */\n slug: string;\n /**\n * Whether the buyer can start the plan at a later date.\n */\n allowFutureStartDate: boolean;\n /**\n * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`cancelOrder()`](wix-paid-plans/cancelOrder) function returns an error.\n */\n buyerCanCancel: boolean;\n /**\n * Whether the same buyer can purchase the plan multiple times. `1` means the buyer can only purchase the plan once. An empty value or `0` means no limitation.\n */\n maxPurchasesPerBuyer?: number;\n /**\n * Any terms and conditions that apply to the plan. This information is displayed during checkout.\n */\n termsAndConditions?: string;\n };\n type Plans = {\n /**\n * List of public and hidden pricing plans.\n */\n plans: Plan[];\n };\n type PlansStats = {\n /**\n * Total number of plans created, including active plans (both public and hidden) and archived plans.\n */\n total: number;\n };\n /**\n * Pricing plan's pricing details, such as the plan price, payment schedule, and expiration. The payment schedule and expiration are based on one of three [pricing models](wix-pricing-plans-backend/introduction): `subscription`, `singlePaymentForDuration`, or `singlePaymentUnlimited`. Only one pricing model can be specified per plan.\n */\n type Pricing = {\n /**\n * Pricing model indicating that the plan has recurring payments. This type of subscription is not a \"Wix subscription,\" which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.\n */\n subscription?: Recurrence;\n /**\n * Pricing model indicating that the plan is paid with a single payment per cycle and what the length of the cycle is. The cycle is the duration of the plan, not a payment cycle.\n */\n singlePaymentForDuration?: Duration;\n /**\n * Pricing model indicating that the plan is paid in one single payment and that the plan is valid until canceled.\n */\n singlePaymentUnlimited?: boolean;\n /**\n * Amount for a single payment. For subscriptions, this is the amount to pay for each single payment cycle and it is required. Otherwise, the single payment for the entire plan.\n */\n price: Money;\n /**\n * Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`.\n */\n freeTrialDays?: number;\n };\n /**\n * Pricing plan's pricing details, such as the plan price, payment schedule, and expiration. The payment schedule and expiration are based on one of three [pricing models](wix-pricing-plans-backend/introduction): `subscription`, `singlePaymentForDuration`, or `singlePaymentUnlimited`.\n */\n type PricingInfo = {\n /**\n * Pricing model indicating that the plan has recurring payments.\n */\n subscription?: Recurrence;\n /**\n * Pricing model indicating that the plan is paid with a single payment per cycle and what the Length of the cycle is. The cycle is the duration of the plan, not a payment cycle.\n */\n singlePaymentForDuration?: Duration;\n /**\n * Pricing model indicating that the plan is paid in one single payment and that the plan is valid until canceled.\n */\n singlePaymentUnlimited?: boolean;\n /**\n * Amount for a single payment. For subscriptions, this is the amount to pay for each single payment cycle and it is required. Otherwise, the single payment for the entire plan.\n */\n price?: MoneyInfo;\n /**\n * Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`.\n */\n freeTrialDays?: number;\n };\n /**\n * Public pricing plan entity containing information about the pricing plan. Can be read by any site member or visitor.\n */\n type PublicPlan = {\n /**\n * Plan ID.\n */\n _id: string;\n /**\n * Plan name.\n */\n name: string;\n /**\n * Plan description.\n */\n description: string;\n /**\n * List of text strings that promote the pricing plan (for example, \"Plenty of parking\" or \"Free gift on your birthday\").\n */\n perks: string[];\n /**\n * Plan price, payment schedule, and expiration.\n */\n pricing: Pricing;\n /**\n * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon. Defaults to `false`.\n */\n primary: boolean;\n /**\n * Date plan was created.\n */\n _createdDate: Date;\n /**\n * Date plan was last updated.\n */\n _updatedDate: Date;\n /**\n * URL-friendly version of the plan name. Unique across all plans in the same site.\n */\n slug: string;\n /**\n * Whether the buyer can start the plan at a later date. Defaults to `false`.\n */\n allowFutureStartDate: boolean;\n /**\n * Whether the buyer is allowed to cancel their plan. Defaults to `false`. If `false`, calling the [`cancelOrder()`](wix-paid-plans/cancelOrder) function returns an error.\n */\n buyerCanCancel: boolean;\n /**\n * Whether the same buyer can purchase the plan multiple times. `1` means the buyer can only purchase the plan once. An empty value or `0` means no limitation. Defaults to empty.\n */\n maxPurchasesPerBuyer?: number;\n /**\n * Any terms and conditions that apply to the plan. This information is displayed during checkout.\n */\n termsAndConditions?: string;\n };\n type PublicPlans = {\n /**\n * List of public pricing plans.\n */\n publicPlans: PublicPlan[];\n };\n /**\n * The pricing plan has recurring payments.\n */\n type Recurrence = {\n /**\n * Length of one payment cycle, for example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. *Currently, only a value of `1` is supported.*\n */\n cycleDuration: Duration;\n /**\n * Number of cycles. Zero for unlimited plans and plans that are valid until canceled.\n */\n cycleCount: number;\n };\n /**\n * The pricing plan has recurring payments.\n */\n type RecurrenceInfo = {\n /**\n * Length of one payment cycle, for example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. *Currently, only a value of `1` is supported.*\n */\n cycleDuration?: DurationInfo;\n /**\n * Number of cycles. Zero for unlimited plans and plans that are valid until canceled.\n */\n cycleCount?: number;\n };\n type UpdatePlanInfo = {\n /**\n * Plan ID.\n */\n _id: string;\n /**\n * Plan name.\n */\n name?: string;\n /**\n * Plan description.\n */\n description?: string;\n /**\n * List of text strings that promote the pricing plan (for example, \"Plenty of parking\" or \"Free gift on your birthday\").\n */\n perks?: string[];\n /**\n * Plan price, payment schedule, and expiration.\n */\n pricing?: PricingInfo;\n /**\n * Whether the plan is public (visible to site visitors).\n */\n public?: boolean;\n /**\n * Whether the same buyer can purchase the plan multiple times. `1` means the buyer can only purchase the plan once. An empty value or `0` means no limitation. Defaults to empty.\n */\n maxPurchasesPerBuyer?: number;\n /**\n * Whether the buyer can start the plan at a later date.\n */\n allowFutureStartDate?: boolean;\n /**\n * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`cancelOrder()`](wix-paid-plans/cancelOrder) function returns an error.\n */\n buyerCanCancel?: boolean;\n /**\n * Any terms and conditions that apply to the plan. This information is displayed during checkout.\n */\n termsAndConditions?: string;\n };\n /**\n * The Pricing Plans Checkout API contains functionality for ordering and checking out\n * your site's pricing plan [orders](https://support.wix.com/en/article/pricing-plans-an-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#)\n */\n interface Checkout {\n /**\n * Applies a coupon to a draft order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#applyCoupon)\n */\n applyCoupon(orderId: string, couponCode: string): Promise;\n /**\n * Change the start date of a draft order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#changeStartDate)\n */\n changeStartDate(orderId: string, startDate: Date): Promise;\n /**\n * Creates an order for a buyer who purchased the plan with an offline transaction.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#createOfflineOrder)\n */\n createOfflineOrder(planId: string, buyerId: string, options?: Checkout.CreateOfflineOrderOptions): Promise;\n /**\n * Creates an order online for currently logged-in member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#createOnlineOrder)\n */\n createOnlineOrder(planId: string, startDate?: Date, couponCode?: string): Promise;\n /**\n * Provides a preview of an offline order as if it was purchased.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#previewOfflineOrder)\n */\n previewOfflineOrder(planId: string, buyerId: string, options?: Checkout.PreviewOfflineOrderOptions): Promise;\n /**\n * Provides a preview of an online order as if it was purchased.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#previewOnlineOrder)\n */\n previewOnlineOrder(planId: string, options?: Checkout.PreviewOnlineOrderOptions): Promise;\n /**\n * Provides a preview of an order's pricing as if was purchased.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#previewPrice)\n */\n previewPrice(planId: string, couponCode?: string): Promise;\n }\n /**\n * Events fired by pricing plans.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#)\n */\n interface Events {\n /**\n * An event that triggers when an order is canceled with `effectiveAt` as `NEXT_PAYMENT_DATE`.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderAutoRenewCanceled)\n */\n onOrderAutoRenewCanceled(event: Events.OrderAutoRenewCanceledEvent): void;\n /**\n * An event that triggers when an order is canceled.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderCanceled)\n */\n onOrderCanceled(event: Events.OrderCanceledEvent): void;\n /**\n * An event that triggers when an order is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderCreated)\n */\n onOrderCreated(event: Events.OrderCreatedEvent): void;\n /**\n * An event that triggers at the start of each payment cycle for online orders.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderCycleStarted)\n */\n onOrderCycleStarted(event: Events.OrderCycleStartedEvent): void;\n /**\n * An event that triggers when the `endDate` of an order is postponed or made earlier.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderEndDatePostponed)\n */\n onOrderEndDatePostponed(event: Events.OrderEndDatePostponedEvent): void;\n /**\n * An event that triggers when an order expires or is canceled immediately.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderEnded)\n */\n onOrderEnded(event: Events.OrderEndedEvent): void;\n /**\n * An event that triggers when an offline order is marked as paid.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderMarkedAsPaid)\n */\n onOrderMarkedAsPaid(event: Events.OrderMarkedAsPaidEvent): void;\n /**\n * An event that triggers when an order is paused.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderPaused)\n */\n onOrderPaused(event: Events.OrderPausedEvent): void;\n /**\n * An event that triggers when an order is purchased.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderPurchased)\n */\n onOrderPurchased(event: Events.OrderPurchasedEvent): void;\n /**\n * An event that triggers when an order resumes.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderResumed)\n */\n onOrderResumed(event: Events.OrderResumedEvent): void;\n /**\n * An event that triggers when the start date of an order is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderStartDateChanged)\n */\n onOrderStartDateChanged(event: Events.OrderStartDateChangedEvent): void;\n /**\n * An event that triggers when the start date of a purchased or free order is reached.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderStarted)\n */\n onOrderStarted(event: Events.OrderUpdatedEvent): void;\n /**\n * An event that triggers when an order is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onOrderUpdated)\n */\n onOrderUpdated(event: Events.OrderUpdatedEvent): void;\n /**\n * An event that triggers when a pricing plan is archived.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onPlanArchived)\n */\n onPlanArchived(event: Events.PlanArchivedEvent): void;\n /**\n * An event that triggers when a pricing plan is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onPlanCreated)\n */\n onPlanCreated(event: Events.PlanCreatedEvent): void;\n /**\n * An event that triggers when a member purchases a plan.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onPlanPurchased)\n */\n onPlanPurchased(event: Events.PlanPurchasedEvent): void;\n /**\n * An event that triggers when a pricing plan is changed.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#onPlanUpdated)\n */\n onPlanUpdated(event: Events.PlanUpdatedEvent): void;\n }\n /**\n * The Pricing Plans Orders API contains functionality for managing\n * your site's pricing plan [orders](https://support.wix.com/en/article/pricing-plans-an-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#)\n */\n interface Orders {\n /**\n * Cancels an existing order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#cancelOrder)\n */\n cancelOrder(orderId: string, effectiveAt: string, options?: Options): Promise;\n /**\n * Gets an order for the currently logged-in member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#getCurrentMemberOrder)\n */\n getCurrentMemberOrder(orderId: string): Promise;\n /**\n * Gets an existing pricing plan order by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#getOrder)\n */\n getOrder(orderId: string, options?: Options): Promise;\n /**\n * Lists orders for the currently logged-in member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#listCurrentMemberOrders)\n */\n listCurrentMemberOrders(filters?: Orders.CurrentMemberFilterOptions, sorting?: Orders.SortingOptions, paging?: Orders.PaginationOptions): Promise;\n /**\n * Lists pricing plan orders.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#listOrders)\n */\n listOrders(filters?: Orders.FilterOptions, sorting?: Orders.SortingOptions, paging?: Orders.PaginationOptions, options?: Options): Promise;\n /**\n * Marks an offline pricing plan order as paid.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#markAsPaid)\n */\n markAsPaid(orderId: string, options?: Options): Promise;\n /**\n * Pauses a pricing plans order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#pauseOrder)\n */\n pauseOrder(orderId: string, options?: Options): Promise;\n /**\n * Extends the duration of a pricing plan order by postponing the order's `endDate`.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#postponeEndDate)\n */\n postponeEndDate(orderId: string, endDate: Date, options?: Options): Promise;\n /**\n * Starts the process of cancelling the logged-in member's pricing plan order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#requestCurrentMemberOrderCancellation)\n */\n requestCurrentMemberOrderCancellation(orderId: string, effectiveAt: string): Promise;\n /**\n * Resumes a paused pricing plan order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#resumeOrder)\n */\n resumeOrder(orderId: string, options?: Options): Promise;\n }\n /**\n * Contains functionality for refining a public pricing plan query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#)\n */\n interface PublicPlansQueryBuilder {\n /**\n * Adds an `and` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#and)\n */\n and(query: PublicPlansQueryBuilder): PublicPlansQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#ascending)\n */\n ascending(...propertyName: string[]): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is within a specified range.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#between)\n */\n between(propertyName: string, rangeStart: string | number | Date, rangeEnd: string | number | Date): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value contains a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#contains)\n */\n contains(propertyName: string, string: string): PublicPlansQueryBuilder;\n /**\n * Adds a sort to a query or sort, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#descending)\n */\n descending(...propertyName: string[]): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value ends with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#endsWith)\n */\n endsWith(propertyName: string, string: string): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): PublicPlansQueryBuilder;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#find)\n */\n find(): Promise;\n /**\n * Refines a query to match items whose specified property value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#ge)\n */\n ge(propertyName: string, value: string | number | Date): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#gt)\n */\n gt(propertyName: string, value: string | number | Date): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property contains any of the specified `value` parameters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#hasSome)\n */\n hasSome(propertyName: string, values: string[]): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#le)\n */\n le(propertyName: string, value: string | number | Date): PublicPlansQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#limit)\n */\n limit(limit: number): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#lt)\n */\n lt(propertyName: string, value: string | number | Date): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): PublicPlansQueryBuilder;\n /**\n * Adds a `not` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#not)\n */\n not(query: PublicPlansQueryBuilder): PublicPlansQueryBuilder;\n /**\n * Adds an `or` condition to the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#or)\n */\n or(query: PublicPlansQueryBuilder): PublicPlansQueryBuilder;\n /**\n * Sets the number of items to skip before returning query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#skip)\n */\n skip(skip: number): PublicPlansQueryBuilder;\n /**\n * Refines a query to match items whose specified property value starts with a specified string.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryBuilder.html#startsWith)\n */\n startsWith(propertyName: string, string: string): PublicPlansQueryBuilder;\n }\n /**\n * The results of a public pricing plans query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#)\n */\n interface PublicPlansQueryResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#items)\n */\n readonly items: PublicPlansQueryResult.Item[];\n /**\n * Returns the number of items in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the query page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the query used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#query)\n */\n readonly query: PublicPlansQueryBuilder;\n /**\n * Returns the total number of items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the query produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * The Pricing Plans Checkout API contains functionality for ordering and checking out\n * your site's pricing plan [orders](https://support.wix.com/en/article/pricing-plans-an-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Checkout.html#)\n */\n namespace Checkout {\n type ApplyCoupon = {\n /**\n * The order with the coupon applied.\n */\n order?: Orders.Order;\n };\n type CreateOfflineOrderOptions = {\n /**\n * Start date and time for the ordered plan.\n *\n * Default: Current date and time\n */\n startDate?: Date;\n /**\n * Whether the order is paid.\n *\n * Default: `false`\n */\n paid?: boolean;\n /**\n * Whether to suppress permission checks from running for the operation.\n *\n * Default: `false`\n */\n suppressAuth?: boolean;\n /**\n * Coupon code to apply.\n *\n * To learn more about coupons, see [applyCoupon()](wix-pricing-plans-backend/checkout/apply-coupon).\n */\n couponCode?: string;\n };\n type OrderPreview = {\n /**\n * The preview, as if the plan had been ordered.\n */\n order?: Orders.Order;\n /**\n * Whether this previewed order would exceed the permitted amount of purchases\n * available for this plan for this buyer.\n *\n * Always `false` for plans that do not have purchase limits.\n */\n purchaseLimitExceeded: boolean;\n };\n type PreviewOfflineOrderOptions = {\n /**\n * Date from which the plan is active. Defaults to the current date.\n */\n startDate?: Date;\n /**\n * When `true`, prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth?: boolean;\n /**\n * Coupon code to apply.\n *\n * To learn more about coupons, see [applyCoupon()](checkout/apply-coupon).\n */\n couponCode?: string;\n };\n type PreviewOnlineOrderOptions = {\n /**\n * Date from which the plan is active. Defaults to the current date.\n */\n startDate?: Date;\n /**\n * Coupon code to apply.\n *\n * To learn more about coupons, see [applyCoupon()](wix-pricing-plans-backend/checkout/apply-coupon).\n */\n couponCode?: string;\n };\n type PricePreview = {\n /**\n * **Deprecated.** Use `prices` instead.\n */\n price: Orders.PriceDetails;\n /**\n * Pricing details.\n */\n prices: Orders.Prices;\n };\n }\n /**\n * Events fired by pricing plans.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Events.html#)\n */\n namespace Events {\n /**\n * Event data.\n */\n type EventData = {\n /**\n * Plan information.\n */\n plan: Plan;\n };\n /**\n * Event metadata.\n */\n type EventMetadata = {\n /**\n * Event ID.\n */\n id: string;\n /**\n * Plan ID associated with this event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Whether the event is triggered as a result of a privacy regulation application. For example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions). For advanced users.\n */\n triggeredByAnonymizeRequest?: boolean;\n };\n /**\n * An object representing a new pricing plan order (subscription).\n */\n type Order = {\n /**\n * Order ID of the purchase of the plan, auto-generated when an order is created.\n */\n id: string;\n /**\n * Status of the payment for the plan. Can be `PAID`, `REFUNDED`, `FAILED`, `UNPAID`, and `PAYMENT_STATUS_UNDEFINED`.\n */\n paymentStatus: string;\n /**\n * Date and time until which the plan is valid.\n */\n validUntil: Date;\n /**\n * Object containing the price of the plan.\n */\n price: Events.Price;\n /**\n * If the plan is canceled, the reason why. One of:\n *\n * + `OWNER_CANCELED`: The owner canceled.\n * + `PAYMENT_PROVIDER_CANCELED`: The payment provider canceled.\n * + `PAYMENT_FAILED`: The payment failed.\n * + `UOU_CANCELED`: The site member canceled.\n * + `CANCELLATION_REASON_UNDEFINED`: The reason is undefined.\n */\n cancellationReason: string;\n /**\n * If the plan is cancelled, the cause of the cancellation. One of:\n *\n * + `\"UNDEFINED\"`: Cancellation initiator undefined.\n * + `\"OWNER\"`: Site owner canceled the order.\n * + `\"MEMBER\"`: Buyer initiated the cancellation.\n * + `\"PAYMENT_FAILURE\"`: Payment transaction failed.\n * + `\"SETUP_FAILURE\"`: Buyer's payment details weren't set up correctly.\n */\n cancellationInitiator: string;\n /**\n * Date and time from which the plan is valid.\n */\n validFrom: Date;\n /**\n * Name of the plan.\n */\n planName: string;\n /**\n * ID of the plan for Wix Pay. If plan is free, this ID is blank.\n */\n wixPayOrderId: string;\n /**\n * If the plan is recurring. If true, the price is deducted weekly, monthly, or yearly.\n */\n recurring: boolean;\n /**\n * Date and time the order was created.\n */\n dateCreated: Date;\n /**\n * Status of the order. Can be `ACTIVE`, `PENDING`, `CANCELED`, `EXPIRED`, `PENDING_CANCELLATION`, and `ORDER_STATUS_UNDEFINED`.\n */\n status: string;\n /**\n * Description of the plan.\n */\n planDescription: string;\n /**\n * ID for the member who ordered the plan.\n */\n memberId: string;\n /**\n * How the plan was ordered, either `ONLINE` or `OFFLINE`.\n */\n orderType: string;\n /**\n * ID of the plan.\n */\n planId: string;\n /**\n * Object containing properties about how long the plan is valid.\n */\n validFor: Events.ValidFor;\n /**\n * How many trial days were given to the subscriber of the plan. Available only for orders whose plans are recurring, meaning plans whose pricing model is `subscription`.\n */\n freeTrialDays?: number;\n /**\n * Role assigned after ordering the plan.\n */\n roleId: string;\n };\n /**\n * Information about the event fired when the order auto-renewal is canceled.\n */\n type OrderAutoRenewCanceledEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order cancellation event.\n */\n type OrderCanceledEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order's creation event.\n */\n type OrderCreatedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Order information.\n */\n entity: Orders.Order;\n };\n /**\n * Information about the event fired when the order's payment cycle is triggered. This means the next payment date has arrived.\n */\n type OrderCycleStartedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderCycleStartedEventData;\n };\n /**\n * Event data.\n */\n type OrderCycleStartedEventData = {\n /**\n * Order information.\n */\n order: Orders.Order;\n /**\n * Number of the payment cycle. Zero for unlimited plan orders and orders whose plans are valid until canceled.\n */\n cycleNumber: number;\n };\n /**\n * Information about the order postponed event.\n */\n type OrderEndDatePostponedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order end event.\n */\n type OrderEndedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Event data.\n */\n type OrderEventData = {\n /**\n * Order information.\n */\n order: Orders.Order;\n };\n /**\n * Event metadata.\n */\n type OrderEventMetadata = {\n /**\n * Event ID.\n */\n id: string;\n /**\n * Order ID associated with this event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Whether the event is triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.\n */\n triggeredByAnonymizeRequest?: boolean;\n };\n /**\n * Information about the offline order \"marked as paid\" event.\n */\n type OrderMarkedAsPaidEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order pause event.\n */\n type OrderPausedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order purchase event.\n */\n type OrderPurchasedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order resumption event.\n */\n type OrderResumedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order's start date change event.\n */\n type OrderStartDateChangedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Data about the order.\n */\n data: Events.OrderEventData;\n };\n /**\n * Information about the order update event.\n */\n type OrderUpdatedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.OrderEventMetadata;\n /**\n * Order information.\n */\n entity: Orders.Order;\n };\n /**\n * An object representing the period for which a plan is valid.\n */\n type Period = {\n /**\n * The number of units until the plan expires.\n */\n amount: number;\n /**\n * Time period for billing the plan, such as `MONTH`.\n */\n unit: string;\n };\n /**\n * Information about the plan archive event.\n */\n type PlanArchivedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Event data, including information about the archived plan.\n */\n data: Events.EventData;\n };\n /**\n * Information about the create plan event.\n */\n type PlanCreatedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Plan information.\n */\n entity: Plan;\n };\n /**\n * An object representing a new pricing plan purchase.\n */\n type PlanPurchasedEvent = {\n /**\n * Object containing the details about the plan's order.\n */\n order: Events.Order;\n };\n /**\n * Information about the plan update event.\n */\n type PlanUpdatedEvent = {\n /**\n * Event metadata.\n */\n metadata: Events.EventMetadata;\n /**\n * Plan information.\n */\n entity: Plan;\n };\n /**\n * An object representing the price of the plan.\n */\n type Price = {\n /**\n * Payment currency. A three-letter\n * [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n */\n currency: string;\n /**\n * The cost of the plan.\n */\n amount: number;\n };\n /**\n * An object representing how long a plan is valid.\n */\n type ValidFor = {\n /**\n * If true, the plan does not expire.\n */\n forever: boolean;\n /**\n * Object containing the period for which the plan is valid.\n */\n period: Events.Period;\n };\n }\n /**\n * The Pricing Plans Orders API contains functionality for managing\n * your site's pricing plan [orders](https://support.wix.com/en/article/pricing-plans-an-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.Orders.html#)\n */\n namespace Orders {\n /**\n * Buyer details.\n */\n type Buyer = {\n /**\n * Member ID for the buyer. See [`wix-members-backend`](wix-members-backend/introduction) to learn more about a site's members.\n */\n memberId: string;\n /**\n * Contact ID for the buyer. See [Contacts in `wix-crm-backend`](wix-crm-backend/contacts/introduction) to learn more about a site's contacts.\n */\n contactId: string;\n };\n /**\n * Details about the cancellation of an order. Only present if the order `status` is `\"CANCELED\"`.\n */\n type Cancellation = {\n /**\n * Date and time when the cancellation was requested.\n */\n requestedDate: Date;\n /**\n * The reason for the cancellation.\n * Supported values:\n * + `\"OWNER_ACTION\"`. The site owner canceled the order.\n * + `\"MEMBER_ACTION\"`. The buyer initiated the cancellation.\n * + `\"PAYMENT_FAILURE\"`. A payment transaction failed.\n * + `\"PAYMENT_SETUP_FAILURE\"`. The buyer's payment details weren't set up correctly.\n */\n cause: string;\n /**\n * When the cancellation takes effect. This is set when cancelling the order.\n * Supported values:\n * + `\"IMMEDIATELY\"`. The cancellation occurs immediately and the buyer can no longer use the plan at this point.\n * + `\"NEXT_PAYMENT_DATE\"`. The cancellation occurs at the next payment date and time. The buyer can continue to use the plan until that date and time.\n */\n effectiveAt: string;\n };\n /**\n * Coupon applied to the order.\n *\n * To learn more about coupons, see [applyCoupon()](wix-pricing-plans-backend/checkout/applycoupon).\n */\n type Coupon = {\n /**\n * Code of the applied coupon.\n */\n code: string;\n /**\n * Total discount of the coupon, as a monetary amount.\n */\n amount: string;\n /**\n * Coupon ID.\n */\n id: string;\n };\n /**\n * Current payment cycle for the order.\n *\n * `currentCycle` will be omitted if the order's `status` is `CANCELED` or `ENDED`, or if the `startDate` hasn't been reached yet.\n */\n type CurrentCycle = {\n /**\n * Index of the current payment cycle in the order.\n *\n * `0` when the order is in a free trial period. In all other cases, the index starts with `1`.\n */\n index: number;\n /**\n * Start date and time for the current payment cycle.\n */\n startedDate: Date;\n /**\n * End date and time for the current payment cycle.\n */\n endedDate: Date;\n };\n /**\n * Fields to filter by when listing orders for the current member.\n */\n type CurrentMemberFilterOptions = {\n /**\n * Specific IDs of plans that were ordered by the current member.\n */\n planIds?: string[];\n /**\n * Whether the auto-renewal of the current member's recurring orders was canceled.\n */\n autoRenewCanceled?: boolean;\n /**\n * Specific statuses for the current member's orders.\n * + `\"DRAFT\"`. The order has been initiated but payment has not been processed yet. The plan is not yet available for use.\n * + `\"PENDING\"`. Payment is being processed. The plan is not yet available for use.\n * + `\"ACTIVE\"`. The order has been processed and paid for. The plan is available for use.\n * + `\"PAUSED\"`. Use of the plan has been [paused](wix-pricing-plans-backend/orders/pauseorder), for example, if the buyer is away. The plan can be [resumed](wix-pricing-plans-backend/orders/resumeorder).\n * + `\"ENDED\"`. The order has completed its duration and is no longer available for use.\n * + `\"CANCELED\"`. The order has been [canceled](wix-pricing-plans-backend/orders/cancelorder).\n */\n orderStatuses?: string[];\n /**\n * Specific payment statuses for the current member's orders.\n * + `\"PAID\"`. The last payment was paid.\n * + `\"REFUNDED\"`. The last payment was refunded.\n * + `\"FAILED\"`. The last payment transaction did not complete.\n * + `\"UNPAID\"`. The last payment was not paid.\n * + `\"PENDING\"`. Awaiting payment.\n * + `\"NOT_APPLICABLE\"`. No payment was necessary, such as for free plans or free trials.\n */\n paymentStatuses?: string[];\n };\n /**\n * Length of one payment cycle. For example, `1` `MONTH` for monthly payments.\n */\n type Duration = {\n /**\n * The amount of a duration `unit` in a single payment cycle.\n *\n * Currently limited to support only value of `1`.\n */\n count: number;\n /**\n * Unit of time for the cycle duration.\n *\n * Supported values: `\"UNDEFINED\"`, `\"DAY\"`, `\"WEEK\"`, `\"MONTH\"`, `\"YEAR\"`\n */\n unit: string;\n };\n /**\n * Fields to filter by when listing orders.\n */\n type FilterOptions = {\n /**\n * Specific member IDs of buyers who ordered a pricing plan.\n */\n buyerIds?: string[];\n /**\n * Specific IDs of plans that were ordered.\n */\n planIds?: string[];\n /**\n * Whether the auto-renewal of recurring orders was canceled.\n */\n autoRenewCanceled?: boolean;\n /**\n * Specific order statuses.\n * + `\"DRAFT\"`. The order has been initiated but payment has not been processed yet. The plan is not yet available for use.\n * + `\"PENDING\"`. Payment is being processed. The plan is not yet available for use.\n * + `\"ACTIVE\"`. The order has been processed and paid for. The plan is available for use.\n * + `\"PAUSED\"`. Use of the plan has been [paused](wix-pricing-plans-backend/orders/pauseorder), for example, if the buyer is away. The plan can be [resumed](wix-pricing-plans-backend/orders/resumeorder).\n * + `\"ENDED\"`. The order has completed its duration and is no longer available for use.\n * + `\"CANCELED\"`. The order has been [canceled](wix-pricing-plans-backend/orders/cancelorder).\n */\n orderStatuses?: string[];\n /**\n * Specific payment statuses.\n * + `\"PAID\"`. The last payment was paid.\n * + `\"REFUNDED\"`. The last payment was refunded.\n * + `\"FAILED\"`. The last payment transaction did not complete.\n * + `\"UNPAID\"`. The last payment was not paid.\n * + `\"PENDING\"`. Awaiting payment.\n * + `\"NOT_APPLICABLE\"`. No payment was necessary, such as for free plans or free trials.\n */\n paymentStatuses?: string[];\n };\n type Order = {\n /**\n * Order ID.\n */\n _id: string;\n /**\n * ID of the plan that was ordered.\n */\n planId: string;\n /**\n * ID of the related Wix subscription.\n *\n * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. You can see all orders from your site's [Subscriptions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsubscriptions%3FreferralInfo%3Dvelo-docs) page in the Dashboard.\n */\n subscriptionId: string;\n /**\n * ID of the associated Wix Pay order.\n *\n * Created by the [`createOnlineOrder()`](wix-pricing-plans-backend/checkout/createonlineorder) or [`createfflineOrder()`](wix-pricing-plans-backend/checkout/createofflineorder) function. For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](wix-pay-frontend/startPayment) function to enable your buyer to pay for the order. `wixPayOrderId` is omitted if the order is free.\n */\n wixPayOrderId?: string;\n /**\n * The buyer's IDs. Includes `memberId` and `contactId`.\n *\n * Currently, Pricing Plan orders are limited to members only. `contactId` is returned, but a buyer will not be able to order a plan without a `memberId`.\n */\n buyer: Orders.Buyer;\n /**\n * **Deprecated.** Use `pricing` instead.\n */\n priceDetails: Orders.PriceDetails;\n /**\n * Order [pricing model](wix-pricing-plans-backend/introduction#pricing-models), price, and payment schedule.\n */\n pricing?: Orders.Pricing;\n /**\n * How the order was processed.\n * Supported values:\n * + `\"ONLINE\"`. The buyer ordered the plan using the site.\n * + `\"OFFLINE\"`. The buyer made a manual, offline order without using the site.\n */\n type: string;\n /**\n * Status of the order.\n * Supported values:\n * + `\"DRAFT\"`. The order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use.\n * + `\"PENDING\"`. The order has been processed and its start date is set in the future. The plan isn't yet available for use.\n * + `\"ACTIVE\"`. The order has been processed. The plan is available for use.\n * + `\"PAUSED\"`. The order, and use of the plan, is [paused](wix-pricing-plans-backend/orders/pauseorder). For example, if the buyer is away. The order, and use of the plan, can be [resumed](wix-pricing-plans-backend/orders/resumeorder).\n * + `\"ENDED\"`. The order has completed its duration and is no longer available for use.\n * + `\"CANCELED\"`. The order has been [canceled](wix-pricing-plans-backend/orders/cancelorder).\n */\n status: string;\n /**\n * Whether the order will be canceled at the next payment date.\n *\n * If `true`, the order `status` will be `CANCELED` and the next payment won't be charged. Omitted for single payment orders.\n */\n autoRenewCanceled?: boolean;\n /**\n * Details about the cancellation of an order. Only present if the `status` is `\"CANCELED\"`.\n */\n cancellation?: Orders.Cancellation;\n /**\n * Status of the last payment for the order. This is updated automatically for online orders. The site owner updates this manually for offline orders.\n * Supported values:\n * + `\"PAID\"`. The last payment was paid.\n * + `\"REFUNDED\"`. The last payment was refunded.\n * + `\"FAILED\"`. The last payment transaction didn't complete.\n * + `\"UNPAID\"`. The last payment wasn't paid.\n * + `\"PENDING\"`. Awaiting payment.\n * + `\"NOT_APPLICABLE\"`. No payment was necessary. For example, for free plans or free trials.\n */\n lastPaymentStatus: string;\n /**\n * Start date and time for the ordered plan.\n */\n startDate: Date;\n /**\n * Current date and time the ordered plan will expire.\n *\n * `endDate` may be updated over the course of an order. If the order is [paused](wix-pricing-plans-backend/orders/pauseorder), it will have a later `endDate` once it [resumes](wix-pricing-plans-backend/orders/resumeorder). `endDate` may also be [postponed](wix-pricing-plans-backend/orders/postponeenddate).\n *\n * Omitted if the order is valid until canceled and still `\"ACTIVE\"`.\n */\n endDate?: Date;\n /**\n * List of periods during which this order is paused.\n */\n pausePeriods: Orders.PausePeriod[];\n /**\n * Free trial period, in days. Only available for recurring plans.\n */\n freeTrialDays?: string;\n /**\n * Earliest end date and time that the plan for this order can expire.\n *\n * This is calculated by adding all pause periods to the original end date. Omitted if the order is active until canceled. Reserved for future use.\n */\n earliestEndDate?: Date;\n /**\n * Current payment cycle for the order.\n *\n * `currentCycle` will be omitted if the order's status is `CANCELED` or `ENDED`, or if the `startDate` hasn't passed yet.\n */\n currentCycle: Orders.CurrentCycle;\n /**\n * Name of the plan at the time of the order.\n */\n planName: string;\n /**\n * Description of the plan at the time of the order.\n */\n planDescription: string;\n /**\n * Plan price as it was at the moment of order creation.\n */\n planPrice: string;\n /**\n * Date and time the order was created.\n */\n _createdDate: Date;\n /**\n * Date and time the order was last updated. For example, the date and time an order was paused, resumed, or canceled.\n */\n _updatedDate: Date;\n };\n /**\n * The order has recurring payments.\n */\n type OrderRecurrence = {\n /**\n * Length of one payment cycle. For example, `1` `MONTH` for monthly payments.\n */\n cycleDuration: Orders.Duration;\n /**\n * Amount of payment cycles this subscription is valid for.\n *\n * `0` for orders of plans that are unlimited or until-canceled.\n */\n cycleCount: number;\n };\n type PaginationOptions = {\n /**\n * Limit the number of orders returned.\n *\n * Default: `50`\n */\n limit?: number;\n /**\n * Number of entries to skip.\n */\n skip?: number;\n };\n /**\n * Period during which the order of a plan is suspended.\n */\n type PausePeriod = {\n /**\n * Status of the pause period.\n * Supported values:\n * + `\"ACTIVE\"`. Status while the order is [paused](wix-pricing-plans-backend/orders/pauseorder).\n * + `\"ENDED\"`. Status while the order is [resumed](wix-pricing-plans-backend/orders/resumeorder).\n */\n status: string;\n /**\n * Start date and time of the pause period.\n */\n pauseDate: Date;\n /**\n * End date and time of the pause period.\n *\n * Omitted while the pause period remains `\"ACTIVE\"`.\n */\n resumeDate: Date;\n };\n /**\n * Order price details.\n */\n type Price = {\n /**\n * Price of the order excluding tax, specified as a monetary amount. For example, `\"9.99\"`.\n */\n subtotal: string;\n /**\n * Coupon applied to the order.\n *\n * To learn more about coupons, see [applyCoupon()](wix-pricing-plans-backend/checkout/applycoupon).\n */\n coupon: Orders.Coupon;\n /**\n * Total discount applied to the order.\n */\n discount: string;\n /**\n * Tax applied to the order.\n */\n tax?: Orders.Tax;\n /**\n * Price after tax and discount is applied, specified as a monetary amount. For example, `\"13.98\"`.\n *\n * If no tax is applied, this amount is the same as `subtotal`.\n */\n total: string;\n /**\n * Three-letter currency code in [ISO 4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency: string;\n };\n /**\n * **Deprecated.** Use `pricing` instead.\n */\n type PriceDetails = {\n /**\n * Price of the order, excluding tax. Specified as a monetary amount, such as `\"3.99\"`.\n */\n subtotal: string;\n /**\n * Tax applied for the plan. Omitted if no tax was applied.\n */\n tax?: Orders.Tax;\n /**\n * Price after tax is applied. Specified as a monetary amount, such as `\"4.98\"`. If no tax was applied, this amount is the same as `subtotal`.\n */\n total: string;\n /**\n * Price of the plan when the order was created. This price is the amount for a single payment. For subscriptions, this is the amount to pay for each single payment cycle and the `planPrice` is required. Otherwise, the payment is for the entire plan.\n */\n planPrice: string;\n /**\n * Currency code. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (for example, `\"USD\"`).\n */\n currency: string;\n /**\n * Pricing model indicating that the order has recurring payments. This type of subscription isn't a \"Wix subscription,\" which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.\n */\n subscription?: Orders.OrderRecurrence;\n /**\n * Pricing model indicating that the order is paid with a single payment per cycle and what the length of the cycle is. The cycle is the duration of the order's plan, not a payment cycle.\n */\n singlePaymentForDuration?: Duration;\n /**\n * Pricing model indicating that the order of the plan is paid in one single payment and that the order is active until canceled.\n */\n singlePaymentUnlimited?: boolean;\n /**\n * Free trial period for the order in days. Available only for orders whose plans are recurring, meaning plans whose pricing model is `subscription`.\n */\n freeTrialDays?: number;\n };\n /**\n * Cycle duration to apply `price` for.\n */\n type PriceDuration = {\n /**\n * Price starts to apply with this cycle.\n *\n * `1` is the first payment cycle for all pricing models.\n */\n cycleFrom: number;\n /**\n * Amount of cycles to apply price for.\n *\n * For `subscription` pricing models with a finite number of cycles, the `numberOfCycles` is the same as `pricing.subscription.cycleCount`.\n *\n * For `subscription` pricing models that are unlimited or until-canceled, the `numberOfCycles` is not returned.\n *\n * For `singlePaymentForDuration` and `singlePaymentUnlimited` pricing models, the `numberOfCycles` is `1`.\n */\n numberOfCycles: number;\n };\n /**\n * Pricing details for all pricing models.\n */\n type Prices = {\n /**\n * Cycle duration to apply `price` for.\n *\n * Use with all pricing models. Can apply the same price to multiple payment cycles.\n */\n duration: Orders.PriceDuration;\n /**\n * Order price.\n */\n price: Orders.Price;\n };\n /**\n * Order pricing model, price, and payment schedule.\n */\n type Pricing = {\n /**\n * Pricing model for an order with recurring payment cycles.\n */\n subscription?: Orders.OrderRecurrence;\n /**\n * Pricing model for an order with a one-time payment and the order is valid for a specific amount of time.\n */\n singlePaymentForDuration?: Orders.Duration;\n /**\n * Pricing model for an order with a one-time payment and the order is valid until canceled.\n */\n singlePaymentUnlimited?: boolean;\n /**\n * Pricing details for all pricing models.\n */\n prices: Orders.Prices;\n };\n /**\n * Sorting details.\n */\n type SortingOptions = {\n /**\n * Name of the property to sort by.\n *\n * Supported values: `_createdDate`, `endDate`\n *\n * Default: `_createdDate`\n */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Supported values:\n * + `\"ASC\"`: Ascending\n * + `\"DESC\"`: Descending\n *\n * Default: `\"ASC\"`\n */\n order?: string;\n };\n /**\n * Tax applied to the order. If empty, no tax was applied.\n */\n type Tax = {\n /**\n * Name of the tax. For example, VAT.\n */\n name: string;\n /**\n * Whether tax is included in the original price. When `false`, tax is added at checkout.\n */\n includedInPrice: boolean;\n /**\n * Tax rate percentage, as a number between 0 and 100. For example, a 7% tax rate is `\"7.00\"`.\n */\n rate: string;\n /**\n * Total tax, specified as a monetary amount. For example, `\"3.99\"`.\n */\n amount: string;\n };\n }\n /**\n * The results of a public pricing plans query, containing the retrieved items.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-pricing-plans-backend.PublicPlansQueryResult.html#)\n */\n namespace PublicPlansQueryResult {\n /**\n * An item returned by a query.\n */\n type Item = {\n /**\n * An item that matches the query.\n */\n publicPlan: PublicPlan;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-realtime-backend.d.ts", "content": "/**\n * The wix-realtime module contains functionality for publishing messages\n * on channels that site visitors can subscribe to and for managing channel permissions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.html#)\n */\ndeclare module 'wix-realtime-backend' {\n /**\n * Returns the realtime permissions router.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.html#permissionsRouter)\n */\n const permissionsRouter: PermissionsRouter;\n /**\n * Publishes a message to a channel or channel resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.html#publish)\n */\n function publish(channel: Channel, payload: any, options?: PublishOptions): Promise & void;\n /**\n * Checks permissions for a subscriber on a channel or channel resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.html#realtime_check_permission)\n */\n function realtime_check_permission(channel: Channel, subscriber: Subscriber): Promise & ChannelPermissions;\n /**\n * An object representing a channel or channel resource.\n * Site visitors can subscribe to a channel or channel resource to receive the\n * messages that are published on it. When site visitors subscribe to a channel, they do not\n * receive messages published to a resource on that same channel. Similarly,\n * when site visitors subscribe to a channel resource, they do not\n * receive messages published to that same channel without a specified resource.\n * Channel resources inherit their parent channel's permissions, unless specified\n * otherwise.\n */\n type Channel = {\n /**\n * Channel name. Cannot exceed 140 characters. Cannot include spaces or special characters.\n */\n name: string;\n /**\n * ID of a specific channel resource.\n */\n resourceId?: string;\n };\n /**\n * An object containing permission settings for a channel.\n */\n type ChannelPermissions = {\n /**\n * Whether the subscriber has read permissions. Defaults to `true`.\n */\n read?: boolean;\n };\n /**\n * An object containing options for publishing.\n */\n type PublishOptions = {\n /**\n * User IDs of specific users to publish to.\n */\n users?: string[];\n /**\n * Whether to include information about the message publisher.\n * Defaults to `false`.\n */\n includePublisher?: boolean;\n };\n /**\n * An object representing a channel subscriber.\n */\n type Subscriber = {\n /**\n * The subscriber's user ID.\n */\n id: string;\n /**\n * The type of subscriber.\n *\n * One of:\n *\n * + `\"Admin\"`: Subscriber is the site owner.\n * + `\"Member\"`: Subscriber is a logged-in site member.\n * + `\"Visitor\"`: Subscriber in not logged in.\n */\n type: string;\n };\n /**\n * A router for defining and checking permissions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.PermissionsRouter.html#)\n */\n interface PermissionsRouter {\n /**\n * Sets a permissions handler for a specific channel or channel resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.PermissionsRouter.html#add)\n */\n add(channel: Channel, handler: PermissionsRouter.PermissionsHandler): Promise & void;\n /**\n * Checks the permissions for a subscriber on a channel or channel resource.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.PermissionsRouter.html#check)\n */\n check(channel: Channel, subscriber: Subscriber): Promise & ChannelPermissions;\n /**\n * Sets a permissions handler for default permissions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.PermissionsRouter.html#default)\n */\n default(handler: PermissionsRouter.PermissionsHandler): void;\n }\n /**\n * A router for defining and checking permissions.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-realtime-backend.PermissionsRouter.html#)\n */\n namespace PermissionsRouter {\n type PermissionsHandler = (channel: Channel, subscriber: Subscriber) => Promise | ChannelPermissions;\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-search.d.ts", "content": "/**\n * The wix-search module contains functionality for searching a site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.html#)\n */\ndeclare module 'wix-search' {\n /**\n * Creates a filter builder for building search filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.html#filter)\n */\n function filter(): WixSearchFilterBuilder;\n /**\n * Creates a search builder.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.html#search)\n */\n function search(phrase?: string): WixSearchBuilder;\n /**\n * Contains functionality for filtering a site search.\n */\n type WixSearchFilter = {\n /**\n * An object containing the filter definition.\n */\n filterDefinition: any;\n };\n /**\n * Contains functionality for refining a site search.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#)\n */\n interface WixSearchBuilder {\n /**\n * Refines a search to match documents that meet the conditions of all of the specified filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#and)\n */\n and(...filters: WixSearchFilter[]): WixSearchBuilder;\n /**\n * Adds a sort to a search, sorting by the specified fields in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#ascending)\n */\n ascending(...field: string[]): WixSearchBuilder;\n /**\n * Adds a sort to a search, sorting by the specified fields in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#descending)\n */\n descending(...field: string[]): WixSearchBuilder;\n /**\n * Refines a search builder to only search for documents of the specified document type.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#documentType)\n */\n documentType(type: string): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#eq)\n */\n eq(field: string, value: any): WixSearchBuilder;\n /**\n * Categorizes search results according to the specified facets.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#facets)\n */\n facets(...facets: string[]): WixSearchBuilder;\n /**\n * Returns the documents that match the search.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#find)\n */\n find(): Promise;\n /**\n * Sets whether to search for exact matches or approximate matches of the search phrase.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#fuzzy)\n */\n fuzzy(fuzzy: boolean): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#ge)\n */\n ge(field: string, value: string | number | Date): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#gt)\n */\n gt(field: string, value: string | number | Date): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field value contains all of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#hasAll)\n */\n hasAll(field: string, values: string[]): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#hasSome)\n */\n hasSome(field: string, values: string[]): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field value equals any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#in)\n */\n in(field: string, values: string[] | number[]): WixSearchBuilder;\n /**\n * Refines a search builder to search in the specified language.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#language)\n */\n language(language: string): WixSearchBuilder;\n /**\n * Refines a search or filter to match documents whose specified field value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#le)\n */\n le(field: string, value: string | number | Date): WixSearchBuilder;\n /**\n * Limits the number of documents the search returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#limit)\n */\n limit(limit: number): WixSearchBuilder;\n /**\n * Refines a search or filter to match documents whose specified field value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#lt)\n */\n lt(field: string, value: string | number | Date): WixSearchBuilder;\n /**\n * Refines a search to match documents whose specified field value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#ne)\n */\n ne(field: string, value: any): WixSearchBuilder;\n /**\n * Refines a search to match documents that do not meet the conditions of all of the specified filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#not)\n */\n not(...filters: WixSearchFilter[]): WixSearchBuilder;\n /**\n * Refines a search to match documents that meet the condition of any of the specified filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#or)\n */\n or(...filters: WixSearchFilter[]): WixSearchBuilder;\n /**\n * Sets the search phrase to search for.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#query)\n */\n query(phrase: string): WixSearchBuilder;\n /**\n * Refines a search to include only certain fields.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#searchFields)\n */\n searchFields(fields: string[]): WixSearchBuilder;\n /**\n * Sets the number of documents to skip before returning search results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchBuilder.html#skip)\n */\n skip(skip: number): WixSearchBuilder;\n }\n /**\n * Contains functionality for creating filters to use in a site search.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#)\n */\n interface WixSearchFilterBuilder {\n /**\n * Creates a search filter for matching documents that meet the conditions of all of the specified filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#and)\n */\n and(...filters: WixSearchFilter[]): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#eq)\n */\n eq(field: string, value: any): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#ge)\n */\n ge(field: string, value: string | number | Date): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#gt)\n */\n gt(field: string, value: string | number | Date): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value contains all of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#hasAll)\n */\n hasAll(field: string, values: string[]): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field contains any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#hasSome)\n */\n hasSome(field: string, values: string[]): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value equals any of the specified values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#in)\n */\n in(field: string, values: string[] | number[]): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#le)\n */\n le(field: string, value: string | number | Date): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#lt)\n */\n lt(field: string, value: string | number | Date): WixSearchFilter;\n /**\n * Creates a search filter for matching documents whose specified field value does not equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#ne)\n */\n ne(field: string, value: any): WixSearchFilter;\n /**\n * Creates a search filter for matching documents that do not meet the conditions of all of the specified filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#not)\n */\n not(...filters: WixSearchFilter[]): WixSearchFilter;\n /**\n * Creates a filter for matching documents that meet the condition of any of the specified filters.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchFilterBuilder.html#or)\n */\n or(...filters: WixSearchFilter[]): WixSearchFilter;\n }\n /**\n * The results of a site search, containing the retrieved documents.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#)\n */\n interface WixSearchResult {\n /**\n * Returns the index of the current results page number.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#currentPage)\n */\n readonly currentPage: number;\n /**\n * Returns the documents that match the search.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#documents)\n */\n readonly documents: WixSearchResult.Document[];\n /**\n * Returns the facet results retrieved by the search.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#facets)\n */\n readonly facets: WixSearchResult.FacetResult[];\n /**\n * Returns the number of documents in the current results page.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#length)\n */\n readonly length: number;\n /**\n * Returns the search page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#pageSize)\n */\n readonly pageSize: number;\n /**\n * Returns the total number of documents that match the search.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#totalCount)\n */\n readonly totalCount: number;\n /**\n * Returns the total number of pages the search produced.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#totalPages)\n */\n readonly totalPages: number;\n /**\n * Indicates if the search has another page of results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates if the search has a previous page of results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of search results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of search results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * The results of a site search, containing the retrieved documents.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-search.WixSearchResult.html#)\n */\n namespace WixSearchResult {\n /**\n * A document returned by a site search. The following are the default properties included in every search result document. For app-specific properties, check the supported schema for each [`documentType`](wix-search.WixSearchBuilder.html#documentType).\n */\n type Document = {\n /**\n * Unique document identifier.\n */\n _id: string;\n /**\n * Document image in the following format: `wix:image://v1//#originWidth=&originHeight=[&watermark=]`\n */\n image: string;\n /**\n * Document type.\n * One of the following:\n *\n * + `Site/Pages`\n * + `Blog/Posts`\n * + `Bookings/Services`\n * + `Forum/Content`\n * + `Stores/Products`\n */\n documentType: string;\n /**\n * The relative page URL. For regular site pages, the URL defined in [SEO settings](https://support.wix.com/en/article/changing-your-page-url). Note that the `url` for the home page is an empty string. For Wix app pages, the URL stored in the database collection.\n */\n url: string;\n /**\n * For regular site pages, all text on the page. For Wix app pages, the description or content stored in the database collection.\n */\n description: string;\n /**\n * For regular site pages, the [SEO page title](https://support.wix.com/en/article/adding-seo-page-titles-and-descriptions-meta-tags#page-titles). For Wix app pages, the title or name stored in the database collection.\n */\n title: string;\n };\n /**\n * Facet value information.\n */\n type Facet = {\n /**\n * Facet value.\n */\n facetValue: string;\n /**\n * Number of returned documents that match the facet value.\n */\n count: number;\n };\n /**\n * Facet information for a single facet specified for the search. Includes the name of the specified facet and the results for each facet value.\n */\n type FacetGroup = {\n /**\n * Name of the facet specified for the search.\n */\n facet: string;\n /**\n * Information about the facet values for the specified facet.\n */\n facets: WixSearchResult.Facet[];\n };\n /**\n * A facet result returned by a site search. A facet result is returned for each parameter specified in the [`facets()`](wix-search.WixSearchBuilder.html#facets) function.\n */\n type FacetResult = {\n /**\n * A facet group with facet information. Includes the name of the specified facet and the results for each facet value.\n */\n facets: WixSearchResult.FacetGroup[];\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-secrets-backend.d.ts", "content": "/**\n * The wix-secrets-backend module contains functionality for\n * managing secrets you safely store in your site's [Secrets Manager](https://support.wix.com/en/article/velo-about-the-secrets-manager).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.html#)\n */\ndeclare module 'wix-secrets-backend' {\n /**\n * > **Deprecation Warning**\n * >\n * > This method will be deprecated on September 7, 2025.\n * >\n * > Replace with [Create Secret](https://dev.wix.com/docs/velo/apis/wix-secrets-backend-v2/secrets/create-secret).\n *\n * Creates a new secret.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.html#createSecret)\n */\n function createSecret(secret: Secret): Promise;\n /**\n * > **Deprecation Warning**\n * >\n * > This method will be deprecated on September 7, 2025.\n * >\n * > Replace with [Delete Secret](https://dev.wix.com/docs/velo/apis/wix-secrets-backend-v2/secrets/delete-secret).\n *\n * Deletes an existing secret by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.html#deleteSecret)\n */\n function deleteSecret(id: string): Promise;\n /**\n * > **Deprecation Warning**\n * >\n * > This method will be deprecated on September 7, 2025.\n * >\n * > Replace with [Get Secret Value](https://dev.wix.com/docs/velo/apis/wix-secrets-backend-v2/secrets/get-secret-value).\n *\n * Gets a secret by name.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.html#getSecret)\n */\n function getSecret(name: string): Promise;\n /**\n * > **Deprecation Warning**\n * >\n * > This method will be deprecated on September 7, 2025.\n * >\n * > Replace with [List Secret Info](https://dev.wix.com/docs/velo/apis/wix-secrets-backend-v2/secrets/list-secret-info).\n *\n * Gets a list of objects containing information about all secrets stored in the Secrets Manager.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.html#listSecretInfo)\n */\n function listSecretInfo(): Promise;\n /**\n * > **Deprecation Warning**\n * >\n * > This method will be deprecated on September 7, 2025.\n * >\n * > Replace with [Update Secret](https://dev.wix.com/docs/velo/apis/wix-secrets-backend-v2/secrets/update-secret).\n *\n * Updates the specified fields of an existing secret by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.html#updateSecret)\n */\n function updateSecret(id: string, secret: SecretUpdateInfo): Promise;\n /**\n * An object representing information for creating or updating a secret.\n */\n type Secret = {\n /**\n * A unique, meaningful name used for retrieving the secret at runtime using [`getSecret()`](wix-secrets-backend.html#getSecret). You can use alphanumeric characters and the following special characters: `_+=-#@$#`. Spaces are not supported.\n */\n name: string;\n /**\n * The confidential value to protect, such as an API key.\n */\n value: string;\n /**\n * An optional text describing the secret's purpose or any other notes.\n */\n description?: string;\n };\n /**\n * Information about a secret, not including the protected `value`.\n */\n type SecretInfo = {\n /**\n * The secret's ID.\n */\n id: string;\n /**\n * A unique, meaningful name used for retrieving the secret at runtime using [`getSecret()`](wix-secrets-backend.html#getSecret).\n */\n name: string;\n /**\n * An optional text describing the secret's purpose or any other notes about it.\n */\n description: string;\n /**\n * The date and time the secret was created.\n */\n createdDate: Date;\n /**\n * The date and time the secret was last updated.\n */\n updatedDate: Date;\n };\n /**\n * An object representing information for creating or updating a secret.\n */\n type SecretUpdateInfo = {\n /**\n * A unique, meaningful name used for retrieving the secret at runtime using [`getSecret()`](wix-secrets-backend.html#getSecret). You can use alphanumeric characters and the following special characters: `_+=-#@$#`. Spaces are not supported.\n */\n name?: string;\n /**\n * The confidential value to protect, such as an API key.\n */\n value?: string;\n /**\n * An optional text describing the secret's purpose or any other notes.\n */\n description?: string;\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-secrets-backend.v2.d.ts", "content": "/**\n * [Read more](https://www.wix.com/corvid/reference/wix-secrets-backend.v2.html#)\n */\ndeclare module 'wix-secrets-backend.v2' {\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.html#secrets)\n */\n const secrets: Secrets;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#)\n */\n interface Secrets {\n /**\n * Creates a new secret.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#createSecret)\n */\n createSecret(secret: Secrets.Secret): Promise;\n /**\n * Deletes an existing secret by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#deleteSecret)\n */\n deleteSecret(_id: string): Promise;\n /**\n * Retrieves the secret value specified by the secret name.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#getSecretValue)\n */\n getSecretValue(name: string): Promise;\n /**\n * Retrieves a list of objects containing information about all secrets.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#listSecretInfo)\n */\n listSecretInfo(): Promise;\n /**\n * Updates the specified fields of an existing secret by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#updateSecret)\n */\n updateSecret(_id: string, secret: Secrets.Secret): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-secrets-backend-v2.Secrets.html#)\n */\n namespace Secrets {\n type CreateSecretRequest = {\n /**\n * The object including the fields of a new secret.\n */\n secret: Secrets.Secret;\n };\n type CreateSecretResponse = {\n /**\n * The globally-unique ID assigned to the secret.\n */\n _id?: string;\n };\n type DeleteSecretRequest = {\n /**\n * The unique ID of the secret to be deleted.\n */\n _id: string;\n };\n type DeleteSecretResponse = {};\n type GetSecretValueRequest = {\n /**\n * The name of the secret to get the value of.\n */\n name: string;\n };\n type GetSecretValueResponse = {\n /**\n * The plaintext, unencrypted value of the secret.\n */\n value?: string;\n };\n type ListSecretInfoRequest = {};\n type ListSecretInfoResponse = {\n /**\n * Object containing information for each secret.\n */\n secrets?: Array;\n };\n type Secret = {\n /**\n * The date and time the secreted was created.\n */\n _createdDate?: Date;\n /**\n * The secret's unique ID.\n */\n _id?: string;\n /**\n * The date and time the secret was last updated.\n */\n _updatedDate?: Date;\n /**\n * An optional text describing the secret's purpose or any other notes about it.\n */\n description?: string;\n /**\n * A unique, meaningful name used for retrieving the secret at runtime with the [`getSecretValue()`](#getsecretvalue) function. You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.\n */\n name?: string;\n };\n type UpdateSecretRequest = {\n /**\n * The unique ID of the secret to be updated.\n */\n _id: string;\n /**\n * The secret fields to update.\n */\n secret: Secrets.Secret;\n };\n type UpdateSecretResponse = {};\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-site-backend.d.ts", "content": "/**\n * The wix-site-backend module contains functionality for working with\n * your site and its pages from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.html#)\n */\ndeclare module 'wix-site-backend' {\n /**\n * The generalInfo API contains functionality for getting\n * [the information about your business](https://support.wix.com/en/article/adding-your-sites-business-info) that\n * has been entered in the **General Info** section of your site's [**Dashboard**](https://support.wix.com/en/article/wix-dashboard-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.html#generalInfo)\n */\n const generalInfo: GeneralInfo;\n /**\n * Invalidates the cache for a site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.html#invalidateCache)\n */\n function invalidateCache(): Promise;\n /**\n * The generalInfo API contains functionality for getting\n * [the information about your business](https://support.wix.com/en/article/adding-your-sites-business-info) that\n * has been entered in the **General Info** section of your site's [**Dashboard**](https://support.wix.com/en/article/wix-dashboard-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#)\n */\n interface GeneralInfo {\n /**\n * Gets the physical address of the site's business.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getAddress)\n */\n getAddress(): Promise;\n /**\n * Gets the site business name.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getBusinessName)\n */\n getBusinessName(): Promise;\n /**\n * Gets the business hours of the site's business.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getBusinessSchedule)\n */\n getBusinessSchedule(): Promise;\n /**\n * Gets the site category information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getCategories)\n */\n getCategories(): Promise;\n /**\n * Gets the site description.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getDescription)\n */\n getDescription(): Promise;\n /**\n * Gets the email address used for notifications of activities on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getEmail)\n */\n getEmail(): Promise;\n /**\n * Gets the fax number used for notifications of activities on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getFax)\n */\n getFax(): Promise;\n /**\n * Gets site language information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getLanguage)\n */\n getLanguage(): Promise;\n /**\n * Gets site locale information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getLocale)\n */\n getLocale(): Promise;\n /**\n * Gets the site logo file name.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getLogo)\n */\n getLogo(): Promise;\n /**\n * Gets site multilingual information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getMultilingual)\n */\n getMultilingual(): Promise;\n /**\n * Gets site payment currency information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getPaymentCurrency)\n */\n getPaymentCurrency(): Promise;\n /**\n * Gets the phone number used for notifications of activities on your site.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getPhone)\n */\n getPhone(): Promise;\n /**\n * Gets the site display name.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getSiteDisplayName)\n */\n getSiteDisplayName(): Promise;\n /**\n * Gets site time zone information.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#getTimeZone)\n */\n getTimeZone(): Promise;\n }\n /**\n * The generalInfo API contains functionality for getting\n * [the information about your business](https://support.wix.com/en/article/adding-your-sites-business-info) that\n * has been entered in the **General Info** section of your site's [**Dashboard**](https://support.wix.com/en/article/wix-dashboard-overview).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-site-backend.GeneralInfo.html#)\n */\n namespace GeneralInfo {\n /**\n * An object representing a site's corresponding physical address.\n */\n type GeneralInfoAddress = {\n /**\n * Address street.\n */\n street: string;\n /**\n * Address city.\n */\n city: string;\n /**\n * Address country.\n */\n country: string;\n /**\n * Address state.\n */\n state: string;\n /**\n * Address zip code.\n */\n zip: string;\n /**\n * Address description.\n */\n hint: GeneralInfo.GeneralInfoAddressHint;\n /**\n * Whether the business has a physical address.\n */\n isPhysical: boolean;\n /**\n * Address as formatted by Google.\n */\n googleFormattedAddress: string;\n /**\n * Address street number.\n */\n streetNumber: string;\n /**\n * Address apartment number.\n */\n apartmentNumber: string;\n /**\n * Address coordinates.\n */\n coordinates: GeneralInfo.GeneralInfoAddressCoordinates;\n };\n /**\n * An object representing the coordinates of the site address.\n */\n type GeneralInfoAddressCoordinates = {\n /**\n * Address latitude.\n */\n latitude: string;\n /**\n * Address longitude.\n */\n longitude: string;\n };\n /**\n * An object representing a description of a site's address.\n */\n type GeneralInfoAddressHint = {\n /**\n * Address description.\n */\n text: string;\n /**\n * Whether description is shown before, after, or instead of the actual address.\n */\n placement: string;\n };\n /**\n * An object representing the categories that describe your site's business.\n */\n type GeneralInfoCategories = {\n /**\n * Primary site category.\n */\n primary: string;\n /**\n * List of secondary site categories.\n */\n secondary: string[];\n };\n /**\n * An object representing the site's languages.\n */\n type GeneralInfoLanguages = {\n /**\n * List supported languages.\n */\n supportedLanguages: GeneralInfo.GeneralInfoLanguagesSupported[];\n /**\n * Whether to automatically redirect users based on their browser's settings.\n */\n autoRedirect: boolean;\n };\n /**\n * An object representing the site's supported languages.\n */\n type GeneralInfoLanguagesSupported = {\n /**\n * Site's two-letter or four-letter language code.\n */\n languageCode: string;\n /**\n * Language locale.\n */\n locale: GeneralInfo.GeneralInfoLocale;\n /**\n * Country Code for the Language icon.\n */\n countryCode: string;\n /**\n * Whether the language is the primary language.\n */\n isPrimary: boolean;\n };\n /**\n * An object representing a site's locale.\n */\n type GeneralInfoLocale = {\n /**\n * Site country.\n */\n country: string;\n /**\n * Site's two-letter or four-letter language code.\n */\n languageCode: string;\n };\n /**\n * An object representing business hours.\n */\n type GeneralInfoSchedule = {\n /**\n * List of opening and closing days and times.\n */\n periods: GeneralInfo.GeneralInfoSchedulePeriods[];\n /**\n * Special hours.\n */\n specialHourPeriod: GeneralInfo.GeneralInfoScheduleSpecial[];\n };\n /**\n * An object representing business opened and closed hours.\n */\n type GeneralInfoSchedulePeriods = {\n /**\n * Business opening day.\n */\n openDay: string;\n /**\n * Business opening time.\n */\n openTime: string;\n /**\n * Business closing day.\n */\n closeDay: string;\n /**\n * Business closing time.\n */\n closeTime: string;\n };\n /**\n * An object representing special business hours.\n */\n type GeneralInfoScheduleSpecial = {\n /**\n * Special hours start date.\n */\n startDate: string;\n /**\n * Special hours end date.\n */\n endDate: string;\n /**\n * Whether the business is closed.\n */\n isClosed: boolean;\n /**\n * Special hours comment.\n */\n comment: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-stores-backend.d.ts", "content": "/**\n * The wix-stores-backend module contains functionality for working with your\n * site's store from backend code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#)\n */\ndeclare module 'wix-stores-backend' {\n /**\n * Adds media items by ID to a product.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#addProductMedia)\n */\n function addProductMedia(productId: string, media: Media[]): Promise;\n /**\n * Adds media items by ID to product options.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#addProductMediaToChoices)\n */\n function addProductMediaToChoices(productId: string, mediaChoices: MediaChoice[]): Promise;\n /**\n * Adds products by ID to a product collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#addProductsToCollection)\n */\n function addProductsToCollection(collectionId: string, productIds: string[]): Promise;\n /**\n * Adjusts a numeric property for up to 100 products at a time.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#bulkAdjustProductProperty)\n */\n function bulkAdjustProductProperty(ids: string[], adjust: BulkAdjustProperties): Promise;\n /**\n * Updates a property for up to 100 products at a time.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#bulkUpdateProductProperty)\n */\n function bulkUpdateProductProperty(ids: string[], set: BulkUpdateProperties): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.OrderFulfillments.createFulfillment()`](/wix-ecom-backend/order-fulfillments/create-fulfillment).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#createFulfillment)\n */\n function createFulfillment(orderId: string, fulfillment: FulfillmentInfo): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Orders.createOrder()`](/wix-ecom-backend/orders/create-order).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#createOrder)\n */\n function createOrder(orderInfo: OrderInfo): Promise;\n /**\n * Creates a new product.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#createProduct)\n */\n function createProduct(productInfo: ProductInfo): Promise;\n /**\n * Subtracts a set number of items from inventory.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#decrementInventory)\n */\n function decrementInventory(items: DecrementInfo[]): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.OrderFulfillments.deleteFulfillment()`](/wix-ecom-backend/order-fulfillments/delete-fulfillment).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#deleteFulfillment)\n */\n function deleteFulfillment(orderId: string, fulfillmentId: string): Promise;\n /**\n * Deletes an existing product.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#deleteProduct)\n */\n function deleteProduct(productId: string): Promise;\n /**\n * Deletes all options for an existing product.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#deleteProductOptions)\n */\n function deleteProductOptions(productId: string): Promise;\n /**\n * Gets the specified abandoned shopping cart.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#getAbandonedCart)\n */\n function getAbandonedCart(cartId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.CurrentCart.getCurrentCart()`](/wix-ecom-backend/current-cart/get-current-cart).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#getCurrentCart)\n */\n function getCurrentCart(): Promise;\n /**\n * Generates a link to a PDF file containing information about one or more specified orders, up to 1000 orders.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#getOrdersLink)\n */\n function getOrdersLink(orderIds: string[]): Promise;\n /**\n * Generates a link to a PDF file containing an order's packing slip.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#getPackingSlipLink)\n */\n function getPackingSlipLink(orderId: string): Promise;\n /**\n * Gets the availability of a product based on the specified option choices.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#getProductOptionsAvailability)\n */\n function getProductOptionsAvailability(productId: string, choices: ProductChoices): Promise;\n /**\n * Gets a product's available variants based on the specified product ID and either option choices or variant IDs.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#getProductVariants)\n */\n function getProductVariants(productId: string, options?: ProductVariantOptions): Promise;\n /**\n * Adds a set number of items from inventory.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#incrementInventory)\n */\n function incrementInventory(items: IncrementInfo[]): Promise;\n /**\n * Removes media items by ID from a product.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#removeProductMedia)\n */\n function removeProductMedia(productId: string, media: Media[]): Promise;\n /**\n * Removes media items by ID from a product's options.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#removeProductMediaFromChoices)\n */\n function removeProductMediaFromChoices(productId: string, mediaChoices: MediaChoice[]): Promise;\n /**\n * Removes products by ID from a collection.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#removeProductsFromCollection)\n */\n function removeProductsFromCollection(collectionId: string, productIds: string[]): Promise;\n /**\n * Resets the data (such as the price and the weight) of all variants for a given product to their default values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#resetVariantData)\n */\n function resetVariantData(productId: string): Promise;\n /**\n * Sends a fulfillment email to a specified custom fulfiller of a line item in a given order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#sendFulfillmentEmail)\n */\n function sendFulfillmentEmail(orderId: string, fulfillerId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.OrderFulfillments.updateFulfillment()`](/wix-ecom-backend/order-fulfillments/update-fulfillment).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#updateFulfillment)\n */\n function updateFulfillment(orderId: string, fulfillmentId: string, trackingInfo: TrackingInfo): Promise;\n /**\n * Updates an existing inventory item's variants by inventory ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#updateInventoryVariantFields)\n */\n function updateInventoryVariantFields(inventoryId: string, inventoryInfo: InventoryItemVariantInfo): Promise;\n /**\n * Updates an existing inventory item's variants by product ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#updateInventoryVariantFieldsByProductId)\n */\n function updateInventoryVariantFieldsByProductId(productId: string, inventoryInfo: InventoryItemVariantInfo): Promise;\n /**\n * Updates an existing product by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#updateProductFields)\n */\n function updateProductFields(productId: string, productInfo: UpdateProductInfo): Promise;\n /**\n * Updates the data (such as the price and the weight) of an existing product variant in the store.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.html#updateVariantData)\n */\n function updateVariantData(productId: string, variantInfo: VariantInfo[]): Promise;\n /**\n * An object representing an abandoned shopping cart.\n */\n type AbandonedCart = {\n /**\n * Unique identifier of the shopping cart.\n */\n _id: string;\n /**\n * Date and time the shopping cart was abandoned.\n */\n abandonTime: string;\n /**\n * Total price of all items in the cart.\n */\n total: string;\n /**\n * The buyer's information.\n */\n buyerInfo: BuyerInfo;\n /**\n * Log of updates related to the cart.\n */\n activities: Activity;\n /**\n * Status of the abandoned cart. Either `\"ABANDONED\"` or `\"RECOVERED\"`.\n */\n status: string;\n };\n /**\n * An array of objects representing a log of updates related to the order.\n */\n type Activities = {\n /**\n * Activity type.\n * One of:\n *\n *\n * - `\"MERCHANT_COMMENT\"`\n * - `\"ORDER_PLACED\"`\n * - `\"ORDER_PAID\"`\n * - `\"ORDER_FULFILLED\"`\n * - `\"ORDER_NOT_FULFILLED\"`\n * - `\"DOWNLOAD_LINK_SENT\"`\n * - `\"PICKUP_READY_EMAIL_SENT\"`\n * - `\"TRACKING_NUMBER_ADDED\"`\n * - `\"TRACKING_NUMBER_EDITED\"`\n * - `\"TRACKING_LINK_WAS_SET\"`\n * - `\"SHIPPING_CONFIRMATION_EMAIL_SENT\"`\n * - `\"INVOICE_WAS_SET\"`\n * - `\"INVOICE_WAS_REMOVED\"`\n * - `\"INVOICE_WAS_SENT\"`\n */\n type: string;\n /**\n * Who made the update (activity) to the order item.\n */\n author: string;\n /**\n * Comment added to the activity.\n */\n message: string;\n /**\n * The time the update (activity) occurred.\n */\n timestamp: string;\n };\n /**\n * An object representing a shopping cart activity.\n */\n type Activity = {\n /**\n * One of:\n *\n * + `\"CUSTOM_ACTIVITY\"`\n * + `\"EMAIL_NOT_SENT\"`\n * + `\"EMAIL_SENT\"`\n * + `\"NOTIFICATION_SENT\"`\n * + `\"SCHEDULED\"`\n * + `\"TASK_CREATED\"`\n * + `\"UNRECOGNIZED_TYPE\"`\n */\n activityType: string;\n /**\n * Activity message.\n */\n message: string;\n /**\n * Time activity occurred.\n */\n timestamp: string;\n /**\n * Custom activity data.\n */\n customData: CustomData;\n };\n /**\n * An object representing address information.\n */\n type Address = {\n /**\n * Address in readable format.\n */\n formatted?: string;\n /**\n * City.\n */\n city: string;\n /**\n * Country.\n */\n country: string;\n /**\n * Main address information.\n */\n addressLine: string;\n /**\n * Additional address information (apt, floor, etc.), if used.\n */\n addressLine2?: string;\n /**\n * Alternative property for street name and number.\n */\n streetAddress?: StreetAddress;\n /**\n * Postal/zip code.\n */\n postalCode: string;\n /**\n * Subdivision of a country, such as a state or province.\n */\n subdivision: string;\n };\n type AdjustBy = {\n /**\n * Adjust by percentage.\n */\n percentage?: PercentageAdjustment;\n /**\n * Adjust by amount.\n */\n amount?: number;\n };\n /**\n * An object representing a coupon applied to the order.\n */\n type AppliedCoupon = {\n /**\n * Coupon ID.\n */\n couponId: string;\n /**\n * Coupon name.\n */\n name: string;\n /**\n * Coupon code (used by a buyer to apply the coupon).\n */\n code: string;\n };\n /**\n * An object representing an order's billing info.\n */\n type BillingInfo = {\n /**\n * Billing address.\n */\n address?: Address;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * VAT information.\n */\n vatId?: VatId;\n /**\n * Deprecated: replaced with paymentProviderTransactionId.\n */\n externalTransactionId?: string;\n /**\n * Date and time the payment was made.\n */\n paidDate?: string;\n /**\n * Payment method.\n */\n paymentMethod?: string;\n /**\n * Unique transaction ID for the payment gateway.\n */\n paymentGatewayTransactionId?: string;\n /**\n * Unique ID for the payment provider.\n */\n paymentProviderTransactionId?: string;\n };\n type BulkActionMetadata = {\n /**\n * Number of items that were successfully processed.\n */\n totalSuccesses: number;\n /**\n * Number of items that couldn't be processed.\n */\n totalFailures: number;\n /**\n * Number of failures without details because detailed failure threshold was exceeded.\n */\n undetailedFailures: number;\n };\n type BulkAdjustProperties = {\n /**\n * Adjust product price.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, variants prices are calculated according to the adjusted price.\n * If the variant price is negative after the adjustment, the update fails.\n */\n price?: AdjustBy;\n /**\n * Adjust the product's cost of goods.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, cost of goods is adjusted per variant.\n */\n cost?: AdjustBy;\n /**\n * Adjust product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight is adjusted per variant.\n */\n weight?: AdjustBy;\n };\n type BulkResults = {\n /**\n * Item metadata.\n */\n itemMetadata: ItemMetadata;\n };\n type BulkUpdateProperties = {\n /**\n * Set product price.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, variants prices are calculated according to the set product price.\n * If the variant price is negative after setting the new price, the update fails.\n */\n price?: number;\n /**\n * Set the product's cost of goods.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, cost of goods is set per variant.\n */\n cost?: number;\n /**\n * Set product weight.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight is set per variant.\n */\n weight?: number;\n /**\n * Set product ribbon. Pass an empty string to remove the existing ribbon.\n */\n ribbon?: string;\n /**\n * Set product brand. Pass an empty string to remove the existing brand.\n */\n brand?: string;\n };\n type BulkUpdateResponse = {\n /**\n * Bulk action results.\n */\n results: BulkResults[];\n /**\n * Bulk action metadata.\n */\n bulkActionMetadata: BulkActionMetadata;\n };\n /**\n * An object representing information about the buyer.\n */\n type BuyerInfo = {\n /**\n * Unique buyer's ID.\n */\n id: string;\n /**\n * Buyer's email address.\n */\n email: string;\n /**\n * Buyer's first name.\n */\n firstName: string;\n /**\n * Buyer's last name.\n */\n lastName: string;\n /**\n * Buyer's identity.\n * One of:\n *\n * + `\"MEMBER\"`: A logged-in site member.\n * + `\"CONTACT\"`: A Wix contact.\n * + `\"ADMIN\"`: Buyer is the site owner.\n * + `\"VISITOR\"`: Buyer is not logged in.\n */\n identityType: string;\n /**\n * Buyer's phone number.\n */\n phone?: string;\n };\n /**\n * An object representing a shopping cart.\n */\n type Cart = {\n /**\n * Unique identifier of the shopping cart.\n */\n _id: string;\n /**\n * Coupon applied in the shopping cart.\n */\n appliedCoupon: CartAppliedCoupon;\n /**\n * Cart billing address.\n */\n billingAddress: CartAddress;\n /**\n * The buyer's information.\n */\n buyerInfo: CartBuyerInfo;\n /**\n * Cart status. Either `\"INCOMPLETE\"` or `\"COMPLETE\"`.\n */\n status: string;\n /**\n * Currency of the shopping cart.\n */\n currency: Currency;\n /**\n * The shopping cart's shipping information.\n */\n shippingInfo: CartShippingInfo;\n /**\n * Items in the shopping cart.\n */\n lineItems: CartLineItem[];\n /**\n * The shopping cart's totals.\n */\n totals: OrderTotals;\n /**\n * The order's units of weight. One of: `\"KG\"`, `\"LB\"`, or `\"UNSPECIFIED_WEIGHT_UNIT\"`.\n */\n weightUnit: string;\n };\n /**\n * An object representing an address.\n */\n type CartAddress = {\n /**\n * First name.\n */\n firstName: string;\n /**\n * Last name.\n */\n lastName: string;\n /**\n * Email address.\n */\n email: string;\n /**\n * Phone number.\n */\n phone: string;\n /**\n * Address.\n */\n address: string;\n };\n /**\n * An object representing a coupon applied in a shopping cart.\n */\n type CartAppliedCoupon = {\n /**\n * Coupon code.\n */\n code: string;\n /**\n * Coupon unique identifier.\n */\n couponId: string;\n /**\n * Coupon name.\n */\n name: string;\n /**\n * Type of coupon.\n * One of:\n *\n * + `\"BuyXGetY\"`\n * + `\"FixedPriceAmount\"`\n * + `\"FreeShipping\"`\n * + `\"MoneyOffAmount\"`\n * + `\"PercentOffRate\"`\n */\n couponType: string;\n /**\n * Value of the coupon discount.\n */\n discountValue: string;\n };\n /**\n * An object representing a visitor who abandoned a shopping cart.\n */\n type CartBuyerInfo = {\n /**\n * Buyer's unique ID.\n */\n id: string;\n /**\n * Buyer's email address.\n */\n email: string;\n /**\n * Buyer's first name.\n */\n firstName: string;\n /**\n * Buyer's last name.\n */\n lastName: string;\n /**\n * Buyer's identity.\n * One of:\n *\n * + `\"ADMIN\"`: Buyer is the site owner.\n * + `\"MEMBER\"`: Buyer is a logged-in site member.\n * + `\"VISITOR\"`: Buyer is not logged in.\n * + `\"CONTACT\"`: A contact has been created for the buyer.\n */\n identityType: string;\n /**\n * Buyer's phone number.\n */\n phone: string;\n };\n /**\n * An object representing a custom text field.\n */\n type CartCustomTextField = {\n /**\n * Field title.\n */\n title: string;\n /**\n * Field value.\n */\n value: string;\n };\n /**\n * An object representing a line item in a shopping cart.\n */\n type CartLineItem = {\n /**\n * Name of the line item.\n */\n name: string;\n /**\n * Notes about the line item.\n */\n notes: string;\n /**\n * Line item price.\n */\n price: string;\n /**\n * Line item product ID.\n */\n productId: string;\n /**\n * Line item quantity.\n */\n quantity: number;\n /**\n * Line item stock keeping unit.\n */\n sku: string;\n /**\n * Total price charged to the customer for all line items after any applicable discounts.\n */\n totalPrice: string;\n /**\n * Line item weight.\n */\n weight: string;\n /**\n * Type of the line item.\n * One of:\n *\n * + `\"DIGITAL\"`: Digital item.\n * + `\"PHYSICAL\"`: Physical item.\n * + `\"CUSTOM_AMOUNT_ITEM\"`: Item with a custom price.\n * + `\"UNSPECIFIED\"`: Type can't be classified due to an error.\n */\n lineItemType: string;\n /**\n * Line item options.\n */\n options: Option[];\n /**\n * Media item.\n */\n mediaItem: CartMediaItem;\n /**\n * Custom text.\n */\n customTextFields: CartCustomTextField[];\n /**\n * Cart line item ID.\n */\n id: number;\n };\n /**\n * An object representing a line item's primary media.\n */\n type CartMediaItem = {\n /**\n * Media item source for media uploaded to Wix (wix:image, wix:video or external URL).\n */\n src: string;\n /**\n * Media item type. Currently only `\"IMAGE\"` type supported.\n */\n type: string;\n };\n /**\n * An object representing shipping information.\n */\n type CartShippingInfo = {\n /**\n * Shipment address.\n */\n shippingAddress?: CartAddress;\n /**\n * Pickup address.\n */\n pickupInfo?: CartAddress;\n };\n /**\n * An object representing information about the sales channel that submitted this order.\n */\n type ChannelInfo = {\n /**\n * Order ID from an external system (such as eBay or Amazon).\n */\n externalOrderId?: string;\n /**\n * URL to the order in the external system (such as eBay or Amazon).\n */\n externalOrderUrl?: string;\n /**\n * Sales channel that submitted the order.\n * One of:\n *\n *\n * + `\"WEB\"`: Wix online store.\n * + `\"POS\"`: Point of sale.\n * + `\"EBAY\"`: eBay.\n * + `\"OTHER_PLATFORM\"`: Order imported from another system (such as Cart2Cart).\n * + `\"WIX_APP_STORE\"`: Order created via the Wix mobile app.\n */\n type: string;\n };\n /**\n * An object representing the choice for a product variant.\n */\n type Choice = {\n /**\n * Product options to use when creating or updating the\n * product. The object contains key:value pairs where the key is the\n * option name and the value is the chosen option value.\n */\n choices: any;\n };\n /**\n * An object representing the choice for a product variant.\n */\n type Choices = {\n /**\n * Option name.\n */\n option: string;\n /**\n * Choice name.\n */\n choice: string;\n };\n /**\n * An object representing billing information for creating an order.\n */\n type CreateOrderBillingInfo = {\n /**\n * Billing address.\n */\n address: Address;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * VAT information.\n */\n vatId?: VatId;\n /**\n * Payment method.\n */\n paymentMethod?: string;\n /**\n * Unique transaction ID for the payment gateway.\n */\n paymentGatewayTransactionId?: string;\n /**\n * Unique ID for the payment provider.\n */\n paymentProviderTransactionId?: string;\n };\n /**\n * An object representing buyer information for creating an order.\n */\n type CreateOrderBuyerInfo = {\n /**\n * Unique buyer's ID.\n */\n id: string;\n /**\n * Buyer's identity.\n * One of:\n *\n * + `\"MEMBER\"`: A logged-in site member.\n * + `\"CONTACT\"`: A Wix contact.\n */\n identityType: string;\n };\n /**\n * An object representing a line item for creating an order.\n */\n type CreateOrderLineItem = {\n /**\n * Custom text.\n */\n customTextFields?: CustomTextField[];\n /**\n * Line item product ID.\n */\n productId?: string;\n /**\n * Type of line item.\n * One of:\n *\n *\n * - `\"DIGITAL\"`: Digital item.\n * - `\"PHYSICAL\"`: Physical item.\n * - `\"CUSTOM_AMOUNT_ITEM\"`: Item with a custom price.\n */\n lineItemType?: string;\n /**\n * Line item's primary media item.\n */\n mediaItem?: CreateOrderMediaItem;\n /**\n * Name of the line item.\n */\n name: string;\n /**\n * Notes about the line item.\n */\n notes?: string;\n /**\n * Line item options.\n */\n options?: Option[];\n /**\n * Line item quantity.\n */\n quantity: number;\n /**\n * Line item stock keeping unit.\n */\n sku?: string;\n /**\n * Line item weight.\n */\n weight?: number;\n /**\n * Line item's name, translated into the customer's language.\n */\n translatedName?: string;\n /**\n * Line item's discount amount.\n */\n discount?: number;\n /**\n * Line item's total amount of tax applied.\n */\n tax?: number;\n /**\n * Price information.\n */\n priceData: CreateOrderLineItemPriceData;\n /**\n * Tax group ID.\n */\n taxGroupId?: string;\n /**\n * Line item's fulfiller ID.\n */\n fulfillerId?: string;\n /**\n * Line item's variant ID.\n */\n variantId?: string;\n };\n /**\n * An object representing an line item's price information for creating an order.\n */\n type CreateOrderLineItemPriceData = {\n /**\n * Price of the item.\n */\n price: number;\n /**\n * Whether the price includes tax.\n */\n taxIncludedInPrice?: boolean;\n };\n /**\n * An object representing a line item's primary media item for creating an order.\n */\n type CreateOrderMediaItem = {\n /**\n * Image description for accessibility purposes.\n */\n altText?: string;\n /**\n * Media item source (wix:image or external URL).\n */\n src?: string;\n };\n /**\n * An object representing an order's totals for creating an order.\n */\n type CreateOrderTotals = {\n /**\n * Total calculated discount amount.\n */\n discount?: number;\n /**\n * Total shipping price, including tax.\n */\n shipping?: number;\n /**\n * Subtotal of all the order's line items, excluding tax.\n */\n subtotal: number;\n /**\n * Total amount of tax.\n */\n tax?: number;\n /**\n * Total price.\n */\n total: number;\n };\n /**\n * An object representing a currency.\n */\n type Currency = {\n /**\n * The currency code.\n */\n currency: string;\n /**\n * The currency symbol.\n */\n symbol: string;\n };\n /**\n * An object representing custom activity data.\n */\n type CustomData = {\n /**\n * Activity namespace.\n */\n namespace: string;\n /**\n * JSON object containing custom data.\n */\n customValue: any;\n };\n /**\n * An object representing a custom field added by the customer during the checkout process.\n */\n type CustomField = {\n /**\n * Custom field's title.\n */\n title: string;\n /**\n * Title translated into the buyer's language.\n */\n translatedTitle: string;\n /**\n * Custom field's text.\n */\n value: string;\n };\n /**\n * An object representing a custom text field.\n */\n type CustomTextField = {\n /**\n * Field title.\n */\n title: string;\n /**\n * Field value.\n */\n value: string;\n };\n type DecrementInfo = {\n /**\n * Variant ID.\n */\n variantId: string;\n /**\n * Number to decrement inventory by.\n */\n decrementBy: number;\n /**\n * Product ID.\n */\n productId?: string;\n /**\n * Inventory item ID. This is the `_id` field in the [\"InventoryItems\" Collection](https://www.wix.com/velo/reference/wix-stores-backend/%22inventoryitems%22-collection-fields).\n */\n inventoryId?: string;\n };\n /**\n * An object representing a discount applied to the order.\n */\n type Discount = {\n /**\n * Information about an applied coupon.\n */\n appliedCoupon: AppliedCoupon;\n };\n /**\n * An object representing information about the identity of the order initiator.\n * Occasionally, the person that completes the order isn't the buyer. For example, this occurs when an order is created using a point of sale terminal.\n */\n type EnteredBy = {\n /**\n * ID of the order initiator.\n */\n id: string;\n /**\n * Order was created by one of the following:\n *\n *\n * + `\"USER\"`: Wix user who performed a POS transaction on behalf of the buyer.\n * + `\"MEMBER\"`: Logged-in site member.\n * + `\"CONTACT\"`: A Wix contact.\n */\n identityType: string;\n };\n /**\n * An object representing order fulfillment details.\n */\n type Fulfillment = {\n /**\n * Unique ID automatically generated upon fulfillment.\n */\n id: string;\n /**\n * Date and time of fulfillment.\n */\n dateCreated: string;\n /**\n * Information about the line items in the fulfilled order.\n */\n lineItems: FulfillmentLineItem[];\n /**\n * Tracking information for a fulfilled order.\n */\n trackingInfo?: TrackingInfo;\n };\n /**\n * An object representing new fulfillment details.\n */\n type FulfillmentInfo = {\n /**\n * Information about the line items in the fulfilled order.\n */\n lineItems: FulfillmentLineItem[];\n /**\n * Tracking information for a fulfilled order.\n */\n trackingInfo?: TrackingInfo;\n };\n /**\n * An object representing information about a fulfillment's line items.\n */\n type FulfillmentLineItem = {\n /**\n * Line item's position in the list of line items.\n */\n index: number;\n /**\n * Number of units of this line item. On creation, if this field is left empty, the new fulfillment will automatically include all items of this line item that have not already been linked to a fulfillment.\n *\n * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error will be returned. This property will always have a value when returned.\n */\n quantity?: number;\n };\n type IncrementInfo = {\n /**\n * Variant ID.\n */\n variantId: string;\n /**\n * Number to increment inventory by.\n */\n incrementBy: number;\n /**\n * Product ID.\n */\n productId?: string;\n /**\n * Inventory item ID. This is the `_id` field in the [\"InventoryItems\" Collection](https://www.wix.com/velo/reference/wix-stores-backend/%22inventoryitems%22-collection-fields).\n */\n inventoryId?: string;\n };\n /**\n * An object representing an inventory item for a product variant in a store.\n */\n type InventoryItem = {\n /**\n * Unique identifier for the inventory item.\n */\n _id: string;\n /**\n * Deprecated: use productId.\n */\n externalId: string;\n /**\n * Product ID.\n */\n productId: string;\n /**\n * Indicates whether the on-hand inventory quantity is tracked for the inventory item's variants. If true, you can update the actual number of variants available. If false, you can indicate if a variant is in stock.\n */\n trackQuantity: boolean;\n /**\n * Inventory item's variants.\n */\n variants: InventoryItemVariantItem[];\n /**\n * Date the inventory item was last updated.\n */\n _updatedDate: string;\n };\n type InventoryItemVariantInfo = {\n /**\n * Indicates whether the on-hand inventory quantity is tracked for the inventory item's variants. If true, you can update the actual number of variants available. If false, you can indicate if a variant is in stock.\n */\n trackQuantity: boolean;\n /**\n * Inventory item variants.\n */\n variants: InventoryItemVariantItem[];\n };\n /**\n * An object representing an inventory item's variant.\n */\n type InventoryItemVariantItem = {\n /**\n * Unique inventory item's variant ID.\n */\n variantId: string;\n /**\n * Whether the variant is in stock at the store. Used when `trackQuantity` is false. If `trackQuantity` is true, `inStock` is based on the actual tracked `quantity`.\n */\n inStock: boolean;\n /**\n * In-stock quantity at the store. Used when `trackQuantity` is true. If `trackQuantity` is false, undefined.\n */\n quantity: number;\n };\n type ItemMetadata = {\n /**\n * Item ID. Item Id. Omitted in certain cases, such as when failing to create an item.\n */\n id: string;\n /**\n * Index of the item within the update array.\n */\n originalIndex: number;\n /**\n * Whether the requested action succeeded for this item.\n * When `false`, the `error` property is populated.\n */\n success: boolean;\n /**\n * Details about the error in case of failure, as a key:value pair.\n */\n error: ItemMetadataError;\n };\n type ItemMetadataError = {\n /**\n * Error code.\n */\n code: string;\n /**\n * Error description.\n */\n description: string;\n /**\n * Error data.\n */\n data: object;\n };\n /**\n * An object representing an line item's price information.\n */\n type LineItemPriceData = {\n /**\n * Price of the item.\n */\n price: number;\n /**\n * Total price charged to the customer (per line item) after calculation of quantity and discount.\n */\n totalPrice: number;\n /**\n * Whether the price includes tax.\n */\n taxIncludedInPrice: boolean;\n };\n /**\n * An object with the link to a PDF file.\n */\n type LinkToPdf = {\n /**\n * URL to a PDF file.\n */\n link: string;\n };\n /**\n * An object representing the media item for a product.\n */\n type Media = {\n /**\n * Deprecated.\n */\n mediaId: string;\n /**\n * Deprecated.\n */\n url: string;\n /**\n * Media item source for media uploaded to Wix (wix:image, wix:video or external URL).\n */\n src: string;\n /**\n * A choice of the product variant.\n */\n choice: Choice;\n };\n /**\n * An object representing the media item for a product's choices.\n */\n type MediaChoice = {\n /**\n * Deprecated. See `mediaSources`.\n */\n mediaIds: string[];\n /**\n * Media item source for media uploaded to Wix (wix:image or wix:video).\n */\n mediaSources: string[];\n /**\n * Option name.\n */\n option: string;\n /**\n * Choice name.\n */\n choice: string;\n };\n /**\n * An object representing a media item.\n */\n type MediaItem = {\n /**\n * Media item title.\n */\n title: string;\n /**\n * Media item description.\n */\n description: string;\n /**\n * Media items type. Currently only `IMAGE` type supported.\n */\n type: string;\n /**\n * Media item source for media uploaded to Wix (wix:image, wix:video or external URL).\n */\n src: string;\n /**\n * Thumbnail URL for videos only.\n */\n thumbnail?: string;\n };\n /**\n * An object representing order fulfillment details.\n */\n type NewFulfillmentAndOrder = {\n /**\n * ID for the newly created fulfillment.\n */\n id: string;\n /**\n * Updated order.\n */\n order: Order;\n };\n /**\n * An object representing a line item option.\n */\n type Option = {\n /**\n * Name of the product option.\n */\n option: string;\n /**\n * Selected option.\n */\n selection: string;\n };\n /**\n * An object representing an order.\n */\n type Order = {\n /**\n * Unique order ID.\n */\n _id: string;\n /**\n * Date and time the order was updated.\n */\n _updatedDate: string;\n /**\n * The site's displayed language.\n */\n buyerLanguage: string;\n /**\n * Shopping cart ID.\n */\n cartId?: string;\n /**\n * Channel information.\n */\n channelInfo: ChannelInfo;\n /**\n * Identity of the order's initiator.\n */\n enteredBy: EnteredBy;\n /**\n * Billing information.\n */\n billingInfo?: BillingInfo;\n /**\n * Buyer information.\n */\n buyerInfo: BuyerInfo;\n /**\n * A note added by the buyer.\n */\n buyerNote?: string;\n /**\n * Date and time the order was created.\n */\n _dateCreated: string;\n /**\n * Order currency.\n */\n currency: string;\n /**\n * The order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).\n * One of:\n *\n * + `\"NOT_FULFILLED\"`: Order is not yet fulfilled.\n * + `\"FULFILLED\"`: Order was fulfilled successfully.\n * + `\"CANCELED\"`: Order was canceled.\n * + `\"PARTIALLY_FULFILLED\"`: Order was partially fulfilled. For example, when only some of the order's items were fulfilled.\n */\n fulfillmentStatus: string;\n /**\n * Whether or not the order was archived.\n */\n archived: boolean;\n /**\n * Log of updates related to the order.\n */\n activities: Activities[];\n /**\n * Running order number.\n */\n number: number;\n /**\n * Current status of the payment.\n * One of:\n *\n * + `\"NOT_PAID\"`: Payment was not made.\n * + `\"PAID\"`: Order was successfully paid for.\n * + `\"PARTIALLY_REFUNDED\"`: Order was partially refunded.\n * + `\"FULLY_REFUNDED\"`: Order was refunded in full.\n */\n paymentStatus: string;\n /**\n * Shipping information.\n */\n shippingInfo?: OrderShippingInfo;\n /**\n * Order items.\n */\n lineItems: OrderLineItem[];\n /**\n * Order totals.\n */\n totals: Totals;\n /**\n * The unit in which the order's weight is measured. Either `\"KG\"` or `\"LB\"`. If not provided, the site's default weight unit is used.\n */\n weightUnit?: string;\n /**\n * Custom field information.\n */\n customField?: CustomField;\n /**\n * Order fulfillment information.\n */\n fulfillments: Fulfillment[];\n /**\n * Discount information.\n */\n discount?: Discount;\n /**\n * Refund information.\n */\n refunds?: Refund[];\n /**\n * Subscription information. Omitted unless the order is a subscription.\n * Learn more about [selling product subscriptions](https://support.wix.com/en/article/wix-stores-selling-product-subscriptions).\n */\n subscriptionInfo?: SubscriptionInfo;\n };\n /**\n * An object representing information for creating an order.\n */\n type OrderInfo = {\n /**\n * Shopping cart ID.\n */\n cartId?: string;\n /**\n * The language displayed to the buyer. If not provided, the site's default language is used.\n */\n buyerLanguage?: string;\n /**\n * Channel information.\n */\n channelInfo: ChannelInfo;\n /**\n * Billing information.\n */\n billingInfo: CreateOrderBillingInfo;\n /**\n * Buyer information. Only pass these fields if you want to override the buyer identity e.g. when creating an order on behalf of a contact or member.\n */\n buyerInfo?: CreateOrderBuyerInfo;\n /**\n * A note added by the buyer.\n */\n buyerNote?: string;\n /**\n * Order currency. If not provided, the site's default currency is used.\n */\n currency?: string;\n /**\n * Current status of the payment.\n * One of:\n *\n * + `\"NOT_PAID\"`: Payment was not made.\n * + `\"PAID\"`: Order was successfully paid for.\n */\n paymentStatus: string;\n /**\n * Shipping information.\n */\n shippingInfo: OrderShippingInfo;\n /**\n * Order items.\n */\n lineItems: CreateOrderLineItem[];\n /**\n * Order totals.\n */\n totals: CreateOrderTotals;\n /**\n * The unit in which the order's weight is measured. Either `\"KG\"` or `\"LB\"`. If not provided, the site's default weight unit is used.\n */\n weightUnit?: string;\n /**\n * Information about a custom field.\n */\n customField?: CustomField;\n /**\n * Discount information.\n */\n discount?: Discount;\n };\n /**\n * An object representing a line item in an order.\n */\n type OrderLineItem = {\n /**\n * Custom text.\n */\n customTextFields?: CustomTextField[];\n /**\n * Line item product ID.\n */\n productId?: string;\n /**\n * Type of line item.\n * One of:\n *\n *\n * - `\"DIGITAL\"`: Digital item.\n * - `\"PHYSICAL\"`: Physical item.\n * - `\"CUSTOM_AMOUNT_ITEM\"`: Item with a custom price.\n */\n lineItemType?: string;\n /**\n * Information about the line item's primary media item.\n */\n mediaItem: OrderMediaItem;\n /**\n * Name of the line item.\n */\n name: string;\n /**\n * Notes about the line item.\n */\n notes?: string;\n /**\n * Line item options.\n */\n options?: Option[];\n /**\n * Deprecated: see priceData.\n */\n price: number;\n /**\n * Line item quantity.\n */\n quantity: number;\n /**\n * Line item stock keeping unit.\n */\n sku?: string;\n /**\n * Deprecated: see priceData.\n */\n totalPrice: number;\n /**\n * Line item weight.\n */\n weight?: number;\n /**\n * Line item index.\n */\n index?: number;\n /**\n * Line item's name, translated into the customer's language.\n */\n translatedName?: string;\n /**\n * Line item's discount amount.\n */\n discount?: number;\n /**\n * Line item's total amount of tax applied.\n */\n tax?: number;\n /**\n * Price information.\n */\n priceData: LineItemPriceData;\n /**\n * Tax group ID.\n */\n taxGroupId?: string;\n /**\n * Line item's fulfiller ID.\n */\n fulfillerId?: string;\n /**\n * Line item's variant ID.\n */\n variantId?: string;\n };\n /**\n * An object representing a line item's primary media item.\n */\n type OrderMediaItem = {\n /**\n * Image description for accessibility purposes.\n */\n altText?: string;\n /**\n * Media item source (wix:image or external URL).\n */\n src: string;\n /**\n * Media item type. Currently only `IMAGE` type supported.\n */\n type: string;\n };\n /**\n * An object representing an order's shipping information.\n */\n type OrderShippingInfo = {\n /**\n * Expected date of delivery.\n */\n deliverByDate?: string;\n /**\n * Delivery option name.\n */\n deliveryOption?: string;\n /**\n * Estimated time until delivery.\n */\n estimatedDeliveryTime?: string;\n /**\n * Shipment details (empty if order was designated for pickup).\n */\n shipmentDetails: ShipmentDetails;\n /**\n * Pickup details (empty if order was designated for delivery).\n */\n pickupDetails?: PickupDetails;\n /**\n * Shipping region.\n */\n shippingRegion?: string;\n };\n /**\n * An object representing an order's totals.\n */\n type OrderTotals = {\n /**\n * The subtotal of all the order's line items, excluding tax.\n */\n subtotal: number;\n /**\n * The total shipping price, including tax.\n */\n shipping: number;\n /**\n * The total amount of tax.\n */\n tax: string;\n /**\n * The total calculated discount amount.\n */\n discount: number;\n /**\n * The total price.\n */\n total: number;\n /**\n * The total weight of the order's items.\n */\n weight: number;\n /**\n * The total quantity of the the order's line items.\n */\n quantity: number;\n };\n /**\n * An object representing paging options.\n */\n type PagingOptions = {\n /**\n * Maximum number of variants to retrieve. Defaults to 300.\n */\n limit: number;\n /**\n * Number of variants to skip before the retrieved variants. Defaults to 0.\n */\n skip: number;\n };\n type PercentageAdjustment = {\n /**\n * When `true`, result is rounded to the nearest whole number (integer).\n * When `false`, result is rounded to 2 places after the decimal point.\n */\n roundToInt: string;\n /**\n * Percentage value, as a whole number (integer) between `-100` and `1000`.\n * For example, pass `100` to increase value by 100% (multiply original value by 2).\n */\n rate: number;\n };\n /**\n * An object representing an order's pickup details.\n */\n type PickupDetails = {\n /**\n * Pickup instructions.\n */\n pickupInstructions?: string;\n /**\n * Pickup address.\n */\n pickupAddress?: Address;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n };\n /**\n * An object representing a product in a store.\n */\n type Product = {\n /**\n * Product ID.\n */\n _id: string;\n /**\n * Date product was last updated.\n */\n _updatedDate: string;\n /**\n * Product name.\n */\n name: string;\n /**\n * Product description.\n */\n description: string;\n /**\n * Main product media item URL (wix:image or https).\n */\n mainMedia: string;\n /**\n * List of product media items.\n */\n mediaItems: MediaItem[];\n /**\n * Product stock keeping unit value. Must be unique.\n */\n sku: string;\n /**\n * Deprecated. Use `ribbon` instead.\n */\n ribbons: ProductRibbon[];\n /**\n * Product currency.\n */\n currency: string;\n /**\n * Product price.\n * The price must be greater than its discount.\n * The product price is propagated to the product's newly-created variants. Product variants whose prices have been updated directly are not affected by changes to the product price.\n */\n price: number;\n /**\n * Discounted product price.\n */\n discountedPrice: number;\n /**\n * Product price formatted with the currency.\n */\n formattedPrice: string;\n /**\n * Discounted product price formatted with currency symbol.\n */\n formattedDiscountedPrice: string;\n /**\n * ID for the inventory item.\n */\n inventoryItemId: string;\n /**\n * Product discount.\n */\n discount: ProductDiscount;\n /**\n * Indicates whether inventory is tracked for the product.\n */\n trackInventory: boolean;\n /**\n * Indicates whether the product is in stock.\n */\n inStock: boolean;\n /**\n * Number of units currently in stock.\n */\n quantityInStock: number;\n /**\n * Additional product information sections.\n */\n additionalInfoSections: ProductAdditionalInfoSection[];\n /**\n * All the available options for a store product.\n */\n productOptions: ProductOptions;\n /**\n * Product page relative URL.\n */\n productPageUrl: string;\n /**\n * Indicates whether product variants are managed. Can be set to true only if the product has options. Once set to true, can be reset to false only if no variants exist. Use [`getProductVariants()`](wix-stores.html#getProductVariants) to check if variants exist. You cannot set `manageVariants` to true if more than 300 variants are defined.\n */\n manageVariants: boolean;\n /**\n * List of product customization fields.\n */\n customTextFields: ProductCustomTextFields[];\n /**\n * Product type.\n */\n productType: string;\n /**\n * Product slug.\n */\n slug: string;\n /**\n * Product weight.\n */\n weight: string;\n /**\n * Whether the product is visible to site visitors and appears in Content Manager collections.\n */\n visible: boolean;\n /**\n * Product variants.\n */\n variants: VariantItem[];\n /**\n * Custom SEO data for the product. Learn more [about SEO](https://support.wix.com/en/search?term=seo).\n */\n seoData: SeoData;\n /**\n * Details of the product's price per unit.\n */\n pricePerUnitData: pricePerUnitData;\n /**\n * Price per unit.\n */\n pricePerUnit: number;\n /**\n * Price per unit formatted with currency symbol.\n */\n formattedPricePerUnit: string;\n /**\n * Product ribbon. Used to highlight relevant information about a product. For example, `\"Sale\"`, `\"New Arrival\"`, `\"Sold Out\"`.\n */\n ribbon: string;\n /**\n * Product brand. Including a brand name can help improve your site’s [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores).\n */\n brand: string;\n };\n /**\n * An object representing an additional info section for a store product.\n */\n type ProductAdditionalInfoSection = {\n /**\n * Section title.\n */\n title: string;\n /**\n * Section description.\n */\n description: string;\n };\n /**\n * An object representing a product variant's option choices.\n */\n type ProductChoices = {\n /**\n * Value of the choice. This key name is dependent on the product option. For example, if a product has a size option, this\n * key value will be something like `\"Size\"` and its value will be something like\n * `\"Large\"`.\n *\n * `optionKey` is not case-sensitive. Therefore the values for the option keys `\"Size\"`, `\"SIZE\"`, and `\"size\"` are combined.\n */\n optionKey: string;\n };\n /**\n * An object representing a custom text field for a store product.\n */\n type ProductCustomTextFields = {\n /**\n * Product customization field title.\n */\n title: string;\n /**\n * Maximum length of product customization field in characters.\n */\n maxLength: string;\n };\n /**\n * An object representing a product discount.\n */\n type ProductDiscount = {\n /**\n * Discount type. Required.\n *\n *\n *\n * One of:\n *\n *\n *\n * - `\"AMOUNT\"`\n *\n * - `\"PERCENT\"`\n *\n * - `\"NONE\"`\n */\n type: string;\n /**\n * Discount value. The discount value cannot be greater than the price of the product or the variant.\n */\n value: string;\n };\n /**\n * An object representing information for creating or updating a product in a store.\n */\n type ProductInfo = {\n /**\n * Product name. Limited to 80 characters.\n */\n name: string;\n /**\n * Product description.\n */\n description?: string;\n /**\n * Product stock keeping unit value. Must be unique.\n */\n sku?: string;\n /**\n * Product price.\n * The price must be greater than its discount.\n * The product price is propagated to the product's newly-created variants. Product variants whose prices have been updated directly are not affected by changes to the product price.\n */\n price: number;\n /**\n * An object representing a product discount.\n */\n discount?: ProductDiscount;\n /**\n * An object representing all the available options for a store product.\n */\n productOptions?: ProductOptionsInfo;\n /**\n * Indicates whether product variants can be managed. Can be set to true only if the product has options. Once set to true, can be reset to false only if no variants exist. Use [`getProductVariants()`](wix-stores.html#getProductVariants) to check if variants exist. You cannot set `manageVariants` to true if more than 300 variants are defined.\n */\n manageVariants?: boolean;\n /**\n * Product type. Currently, only creating physical products (`\"productType\": \"physical\"`) is supported via the API.\n */\n productType?: string;\n /**\n * Product weight.\n */\n weight?: number;\n /**\n * Whether the product is visible to site visitors. Setting this to false removes the product from Content Manager collections.\n */\n visible?: boolean;\n /**\n * Custom SEO data for the product. Learn more [about SEO](https://support.wix.com/en/search?term=seo).\n */\n seoData?: SeoData;\n /**\n * Details for the product's price per unit. If one of the `pricePerUnitData` fields is provided, all must be provided.\n */\n pricePerUnitData?: pricePerUnitData;\n /**\n * Product ribbon. Used to highlight relevant information about a product.\n * For example, `\"Sale\"`, `\"New Arrival\"`, `\"Sold Out\"`. Limited to 30 characters.\n */\n ribbon?: string;\n /**\n * Product brand.\n * Including a brand name can help improve your site’s [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores).\n * Limited to 50 characters.\n */\n brand?: string;\n };\n /**\n * An object representing an option for a store product.\n */\n type ProductOption = {\n /**\n * Option type. Either `\"color\"` or `\"drop_down\"`.\n */\n optionType: string;\n /**\n * Option name.\n */\n name: string;\n /**\n * Option choices.\n * Each option can contain between one and thirty choices.\n */\n choices: ProductOptionsChoice[];\n };\n /**\n * An object representing an option for a store product.\n */\n type ProductOptionInfo = {\n /**\n * Option name.\n */\n name: string;\n /**\n * Option choices.\n * Each option can contain between one and thirty choices.\n */\n choices: ProductOptionsChoiceInfo[];\n };\n /**\n * An object representing all the available options for a store product, such as \"Size\" or \"Color.\"\n */\n type ProductOptions = {\n /**\n * Name of the option. This key name\n *  is dependent on the options added to the product. For example, if a product has a size\n * option, this key will be something like `\"Size\"`.\n *\n * `optionKey` is not case-sensitive. Therefore the values for the option keys `\"Size\"`, `\"SIZE\"`,\n * and `\"size\"` are combined.\n *\n * An option cannot be changed if it has choices and variants. To change an option, reset its variants\n * with [`resetVariantData()`](wix-stores-backend.html#resetVariantData).\n * For each option, you can define a maximum of six choices.\n */\n optionKey: ProductOption;\n };\n /**\n * An object returned by the `getProductOptionsAvailability()` function representing the availability of a product.\n */\n type ProductOptionsAvailability = {\n /**\n * Whether the product with the specified option choices is available for purchase.\n */\n availableForPurchase: boolean;\n /**\n * An object representing all the available options for a store product.\n */\n productOptions: ProductOptions;\n /**\n * Main product media item (image or video) URL.\n */\n mainMedia: string;\n /**\n * List of product media items.\n */\n mediaItems: MediaItem[];\n /**\n * The variant of the product selected using the specified option choices if there is one.\n */\n selectedVariant: ProductOptionsAvailabilitySelectedVariant;\n };\n /**\n * An object representing the product variant selected using the `getProductOptionsAvailability()` function.\n */\n type ProductOptionsAvailabilitySelectedVariant = {\n /**\n * Product variant stock keeping unit value.\n */\n sku: string;\n /**\n * Product variant currency.\n */\n currency: string;\n /**\n * Product variant price. The variant price must be greater than its discount.\n */\n price: number;\n /**\n * Discounted product variant price.\n */\n discountedPrice: number;\n /**\n * Product variant price formatted with the currency.\n */\n formattedPrice: string;\n /**\n * Discounted product variant price formatted with the currency.\n */\n formattedDiscountedPrice: string;\n /**\n * Whether the product variant is visible to site visitors and appears in Content Manager collections.\n */\n visible: boolean;\n /**\n * Whether the product variant is in stock.\n */\n inStock: boolean;\n /**\n * Product variant weight.\n */\n weight: number;\n };\n /**\n * An object representing an options choice for a store product, such as choice \"Small\" for the option \"Size.\"\n */\n type ProductOptionsChoice = {\n /**\n * Choice value.\n */\n value: number;\n /**\n * Choice description.\n */\n description: number;\n /**\n * Whether the product with this choice is in stock.\n */\n inStock: boolean;\n /**\n * Whether the product with this option is visible.\n */\n visible: boolean;\n };\n type ProductOptionsChoiceInfo = {\n /**\n * Choice value.\n */\n value: number;\n /**\n * Choice description.\n */\n description: number;\n };\n /**\n * An object representing all the available options for a store product.\n */\n type ProductOptionsInfo = {\n /**\n * Name of the option. This key name is dependent on the options added to the product. For example, if a product has a color or size option, this key will be something like `\"Color\"` or `\"Size\"`.\n *\n * `optionKey` is not case-sensitive. Therefore the values for the option keys `\"Size\"`, `\"SIZE\"`, and `\"size\"` are combined.\n */\n optionKey: ProductOptionInfo;\n };\n /**\n * An object representing a ribbon for a store product.\n */\n type ProductRibbon = {\n /**\n * Ribbon text.\n */\n text: string;\n };\n /**\n * An object representing the selection of specific variants of a product. Use only one of\n * `choices` or `variantIds`.\n */\n type ProductVariantOptions = {\n /**\n * The choices the retrieved variants will have, in `key:value` pairs.\n */\n choices?: any;\n /**\n * IDs of variants to retrieve.\n */\n variantIds?: string[];\n };\n /**\n * An object representing order refund information.\n */\n type Refund = {\n /**\n * Refund ID.\n */\n id: string;\n /**\n * Date and time the refund was issued.\n */\n dateCreated: string;\n /**\n * Refund amount.\n */\n amount: string;\n /**\n * Reason for refund.\n */\n reason?: string;\n /**\n * Whether the refund was made externally.\n * An external refund refers to refunds processed by the payment provider and reported to the Wix orders system.\n * When the value is false, the refund was reported to the Wix orders system, but was not processed by the payment provider.\n */\n externalRefund: boolean;\n /**\n * Payment provider transaction ID.\n */\n paymentProviderTransactionId?: string;\n };\n /**\n * An object representing custom SEO data for the product.\n */\n type SeoData = {\n /**\n * SEO tag details.\n */\n tags: SeoTag[];\n };\n /**\n * An object representing the product's custom SEO tags.\n */\n type SeoTag = {\n /**\n * SEO tag type.\n * Supported values:\n *\n * + `\"title\"`\n * + `\"meta\"`\n * + `\"script\"`\n * + `\"link\"`\n */\n type: string;\n /**\n * The props property holds an object of `{\"key\": \"value\"}` pairs where the key is one of the SEO tag's properties (name, content, rel, href, etc.)\n * and the value is the value for that property. `{\"name\": \"description\", \"content\": \"The description itself.\"}`.\n */\n props: object;\n /**\n * Tag metadata. For example, `{\"height\": 300, \"width\": 240}`.\n */\n meta: object;\n /**\n * Tag inner content. For example, ` inner content `.\n */\n children: string;\n /**\n * Whether the tag is a custom tag.\n */\n custom: boolean;\n /**\n * Whether the tag is disabled.\n */\n disabled: boolean;\n };\n /**\n * An object representing an order's shipping details.\n */\n type ShipmentDetails = {\n /**\n * Shipping address.\n */\n address?: Address;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * First name.\n */\n firstName?: string;\n /**\n * Email address.\n */\n email?: string;\n /**\n * Phone number.\n */\n phone?: string;\n /**\n * Company name.\n */\n company?: string;\n /**\n * VAT information.\n */\n vatId?: VatId;\n /**\n * Deprecated: see priceData.\n */\n tax?: number;\n /**\n * Deprecated: see priceData.\n */\n discount?: number;\n /**\n * Shipment price information.\n */\n priceData?: ShipmentPriceData;\n };\n /**\n * An object representing shipment price information.\n */\n type ShipmentPriceData = {\n /**\n * Price of the item.\n */\n price: number;\n /**\n * Whether the price includes tax.\n */\n taxIncludedInPrice: boolean;\n };\n /**\n * An object representing information about the street name and street number of an address.\n */\n type StreetAddress = {\n /**\n * Address street name.\n */\n name: string;\n /**\n * Address street number.\n */\n number: string;\n };\n type SubscriptionInfo = {\n /**\n * ID of the current subscription's cycle.\n */\n id: string;\n /**\n * Current billing cycle number. For example, if the subscription is in the 3rd month of a 4-month subscription, the value is `3`.\n */\n cycleNumber: number;\n /**\n * Subscription settings.\n */\n subscriptionSettings: SubscriptionSettings;\n /**\n * Subscription option information.\n */\n subscriptionOptionInfo: SubscriptionOptionInfo;\n };\n type SubscriptionOptionInfo = {\n /**\n * Subscription option ID.\n */\n id: string;\n /**\n * Subscription option title. For example, \"Coffee of the week\".\n */\n title: string;\n /**\n * Subscription option description. For example, \"Subscribe and get 15% off\".\n */\n description: string;\n };\n type SubscriptionSettings = {\n /**\n * Frequency of recurring payment.\n * Supported values:\n *\n * + `\"DAY\"`\n * + `\"WEEK\"`\n * + `\"MONTH\"`\n * + `\"YEAR\"`\n */\n frequency: string;\n /**\n * Whether subscription is renewed automatically at the end of each period.\n * If the value is `true`, then `billingCycles` is ignored.\n */\n autoRenewal: boolean;\n /**\n * Number of billing cycles before subscription ends. Ignored if `autoRenewal: false`.\n */\n billingCycles: number;\n };\n /**\n * An object representing an order's totals.\n */\n type Totals = {\n /**\n * Total calculated discount amount.\n */\n discount?: number;\n /**\n * Total quantity of the the order's line items.\n */\n quantity: number;\n /**\n * Total shipping price, including tax.\n */\n shipping?: number;\n /**\n * Subtotal of all the order's line items, excluding tax.\n */\n subtotal: number;\n /**\n * Total amount of tax.\n */\n tax?: number;\n /**\n * Total price.\n */\n total: number;\n /**\n * Total weight of the order's items.\n */\n weight: number;\n };\n /**\n * An object representing tracking information for a fulfilled order.\n */\n type TrackingInfo = {\n /**\n * Tracking number.\n */\n trackingNumber: string;\n /**\n * Shipping provider.\n */\n shippingProvider: string;\n /**\n * Link to the tracking summary of the fulfilled order.\n */\n trackingLink: string;\n };\n /**\n * An object representing information for creating or updating a product in a store.\n */\n type UpdateProductInfo = {\n /**\n * Product name. Limited to 80 characters.\n */\n name?: string;\n /**\n * Product description.\n */\n description?: string;\n /**\n * Product stock keeping unit value. Must be unique.\n */\n sku?: string;\n /**\n * Product price.\n * The price must be greater than its discount.\n * The product price is propagated to the product's newly-created variants. Product variants whose prices have been updated directly are not affected by changes to the product price.\n */\n price?: number;\n /**\n * Details for the product's price per unit. If one of the `pricePerUnitData` fields is provided, all must be provided.\n */\n pricePerUnitData?: pricePerUnitData;\n /**\n * An object representing a product discount.\n */\n discount?: ProductDiscount;\n /**\n * An object representing all the available options for a store product.\n */\n productOptions?: ProductOptionsInfo;\n /**\n * Indicates whether product variants can be managed. Can be set to true only if the product has options. Once set to true, can be reset to false only if no variants exist. Use [`getProductVariants()`](wix-stores.html#getProductVariants) to check if variants exist. You cannot set `manageVariants` to true if more than 300 variants are defined.\n */\n manageVariants?: boolean;\n /**\n * Product type.\n */\n productType?: string;\n /**\n * Product weight.\n */\n weight?: number;\n /**\n * Whether the product is visible to site visitors. Setting this to false removes the product from Content Manager collections.\n */\n visible?: boolean;\n /**\n * Custom SEO data for the product. Learn more [about SEO](https://support.wix.com/en/search?term=seo).\n */\n seoData?: SeoData;\n /**\n * Product ribbon. Used to highlight relevant information about a product.\n * For example, `\"Sale\"`, `\"New Arrival\"`, `\"Sold Out\"`. Limited to 30 characters.\n */\n ribbon?: string;\n /**\n * Product brand.\n * Including a brand name can help improve your site’s [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores).\n * Limited to 50 characters.\n */\n brand?: string;\n };\n /**\n * An object containing variant information.\n */\n type VariantData = {\n /**\n * Variant currency.\n */\n currency: string;\n /**\n * Variant price. The variant price must be greater than its discount.\n */\n price: number;\n /**\n * Discounted variant price.\n */\n discountedPrice: number;\n /**\n * Price per unit.\n */\n pricePerUnit: number;\n /**\n * Price per unit formatted with currency symbol.\n */\n formattedPricePerUnit: string;\n /**\n * Variant weight.\n */\n weight: number;\n /**\n * Variant stock keeping unit value.\n */\n sku: string;\n /**\n * Whether the variant is visible to site visitors and appears in Content Manager collections.\n */\n visible: boolean;\n };\n /**\n * An object containing variant information for update.\n */\n type VariantInfo = {\n /**\n * Variant currency.\n */\n currency: string;\n /**\n * Variant price. The variant price must be greater than its discount.\n */\n price: number;\n /**\n * Discounted variant price.\n */\n discountedPrice: number;\n /**\n * Variant weight.\n */\n weight: number;\n /**\n * Variant stock keeping unit value.\n */\n sku: string;\n /**\n * Whether the variant is visible to site visitors and appears in Content Manager collections.\n */\n visible: boolean;\n /**\n * Specific product options to update.\n * The `choices` object contains key:value pairs where the key is the\n * option name and the value is the chosen option value.\n * For example, to update the blue t-shirt in size large, you would pass something like this: `{\"Color\": \"Blue\", \"Size\": \"Large\"}`.\n */\n choices: any;\n };\n /**\n * An object representing a product variant item.\n */\n type VariantItem = {\n /**\n * Unique variant ID.\n */\n _id: string;\n /**\n * The choices of the retrieved variant.\n */\n choices: ProductChoices;\n /**\n * Variant information.\n */\n variant: VariantData;\n };\n /**\n * An object representing product variants.\n */\n type Variants = {\n /**\n * List of variant items that match the specified choices or variant IDs.\n */\n items: VariantItem[];\n /**\n * Number of items in the current results page.\n */\n length: number;\n /**\n * Total number of variants with the specified choices.\n */\n totalCount: number;\n };\n /**\n * An object representing value added tax (VAT) information.\n */\n type VatId = {\n /**\n * VAT number.\n */\n number: string;\n /**\n * VAT type. Either `\"CPF\"` or `\"CNPJ\"`.\n */\n type: string;\n };\n /**\n * An object used by the Gallery properties `items` and `currentItem` to represent a single gallery video.\n */\n type VideoItem = {\n /**\n * Item type. Value is `\"video\"`.\n */\n type: string;\n /**\n * Video source URL.\n */\n src: string;\n /**\n * Item slug.\n */\n slug?: string;\n /**\n * Video title.\n */\n title?: string;\n /**\n * Video description. Descriptions over 100 characters are truncated.\n */\n description?: string;\n /**\n * URL of the video's clickable link. See [here]($w.LinkableMixin.html#link) for more information about links.\n */\n link?: string;\n /**\n * Video thumbnail URL.\n */\n thumbnail?: string;\n };\n /**\n * An object representing a product's price per unit data.\n */\n type pricePerUnitData = {\n /**\n * Product’s total weight, volume, or area. For example, if your product weighs 1 kilogram, the `totalQuantity` is `1`.\n */\n totalQuantity: number;\n /**\n * Total measurement unit of weight, volume, or area. For example, if your product weighs 1 kilogram, the `totalMeasurementUnit` is `\"KG\"`.\n *\n * Make sure the measurement system (metric or imperial) matches the one in your site's [Regional Settings](https://support.wix.com/en/article/changing-your-sites-regional-settings).\n *\n * Supported metric values:\n * `\"ML\"`, `\"CL\"`, `\"L\"`, `\"CBM\"`, `\"MG\"`, `\"G\"`, `\"KG\"`, `\"MM\"`, `\"CM\"`, `\"M\"`, `\"SQM\"`.\n *\n * Supported imperial values:\n * `\"OZ\"`, `\"LB\"`, `\"FLOZ\"`, `\"PT\"`, `\"QT\"`, `\"GAL\"`, `\"IN\"`, `\"FT\"`, `\"YD\"`, `\"SQFT\"`.\n */\n totalMeasurementUnit: string;\n /**\n * Product’s base weight, volume, or area. For example, for a product weighing 1 kilogram, the `baseQuantity` could be `100` (grams).\n */\n baseQuantity: number;\n /**\n * Base measurement unit of weight, volume, or area. For example, if your product weighs 1 kilogram, and the `baseQuantity` is `100` grams, `baseMeasurementUnit` is `\"G\"`.\n *\n * Make sure the measurement system (metric or imperial) matches the one in your site's [Regional Settings](https://support.wix.com/en/article/changing-your-sites-regional-settings).\n *\n * Supported metric values:\n * `\"ML\"`, `\"CL\"`, `\"L\"`, `\"CBM\"`, `\"MG\"`, `\"G\"`, `\"KG\"`, `\"MM\"`, `\"CM\"`, `\"M\"`, `\"SQM\"`.\n *\n * Supported imperial values:\n * `\"OZ\"`, `\"LB\"`, `\"FLOZ\"`, `\"PT\"`, `\"QT\"`, `\"GAL\"`, `\"IN\"`, `\"FT\"`, `\"YD\"`, `\"SQFT\"`.\n */\n baseMeasurementUnit: string;\n };\n /**\n * Events that are fired from a Wix Store.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#)\n */\n interface Events {\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onAbandonedCheckoutCreated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onabandonedcheckoutcreated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCartAbandoned)\n */\n onCartAbandoned(event: Events.CartAbandonedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onCheckoutCompleted()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/oncheckoutcompleted).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCartCompleted)\n */\n onCartCompleted(event: Events.CartCompletedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onCartCreated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/oncartcreated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n *\n * For more info about the differences between the Stores Cart and eCommerce Cart, refer to the [cart conversion table](https://www.wix.com/velo/reference/wix-ecom-backend/cart/stores-to-ecommerce-cart-conversion-table).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCartCreated)\n */\n onCartCreated(event: Events.CartCreatedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onAbandonedCheckoutRecovered()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onabandonedcheckoutrecovered).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCartRecovered)\n */\n onCartRecovered(event: Events.CartRecoveredEvent): void;\n /**\n * An event that fires when a product collection is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCollectionCreated)\n */\n onCollectionCreated(event: Events.CollectionCreatedEvent): void;\n /**\n * An event that fires when a product collection is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCollectionDeleted)\n */\n onCollectionDeleted(event: Events.CollectionDeletedEvent): void;\n /**\n * An event that fires when a product collection is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onCollectionUpdated)\n */\n onCollectionUpdated(event: Events.CollectionUpdatedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onFulfillmentsUpdated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onfulfillmentsupdated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onFulfillmentCreated)\n */\n onFulfillmentCreated(event: Events.FulfillmentCreatedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onFulfillmentsUpdated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onfulfillmentsupdated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onFulfillmentDeleted)\n */\n onFulfillmentDeleted(event: Events.FulfillmentDeletedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onFulfillmentsUpdated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onfulfillmentsupdated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onFulfillmentUpdated)\n */\n onFulfillmentUpdated(event: Events.FulfillmentUpdatedEvent): void;\n /**\n * An event that fires when an inventory item's information is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onInventoryItemUpdated)\n */\n onInventoryItemUpdated(event: Events.InventoryItemUpdatedEvent): void;\n /**\n * An event that fires when the inventory information of a product variant is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onInventoryVariantUpdated)\n */\n onInventoryVariantUpdated(event: Events.InventoryVariantUpdatedEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onOrderApproved()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onorderapproved).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onNewOrder)\n */\n onNewOrder(event: Events.NewOrderEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onOrderCanceled()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onordercanceled).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onOrderCanceled)\n */\n onOrderCanceled(event: Events.OrderCanceledEvent): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onOrderPaymentStatusUpdated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onorderpaymentstatusupdated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onOrderPaid)\n */\n onOrderPaid(event: Order): void;\n /**\n * **Deprecated.**\n * This event will continue to work until September 4, 2024, but a newer version is available at\n * [`wix-ecom-backend.Events.onOrderTransactionsUpdated()`](https://www.wix.com/velo/reference/wix-ecom-backend/events/onordertransactionsupdated).\n *\n * We recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onOrderRefunded)\n */\n onOrderRefunded(event: Events.OrderRefundedEvent): void;\n /**\n * An event that fires when a product is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onProductCreated)\n */\n onProductCreated(event: Events.ProductCreatedEvent): void;\n /**\n * An event that fires when a product is deleted.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onProductDeleted)\n */\n onProductDeleted(event: Events.ProductDeletedEvent): void;\n /**\n * An event that fires when a product is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onProductUpdated)\n */\n onProductUpdated(event: Events.ProductUpdatedEvent): void;\n /**\n * An event that fires when variant information for a product is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#onVariantsUpdated)\n */\n onVariantsUpdated(event: Events.VariantsUpdatedEvent): void;\n }\n /**\n * Events that are fired from a Wix Store.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-stores-backend.Events.html#)\n */\n namespace Events {\n /**\n * An object representing a shopping cart that was abandoned.\n */\n type CartAbandonedEvent = {\n /**\n * Time the abandoned cart was abandoned.\n */\n abandonTime: string;\n /**\n * Information about the visitor who abandoned the shopping cart.\n */\n buyerInfo: BuyerInfo;\n /**\n * ID of the shopping cart that was abandoned.\n */\n cartId: string;\n /**\n * URL of the abandoned cart's checkout page.\n */\n checkoutUrl: string;\n /**\n * ID of coupon used in the abandoned cart.\n */\n couponId: string;\n /**\n * Time the abandoned cart was created.\n */\n creationTime: string;\n /**\n * Number of items in the abandoned cart.\n */\n itemsCount: number;\n /**\n * Abandoned cart totals.\n */\n totals: Events.CartTotals;\n };\n /**\n * An object representing a shopping cart that was completed.\n */\n type CartCompletedEvent = {\n /**\n * ID of the shopping cart that was completed.\n */\n cartId: string;\n /**\n * Time the shopping cart was completed.\n */\n completedTime: string;\n /**\n * The buyer's information.\n */\n buyerInfo: BuyerInfo;\n /**\n * Message from the buyer.\n */\n buyerNote: string;\n /**\n * Coupon applied in the shopping cart.\n */\n appliedCoupon: CartAppliedCoupon;\n /**\n * Billing address.\n */\n billingAddress: Address;\n /**\n * Currency of the shopping cart.\n */\n currency: Currency;\n /**\n * The order's units of weight. One of: `\"KG\"`, `\"LB\"`, or `\"UNSPECIFIED_WEIGHT_UNIT\"`.\n */\n weightUnit: string;\n /**\n * The shopping cart's totals.\n */\n totals: OrderTotals;\n /**\n * The shopping cart's shipping information.\n */\n shippingInfo: CartShippingInfo;\n };\n /**\n * An object representing a shopping cart that was created.\n */\n type CartCreatedEvent = {\n /**\n * ID of the shopping cart that was created.\n */\n cartId: string;\n /**\n * Time the shopping cart was created.\n */\n creationTime: string;\n /**\n * The buyer's information.\n */\n buyerInfo: BuyerInfo;\n /**\n * The order's units of weight. One of: `\"KG\"`, `\"LB\"`, or `\"UNSPECIFIED_WEIGHT_UNIT\"`.\n */\n weightUnit: string;\n /**\n * Currency of the shopping cart.\n */\n currency: Currency;\n /**\n * The shopping cart's totals.\n */\n totals: OrderTotals;\n };\n /**\n * An object representing a shopping cart that was recovered.\n */\n type CartRecoveredEvent = {\n /**\n * Time the recovered cart was abandoned.\n */\n abandonedTime: string;\n /**\n * ID of the shopping cart that was abandoned.\n */\n cartId: string;\n /**\n * Time the recovered cart was originally created.\n */\n creationTime: string;\n /**\n * Time the cart was recovered.\n */\n recoveredTime: string;\n };\n /**\n * An object representing the totals of a shopping cart.\n */\n type CartTotals = {\n /**\n * Subtotal of all the line items in the abandoned cart, not including shipping and tax.\n */\n subtotal: number;\n /**\n * Total of all the line items in the abandoned cart, including shipping and tax.\n */\n total: number;\n /**\n * Total formatted with currency symbol.\n */\n formattedTotal: string;\n };\n /**\n * An object representing a product collection that was created.\n */\n type CollectionCreatedEvent = {\n /**\n * ID of the created collection.\n */\n _id: string;\n /**\n * Collection name.\n */\n name: string;\n /**\n * Main product media item (image) URL.\n */\n mainMedia: string;\n };\n /**\n * An object representing a product collection that was deleted.\n */\n type CollectionDeletedEvent = {\n /**\n * ID of the delete collection.\n */\n collectionId: string;\n };\n /**\n * An object representing a product collection that was updated.\n */\n type CollectionUpdatedEvent = {\n /**\n * ID of the updated collection.\n */\n collectionId: string;\n /**\n * Names of the collection fields that were updated.\n */\n updatedFields: string[];\n };\n /**\n * An object representing fulfillment information that was created.\n */\n type FulfillmentCreatedEvent = {\n /**\n * ID of the order the fulfillment was created for.\n */\n orderId: string;\n /**\n * ID of the fulfillment that was created.\n */\n fulfillmentId: string;\n /**\n * Date and time the fulfillment was created.\n */\n dateCreated: string;\n /**\n * Information about the order's buyer.\n */\n buyerInfo: BuyerInfo;\n /**\n * Tracking information.\n */\n trackingInfo: TrackingInfo;\n /**\n * The order's current fulfillment status.\n * One of:\n *\n * + `\"NOT_FULFILLED\"`: Order is not yet fulfilled.\n * + `\"FULFILLED\"`: Order was fulfilled successfully.\n * + `\"CANCELED\"`: Order was canceled.\n * + `\"PARTIALLY_FULFILLED\"`: Order was partially fulfilled. For example, when only some of the order's items were fulfilled.\n */\n fulfillmentStatus: string;\n };\n /**\n * An object representing fulfillment information that was deleted.\n */\n type FulfillmentDeletedEvent = {\n /**\n * ID of the order the fulfillment was deleted from.\n */\n orderId: string;\n /**\n * ID of the fulfillment that was deleted.\n */\n fulfillmentId: string;\n /**\n * The order's current fulfillment status.\n * One of:\n *\n * + `\"NOT_FULFILLED\"`: Order is not yet fulfilled.\n * + `\"FULFILLED\"`: Order was fulfilled successfully.\n * + `\"CANCELED\"`: Order was canceled.\n * + `\"PARTIALLY_FULFILLED\"`: Order was partially fulfilled. For example, when only some of the order's items were fulfilled.\n */\n fulfillmentStatus: string;\n };\n /**\n * An object representing fulfillment information that was updated.\n */\n type FulfillmentUpdatedEvent = {\n /**\n * ID of the order the fulfillment was updated for.\n */\n orderId: string;\n /**\n * ID of the fulfillment that was updated.\n */\n fulfillmentId: string;\n /**\n * Tracking information.\n */\n trackingInfo: TrackingInfo;\n };\n /**\n * An object representing an inventory item that was updated.\n */\n type InventoryItemUpdatedEvent = {\n /**\n * ID of the inventory item.\n */\n inventoryItemId: string;\n /**\n * External ID of the inventory item. For example, the product ID for inventory items which are store products.\n */\n externalId: string;\n /**\n * Whether the item's inventory is tracked.\n */\n trackInventory: boolean;\n };\n /**\n * An object representing product variant information that was updated.\n */\n type InventoryVariantUpdatedEvent = {\n /**\n * ID of the inventory item.\n */\n inventoryItemId: string;\n /**\n * External ID of the inventory item. For example, the product ID for inventory items which are store products.\n */\n externalId: string;\n /**\n * List of variants that were updated.\n */\n variants: Events.UpdatedVariantInventory[];\n };\n /**\n * An object representing a new order from a store.\n */\n type NewOrderEvent = {\n /**\n * The ID of the order, auto-generated when an order is created an unique within all Wix Stores.\n */\n orderId: string;\n /**\n * Running order number unique to the current store.\n */\n number: string;\n /**\n * The date the order was created.\n */\n dateCreated: string;\n /**\n * The buyer's information.\n */\n buyerInfo: BuyerInfo;\n /**\n * The currency code for all of the order's prices.\n */\n currency: string;\n /**\n * The order's units of weight. One of: `\"KG\"`, `\"LB\"`, or `\"UNSPECIFIED_WEIGHT_UNIT\"`.\n */\n weightUnit: string;\n /**\n * The order's totals.\n */\n totals: OrderTotals;\n /**\n * The order's payment status. One of: `\"PAID\"` or `\"NOT_PAID\"`.\n */\n paymentStatus: string;\n /**\n * The order's fulfillment status. One of: `\"FULFILLED\"` or `\"NOT_FULFILLED\"`.\n */\n fulfillmentStatus: string;\n /**\n * Subscription information. Omitted unless the order is a subscription.\n * Learn more about [selling product subscriptions](https://support.wix.com/en/article/wix-stores-selling-product-subscriptions).\n */\n subscriptionInfo?: SubscriptionInfo;\n /**\n * Billing information.\n */\n billingInfo: BillingInfo;\n };\n /**\n * An object representing information about a canceled order.\n */\n type OrderCanceledEvent = {\n /**\n * Information about the canceled order.\n */\n order: Order;\n };\n /**\n * An object representing information about a refunded order.\n */\n type OrderRefundedEvent = {\n /**\n * Order refund ID.\n */\n refundId: string;\n /**\n * Information about the refunded order.\n */\n order: Order;\n };\n /**\n * An object representing the specific choices from the product's options.\n */\n type ProductChoices = {\n /**\n * Value of the option. This key name is\n * dependent on the option changed in the product. For example, if a product\n * has a size option, this key value will be something like \"Size\" and its value\n * will be something like \"Large\".\n *\n * `optionKey` is not case-sensitive. Therefore the values for the option keys `\"Size\"` `\"SIZE\"` and `\"size\"` are combined.\n */\n optionKey: string;\n };\n /**\n * An object representing a product that was created.\n */\n type ProductCreatedEvent = {\n /**\n * Product ID.\n */\n _id: string;\n /**\n * Product name.\n */\n name: string;\n /**\n * Product stock keeping unit.\n */\n sku: string;\n /**\n * Discounted product price formatted with the currency.\n */\n formattedDiscountedPrice: string;\n /**\n * Whether the product is shown in the store.\n */\n visible: boolean;\n /**\n * Main product media item (image or video) URL.\n */\n mainMedia: string;\n /**\n * Discounted product price.\n */\n discountedPrice: number;\n /**\n * Product price formatted with the currency.\n */\n formattedPrice: string;\n /**\n * Product price.\n */\n price: number;\n /**\n * Product media items.\n */\n mediaItems: MediaItem[] | VideoItem[];\n /**\n * Product currency.\n */\n currency: string;\n /**\n * URL to the product's page.\n */\n productPageUrl: string;\n /**\n * Price per unit.\n */\n pricePerUnit: number;\n /**\n * Price per unit formatted with currency symbol.\n */\n formattedPricePerUnit: string;\n };\n /**\n * An object representing a product that was deleted.\n */\n type ProductDeletedEvent = {\n /**\n * ID of the deleted product.\n */\n productId: string;\n };\n /**\n * An object representing a product that was updated.\n */\n type ProductUpdatedEvent = {\n /**\n * ID of the updated product.\n */\n productId: string;\n /**\n * Names of the product fields that were updated.\n */\n updatedFields: string[];\n };\n /**\n * An object representing a product variants that was updated.\n */\n type UpdatedVariant = {\n /**\n * ID of the variant that was updated.\n */\n variantId: string;\n /**\n * Names of the product variant fields that were updated.\n */\n updatedFields: string[];\n /**\n * Placeholder text.\n */\n choices: Events.ProductChoices;\n };\n /**\n * An object representing product variant that was updated.\n */\n type UpdatedVariantInventory = {\n /**\n * ID of the productVariant that was updated.\n */\n id: string;\n /**\n * Old variant value.\n */\n oldValue: Events.VariantInventoryValue;\n /**\n * Updated variant value.\n */\n newValue: Events.VariantInventoryValue;\n };\n /**\n * An object representing a product variant value.\n */\n type VariantInventoryValue = {\n /**\n * Whether the variant is in stock.\n */\n inStock: boolean;\n /**\n * Number of items in stock.\n */\n quantity: number;\n };\n /**\n * An object representing product variants that were updated.\n */\n type VariantsUpdatedEvent = {\n /**\n * ID of the product in which variants were updated.\n */\n productId: string;\n /**\n * Variants that were updated.\n */\n variants: Events.UpdatedVariant[];\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-table-reservations.v2.d.ts", "content": "/**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations.v2.html#)\n */\ndeclare module 'wix-table-reservations.v2' {\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.html#reservationLocations)\n */\n const reservationLocations: ReservationLocations;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.html#reservations)\n */\n const reservations: Reservations;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.html#timeSlots)\n */\n const timeSlots: TimeSlots;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Events.html#)\n */\n interface Events {\n /**\n * Triggered when a held reservation is created.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Events.html#onReservationCreated)\n */\n onReservationCreated(event: Events.tableReservationsV1ReservationReservationCreated): void;\n /**\n * Triggered when a reservation location is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Events.html#onReservationLocationCreated)\n */\n onReservationLocationCreated(event: Events.tableReservationsV1ReservationLocationReservationLocationCreated): void;\n /**\n * Triggered when a reservation location is updated.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Events.html#onReservationLocationUpdated)\n */\n onReservationLocationUpdated(event: Events.tableReservationsV1ReservationLocationReservationLocationUpdated): void;\n /**\n * Triggered when a reservation is canceled.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Events.html#onReservationUpdated)\n */\n onReservationUpdated(event: Events.tableReservationsV1ReservationReservationUpdated): void;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.html#)\n */\n interface ReservationLocations {\n /**\n * Retrieves a reservation location by ID.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.html#getReservationLocation)\n */\n getReservationLocation(reservationLocationId: string, options: ReservationLocations.GetReservationLocationOptions): Promise;\n /**\n * Retrieves a list of up to 100 reservation locations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.html#listReservationLocations)\n */\n listReservationLocations(options: ReservationLocations.ListReservationLocationsOptions): Promise;\n /**\n * Creates a query to retrieve a list of reservation locations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.html#queryReservationLocations)\n */\n queryReservationLocations(options: ReservationLocations.QueryReservationLocationsOptions): ReservationLocations.ReservationLocationsQueryBuilder;\n /**\n * Updates a reservation location. Supports partial updates.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.html#updateReservationLocation)\n */\n updateReservationLocation(_id: string, reservationLocation: ReservationLocations.UpdateReservationLocation): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#)\n */\n interface Reservations {\n /**\n * Cancels a reservation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#cancelReservation)\n */\n cancelReservation(reservationId: string, revision: string, options: Reservations.CancelReservationOptions): Promise;\n /**\n * Creates a new temporary reservation and holds it for the customer for 10 minutes.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#createHeldReservation)\n */\n createHeldReservation(reservationDetails: Reservations.HeldReservationDetails): Promise;\n /**\n * Creates a new reservation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#createReservation)\n */\n createReservation(reservation: Reservations.Reservation, options: Reservations.CreateReservationOptions): Promise;\n /**\n * Retrieves a reservation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#getReservation)\n */\n getReservation(reservationId: string, options: Reservations.GetReservationOptions): Promise;\n /**\n * Retrieves a list of up to 100 reservations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#listReservations)\n */\n listReservations(options: Reservations.ListReservationsOptions): Promise;\n /**\n * Creates a query to retrieve a list of reservations.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#queryReservations)\n */\n queryReservations(): Reservations.ReservationsQueryBuilder;\n /**\n * Reserves or requests a held reservation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#reserveReservation)\n */\n reserveReservation(reservationId: string, reservee: Reservations.Reservee, revision: string): Promise;\n /**\n * Updates a reservation.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#updateReservation)\n */\n updateReservation(_id: string, reservation: Reservations.UpdateReservation, options: Reservations.UpdateReservationOptions): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.TimeSlots.html#)\n */\n interface TimeSlots {\n /**\n * Returns a list of time slots at a given restaurant on a given `date`, and their availability for a given `partySize`.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.TimeSlots.html#getTimeSlots)\n */\n getTimeSlots(reservationLocationId: string, date: Date, partySize: number, options: TimeSlots.GetTimeSlotsOptions): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Events.html#)\n */\n namespace Events {\n type tableReservationsV1ReservationActionEvent = {\n bodyAsJson?: string;\n };\n type tableReservationsV1ReservationAggregation = {\n dateHistogram?: Events.tableReservationsV1ReservationDateHistogramAggregation;\n fieldPath?: string;\n groupBy?: Events.tableReservationsV1ReservationGroupByAggregation;\n name?: string;\n nested?: Events.tableReservationsV1ReservationNestedAggregation;\n range?: Events.tableReservationsV1ReservationRangeAggregation;\n scalar?: Events.tableReservationsV1ReservationScalarAggregation;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'NESTED'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n value?: Events.tableReservationsV1ReservationValueAggregation;\n };\n type tableReservationsV1ReservationAggregationData = {\n /**\n * key = aggregation name (as derived from search request)\n */\n results?: Array;\n };\n type tableReservationsV1ReservationAggregationKindOneOf = {\n dateHistogram?: Events.tableReservationsV1ReservationDateHistogramAggregation;\n nested?: Events.tableReservationsV1ReservationNestedAggregation;\n range?: Events.tableReservationsV1ReservationRangeAggregation;\n scalar?: Events.tableReservationsV1ReservationScalarAggregation;\n value?: Events.tableReservationsV1ReservationValueAggregation;\n };\n type tableReservationsV1ReservationAggregationResults = {\n dateHistogram?: Events.tableReservationsV1ReservationDateHistogramResults;\n fieldPath?: string;\n groupedByValue?: Events.tableReservationsV1ReservationGroupByValueResults;\n name?: string;\n nested?: Events.tableReservationsV1ReservationNestedResults;\n ranges?: Events.tableReservationsV1ReservationRangeResults;\n scalar?: Events.tableReservationsV1ReservationScalarResult;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'NESTED'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n values?: Events.tableReservationsV1ReservationValueResults;\n };\n type tableReservationsV1ReservationAggregationResultsResultOneOf = {\n dateHistogram?: Events.tableReservationsV1ReservationDateHistogramResults;\n groupedByValue?: Events.tableReservationsV1ReservationGroupByValueResults;\n nested?: Events.tableReservationsV1ReservationNestedResults;\n ranges?: Events.tableReservationsV1ReservationRangeResults;\n scalar?: Events.tableReservationsV1ReservationScalarResult;\n values?: Events.tableReservationsV1ReservationValueResults;\n };\n type tableReservationsV1ReservationBackendEventMetadata = {\n /**\n * ID of the entity associated with the event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Event ID.\n */\n id: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.\n */\n triggeredByAnonymizeRequest: boolean;\n };\n type tableReservationsV1ReservationCancelReservationRequest = {\n /**\n * The phone number that was provided when the reservation was created.\n *\n * This is required for reservations with any `source` other than `WALK_IN`.\n *\n * This requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.\n */\n phone?: string;\n /**\n * Reservation ID.\n */\n reservationId: string;\n /**\n * Revision number.\n *\n * Include the existing `revision` to prevent conflicting updates to reservations.\n */\n revision: string;\n };\n type tableReservationsV1ReservationCancelReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationCreateHeldReservationRequest = {\n /**\n * Held reservation information to update.\n */\n reservationDetails: Events.tableReservationsV1ReservationHeldReservationDetails;\n };\n type tableReservationsV1ReservationCreateHeldReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationCreateReservationRequest = {\n /**\n * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n * * `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.\n */\n ignoreReservationLocationConflicts?: Array;\n /**\n * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n * * `\"TOO_BIG\"`: The party is too big for the selected table.\n * * `\"TOO_SMALL\"`: The party is too small for the selected table.\n * * `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.\n */\n ignoreTableCombinationConflicts?: Array;\n /**\n * Reservation details.\n */\n reservation: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationCreateReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationCursorPaging = {\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string;\n /**\n * Number of items to load.\n */\n limit?: number;\n };\n type tableReservationsV1ReservationCursorPagingMetadata = {\n /**\n * Number of items returned in the response.\n */\n count?: number;\n /**\n * Offset that was requested.\n */\n cursors?: Events.tableReservationsV1ReservationCursors;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean;\n };\n type tableReservationsV1ReservationCursorQuery = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Events.tableReservationsV1ReservationCursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-and-filtering) article.\n * To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n */\n filter?: Object;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Array;\n };\n type tableReservationsV1ReservationCursorQueryPagingMethodOneOf = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Events.tableReservationsV1ReservationCursorPaging;\n };\n type tableReservationsV1ReservationCursorSearch = {\n /**\n * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.\n */\n aggregations?: Array;\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'\n */\n cursorPaging?: Events.tableReservationsV1ReservationCursorPaging;\n /**\n * A filter object. See the filter section [here](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/wix-api-basics/1011-wql-wix-query-language)\n */\n filter?: Object;\n /**\n * free text to match in searchable fields\n */\n search?: Events.tableReservationsV1ReservationSearchDetails;\n /**\n * Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]\n */\n sort?: Array;\n };\n type tableReservationsV1ReservationCursorSearchPagingMethodOneOf = {\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'\n */\n cursorPaging?: Events.tableReservationsV1ReservationCursorPaging;\n };\n type tableReservationsV1ReservationCursors = {\n /**\n * Cursor pointing to next page in the list of results.\n */\n next?: string;\n /**\n * Cursor pointing to previous page in the list of results.\n */\n prev?: string;\n };\n type tableReservationsV1ReservationDateHistogramAggregation = {\n /**\n * Supported values:\n * - `'DAY'`\n * - `'HOUR'`\n * - `'MINUTE'`\n * - `'MONTH'`\n * - `'SECOND'`\n * - `'UNKNOWN_INTERVAL'`\n * - `'WEEK'`\n * - `'YEAR'`\n */\n interval?: string;\n };\n type tableReservationsV1ReservationDateHistogramResult = {\n count?: number;\n value?: string;\n };\n type tableReservationsV1ReservationDateHistogramResults = {\n results?: Array;\n };\n type tableReservationsV1ReservationDeleteReservationRequest = {\n /**\n * Reservation ID.\n */\n reservationId: string;\n revision?: string;\n };\n type tableReservationsV1ReservationDeleteReservationResponse = {};\n type tableReservationsV1ReservationDetails = {\n /**\n * End date and time of the reservation.\n */\n endDate?: Date;\n /**\n * Party size.\n */\n partySize?: number;\n /**\n * ID of the reservation location at which this reservation will be made.\n */\n reservationLocationId?: string;\n /**\n * Start date and time of the reservation.\n */\n startDate?: Date;\n /**\n * IDs of tables used for this reservation.\n */\n tableIds?: Array;\n };\n type tableReservationsV1ReservationDomainEvent = {\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n actionEvent?: Events.tableReservationsV1ReservationActionEvent;\n createdEvent?: Events.tableReservationsV1ReservationEntityCreatedEvent;\n deletedEvent?: Events.tableReservationsV1ReservationEntityDeletedEvent;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * ID of the entity associated with the event.\n */\n entityId?: string;\n /**\n * Event timestamp.\n */\n eventTime?: Date;\n /**\n * If present, indicates the action that triggered the event.\n */\n originatedFrom?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean;\n updatedEvent?: Events.tableReservationsV1ReservationEntityUpdatedEvent;\n };\n type tableReservationsV1ReservationDomainEventBodyOneOf = {\n actionEvent?: Events.tableReservationsV1ReservationActionEvent;\n createdEvent?: Events.tableReservationsV1ReservationEntityCreatedEvent;\n deletedEvent?: Events.tableReservationsV1ReservationEntityDeletedEvent;\n updatedEvent?: Events.tableReservationsV1ReservationEntityUpdatedEvent;\n };\n type tableReservationsV1ReservationEmpty = {};\n type tableReservationsV1ReservationEntityCreatedEvent = {\n entityAsJson?: string;\n };\n type tableReservationsV1ReservationEntityDeletedEvent = {\n /**\n * Entity that was deleted\n */\n deletedEntityAsJson?: string;\n };\n type tableReservationsV1ReservationEntityUpdatedEvent = {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n };\n type tableReservationsV1ReservationGetReservationRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`.\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: If `fields` is omitted from the request, `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * Reservation ID.\n */\n reservationId: string;\n };\n type tableReservationsV1ReservationGetReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationGroupByAggregation = {\n fieldPath?: string;\n name?: string;\n value?: Events.tableReservationsV1ReservationValueAggregation;\n };\n type tableReservationsV1ReservationGroupByAggregationKindOneOf = {\n value?: Events.tableReservationsV1ReservationValueAggregation;\n };\n type tableReservationsV1ReservationGroupByValueResults = {\n results?: Array;\n };\n type tableReservationsV1ReservationHeldReservationDetails = {\n /**\n * Party size.\n */\n partySize?: number;\n /**\n * ID of the reservation location where the reservation is made.\n */\n reservationLocationId?: string;\n /**\n * Start date and time of the reservation.\n */\n startDate?: Date;\n };\n type tableReservationsV1ReservationIncludeMissingValuesOptions = {\n /**\n * can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...\n */\n addToBucket?: string;\n };\n type tableReservationsV1ReservationListReservationsRequest = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n paging?: Events.tableReservationsV1ReservationCursorPaging;\n /**\n * Defines how reservations in the response are sorted.\n */\n sort?: Events.tableReservationsV1ReservationSorting;\n /**\n * Only reservations starting after this date are returned.\n */\n startDateFrom?: Date;\n /**\n * Only reservations starting before this date are returned.\n */\n startDateTo?: Date;\n /**\n * Only reservations with this status are returned.\n *\n * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n * * `RESERVED`: The reservation is confirmed.\n * * `SEATED`: The customer is currently occupying the table.\n * * `CANCELED`: The reservation is canceled.\n * * `NO_SHOW`: The customer didn't show up for their reservation.\n * * `FINISHED`: The reservation completed successfully.\n */\n status?: string;\n };\n type tableReservationsV1ReservationListReservationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: Events.tableReservationsV1ReservationCursorPagingMetadata;\n /**\n * List of reservations.\n */\n reservations?: Array;\n };\n type tableReservationsV1ReservationLocationActionEvent = {\n bodyAsJson?: string;\n };\n type tableReservationsV1ReservationLocationAddress = {\n /**\n * City name.\n */\n city?: string;\n /**\n * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Full address of the location.\n */\n formatted?: string;\n /**\n * Geographic coordinates of the location.\n */\n location?: Events.tableReservationsV1ReservationLocationAddressLocation;\n /**\n * Postal or zip code.\n */\n postalCode?: string;\n /**\n * Street address of the location. Includes street name, number, and apartment number in separate fields.\n */\n streetAddress?: Events.tableReservationsV1ReservationLocationStreetAddress;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n };\n type tableReservationsV1ReservationLocationAddressLocation = {\n /**\n * Latitude of the location. Must be between -90 and 90.\n */\n latitude?: number;\n /**\n * Longitude of the location. Must be between -180 and 180.\n */\n longitude?: number;\n };\n type tableReservationsV1ReservationLocationApp = {\n /**\n * The AppDefId\n */\n appDefId?: string;\n /**\n * The instance Id\n */\n instanceId?: string;\n };\n type tableReservationsV1ReservationLocationAsset = {\n /**\n * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).\n */\n appDefId?: string;\n /**\n * An instance id. For legacy reasons may be UUID or a string.\n */\n instanceId?: string;\n /**\n * An application state.\n */\n state?: string;\n };\n type tableReservationsV1ReservationLocationAssignedFromFloatingReason = {};\n type tableReservationsV1ReservationLocationBackendEventMetadata = {\n /**\n * ID of the entity associated with the event.\n */\n entityId: string;\n /**\n * Event timestamp.\n */\n eventTime: string;\n /**\n * Event ID.\n */\n id: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.\n */\n triggeredByAnonymizeRequest: boolean;\n };\n type tableReservationsV1ReservationLocationBooleanFeature = {};\n type tableReservationsV1ReservationLocationBusinessSchedule = {\n periods?: Array;\n /**\n * Time periods during which this location is open. Each period represents a range of hours during the week during which the location is\n * open.\n *\n * Max: 100 time periods\n */\n specialHourPeriod?: Array;\n };\n type tableReservationsV1ReservationLocationCancelRequestedReason = {};\n type tableReservationsV1ReservationLocationCheckReservationLocationsCreatedRequest = {};\n type tableReservationsV1ReservationLocationCheckReservationLocationsCreatedResponse = {\n /**\n * Reservation locations created.\n */\n created?: boolean;\n };\n type tableReservationsV1ReservationLocationConfiguration = {\n /**\n * \"My reservations\" field details.\n *\n * These are the fields that appear in the \"My reservations\" section of the Table Reservations page on the restaurant's Wix site dashboard.\n */\n myReservationsFields?: Array;\n /**\n * Settings for this location that are used to determine restaurant availability for reservations made online.\n */\n onlineReservations?: Events.tableReservationsV1ReservationLocationOnlineReservations;\n /**\n * Reservation form settings.\n */\n reservationForm?: Events.tableReservationsV1ReservationLocationReservationForm;\n /**\n * Table management settings.\n */\n tableManagement?: Events.tableReservationsV1ReservationLocationTableManagement;\n };\n type tableReservationsV1ReservationLocationContractSwitchedReason = {};\n type tableReservationsV1ReservationLocationCursorPaging = {\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string;\n /**\n * Number of items to load.\n */\n limit?: number;\n };\n type tableReservationsV1ReservationLocationCursorPagingMetadata = {\n /**\n * Number of items returned in the response.\n */\n count?: number;\n /**\n * Offset that was requested.\n */\n cursors?: Events.tableReservationsV1ReservationLocationCursors;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean;\n };\n type tableReservationsV1ReservationLocationCursors = {\n /**\n * Cursor pointing to next page in the list of results.\n */\n next?: string;\n /**\n * Cursor pointing to previous page in the list of results.\n */\n prev?: string;\n };\n type tableReservationsV1ReservationLocationCustomFieldDefinition = {\n /**\n * Custom field ID.\n */\n _id?: string;\n /**\n * Custom field name.\n */\n name?: string;\n /**\n * Whether the custom field is required.\n *\n * Default: `false`\n */\n required?: boolean;\n };\n type tableReservationsV1ReservationLocationDeleteContext = {\n /**\n * When the meta site was deleted.\n */\n dateDeleted?: Date;\n /**\n * A reason (flow).\n */\n deleteOrigin?: string;\n /**\n * A status.\n */\n deleteStatus?: string;\n /**\n * A service that deleted it.\n */\n initiatorId?: string;\n };\n type tableReservationsV1ReservationLocationDeleteOrphanReservationLocationRequest = {\n /**\n * Id of the ReservationLocation.\n */\n reservationLocationId?: string;\n };\n type tableReservationsV1ReservationLocationDeleteOrphanReservationLocationResponse = {};\n type tableReservationsV1ReservationLocationDomainEvent = {\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n actionEvent?: Events.tableReservationsV1ReservationLocationActionEvent;\n createdEvent?: Events.tableReservationsV1ReservationLocationEntityCreatedEvent;\n deletedEvent?: Events.tableReservationsV1ReservationLocationEntityDeletedEvent;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * ID of the entity associated with the event.\n */\n entityId?: string;\n /**\n * Event timestamp.\n */\n eventTime?: Date;\n /**\n * If present, indicates the action that triggered the event.\n */\n originatedFrom?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean;\n updatedEvent?: Events.tableReservationsV1ReservationLocationEntityUpdatedEvent;\n };\n type tableReservationsV1ReservationLocationDomainEventBodyOneOf = {\n actionEvent?: Events.tableReservationsV1ReservationLocationActionEvent;\n createdEvent?: Events.tableReservationsV1ReservationLocationEntityCreatedEvent;\n deletedEvent?: Events.tableReservationsV1ReservationLocationEntityDeletedEvent;\n updatedEvent?: Events.tableReservationsV1ReservationLocationEntityUpdatedEvent;\n };\n type tableReservationsV1ReservationLocationEmailMarketingCheckbox = {\n /**\n * Whether the checkbox is checked by default.\n *\n * Default: `false`\n */\n checkedByDefault?: boolean;\n /**\n * Whether the checkbox is shown to the customer.\n *\n * Default: `false`\n */\n enabled?: boolean;\n };\n type tableReservationsV1ReservationLocationEmpty = {};\n type tableReservationsV1ReservationLocationEntityCreatedEvent = {\n entityAsJson?: string;\n };\n type tableReservationsV1ReservationLocationEntityDeletedEvent = {\n /**\n * Entity that was deleted\n */\n deletedEntityAsJson?: string;\n };\n type tableReservationsV1ReservationLocationEntityUpdatedEvent = {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n };\n type tableReservationsV1ReservationLocationFeature = {\n /**\n * ID of the feature. __Note:__ Isn't unique. For example, all features that\n * are available to free Wix accounts or site in some capacity have\n * `{\"id\": \"DEFAULT\"}`. Use `uniqueName` as unique identifier for a feature.\n */\n _id?: string;\n /**\n * Deprecated. Use `enabled` instead.\n */\n booleanFeature?: Events.tableReservationsV1ReservationLocationBooleanFeature;\n /**\n * Information about whether the feature belongs to a Wix account or site.\n * Account features have `context.userId`. Site features have `context.metaSiteId` in case\n * they're assigned to a specific site. Site features that aren't assigned to\n * a specific site have neither ID.\n */\n context?: Events.tableReservationsV1ReservationLocationFeatureContext;\n /**\n * Deprecated.\n */\n createdAt?: Date;\n /**\n * Whether the customer is currently allowed to use the feature.\n * `true` means that the customer can use the feature. This means a boolean\n * feature is active or a quota feature has remaining usage.\n * `false` means that the customer can't use the feature.\n * This means a boolean feature isn't active or a quota feature doesn't\n * have remaining usage.\n */\n enabled?: boolean;\n /**\n * Metadata of the feature. Wix Premium uses the metadata object to indicate\n * that customers who purchase a product with the feature also get\n * access to an additional product. For these bundled products `metadata`\n * looks like this: `{\"tpa\": \"{\"appDefId\": \"sample-app-def-id-1234567890\", \"vendorProductId\": \"sample-productId\"}}\"`.\n * But you can use the `metadata` property for other purposes, too.\n */\n metadata?: Record;\n /**\n * Deprecated. Use `quotaInfo` instead.\n */\n quotaFeature?: Events.tableReservationsV1ReservationLocationQuotaFeature;\n /**\n * Information about how often customers can use the feature during a specific\n * period. Available only for quota features.\n */\n quotaInfo?: Events.tableReservationsV1ReservationLocationQuotaInfo;\n /**\n * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)\n * to which the feature instance belongs.\n */\n subscriptionId?: string;\n /**\n * Unique name of the feature. Only lower case letters, numbers, and dashes\n * `-` are supported. Used in the endpoints of the\n * [Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)\n * to specify the feature. Not visible to customers. We recommend to start\n * the unique name with a prefix describing your organization or Wix company.\n * For example, `bookings` or `crm`.\n *\n * Min: 2 characters\n * Max: 50 characters\n */\n uniqueName?: string;\n /**\n * Deprecated.\n */\n updatedAt?: Date;\n };\n type tableReservationsV1ReservationLocationFeatureCancelled = {\n /**\n * Information about the feature cancellation.\n */\n cancelRequest?: Events.tableReservationsV1ReservationLocationCancelRequestedReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: Events.tableReservationsV1ReservationLocationContractSwitchedReason;\n /**\n * Canceled feature.\n */\n feature?: Events.tableReservationsV1ReservationLocationFeature;\n /**\n * Information about a transfer to the account.\n * __Deprecated__. Use `reason.transferred_to_account` instead.\n */\n transferredToAccount?: string;\n /**\n * Information about a transfer to the account.\n */\n transferredToAnotherAccount?: Events.tableReservationsV1ReservationLocationTransferredToAnotherAccountReason;\n };\n type tableReservationsV1ReservationLocationFeatureCancelledReasonOneOf = {\n /**\n * Information about the feature cancellation.\n */\n cancelRequest?: Events.tableReservationsV1ReservationLocationCancelRequestedReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: Events.tableReservationsV1ReservationLocationContractSwitchedReason;\n /**\n * Information about a transfer to the account.\n */\n transferredToAnotherAccount?: Events.tableReservationsV1ReservationLocationTransferredToAnotherAccountReason;\n };\n type tableReservationsV1ReservationLocationFeatureContext = {\n /**\n * ID of the meta site that the feature instance is assigned to.\n * Only available for site level feature instances that are assigned to a Wix\n * site. Not available for account level and unassigned site level feature\n * instances.\n */\n metaSiteId?: string;\n /**\n * ID of the Wix account that the feature instance belongs to.\n * Available for both site and account level feature instances.\n */\n userId?: string;\n };\n type tableReservationsV1ReservationLocationFeatureDisabled = {\n /**\n * Disabled feature. Includes information about the feature's new state,\n * possibly its new context.\n */\n feature?: Events.tableReservationsV1ReservationLocationFeature;\n /**\n * ID of the meta site for which the feature has been disabled.\n */\n metaSiteId?: string;\n /**\n * Information about a feature that's been reassigned to a different\n * site.\n */\n reassignedToAnotherSite?: Events.tableReservationsV1ReservationLocationReassignedToAnotherSiteReason;\n /**\n * Information about a feature that's been replaced by a feature from a\n * different subscription.\n */\n replacedByAnotherSubscription?: Events.tableReservationsV1ReservationLocationReplacedByAnotherSubscriptionReason;\n /**\n * Information about a feature that's no longer assigned to a site.\n */\n unassingedToFloating?: Events.tableReservationsV1ReservationLocationUnAssingedToFloatingReason;\n };\n type tableReservationsV1ReservationLocationFeatureDisabledReasonOneOf = {\n /**\n * Information about a feature that's been reassigned to a different\n * site.\n */\n reassignedToAnotherSite?: Events.tableReservationsV1ReservationLocationReassignedToAnotherSiteReason;\n /**\n * Information about a feature that's been replaced by a feature from a\n * different subscription.\n */\n replacedByAnotherSubscription?: Events.tableReservationsV1ReservationLocationReplacedByAnotherSubscriptionReason;\n /**\n * Information about a feature that's no longer assigned to a site.\n */\n unassingedToFloating?: Events.tableReservationsV1ReservationLocationUnAssingedToFloatingReason;\n };\n type tableReservationsV1ReservationLocationFeatureEnabled = {\n /**\n * Information about a feature that hadn't been assigned to site.\n */\n assignedFromFloating?: Events.tableReservationsV1ReservationLocationAssignedFromFloatingReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: Events.tableReservationsV1ReservationLocationContractSwitchedReason;\n /**\n * Enabled feature.\n */\n feature?: Events.tableReservationsV1ReservationLocationFeature;\n /**\n * Information about the manually created features.\n */\n manualFeatureCreation?: Events.tableReservationsV1ReservationLocationManualFeatureCreationReason;\n /**\n * Information about a feature that was migrated from legacy.\n */\n migratedFromLegacy?: Events.tableReservationsV1ReservationLocationMigratedFromLegacyReason;\n /**\n * Information about the new feature.\n */\n newFeature?: Events.tableReservationsV1ReservationLocationNewFeatureReason;\n /**\n * Information about a transfer from another site.\n * __Deprecated__. Use `reason.reassigned_from_site` instead.\n */\n reassignedFromMetasite?: string;\n /**\n * Information about a transfer from another site.\n */\n reassignedFromSite?: Events.tableReservationsV1ReservationLocationReassignedFromSiteReason;\n /**\n * Information about a transfer from another account.\n * __Deprecated__. Use `reason.transferred_from_another_account` instead.\n */\n transferredFromAccount?: string;\n /**\n * Information about a transfer from another account.\n */\n transferredFromAnotherAccount?: Events.tableReservationsV1ReservationLocationTransferredFromAnotherAccountReason;\n };\n type tableReservationsV1ReservationLocationFeatureEnabledReasonOneOf = {\n /**\n * Information about a feature that hadn't been assigned to site.\n */\n assignedFromFloating?: Events.tableReservationsV1ReservationLocationAssignedFromFloatingReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: Events.tableReservationsV1ReservationLocationContractSwitchedReason;\n /**\n * Information about the manually created features.\n */\n manualFeatureCreation?: Events.tableReservationsV1ReservationLocationManualFeatureCreationReason;\n /**\n * Information about a feature that was migrated from legacy.\n */\n migratedFromLegacy?: Events.tableReservationsV1ReservationLocationMigratedFromLegacyReason;\n /**\n * Information about the new feature.\n */\n newFeature?: Events.tableReservationsV1ReservationLocationNewFeatureReason;\n /**\n * Information about a transfer from another site.\n */\n reassignedFromSite?: Events.tableReservationsV1ReservationLocationReassignedFromSiteReason;\n /**\n * Information about a transfer from another account.\n */\n transferredFromAnotherAccount?: Events.tableReservationsV1ReservationLocationTransferredFromAnotherAccountReason;\n };\n type tableReservationsV1ReservationLocationFeatureEvent = {\n /**\n * Information about an event that cancels a feature for the user.\n * Triggered for example, when a feature is canceled, transferred to\n * another account, or the user switched to a different contract.\n */\n cancelled?: Events.tableReservationsV1ReservationLocationFeatureCancelled;\n /**\n * Information about an event that disables a feature for the user.\n * Triggered for example, when a feature is unassigned from a site,\n * reassigned to a different site, or the user switched to a different contract.\n */\n disabled?: Events.tableReservationsV1ReservationLocationFeatureDisabled;\n /**\n * Information about an event that makes a feature eligible to the user.\n * Triggered for example, for new features or when a feature is reassigned\n * to an account or a site.\n */\n enabled?: Events.tableReservationsV1ReservationLocationFeatureEnabled;\n /**\n * Timestamp of the event in\n * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n */\n timestamp?: Date;\n /**\n * Information about an event that updates a feature. An `updated` event\n * is triggered for example by the\n * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\n * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\n * endpoints.\n */\n updated?: Events.tableReservationsV1ReservationLocationFeatureUpdated;\n };\n type tableReservationsV1ReservationLocationFeatureEventEventOneOf = {\n /**\n * Information about an event that cancels a feature for the user.\n * Triggered for example, when a feature is canceled, transferred to\n * another account, or the user switched to a different contract.\n */\n cancelled?: Events.tableReservationsV1ReservationLocationFeatureCancelled;\n /**\n * Information about an event that disables a feature for the user.\n * Triggered for example, when a feature is unassigned from a site,\n * reassigned to a different site, or the user switched to a different contract.\n */\n disabled?: Events.tableReservationsV1ReservationLocationFeatureDisabled;\n /**\n * Information about an event that makes a feature eligible to the user.\n * Triggered for example, for new features or when a feature is reassigned\n * to an account or a site.\n */\n enabled?: Events.tableReservationsV1ReservationLocationFeatureEnabled;\n /**\n * Information about an event that updates a feature. An `updated` event\n * is triggered for example by the\n * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\n * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\n * endpoints.\n */\n updated?: Events.tableReservationsV1ReservationLocationFeatureUpdated;\n };\n type tableReservationsV1ReservationLocationFeatureQuantityInfoOneOf = {\n /**\n * Deprecated. Use `enabled` instead.\n */\n booleanFeature?: Events.tableReservationsV1ReservationLocationBooleanFeature;\n /**\n * Deprecated. Use `quotaInfo` instead.\n */\n quotaFeature?: Events.tableReservationsV1ReservationLocationQuotaFeature;\n };\n type tableReservationsV1ReservationLocationFeatureUpdated = {\n /**\n * Information about a feature that doesn't have a usage quota.\n */\n booleanFeature?: Events.tableReservationsV1ReservationLocationBooleanFeature;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: Events.tableReservationsV1ReservationLocationContractSwitchedReason;\n /**\n * Updated feature. Includes information about the feature's new state and\n * possibly its new context.\n */\n feature?: Events.tableReservationsV1ReservationLocationFeature;\n /**\n * Information about a feature that has a usage quota.\n */\n quotaFeature?: Events.tableReservationsV1ReservationLocationQuotaFeature;\n };\n type tableReservationsV1ReservationLocationFeatureUpdatedPreviousQuantityInfoOneOf = {\n /**\n * Information about a feature that doesn't have a usage quota.\n */\n booleanFeature?: Events.tableReservationsV1ReservationLocationBooleanFeature;\n /**\n * Information about a feature that has a usage quota.\n */\n quotaFeature?: Events.tableReservationsV1ReservationLocationQuotaFeature;\n };\n type tableReservationsV1ReservationLocationFeatureUpdatedReasonOneOf = {\n /**\n * Information about the contract switch.\n */\n contractSwitched?: Events.tableReservationsV1ReservationLocationContractSwitchedReason;\n };\n type tableReservationsV1ReservationLocationGetReservationLocationRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * ID of the ReservationLocation to retrieve.\n */\n reservationLocationId: string;\n };\n type tableReservationsV1ReservationLocationGetReservationLocationResponse = {\n /**\n * The retrieved reservation location.\n */\n reservationLocation?: Events.tableReservationsV1ReservationLocationReservationLocation;\n };\n type tableReservationsV1ReservationLocationInvalidateCache = {\n /**\n * Invalidate by App\n */\n app?: Events.tableReservationsV1ReservationLocationApp;\n /**\n * Is local DS\n */\n localDc?: boolean;\n /**\n * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!\n */\n metaSiteId?: string;\n /**\n * Invalidate by page id\n */\n page?: Events.tableReservationsV1ReservationLocationPage;\n /**\n * tell us why you're invalidating the cache. You don't need to add your app name\n */\n reason?: string;\n /**\n * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!\n */\n siteId?: string;\n /**\n * Invalidate by URI path\n */\n uri?: Events.tableReservationsV1ReservationLocationUri;\n };\n type tableReservationsV1ReservationLocationInvalidateCacheGetByOneOf = {\n /**\n * Invalidate by App\n */\n app?: Events.tableReservationsV1ReservationLocationApp;\n /**\n * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!\n */\n metaSiteId?: string;\n /**\n * Invalidate by page id\n */\n page?: Events.tableReservationsV1ReservationLocationPage;\n /**\n * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!\n */\n siteId?: string;\n /**\n * Invalidate by URI path\n */\n uri?: Events.tableReservationsV1ReservationLocationUri;\n };\n type tableReservationsV1ReservationLocationListReservationLocationsRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n paging?: Events.tableReservationsV1ReservationLocationCursorPaging;\n /**\n * Sorting for the locations list.\n */\n sort?: Events.tableReservationsV1ReservationLocationSorting;\n };\n type tableReservationsV1ReservationLocationListReservationLocationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: Events.tableReservationsV1ReservationLocationCursorPagingMetadata;\n /**\n * Locations list.\n */\n reservationLocations?: Array;\n };\n type tableReservationsV1ReservationLocationLocation = {\n /**\n * Location ID.\n */\n _id?: string;\n };\n type tableReservationsV1ReservationLocationManualApproval = {\n /**\n * Custom approvals provider id.\n */\n customApprovalsProviderId?: string;\n /**\n * Whether manual approval is required for online reservations.\n */\n enabled?: boolean;\n /**\n * The minimum party size that requires manual approval.\n */\n partySizeThreshold?: number;\n };\n type tableReservationsV1ReservationLocationManualApprovalValueOneOf = {\n /**\n * Custom approvals provider id.\n */\n customApprovalsProviderId?: string;\n /**\n * The minimum party size that requires manual approval.\n */\n partySizeThreshold?: number;\n };\n type tableReservationsV1ReservationLocationManualFeatureCreationReason = {};\n type tableReservationsV1ReservationLocationMetaSiteSpecialEvent = {\n /**\n * A list of \"assets\" (applications). The same as MetaSiteContext.\n */\n assets?: Array;\n /**\n * Emitted when meta site was permanently deleted.\n */\n hardDeleted?: Events.tableReservationsV1ReservationLocationSiteHardDeleted;\n /**\n * A meta site id.\n */\n metaSiteId?: string;\n /**\n * Emitted on a namespace change.\n */\n namespaceChanged?: Events.tableReservationsV1ReservationLocationNamespaceChanged;\n /**\n * Emitted when an application is provisioned (installed).\n */\n serviceProvisioned?: Events.tableReservationsV1ReservationLocationServiceProvisioned;\n /**\n * Emitted when an application is removed (uninstalled).\n */\n serviceRemoved?: Events.tableReservationsV1ReservationLocationServiceRemoved;\n /**\n * Emitted on a meta site creation.\n */\n siteCreated?: Events.tableReservationsV1ReservationLocationSiteCreated;\n /**\n * Emitted on a meta site deletion.\n */\n siteDeleted?: Events.tableReservationsV1ReservationLocationSiteDeleted;\n /**\n * Emitted when meta site is marked as template.\n */\n siteMarkedAsTemplate?: Events.tableReservationsV1ReservationLocationSiteMarkedAsTemplate;\n /**\n * Emitted when meta site is marked as a WixSite.\n */\n siteMarkedAsWixSite?: Events.tableReservationsV1ReservationLocationSiteMarkedAsWixSite;\n /**\n * Emitted on the first* publish of the meta site (* switching from unpublished to published state).\n */\n sitePublished?: Events.tableReservationsV1ReservationLocationSitePublished;\n /**\n * Emitted when meta site name (URL slug) is changed.\n */\n siteRenamedPayload?: Events.tableReservationsV1ReservationLocationSiteRenamed;\n /**\n * Emitted on a meta site transfer completion.\n */\n siteTransferred?: Events.tableReservationsV1ReservationLocationSiteTransferred;\n /**\n * Emitted on a meta site restoration.\n */\n siteUndeleted?: Events.tableReservationsV1ReservationLocationSiteUndeleted;\n /**\n * Emitted on a meta site unpublish.\n */\n siteUnpublished?: Events.tableReservationsV1ReservationLocationSiteUnpublished;\n /**\n * Emitted when Studio is attached.\n */\n studioAssigned?: Events.tableReservationsV1ReservationLocationStudioAssigned;\n /**\n * Emitted when Studio is detached.\n */\n studioUnassigned?: Events.tableReservationsV1ReservationLocationStudioUnassigned;\n /**\n * A timestamp of the event.\n */\n timestamp?: string;\n /**\n * A meta site version. Monotonically increasing.\n */\n version?: string;\n };\n type tableReservationsV1ReservationLocationMetaSiteSpecialEventPayloadOneOf = {\n /**\n * Emitted when meta site was permanently deleted.\n */\n hardDeleted?: Events.tableReservationsV1ReservationLocationSiteHardDeleted;\n /**\n * Emitted on a namespace change.\n */\n namespaceChanged?: Events.tableReservationsV1ReservationLocationNamespaceChanged;\n /**\n * Emitted when an application is provisioned (installed).\n */\n serviceProvisioned?: Events.tableReservationsV1ReservationLocationServiceProvisioned;\n /**\n * Emitted when an application is removed (uninstalled).\n */\n serviceRemoved?: Events.tableReservationsV1ReservationLocationServiceRemoved;\n /**\n * Emitted on a meta site creation.\n */\n siteCreated?: Events.tableReservationsV1ReservationLocationSiteCreated;\n /**\n * Emitted on a meta site deletion.\n */\n siteDeleted?: Events.tableReservationsV1ReservationLocationSiteDeleted;\n /**\n * Emitted when meta site is marked as template.\n */\n siteMarkedAsTemplate?: Events.tableReservationsV1ReservationLocationSiteMarkedAsTemplate;\n /**\n * Emitted when meta site is marked as a WixSite.\n */\n siteMarkedAsWixSite?: Events.tableReservationsV1ReservationLocationSiteMarkedAsWixSite;\n /**\n * Emitted on the first* publish of the meta site (* switching from unpublished to published state).\n */\n sitePublished?: Events.tableReservationsV1ReservationLocationSitePublished;\n /**\n * Emitted when meta site name (URL slug) is changed.\n */\n siteRenamedPayload?: Events.tableReservationsV1ReservationLocationSiteRenamed;\n /**\n * Emitted on a meta site transfer completion.\n */\n siteTransferred?: Events.tableReservationsV1ReservationLocationSiteTransferred;\n /**\n * Emitted on a meta site restoration.\n */\n siteUndeleted?: Events.tableReservationsV1ReservationLocationSiteUndeleted;\n /**\n * Emitted on a meta site unpublish.\n */\n siteUnpublished?: Events.tableReservationsV1ReservationLocationSiteUnpublished;\n /**\n * Emitted when Studio is attached.\n */\n studioAssigned?: Events.tableReservationsV1ReservationLocationStudioAssigned;\n /**\n * Emitted when Studio is detached.\n */\n studioUnassigned?: Events.tableReservationsV1ReservationLocationStudioUnassigned;\n };\n type tableReservationsV1ReservationLocationMigrateOldRestaurantSettingsRequest = {\n /**\n * Mode.\n */\n mode?: string;\n /**\n * Override not default.\n */\n overrideNotDefault?: boolean;\n };\n type tableReservationsV1ReservationLocationMigrateOldRestaurantSettingsResponse = {\n /**\n * Migration results.\n */\n migrationResults?: Array;\n };\n type tableReservationsV1ReservationLocationMigratedFromLegacyReason = {};\n type tableReservationsV1ReservationLocationMigrationParsingError = {\n /**\n * Message.\n */\n message?: string;\n /**\n * Field.\n */\n path?: string;\n /**\n * Target.\n */\n target?: Object;\n };\n type tableReservationsV1ReservationLocationMigrationResult = {\n /**\n * Migration parsing errors.\n */\n migrationParsingErrors?: Array;\n /**\n * Old settings.\n */\n oldSettings?: Object;\n /**\n * Parsed settings.\n */\n parsedSettings?: Events.tableReservationsV1ReservationLocationParsedSettings;\n /**\n * The migrated ReservationLocation.\n */\n reservationLocation?: Events.tableReservationsV1ReservationLocationReservationLocation;\n };\n type tableReservationsV1ReservationLocationMyReservationsField = {\n /**\n * Custom field ID.\n *\n * This should only be provided if the `fieldType` is `CUSTOM_FIELD`, in which case it is required and must match the ID of a custom field in the `customFieldDefinitions` array of the `reservationForm`.\n */\n customFieldId?: string;\n /**\n * Field type.\n */\n fieldType?: string;\n /**\n * Whether the field is shown.\n */\n shown?: boolean;\n };\n type tableReservationsV1ReservationLocationNamespaceChanged = {\n /**\n * A new namespace.\n */\n newNamespace?: string;\n /**\n * A previous namespace.\n */\n oldNamespace?: string;\n };\n type tableReservationsV1ReservationLocationNewFeatureReason = {};\n type tableReservationsV1ReservationLocationNoticePeriod = {\n /**\n * The quantity of the chosen time unit.\n */\n number?: number;\n /**\n * Time unit.\n */\n unit?: string;\n };\n type tableReservationsV1ReservationLocationOldCustomField = {\n label?: string;\n required?: boolean;\n };\n type tableReservationsV1ReservationLocationOldInstant = {\n day?: number;\n hour?: number;\n minute?: number;\n month?: number;\n year?: number;\n };\n type tableReservationsV1ReservationLocationOldPolicy = {\n isPlainText?: boolean;\n value?: string;\n };\n type tableReservationsV1ReservationLocationOldScheduleException = {\n available?: boolean;\n comment?: string;\n end?: Events.tableReservationsV1ReservationLocationOldInstant;\n start?: Events.tableReservationsV1ReservationLocationOldInstant;\n };\n type tableReservationsV1ReservationLocationOldScheduleInterval = {\n durationMins?: number;\n minuteOfWeek?: number;\n };\n type tableReservationsV1ReservationLocationOldTerms = {\n isPlainText?: boolean;\n value?: string;\n };\n type tableReservationsV1ReservationLocationOnlineReservations = {\n /**\n * The location's business schedule.\n *\n * By default, the business schedule of a reservation location uses the values of its location's business schedule. However, after the first time a reservation location's business schedule has been modified, it stores and uses its own values and no longer mirrors its location's business schedule.\n * Limited to 100 time periods.\n */\n businessSchedule?: Events.tableReservationsV1ReservationLocationBusinessSchedule;\n /**\n * Default turnover time in minutes.\n *\n * Turnover time is how much time a party is allotted for their entire reservation - from being seated to leaving the restaurant.\n */\n defaultTurnoverTime?: number;\n /**\n * Manual approval settings.\n */\n manualApproval?: Events.tableReservationsV1ReservationLocationManualApproval;\n /**\n * Minimum reservation notice.\n *\n * The minimum amount of time that must be allowed between making a reservation and that reservation's start time.\n */\n minimumReservationNotice?: Events.tableReservationsV1ReservationLocationNoticePeriod;\n /**\n * Whether online reservations are enabled.\n */\n onlineReservationsEnabled?: boolean;\n /**\n * Party pacing settings.\n *\n * The maximum number of party reservations that can start within a 15-minute period.\n * For example, a party pacing of 5 would mean that no more than 5 parties could make a reservation for the period between `10:00.000`-`10:14.999`.\n */\n partyPacing?: Events.tableReservationsV1ReservationLocationPartyPacing;\n /**\n * Party size limits for a reservation.\n */\n partySize?: Events.tableReservationsV1ReservationLocationPartySize;\n /**\n * Seat pacing settings.\n *\n * The maximum number of seats that can be filled by new reservations within a 15-minute period.\n * For example, setting a seat pacing of 15 would mean that between `10:00.000`-`10:14.999` there will be no more than 15 new seats available for reservation.\n */\n seatPacing?: Events.tableReservationsV1ReservationLocationSeatPacing;\n /**\n * Whether a phone number is shown.\n */\n showPhoneNumber?: boolean;\n /**\n * Custom turnover time rules.\n *\n * This allows you to set different turnover times for different party sizes.\n */\n turnoverTimeRules?: Array;\n };\n type tableReservationsV1ReservationLocationPage = {\n /**\n * the msid the page is on\n */\n metaSiteId?: string;\n /**\n * Invalidate by Page ID\n */\n pageId?: string;\n };\n type tableReservationsV1ReservationLocationPaging = {\n /**\n * Number of items to load.\n */\n limit?: number;\n /**\n * Number of items to skip in the current sort order.\n */\n offset?: number;\n };\n type tableReservationsV1ReservationLocationPagingMetadataV2 = {\n /**\n * Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.\n */\n cursors?: Events.tableReservationsV1ReservationLocationCursors;\n /**\n * Offset that was requested.\n */\n offset?: number;\n };\n type tableReservationsV1ReservationLocationParsedSettings = {\n available?: boolean;\n customFields?: Array;\n futureDelayMins?: number;\n locale?: string;\n partySizeMax?: number;\n partySizeMin?: number;\n privacyPolicy?: Events.tableReservationsV1ReservationLocationOldPolicy;\n scheduleExceptions?: Array;\n termsAndConditions?: Events.tableReservationsV1ReservationLocationOldTerms;\n weeklySchedule?: Array;\n };\n type tableReservationsV1ReservationLocationPartiesSize = {\n /**\n * Maximum number of seats a party can reserve.\n */\n max?: number;\n /**\n * Minimum number of seats a party can reserve.\n */\n min?: number;\n };\n type tableReservationsV1ReservationLocationPartyPacing = {\n /**\n * Whether this option is enabled.\n */\n enabled?: boolean;\n /**\n * Maximum number of new party reservations that can be made every 15 minutes.\n */\n number?: number;\n };\n type tableReservationsV1ReservationLocationPartySize = {\n /**\n * Maximum number of seats a party can reserve.\n */\n max?: number;\n /**\n * Minimum number of seats a party can reserve.\n */\n min?: number;\n };\n type tableReservationsV1ReservationLocationPrivacyPolicy = {\n /**\n * Whether the privacy policy is shown to the customer.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Privacy policy text.\n */\n text?: string;\n /**\n * Privacy policy URL.\n */\n url?: string;\n };\n type tableReservationsV1ReservationLocationPrivacyPolicyValueOneOf = {\n /**\n * Privacy policy text.\n */\n text?: string;\n /**\n * Privacy policy URL.\n */\n url?: string;\n };\n type tableReservationsV1ReservationLocationQueryReservationLocationsRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * Query options.\n */\n query: Events.tableReservationsV1ReservationLocationQueryV2;\n };\n type tableReservationsV1ReservationLocationQueryReservationLocationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: Events.tableReservationsV1ReservationLocationPagingMetadataV2;\n /**\n * List of reservation locations\n */\n reservationLocations?: Array;\n };\n type tableReservationsV1ReservationLocationQueryV2 = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Events.tableReservationsV1ReservationLocationCursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-and-filtering) article.\n * To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n */\n filter?: Object;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: Events.tableReservationsV1ReservationLocationPaging;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Array;\n };\n type tableReservationsV1ReservationLocationQueryV2PagingMethodOneOf = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Events.tableReservationsV1ReservationLocationCursorPaging;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: Events.tableReservationsV1ReservationLocationPaging;\n };\n type tableReservationsV1ReservationLocationQuotaFeature = {\n /**\n * Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount.\n */\n limit?: string;\n /**\n * Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset.\n */\n period?: string;\n /**\n * Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit.\n */\n units?: string;\n };\n type tableReservationsV1ReservationLocationQuotaInfo = {\n /**\n * How often the customer has used the feature during the current\n * period.\n */\n currentUsage?: string;\n /**\n * How often the customer is allowed to use the feature during the specified\n * period. `null` means that the customer has unlimited access to the feature.\n */\n limit?: string;\n /**\n * Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`\n * isn't automatically reset to the feature's `limit` after a specific period.\n * You may still manually call\n * [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).\n */\n period?: string;\n /**\n * How often the customer can still use the feature during the current\n * period. `null` means that the customer has unlimited access to the feature.\n */\n remainingUsage?: string;\n };\n type tableReservationsV1ReservationLocationReassignedFromSiteReason = {\n /**\n * Information about a transfer from another site.\n */\n reassignedFromMetasite?: string;\n };\n type tableReservationsV1ReservationLocationReassignedToAnotherSiteReason = {\n /**\n * Information about a transfer to the site.\n */\n reassignedToMetasite?: string;\n };\n type tableReservationsV1ReservationLocationReplacedByAnotherSubscriptionReason = {};\n type tableReservationsV1ReservationLocationReservationForm = {\n /**\n * Custom fields you wish to add to the registration form for the customer to fill in.\n */\n customFieldDefinitions?: Array;\n /**\n * Email marketing checkbox settings.\n */\n emailMarketingCheckbox?: Events.tableReservationsV1ReservationLocationEmailMarketingCheckbox;\n /**\n * Whether an email is required in the reservation form.\n *\n * Default: `false`\n */\n emailRequired?: boolean;\n /**\n * Whether a last_name is required in the reservation form.\n *\n * Default: `false`\n */\n lastNameRequired?: boolean;\n /**\n * Whether to show policies (the terms and conditions, and the privacy policy) to the customer.\n */\n policiesEnabled?: boolean;\n /**\n * Settings for displaying the privacy policy.\n */\n privacyPolicy?: Events.tableReservationsV1ReservationLocationPrivacyPolicy;\n /**\n * A message shown to the customer in the registration form.\n */\n submitMessage?: string;\n /**\n * Settings for displaying the terms and conditions.\n */\n termsAndConditions?: Events.tableReservationsV1ReservationLocationTermsAndConditions;\n };\n type tableReservationsV1ReservationLocationReservationLocation = {\n /**\n * The date and time this reservation location was created.\n */\n _createdDate?: Date;\n /**\n * Reservation location ID.\n */\n _id?: string;\n /**\n * The date and time this reservation location was last updated.\n */\n _updatedDate?: Date;\n /**\n * Whether this reservation location's `location` is archived.\n */\n archived?: boolean;\n /**\n * Reservation location configuration.\n */\n configuration?: Events.tableReservationsV1ReservationLocationConfiguration;\n /**\n * Whether this reservation location's `location` is the default location of the business.\n */\n default?: boolean;\n /**\n * Physical location details.\n *\n * Locations can be created and configured using the [Locations API](https://dev.wix.com/docs/rest/api-reference/business-info/locations/introduction)\n * or on the [Business Info](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsettings/business-info) page in the Dashboard.\n */\n location?: Events.tableReservationsV1ReservationLocationLocation;\n /**\n * Represents the current state of a reservation location. Each time the reservation location is modified, its `revision` changes. For an update operation to succeed, you must pass the latest revision.\n */\n revision?: string;\n };\n type tableReservationsV1ReservationLocationReservationLocationCreated = {\n /**\n * Information about the reservation location that was created.\n */\n entity: Events.tableReservationsV1ReservationLocationReservationLocation;\n /**\n * Event metadata.\n */\n metadata: Events.tableReservationsV1ReservationLocationBackendEventMetadata;\n };\n type tableReservationsV1ReservationLocationReservationLocationUpdated = {\n /**\n * Information about the reservation location that was updated.\n */\n entity: Events.tableReservationsV1ReservationLocationReservationLocation;\n /**\n * Event metadata.\n */\n metadata: Events.tableReservationsV1ReservationLocationBackendEventMetadata;\n };\n type tableReservationsV1ReservationLocationSeatPacing = {\n /**\n * Whether this option is enabled.\n */\n enabled?: boolean;\n /**\n * Maximum number of seats that can be reserved every 15 minutes.\n */\n number?: number;\n };\n type tableReservationsV1ReservationLocationServiceProvisioned = {\n /**\n * Either UUID or EmbeddedServiceType.\n */\n appDefId?: string;\n /**\n * Not only UUID. Something here could be something weird.\n */\n instanceId?: string;\n /**\n * An instance id from which this instance is originated.\n */\n originInstanceId?: string;\n /**\n * A version.\n */\n version?: string;\n };\n type tableReservationsV1ReservationLocationServiceRemoved = {\n /**\n * Either UUID or EmbeddedServiceType.\n */\n appDefId?: string;\n /**\n * Not only UUID. Something here could be something weird.\n */\n instanceId?: string;\n /**\n * A version.\n */\n version?: string;\n };\n type tableReservationsV1ReservationLocationSiteCreated = {\n /**\n * A context in which meta site was created.\n */\n context?: string;\n /**\n * A namespace.\n */\n namespace?: string;\n /**\n * A meta site id from which this site was created.\n *\n * In case of a creation from a template it's a template id.\n * In case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.\n */\n originMetaSiteId?: string;\n /**\n * A template identifier (empty if not created from a template).\n */\n originTemplateId?: string;\n /**\n * An account id of the owner.\n */\n ownerId?: string;\n /**\n * A meta site name (URL slug).\n */\n siteName?: string;\n };\n type tableReservationsV1ReservationLocationSiteDeleted = {\n /**\n * A deletion context.\n */\n deleteContext?: Events.tableReservationsV1ReservationLocationDeleteContext;\n };\n type tableReservationsV1ReservationLocationSiteHardDeleted = {\n /**\n * A deletion context.\n */\n deleteContext?: Events.tableReservationsV1ReservationLocationDeleteContext;\n };\n type tableReservationsV1ReservationLocationSiteMarkedAsTemplate = {};\n type tableReservationsV1ReservationLocationSiteMarkedAsWixSite = {};\n type tableReservationsV1ReservationLocationSitePublished = {};\n type tableReservationsV1ReservationLocationSiteRenamed = {\n /**\n * A new meta site name (URL slug).\n */\n newSiteName?: string;\n /**\n * A previous meta site name (URL slug).\n */\n oldSiteName?: string;\n };\n type tableReservationsV1ReservationLocationSiteTransferred = {\n /**\n * A new owner id (user that accepts meta site).\n */\n newOwnerId?: string;\n /**\n * A previous owner id (user that transfers meta site).\n */\n oldOwnerId?: string;\n };\n type tableReservationsV1ReservationLocationSiteUndeleted = {};\n type tableReservationsV1ReservationLocationSiteUnpublished = {\n /**\n * A list of URLs previously associated with the meta site.\n */\n urls?: Array;\n };\n type tableReservationsV1ReservationLocationSorting = {\n /**\n * Name of the field to sort by.\n */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.\n */\n order?: string;\n };\n type tableReservationsV1ReservationLocationSpecialHourPeriod = {\n /**\n * Additional details about the period.\n */\n comment?: string;\n /**\n * End date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n */\n endDate?: string;\n /**\n * Whether or not the location is closed during this period.\n */\n isClosed?: boolean;\n /**\n * Start date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n */\n startDate?: string;\n };\n type tableReservationsV1ReservationLocationStreetAddress = {\n /**\n * Apartment number.\n */\n apt?: string;\n /**\n * Street name.\n */\n name?: string;\n /**\n * Street number.\n */\n number?: string;\n };\n type tableReservationsV1ReservationLocationStudioAssigned = {};\n type tableReservationsV1ReservationLocationStudioUnassigned = {};\n type tableReservationsV1ReservationLocationTableCombination = {\n /**\n * Table combination ID.\n */\n _id?: string;\n /**\n * Whether the table combination is active (available to be reserved).\n */\n isActive?: boolean;\n /**\n * Maximum number of seats that can be reserved in this table combination.\n */\n seatsMax?: number;\n /**\n * Minimum number of seats that can be reserved in this table combination.\n */\n seatsMin?: number;\n /**\n * IDs of tables in the combination.\n */\n tableIds?: Array;\n };\n type tableReservationsV1ReservationLocationTableDefinition = {\n /**\n * Table ID.\n */\n _id?: string;\n /**\n * Whether the table is active (available to be reserved).\n */\n isActive?: boolean;\n /**\n * Table name.\n */\n name?: string;\n /**\n * Maximum number of seats.\n */\n seatsMax?: number;\n /**\n * Minimum number of seats.\n */\n seatsMin?: number;\n };\n type tableReservationsV1ReservationLocationTableManagement = {\n /**\n * Deleted table definitions.\n */\n deletedTableDefinitions?: Array;\n /**\n * Table combinations.\n */\n tableCombinations?: Array;\n /**\n * Table definitions.\n */\n tableDefinitions?: Array;\n };\n type tableReservationsV1ReservationLocationTablesDeleted = {\n /**\n * ID of the affected reservation location.\n */\n reservationLocationId?: string;\n /**\n * IDs of deleted tables.\n */\n tableIds?: Array;\n };\n type tableReservationsV1ReservationLocationTermsAndConditions = {\n /**\n * Whether the terms and conditions are shown to the customer.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Terms and conditions text.\n */\n text?: string;\n /**\n * Terms and conditions URL.\n */\n url?: string;\n };\n type tableReservationsV1ReservationLocationTermsAndConditionsValueOneOf = {\n /**\n * Terms and conditions text.\n */\n text?: string;\n /**\n * Terms and conditions URL.\n */\n url?: string;\n };\n type tableReservationsV1ReservationLocationTimePeriod = {\n /**\n * Day of the week this period ends on.\n */\n closeDay?: string;\n /**\n * Time this period ends in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents\n * midnight at the end of the specified day field.\n *\n * This is the last time a reservation can be made at the restaurant, not the time the restaurant closes its doors.\n */\n closeTime?: string;\n /**\n * Day of the week this period starts on.\n */\n openDay?: string;\n /**\n * Time this period starts in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents\n * midnight at the end of the specified day field.\n */\n openTime?: string;\n };\n type tableReservationsV1ReservationLocationTransferredFromAnotherAccountReason = {\n /**\n * Information about a transfer from another account.\n */\n transferredFromAccount?: string;\n };\n type tableReservationsV1ReservationLocationTransferredToAnotherAccountReason = {\n /**\n * Information about a transfer to the account.\n */\n transferredToAccount?: string;\n };\n type tableReservationsV1ReservationLocationTurnoverRule = {\n /**\n * Maximum number of seats to qualify for this rule.\n */\n maxSeats?: number;\n /**\n * Minimum number of seats to qualify for this rule.\n */\n minSeats?: number;\n /**\n * Turnover time in minutes for qualifying parties.\n */\n minutes?: number;\n };\n type tableReservationsV1ReservationLocationTurnoverTimeRule = {\n /**\n * Turnover time in minutes for qualifying parties.\n */\n minutes?: number;\n /**\n * Maximum number of seats to qualify for this rule.\n */\n seatsMax?: number;\n /**\n * Minimum number of seats to qualify for this rule.\n */\n seatsMin?: number;\n };\n type tableReservationsV1ReservationLocationUnAssingedToFloatingReason = {};\n type tableReservationsV1ReservationLocationUpdateReservationLocationRequest = {\n /**\n * ReservationLocation to be updated, may be partial.\n */\n reservationLocation: Events.tableReservationsV1ReservationLocationReservationLocation;\n };\n type tableReservationsV1ReservationLocationUpdateReservationLocationResponse = {\n /**\n * The updated reservation location.\n */\n reservationLocation?: Events.tableReservationsV1ReservationLocationReservationLocation;\n };\n type tableReservationsV1ReservationLocationUri = {\n /**\n * the msid the URI is on\n */\n metaSiteId?: string;\n /**\n * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes\n */\n uriPath?: string;\n };\n type tableReservationsV1ReservationMigrationNote = {};\n type tableReservationsV1ReservationNestedAggregation = {\n nestedAggregations?: Array;\n };\n type tableReservationsV1ReservationNestedAggregationItem = {\n dateHistogram?: Events.tableReservationsV1ReservationDateHistogramAggregation;\n fieldPath?: string;\n name?: string;\n range?: Events.tableReservationsV1ReservationRangeAggregation;\n scalar?: Events.tableReservationsV1ReservationScalarAggregation;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n value?: Events.tableReservationsV1ReservationValueAggregation;\n };\n type tableReservationsV1ReservationNestedAggregationItemKindOneOf = {\n dateHistogram?: Events.tableReservationsV1ReservationDateHistogramAggregation;\n range?: Events.tableReservationsV1ReservationRangeAggregation;\n scalar?: Events.tableReservationsV1ReservationScalarAggregation;\n value?: Events.tableReservationsV1ReservationValueAggregation;\n };\n type tableReservationsV1ReservationNestedAggregationResults = {\n fieldPath?: string;\n name?: string;\n ranges?: Events.tableReservationsV1ReservationRangeResults;\n scalar?: Events.tableReservationsV1ReservationScalarResult;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'NESTED'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n values?: Events.tableReservationsV1ReservationValueResults;\n };\n type tableReservationsV1ReservationNestedAggregationResultsResultOneOf = {\n ranges?: Events.tableReservationsV1ReservationRangeResults;\n scalar?: Events.tableReservationsV1ReservationScalarResult;\n values?: Events.tableReservationsV1ReservationValueResults;\n };\n type tableReservationsV1ReservationNestedResultValue = {\n dateHistogram?: Events.tableReservationsV1ReservationValueResult;\n range?: Events.tableReservationsV1ReservationRangeResult;\n scalar?: Events.tableReservationsV1ReservationNestedResultsScalarResult;\n value?: Events.tableReservationsV1ReservationValueResult;\n };\n type tableReservationsV1ReservationNestedResultValueResultOneOf = {\n dateHistogram?: Events.tableReservationsV1ReservationValueResult;\n range?: Events.tableReservationsV1ReservationRangeResult;\n scalar?: Events.tableReservationsV1ReservationNestedResultsScalarResult;\n value?: Events.tableReservationsV1ReservationValueResult;\n };\n type tableReservationsV1ReservationNestedResults = {\n results?: Array;\n };\n type tableReservationsV1ReservationNestedResultsScalarResult = {\n value?: number;\n };\n type tableReservationsV1ReservationNestedValueAggregationResult = {\n nestedResults?: Events.tableReservationsV1ReservationNestedAggregationResults;\n value?: string;\n };\n type tableReservationsV1ReservationQueryReservationsRequest = {\n /**\n * Query to select reservations.\n */\n query: Events.tableReservationsV1ReservationCursorQuery;\n };\n type tableReservationsV1ReservationQueryReservationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: Events.tableReservationsV1ReservationCursorPagingMetadata;\n /**\n * List of reservations.\n */\n reservations?: Array;\n };\n type tableReservationsV1ReservationRangeAggregation = {\n buckets?: Array;\n };\n type tableReservationsV1ReservationRangeAggregationResult = {\n count?: number;\n from?: number;\n to?: number;\n };\n type tableReservationsV1ReservationRangeBucket = {\n /**\n * Inclusive lower bound of the range. Required if to is not given.\n */\n from?: number;\n /**\n * Exclusive upper bound of the range. Required if from is not given.\n */\n to?: number;\n };\n type tableReservationsV1ReservationRangeResult = {\n count?: number;\n from?: number;\n to?: number;\n };\n type tableReservationsV1ReservationRangeResults = {\n results?: Array;\n };\n type tableReservationsV1ReservationReservation = {\n /**\n * Date and time the reservation was created.\n */\n _createdDate?: Date;\n /**\n * Reservation ID.\n */\n _id?: string;\n /**\n * Date and time the reservation was changed.\n */\n _updatedDate?: Date;\n /**\n * The reason the reservation was declined.\n */\n declineReason?: string;\n /**\n * Reservation details.\n */\n details?: Events.tableReservationsV1ReservationDetails;\n /**\n * Information about the person making the reservation.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n reservedBy?: Events.tableReservationsV1ReservationReservedBy;\n /**\n * Information about the person the reservation is being made for.\n *\n * A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.\n * Attempting to create a reservation without these fields results in an error.\n */\n reservee?: Events.tableReservationsV1ReservationReservee;\n /**\n * Revision number, which increments by 1 each time the reservation is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the reservation.\n *\n * Ignored when creating a reservation.\n */\n revision?: string;\n /**\n * Reservation source.\n *\n * This indicates how the reservation was made.\n * * `ONLINE` indicates that the customer made the reservation through a website or app.\n * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.\n * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.\n */\n source?: string;\n /**\n * Status of the reservation.\n *\n * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n * * `RESERVED`: The reservation is confirmed.\n * * `SEATED`: The customer is currently occupying the table.\n * * `CANCELED`: The reservation is canceled.\n * * `NO_SHOW`: The customer didn't show up for their reservation.\n * * `FINISHED`: The reservation completed successfully.\n *\n * See the [Reservation Lifecycle article](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle) for an explanation of the role of statuses in the reservation lifecycle.\n */\n status?: string;\n /**\n * Team message.\n *\n * A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.\n */\n teamMessage?: string;\n };\n type tableReservationsV1ReservationReservationCanceled = {\n /**\n * Reserved reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationReservationCreated = {\n /**\n * Information about the reservation that was created.\n */\n entity: Events.tableReservationsV1ReservationReservation;\n /**\n * Event metadata.\n */\n metadata: Events.tableReservationsV1ReservationBackendEventMetadata;\n };\n type tableReservationsV1ReservationReservationDataUpdated = {\n /**\n * Old reservation.\n */\n oldReservation?: Events.tableReservationsV1ReservationReservation;\n /**\n * Reserved reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationReservationDetailsConflicts = {\n /**\n * Reservation location conflicts.\n */\n reservationLocationConflicts?: Array;\n /**\n * Table combinations conflicts.\n */\n tableCombinationConflicts?: Array;\n };\n type tableReservationsV1ReservationReservationLocationConflict = {\n /**\n * Reservation location conflict type.\n */\n type?: string;\n };\n type tableReservationsV1ReservationReservationReserved = {\n /**\n * Reserved reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationReservationUpdated = {\n /**\n * Information about the reservation that was updated.\n */\n entity: Events.tableReservationsV1ReservationReservation;\n /**\n * Event metadata.\n */\n metadata: Events.tableReservationsV1ReservationBackendEventMetadata;\n };\n type tableReservationsV1ReservationReserveReservationRequest = {\n /**\n * Reservation ID.\n */\n reservationId: string;\n /**\n * Reservee details.\n */\n reservee: Events.tableReservationsV1ReservationReservee;\n /**\n * Revision number.\n *\n * Include the existing `revision` to prevent conflicting updates to reservations.\n */\n revision: string;\n };\n type tableReservationsV1ReservationReserveReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationReservedBy = {\n /**\n * Contact ID for the person who made the reservation. If a contact with this ID does not exist on the site, one will be created.\n */\n contactId?: string;\n };\n type tableReservationsV1ReservationReservee = {\n /**\n * Contact ID. If a contact with this ID does not exist on the site, one will be created.\n */\n contactId?: string;\n /**\n * Custom fields for the reservee in key-value pairs.\n *\n * The key is the custom field's ID, and the value is the custom field's value. For example, a custom field for allergies might have the key-value pair `f4283b2d-6340-4cf9-bae7-8769e6b62127 : \"Nuts, Seafood\"`.\n *\n * Empty fields are not returned.\n */\n customFields?: Object;\n /**\n * Email address.\n */\n email?: string;\n /**\n * First name.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n firstName?: string;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * Whether the reservee has given marketing consent.\n */\n marketingConsent?: boolean;\n /**\n * Phone number.\n *\n * This property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `\"+972555555555\"`.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n phone?: string;\n };\n type tableReservationsV1ReservationResults = {\n results?: Record;\n };\n type tableReservationsV1ReservationScalarAggregation = {\n /**\n * Supported values:\n * - `'AVG'`\n * - `'COUNT_DISTINCT'`\n * - `'MAX'`\n * - `'MIN'`\n * - `'SUM'`\n * - `'UNKNOWN_SCALAR_TYPE'`\n */\n type?: string;\n };\n type tableReservationsV1ReservationScalarResult = {\n /**\n * Supported values:\n * - `'AVG'`\n * - `'COUNT_DISTINCT'`\n * - `'MAX'`\n * - `'MIN'`\n * - `'SUM'`\n * - `'UNKNOWN_SCALAR_TYPE'`\n */\n type?: string;\n value?: number;\n };\n type tableReservationsV1ReservationSearchDetails = {\n /**\n * search term or expression\n */\n expression?: string;\n /**\n * fields to search in. if empty - server will search in own default fields\n */\n fields?: Array;\n /**\n * flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)\n */\n fuzzy?: boolean;\n /**\n * boolean search mode\n */\n mode?: string;\n };\n type tableReservationsV1ReservationSearchReservationsRequest = {\n /**\n * Search query.\n */\n search: Events.tableReservationsV1ReservationCursorSearch;\n };\n type tableReservationsV1ReservationSearchReservationsResponse = {\n /**\n * Aggregation data.\n */\n aggregationData?: Events.tableReservationsV1ReservationAggregationData;\n /**\n * Cursor paging metadata.\n */\n pagingMetadata?: Events.tableReservationsV1ReservationCursorPagingMetadata;\n /**\n * List of Reservations.\n */\n reservations?: Array;\n };\n type tableReservationsV1ReservationSorting = {\n /**\n * Name of the field to sort by.\n */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.\n */\n order?: string;\n };\n type tableReservationsV1ReservationTableCombinationConflict = {\n /**\n * Conflict type.\n */\n type?: string;\n };\n type tableReservationsV1ReservationTableWithReservationConflicts = {\n /**\n * List of reservation ids.\n */\n reservationIds?: Array;\n /**\n * Table id.\n */\n tableId?: string;\n };\n type tableReservationsV1ReservationUpdateReservationRequest = {\n /**\n * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n * * `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.\n */\n ignoreReservationLocationConflicts?: Array;\n /**\n * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n * * `\"TOO_BIG\"`: The party is too big for the selected table.\n * * `\"TOO_SMALL\"`: The party is too small for the selected table.\n * * `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.\n */\n ignoreTableCombinationConflicts?: Array;\n /**\n * Reservation information to update.\n */\n reservation: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationUpdateReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Events.tableReservationsV1ReservationReservation;\n };\n type tableReservationsV1ReservationValueAggregation = {\n /**\n * options for including missing values\n */\n includeOptions?: Events.tableReservationsV1ReservationIncludeMissingValuesOptions;\n /**\n * How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.\n */\n limit?: number;\n /**\n * should missing values be included or excluded from the aggregation results. Default is EXCLUDE\n */\n missingValues?: string;\n /**\n * Supported values:\n * - `'ASC'`\n * - `'DESC'`\n */\n sortDirection?: string;\n /**\n * Supported values:\n * - `'COUNT'`\n * - `'VALUE'`\n */\n sortType?: string;\n };\n type tableReservationsV1ReservationValueAggregationOptionsOneOf = {\n /**\n * options for including missing values\n */\n includeOptions?: Events.tableReservationsV1ReservationIncludeMissingValuesOptions;\n };\n type tableReservationsV1ReservationValueAggregationResult = {\n count?: number;\n value?: string;\n };\n type tableReservationsV1ReservationValueResult = {\n count?: number;\n value?: string;\n };\n type tableReservationsV1ReservationValueResults = {\n results?: Array;\n };\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.html#)\n */\n namespace ReservationLocations {\n type ActionEvent = {\n bodyAsJson?: string;\n };\n type Address = {\n /**\n * City name.\n */\n city?: string;\n /**\n * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string;\n /**\n * Full address of the location.\n */\n formatted?: string;\n /**\n * Geographic coordinates of the location.\n */\n location?: ReservationLocations.AddressLocation;\n /**\n * Postal or zip code.\n */\n postalCode?: string;\n /**\n * Street address of the location. Includes street name, number, and apartment number in separate fields.\n */\n streetAddress?: ReservationLocations.StreetAddress;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string;\n };\n type AddressLocation = {\n /**\n * Latitude of the location. Must be between -90 and 90.\n */\n latitude?: number;\n /**\n * Longitude of the location. Must be between -180 and 180.\n */\n longitude?: number;\n };\n type App = {\n /**\n * The AppDefId\n */\n appDefId?: string;\n /**\n * The instance Id\n */\n instanceId?: string;\n };\n type Asset = {\n /**\n * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).\n */\n appDefId?: string;\n /**\n * An instance id. For legacy reasons may be UUID or a string.\n */\n instanceId?: string;\n /**\n * An application state.\n */\n state?: string;\n };\n type AssignedFromFloatingReason = {};\n type BooleanFeature = {};\n type BusinessSchedule = {\n periods?: Array;\n /**\n * Time periods during which this location is open. Each period represents a range of hours during the week during which the location is\n * open.\n *\n * Max: 100 time periods\n */\n specialHourPeriod?: Array;\n };\n type CancelRequestedReason = {};\n type CheckReservationLocationsCreatedRequest = {};\n type CheckReservationLocationsCreatedResponse = {\n /**\n * Reservation locations created.\n */\n created?: boolean;\n };\n type Configuration = {\n /**\n * \"My reservations\" field details.\n *\n * These are the fields that appear in the \"My reservations\" section of the Table Reservations page on the restaurant's Wix site dashboard.\n */\n myReservationsFields?: Array;\n /**\n * Settings for this location that are used to determine restaurant availability for reservations made online.\n */\n onlineReservations?: ReservationLocations.OnlineReservations;\n /**\n * Reservation form settings.\n */\n reservationForm?: ReservationLocations.ReservationForm;\n /**\n * Table management settings.\n */\n tableManagement?: ReservationLocations.TableManagement;\n };\n type ContractSwitchedReason = {};\n type CursorPaging = {\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string;\n /**\n * Number of items to load.\n */\n limit?: number;\n };\n type CursorPagingMetadata = {\n /**\n * Number of items returned in the response.\n */\n count?: number;\n /**\n * Offset that was requested.\n */\n cursors?: ReservationLocations.Cursors;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean;\n };\n type Cursors = {\n /**\n * Cursor pointing to next page in the list of results.\n */\n next?: string;\n /**\n * Cursor pointing to previous page in the list of results.\n */\n prev?: string;\n };\n type CustomFieldDefinition = {\n /**\n * Custom field ID.\n */\n _id?: string;\n /**\n * Custom field name.\n */\n name?: string;\n /**\n * Whether the custom field is required.\n *\n * Default: `false`\n */\n required?: boolean;\n };\n type DeleteContext = {\n /**\n * When the meta site was deleted.\n */\n dateDeleted?: Date;\n /**\n * A reason (flow).\n */\n deleteOrigin?: string;\n /**\n * A status.\n */\n deleteStatus?: string;\n /**\n * A service that deleted it.\n */\n initiatorId?: string;\n };\n type DeleteOrphanReservationLocationRequest = {\n /**\n * Id of the ReservationLocation.\n */\n reservationLocationId?: string;\n };\n type DeleteOrphanReservationLocationResponse = {};\n type DomainEvent = {\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n actionEvent?: ReservationLocations.ActionEvent;\n createdEvent?: ReservationLocations.EntityCreatedEvent;\n deletedEvent?: ReservationLocations.EntityDeletedEvent;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * ID of the entity associated with the event.\n */\n entityId?: string;\n /**\n * Event timestamp.\n */\n eventTime?: Date;\n /**\n * If present, indicates the action that triggered the event.\n */\n originatedFrom?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean;\n updatedEvent?: ReservationLocations.EntityUpdatedEvent;\n };\n type DomainEventBodyOneOf = {\n actionEvent?: ReservationLocations.ActionEvent;\n createdEvent?: ReservationLocations.EntityCreatedEvent;\n deletedEvent?: ReservationLocations.EntityDeletedEvent;\n updatedEvent?: ReservationLocations.EntityUpdatedEvent;\n };\n type EmailMarketingCheckbox = {\n /**\n * Whether the checkbox is checked by default.\n *\n * Default: `false`\n */\n checkedByDefault?: boolean;\n /**\n * Whether the checkbox is shown to the customer.\n *\n * Default: `false`\n */\n enabled?: boolean;\n };\n type Empty = {};\n type EntityCreatedEvent = {\n entityAsJson?: string;\n };\n type EntityDeletedEvent = {\n /**\n * Entity that was deleted\n */\n deletedEntityAsJson?: string;\n };\n type EntityUpdatedEvent = {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n };\n type Feature = {\n /**\n * ID of the feature. __Note:__ Isn't unique. For example, all features that\n * are available to free Wix accounts or site in some capacity have\n * `{\"id\": \"DEFAULT\"}`. Use `uniqueName` as unique identifier for a feature.\n */\n _id?: string;\n /**\n * Deprecated. Use `enabled` instead.\n */\n booleanFeature?: ReservationLocations.BooleanFeature;\n /**\n * Information about whether the feature belongs to a Wix account or site.\n * Account features have `context.userId`. Site features have `context.metaSiteId` in case\n * they're assigned to a specific site. Site features that aren't assigned to\n * a specific site have neither ID.\n */\n context?: ReservationLocations.FeatureContext;\n /**\n * Deprecated.\n */\n createdAt?: Date;\n /**\n * Whether the customer is currently allowed to use the feature.\n * `true` means that the customer can use the feature. This means a boolean\n * feature is active or a quota feature has remaining usage.\n * `false` means that the customer can't use the feature.\n * This means a boolean feature isn't active or a quota feature doesn't\n * have remaining usage.\n */\n enabled?: boolean;\n /**\n * Metadata of the feature. Wix Premium uses the metadata object to indicate\n * that customers who purchase a product with the feature also get\n * access to an additional product. For these bundled products `metadata`\n * looks like this: `{\"tpa\": \"{\"appDefId\": \"sample-app-def-id-1234567890\", \"vendorProductId\": \"sample-productId\"}}\"`.\n * But you can use the `metadata` property for other purposes, too.\n */\n metadata?: Record;\n /**\n * Deprecated. Use `quotaInfo` instead.\n */\n quotaFeature?: ReservationLocations.QuotaFeature;\n /**\n * Information about how often customers can use the feature during a specific\n * period. Available only for quota features.\n */\n quotaInfo?: ReservationLocations.QuotaInfo;\n /**\n * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)\n * to which the feature instance belongs.\n */\n subscriptionId?: string;\n /**\n * Unique name of the feature. Only lower case letters, numbers, and dashes\n * `-` are supported. Used in the endpoints of the\n * [Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)\n * to specify the feature. Not visible to customers. We recommend to start\n * the unique name with a prefix describing your organization or Wix company.\n * For example, `bookings` or `crm`.\n *\n * Min: 2 characters\n * Max: 50 characters\n */\n uniqueName?: string;\n /**\n * Deprecated.\n */\n updatedAt?: Date;\n };\n type FeatureCancelled = {\n /**\n * Information about the feature cancellation.\n */\n cancelRequest?: ReservationLocations.CancelRequestedReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: ReservationLocations.ContractSwitchedReason;\n /**\n * Canceled feature.\n */\n feature?: ReservationLocations.Feature;\n /**\n * Information about a transfer to the account.\n * __Deprecated__. Use `reason.transferred_to_account` instead.\n */\n transferredToAccount?: string;\n /**\n * Information about a transfer to the account.\n */\n transferredToAnotherAccount?: ReservationLocations.TransferredToAnotherAccountReason;\n };\n type FeatureCancelledReasonOneOf = {\n /**\n * Information about the feature cancellation.\n */\n cancelRequest?: ReservationLocations.CancelRequestedReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: ReservationLocations.ContractSwitchedReason;\n /**\n * Information about a transfer to the account.\n */\n transferredToAnotherAccount?: ReservationLocations.TransferredToAnotherAccountReason;\n };\n type FeatureContext = {\n /**\n * ID of the meta site that the feature instance is assigned to.\n * Only available for site level feature instances that are assigned to a Wix\n * site. Not available for account level and unassigned site level feature\n * instances.\n */\n metaSiteId?: string;\n /**\n * ID of the Wix account that the feature instance belongs to.\n * Available for both site and account level feature instances.\n */\n userId?: string;\n };\n type FeatureDisabled = {\n /**\n * Disabled feature. Includes information about the feature's new state,\n * possibly its new context.\n */\n feature?: ReservationLocations.Feature;\n /**\n * ID of the meta site for which the feature has been disabled.\n */\n metaSiteId?: string;\n /**\n * Information about a feature that's been reassigned to a different\n * site.\n */\n reassignedToAnotherSite?: ReservationLocations.ReassignedToAnotherSiteReason;\n /**\n * Information about a feature that's been replaced by a feature from a\n * different subscription.\n */\n replacedByAnotherSubscription?: ReservationLocations.ReplacedByAnotherSubscriptionReason;\n /**\n * Information about a feature that's no longer assigned to a site.\n */\n unassingedToFloating?: ReservationLocations.UnAssingedToFloatingReason;\n };\n type FeatureDisabledReasonOneOf = {\n /**\n * Information about a feature that's been reassigned to a different\n * site.\n */\n reassignedToAnotherSite?: ReservationLocations.ReassignedToAnotherSiteReason;\n /**\n * Information about a feature that's been replaced by a feature from a\n * different subscription.\n */\n replacedByAnotherSubscription?: ReservationLocations.ReplacedByAnotherSubscriptionReason;\n /**\n * Information about a feature that's no longer assigned to a site.\n */\n unassingedToFloating?: ReservationLocations.UnAssingedToFloatingReason;\n };\n type FeatureEnabled = {\n /**\n * Information about a feature that hadn't been assigned to site.\n */\n assignedFromFloating?: ReservationLocations.AssignedFromFloatingReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: ReservationLocations.ContractSwitchedReason;\n /**\n * Enabled feature.\n */\n feature?: ReservationLocations.Feature;\n /**\n * Information about the manually created features.\n */\n manualFeatureCreation?: ReservationLocations.ManualFeatureCreationReason;\n /**\n * Information about a feature that was migrated from legacy.\n */\n migratedFromLegacy?: ReservationLocations.MigratedFromLegacyReason;\n /**\n * Information about the new feature.\n */\n newFeature?: ReservationLocations.NewFeatureReason;\n /**\n * Information about a transfer from another site.\n * __Deprecated__. Use `reason.reassigned_from_site` instead.\n */\n reassignedFromMetasite?: string;\n /**\n * Information about a transfer from another site.\n */\n reassignedFromSite?: ReservationLocations.ReassignedFromSiteReason;\n /**\n * Information about a transfer from another account.\n * __Deprecated__. Use `reason.transferred_from_another_account` instead.\n */\n transferredFromAccount?: string;\n /**\n * Information about a transfer from another account.\n */\n transferredFromAnotherAccount?: ReservationLocations.TransferredFromAnotherAccountReason;\n };\n type FeatureEnabledReasonOneOf = {\n /**\n * Information about a feature that hadn't been assigned to site.\n */\n assignedFromFloating?: ReservationLocations.AssignedFromFloatingReason;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: ReservationLocations.ContractSwitchedReason;\n /**\n * Information about the manually created features.\n */\n manualFeatureCreation?: ReservationLocations.ManualFeatureCreationReason;\n /**\n * Information about a feature that was migrated from legacy.\n */\n migratedFromLegacy?: ReservationLocations.MigratedFromLegacyReason;\n /**\n * Information about the new feature.\n */\n newFeature?: ReservationLocations.NewFeatureReason;\n /**\n * Information about a transfer from another site.\n */\n reassignedFromSite?: ReservationLocations.ReassignedFromSiteReason;\n /**\n * Information about a transfer from another account.\n */\n transferredFromAnotherAccount?: ReservationLocations.TransferredFromAnotherAccountReason;\n };\n type FeatureEvent = {\n /**\n * Information about an event that cancels a feature for the user.\n * Triggered for example, when a feature is canceled, transferred to\n * another account, or the user switched to a different contract.\n */\n cancelled?: ReservationLocations.FeatureCancelled;\n /**\n * Information about an event that disables a feature for the user.\n * Triggered for example, when a feature is unassigned from a site,\n * reassigned to a different site, or the user switched to a different contract.\n */\n disabled?: ReservationLocations.FeatureDisabled;\n /**\n * Information about an event that makes a feature eligible to the user.\n * Triggered for example, for new features or when a feature is reassigned\n * to an account or a site.\n */\n enabled?: ReservationLocations.FeatureEnabled;\n /**\n * Timestamp of the event in\n * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n */\n timestamp?: Date;\n /**\n * Information about an event that updates a feature. An `updated` event\n * is triggered for example by the\n * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\n * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\n * endpoints.\n */\n updated?: ReservationLocations.FeatureUpdated;\n };\n type FeatureEventEventOneOf = {\n /**\n * Information about an event that cancels a feature for the user.\n * Triggered for example, when a feature is canceled, transferred to\n * another account, or the user switched to a different contract.\n */\n cancelled?: ReservationLocations.FeatureCancelled;\n /**\n * Information about an event that disables a feature for the user.\n * Triggered for example, when a feature is unassigned from a site,\n * reassigned to a different site, or the user switched to a different contract.\n */\n disabled?: ReservationLocations.FeatureDisabled;\n /**\n * Information about an event that makes a feature eligible to the user.\n * Triggered for example, for new features or when a feature is reassigned\n * to an account or a site.\n */\n enabled?: ReservationLocations.FeatureEnabled;\n /**\n * Information about an event that updates a feature. An `updated` event\n * is triggered for example by the\n * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\n * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\n * endpoints.\n */\n updated?: ReservationLocations.FeatureUpdated;\n };\n type FeatureQuantityInfoOneOf = {\n /**\n * Deprecated. Use `enabled` instead.\n */\n booleanFeature?: ReservationLocations.BooleanFeature;\n /**\n * Deprecated. Use `quotaInfo` instead.\n */\n quotaFeature?: ReservationLocations.QuotaFeature;\n };\n type FeatureUpdated = {\n /**\n * Information about a feature that doesn't have a usage quota.\n */\n booleanFeature?: ReservationLocations.BooleanFeature;\n /**\n * Information about the contract switch.\n */\n contractSwitched?: ReservationLocations.ContractSwitchedReason;\n /**\n * Updated feature. Includes information about the feature's new state and\n * possibly its new context.\n */\n feature?: ReservationLocations.Feature;\n /**\n * Information about a feature that has a usage quota.\n */\n quotaFeature?: ReservationLocations.QuotaFeature;\n };\n type FeatureUpdatedPreviousQuantityInfoOneOf = {\n /**\n * Information about a feature that doesn't have a usage quota.\n */\n booleanFeature?: ReservationLocations.BooleanFeature;\n /**\n * Information about a feature that has a usage quota.\n */\n quotaFeature?: ReservationLocations.QuotaFeature;\n };\n type FeatureUpdatedReasonOneOf = {\n /**\n * Information about the contract switch.\n */\n contractSwitched?: ReservationLocations.ContractSwitchedReason;\n };\n type GetReservationLocationOptions = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n };\n type GetReservationLocationRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * ID of the ReservationLocation to retrieve.\n */\n reservationLocationId: string;\n };\n type GetReservationLocationResponse = {\n /**\n * The retrieved reservation location.\n */\n reservationLocation?: ReservationLocations.ReservationLocation;\n };\n type InvalidateCache = {\n /**\n * Invalidate by App\n */\n app?: ReservationLocations.App;\n /**\n * Is local DS\n */\n localDc?: boolean;\n /**\n * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!\n */\n metaSiteId?: string;\n /**\n * Invalidate by page id\n */\n page?: ReservationLocations.Page;\n /**\n * tell us why you're invalidating the cache. You don't need to add your app name\n */\n reason?: string;\n /**\n * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!\n */\n siteId?: string;\n /**\n * Invalidate by URI path\n */\n uri?: ReservationLocations.URI;\n };\n type InvalidateCacheGetByOneOf = {\n /**\n * Invalidate by App\n */\n app?: ReservationLocations.App;\n /**\n * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!\n */\n metaSiteId?: string;\n /**\n * Invalidate by page id\n */\n page?: ReservationLocations.Page;\n /**\n * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!\n */\n siteId?: string;\n /**\n * Invalidate by URI path\n */\n uri?: ReservationLocations.URI;\n };\n type ListReservationLocationsOptions = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n paging?: ReservationLocations.CursorPaging;\n /**\n * Sorting for the locations list.\n */\n sort?: ReservationLocations.Sorting;\n };\n type ListReservationLocationsRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n paging?: ReservationLocations.CursorPaging;\n /**\n * Sorting for the locations list.\n */\n sort?: ReservationLocations.Sorting;\n };\n type ListReservationLocationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: ReservationLocations.CursorPagingMetadata;\n /**\n * Locations list.\n */\n reservationLocations?: Array;\n };\n type Location = {\n /**\n * Location ID.\n */\n _id?: string;\n };\n type ManualApproval = {\n /**\n * Custom approvals provider id.\n */\n customApprovalsProviderId?: string;\n /**\n * Whether manual approval is required for online reservations.\n */\n enabled?: boolean;\n /**\n * The minimum party size that requires manual approval.\n */\n partySizeThreshold?: number;\n };\n type ManualApprovalValueOneOf = {\n /**\n * Custom approvals provider id.\n */\n customApprovalsProviderId?: string;\n /**\n * The minimum party size that requires manual approval.\n */\n partySizeThreshold?: number;\n };\n type ManualFeatureCreationReason = {};\n type MetaSiteSpecialEvent = {\n /**\n * A list of \"assets\" (applications). The same as MetaSiteContext.\n */\n assets?: Array;\n /**\n * Emitted when meta site was permanently deleted.\n */\n hardDeleted?: ReservationLocations.SiteHardDeleted;\n /**\n * A meta site id.\n */\n metaSiteId?: string;\n /**\n * Emitted on a namespace change.\n */\n namespaceChanged?: ReservationLocations.NamespaceChanged;\n /**\n * Emitted when an application is provisioned (installed).\n */\n serviceProvisioned?: ReservationLocations.ServiceProvisioned;\n /**\n * Emitted when an application is removed (uninstalled).\n */\n serviceRemoved?: ReservationLocations.ServiceRemoved;\n /**\n * Emitted on a meta site creation.\n */\n siteCreated?: ReservationLocations.SiteCreated;\n /**\n * Emitted on a meta site deletion.\n */\n siteDeleted?: ReservationLocations.SiteDeleted;\n /**\n * Emitted when meta site is marked as template.\n */\n siteMarkedAsTemplate?: ReservationLocations.SiteMarkedAsTemplate;\n /**\n * Emitted when meta site is marked as a WixSite.\n */\n siteMarkedAsWixSite?: ReservationLocations.SiteMarkedAsWixSite;\n /**\n * Emitted on the first* publish of the meta site (* switching from unpublished to published state).\n */\n sitePublished?: ReservationLocations.SitePublished;\n /**\n * Emitted when meta site name (URL slug) is changed.\n */\n siteRenamedPayload?: ReservationLocations.SiteRenamed;\n /**\n * Emitted on a meta site transfer completion.\n */\n siteTransferred?: ReservationLocations.SiteTransferred;\n /**\n * Emitted on a meta site restoration.\n */\n siteUndeleted?: ReservationLocations.SiteUndeleted;\n /**\n * Emitted on a meta site unpublish.\n */\n siteUnpublished?: ReservationLocations.SiteUnpublished;\n /**\n * Emitted when Studio is attached.\n */\n studioAssigned?: ReservationLocations.StudioAssigned;\n /**\n * Emitted when Studio is detached.\n */\n studioUnassigned?: ReservationLocations.StudioUnassigned;\n /**\n * A timestamp of the event.\n */\n timestamp?: string;\n /**\n * A meta site version. Monotonically increasing.\n */\n version?: string;\n };\n type MetaSiteSpecialEventPayloadOneOf = {\n /**\n * Emitted when meta site was permanently deleted.\n */\n hardDeleted?: ReservationLocations.SiteHardDeleted;\n /**\n * Emitted on a namespace change.\n */\n namespaceChanged?: ReservationLocations.NamespaceChanged;\n /**\n * Emitted when an application is provisioned (installed).\n */\n serviceProvisioned?: ReservationLocations.ServiceProvisioned;\n /**\n * Emitted when an application is removed (uninstalled).\n */\n serviceRemoved?: ReservationLocations.ServiceRemoved;\n /**\n * Emitted on a meta site creation.\n */\n siteCreated?: ReservationLocations.SiteCreated;\n /**\n * Emitted on a meta site deletion.\n */\n siteDeleted?: ReservationLocations.SiteDeleted;\n /**\n * Emitted when meta site is marked as template.\n */\n siteMarkedAsTemplate?: ReservationLocations.SiteMarkedAsTemplate;\n /**\n * Emitted when meta site is marked as a WixSite.\n */\n siteMarkedAsWixSite?: ReservationLocations.SiteMarkedAsWixSite;\n /**\n * Emitted on the first* publish of the meta site (* switching from unpublished to published state).\n */\n sitePublished?: ReservationLocations.SitePublished;\n /**\n * Emitted when meta site name (URL slug) is changed.\n */\n siteRenamedPayload?: ReservationLocations.SiteRenamed;\n /**\n * Emitted on a meta site transfer completion.\n */\n siteTransferred?: ReservationLocations.SiteTransferred;\n /**\n * Emitted on a meta site restoration.\n */\n siteUndeleted?: ReservationLocations.SiteUndeleted;\n /**\n * Emitted on a meta site unpublish.\n */\n siteUnpublished?: ReservationLocations.SiteUnpublished;\n /**\n * Emitted when Studio is attached.\n */\n studioAssigned?: ReservationLocations.StudioAssigned;\n /**\n * Emitted when Studio is detached.\n */\n studioUnassigned?: ReservationLocations.StudioUnassigned;\n };\n type MigrateOldRestaurantSettingsRequest = {\n /**\n * Mode.\n */\n mode?: string;\n /**\n * Override not default.\n */\n overrideNotDefault?: boolean;\n };\n type MigrateOldRestaurantSettingsResponse = {\n /**\n * Migration results.\n */\n migrationResults?: Array;\n };\n type MigratedFromLegacyReason = {};\n type MigrationParsingError = {\n /**\n * Message.\n */\n message?: string;\n /**\n * Field.\n */\n path?: string;\n /**\n * Target.\n */\n target?: Object;\n };\n type MigrationResult = {\n /**\n * Migration parsing errors.\n */\n migrationParsingErrors?: Array;\n /**\n * Old settings.\n */\n oldSettings?: Object;\n /**\n * Parsed settings.\n */\n parsedSettings?: ReservationLocations.ParsedSettings;\n /**\n * The migrated ReservationLocation.\n */\n reservationLocation?: ReservationLocations.ReservationLocation;\n };\n type MyReservationsField = {\n /**\n * Custom field ID.\n *\n * This should only be provided if the `fieldType` is `CUSTOM_FIELD`, in which case it is required and must match the ID of a custom field in the `customFieldDefinitions` array of the `reservationForm`.\n */\n customFieldId?: string;\n /**\n * Field type.\n */\n fieldType?: string;\n /**\n * Whether the field is shown.\n */\n shown?: boolean;\n };\n type NamespaceChanged = {\n /**\n * A new namespace.\n */\n newNamespace?: string;\n /**\n * A previous namespace.\n */\n oldNamespace?: string;\n };\n type NewFeatureReason = {};\n type NoticePeriod = {\n /**\n * The quantity of the chosen time unit.\n */\n number?: number;\n /**\n * Time unit.\n *\n * Supported values:\n * 'UNKNOWN', 'MINUTES, 'HOURS', 'DAYS'.\n */\n unit?: string;\n };\n type OldCustomField = {\n label?: string;\n required?: boolean;\n };\n type OldInstant = {\n day?: number;\n hour?: number;\n minute?: number;\n month?: number;\n year?: number;\n };\n type OldPolicy = {\n isPlainText?: boolean;\n value?: string;\n };\n type OldScheduleException = {\n available?: boolean;\n comment?: string;\n end?: ReservationLocations.OldInstant;\n start?: ReservationLocations.OldInstant;\n };\n type OldScheduleInterval = {\n durationMins?: number;\n minuteOfWeek?: number;\n };\n type OldTerms = {\n isPlainText?: boolean;\n value?: string;\n };\n type OnlineReservations = {\n /**\n * The location's business schedule.\n *\n * By default, the business schedule of a reservation location uses the values of its location's business schedule. However, after the first time a reservation location's business schedule has been modified, it stores and uses its own values and no longer mirrors its location's business schedule.\n * Limited to 100 time periods.\n */\n businessSchedule?: ReservationLocations.BusinessSchedule;\n /**\n * Default turnover time in minutes.\n *\n * Turnover time is how much time a party is allotted for their entire reservation - from being seated to leaving the restaurant.\n */\n defaultTurnoverTime?: number;\n /**\n * Manual approval settings.\n */\n manualApproval?: ReservationLocations.ManualApproval;\n /**\n * Minimum reservation notice.\n *\n * The minimum amount of time that must be allowed between making a reservation and that reservation's start time.\n */\n minimumReservationNotice?: ReservationLocations.NoticePeriod;\n /**\n * Whether online reservations are enabled.\n */\n onlineReservationsEnabled?: boolean;\n /**\n * Party pacing settings.\n *\n * The maximum number of party reservations that can start within a 15-minute period.\n * For example, a party pacing of 5 would mean that no more than 5 parties could make a reservation for the period between `10:00.000`-`10:14.999`.\n */\n partyPacing?: ReservationLocations.PartyPacing;\n /**\n * Party size limits for a reservation.\n */\n partySize?: ReservationLocations.PartySize;\n /**\n * Seat pacing settings.\n *\n * The maximum number of seats that can be filled by new reservations within a 15-minute period.\n * For example, setting a seat pacing of 15 would mean that between `10:00.000`-`10:14.999` there will be no more than 15 new seats available for reservation.\n */\n seatPacing?: ReservationLocations.SeatPacing;\n /**\n * Whether a phone number is shown.\n */\n showPhoneNumber?: boolean;\n /**\n * Custom turnover time rules.\n *\n * This allows you to set different turnover times for different party sizes.\n */\n turnoverTimeRules?: Array;\n };\n type Page = {\n /**\n * the msid the page is on\n */\n metaSiteId?: string;\n /**\n * Invalidate by Page ID\n */\n pageId?: string;\n };\n type Paging = {\n /**\n * Number of items to load.\n */\n limit?: number;\n /**\n * Number of items to skip in the current sort order.\n */\n offset?: number;\n };\n type PagingMetadataV2 = {\n /**\n * Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.\n */\n cursors?: ReservationLocations.Cursors;\n /**\n * Offset that was requested.\n */\n offset?: number;\n };\n type ParsedSettings = {\n available?: boolean;\n customFields?: Array;\n futureDelayMins?: number;\n locale?: string;\n partySizeMax?: number;\n partySizeMin?: number;\n privacyPolicy?: ReservationLocations.OldPolicy;\n scheduleExceptions?: Array;\n termsAndConditions?: ReservationLocations.OldTerms;\n weeklySchedule?: Array;\n };\n type PartiesSize = {\n /**\n * Maximum number of seats a party can reserve.\n */\n max?: number;\n /**\n * Minimum number of seats a party can reserve.\n */\n min?: number;\n };\n type PartyPacing = {\n /**\n * Whether this option is enabled.\n */\n enabled?: boolean;\n /**\n * Maximum number of new party reservations that can be made every 15 minutes.\n */\n number?: number;\n };\n type PartySize = {\n /**\n * Maximum number of seats a party can reserve.\n */\n max?: number;\n /**\n * Minimum number of seats a party can reserve.\n */\n min?: number;\n };\n type PrivacyPolicy = {\n /**\n * Whether the privacy policy is shown to the customer.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Privacy policy text.\n */\n text?: string;\n /**\n * Privacy policy URL.\n */\n url?: string;\n };\n type PrivacyPolicyValueOneOf = {\n /**\n * Privacy policy text.\n */\n text?: string;\n /**\n * Privacy policy URL.\n */\n url?: string;\n };\n type QueryReservationLocationsOptions = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n };\n type QueryReservationLocationsRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,\n * `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,\n * `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,\n * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.\n * - `FULL`: Returns all fields.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Array;\n /**\n * Query options.\n */\n query: ReservationLocations.QueryV2;\n };\n type QueryReservationLocationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: ReservationLocations.PagingMetadataV2;\n /**\n * List of reservation locations\n */\n reservationLocations?: Array;\n };\n type QueryV2 = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: ReservationLocations.CursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-and-filtering) article.\n * To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n */\n filter?: Object;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: ReservationLocations.Paging;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Array;\n };\n type QueryV2PagingMethodOneOf = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: ReservationLocations.CursorPaging;\n /**\n * Paging options to limit and skip the number of items.\n */\n paging?: ReservationLocations.Paging;\n };\n type QuotaFeature = {\n /**\n * Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount.\n */\n limit?: string;\n /**\n * Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset.\n */\n period?: string;\n /**\n * Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit.\n */\n units?: string;\n };\n type QuotaInfo = {\n /**\n * How often the customer has used the feature during the current\n * period.\n */\n currentUsage?: string;\n /**\n * How often the customer is allowed to use the feature during the specified\n * period. `null` means that the customer has unlimited access to the feature.\n */\n limit?: string;\n /**\n * Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`\n * isn't automatically reset to the feature's `limit` after a specific period.\n * You may still manually call\n * [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).\n */\n period?: string;\n /**\n * How often the customer can still use the feature during the current\n * period. `null` means that the customer has unlimited access to the feature.\n */\n remainingUsage?: string;\n };\n type ReassignedFromSiteReason = {\n /**\n * Information about a transfer from another site.\n */\n reassignedFromMetasite?: string;\n };\n type ReassignedToAnotherSiteReason = {\n /**\n * Information about a transfer to the site.\n */\n reassignedToMetasite?: string;\n };\n type ReplacedByAnotherSubscriptionReason = {};\n type ReservationForm = {\n /**\n * Custom fields you wish to add to the registration form for the customer to fill in.\n */\n customFieldDefinitions?: Array;\n /**\n * Email marketing checkbox settings.\n */\n emailMarketingCheckbox?: ReservationLocations.EmailMarketingCheckbox;\n /**\n * Whether an email is required in the reservation form.\n *\n * Default: `false`\n */\n emailRequired?: boolean;\n /**\n * Whether a last_name is required in the reservation form.\n *\n * Default: `false`\n */\n lastNameRequired?: boolean;\n /**\n * Whether to show policies (the terms and conditions, and the privacy policy) to the customer.\n */\n policiesEnabled?: boolean;\n /**\n * Settings for displaying the privacy policy.\n */\n privacyPolicy?: ReservationLocations.PrivacyPolicy;\n /**\n * A message shown to the customer in the registration form.\n */\n submitMessage?: string;\n /**\n * Settings for displaying the terms and conditions.\n */\n termsAndConditions?: ReservationLocations.TermsAndConditions;\n };\n type ReservationLocation = {\n /**\n * The date and time this reservation location was created.\n */\n _createdDate?: Date;\n /**\n * Reservation location ID.\n */\n _id?: string;\n /**\n * The date and time this reservation location was last updated.\n */\n _updatedDate?: Date;\n /**\n * Whether this reservation location's `location` is archived.\n */\n archived?: boolean;\n /**\n * Reservation location configuration.\n */\n configuration?: ReservationLocations.Configuration;\n /**\n * Whether this reservation location's `location` is the default location of the business.\n */\n default?: boolean;\n /**\n * Physical location details.\n *\n * Locations can be created and configured using the [Locations API](https://dev.wix.com/docs/rest/api-reference/business-info/locations/introduction)\n * or on the [Business Info](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsettings/business-info) page in the Dashboard.\n */\n location?: ReservationLocations.Location;\n /**\n * Represents the current state of a reservation location. Each time the reservation location is modified, its `revision` changes. For an update operation to succeed, you must pass the latest revision.\n */\n revision?: string;\n };\n type SeatPacing = {\n /**\n * Whether this option is enabled.\n */\n enabled?: boolean;\n /**\n * Maximum number of seats that can be reserved every 15 minutes.\n */\n number?: number;\n };\n type ServiceProvisioned = {\n /**\n * Either UUID or EmbeddedServiceType.\n */\n appDefId?: string;\n /**\n * Not only UUID. Something here could be something weird.\n */\n instanceId?: string;\n /**\n * An instance id from which this instance is originated.\n */\n originInstanceId?: string;\n /**\n * A version.\n */\n version?: string;\n };\n type ServiceRemoved = {\n /**\n * Either UUID or EmbeddedServiceType.\n */\n appDefId?: string;\n /**\n * Not only UUID. Something here could be something weird.\n */\n instanceId?: string;\n /**\n * A version.\n */\n version?: string;\n };\n type SiteCreated = {\n /**\n * A context in which meta site was created.\n */\n context?: string;\n /**\n * A namespace.\n */\n namespace?: string;\n /**\n * A meta site id from which this site was created.\n *\n * In case of a creation from a template it's a template id.\n * In case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.\n */\n originMetaSiteId?: string;\n /**\n * A template identifier (empty if not created from a template).\n */\n originTemplateId?: string;\n /**\n * An account id of the owner.\n */\n ownerId?: string;\n /**\n * A meta site name (URL slug).\n */\n siteName?: string;\n };\n type SiteDeleted = {\n /**\n * A deletion context.\n */\n deleteContext?: ReservationLocations.DeleteContext;\n };\n type SiteHardDeleted = {\n /**\n * A deletion context.\n */\n deleteContext?: ReservationLocations.DeleteContext;\n };\n type SiteMarkedAsTemplate = {};\n type SiteMarkedAsWixSite = {};\n type SitePublished = {};\n type SiteRenamed = {\n /**\n * A new meta site name (URL slug).\n */\n newSiteName?: string;\n /**\n * A previous meta site name (URL slug).\n */\n oldSiteName?: string;\n };\n type SiteTransferred = {\n /**\n * A new owner id (user that accepts meta site).\n */\n newOwnerId?: string;\n /**\n * A previous owner id (user that transfers meta site).\n */\n oldOwnerId?: string;\n };\n type SiteUndeleted = {};\n type SiteUnpublished = {\n /**\n * A list of URLs previously associated with the meta site.\n */\n urls?: Array;\n };\n type Sorting = {\n /**\n * Name of the field to sort by.\n */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.\n */\n order?: string;\n };\n type SpecialHourPeriod = {\n /**\n * Additional details about the period.\n */\n comment?: string;\n /**\n * End date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n */\n endDate?: string;\n /**\n * Whether or not the location is closed during this period.\n */\n isClosed?: boolean;\n /**\n * Start date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n */\n startDate?: string;\n };\n type StreetAddress = {\n /**\n * Apartment number.\n */\n apt?: string;\n /**\n * Street name.\n */\n name?: string;\n /**\n * Street number.\n */\n number?: string;\n };\n type StudioAssigned = {};\n type StudioUnassigned = {};\n type TableCombination = {\n /**\n * Table combination ID.\n */\n _id?: string;\n /**\n * Whether the table combination is active (available to be reserved).\n */\n isActive?: boolean;\n /**\n * Maximum number of seats that can be reserved in this table combination.\n */\n seatsMax?: number;\n /**\n * Minimum number of seats that can be reserved in this table combination.\n */\n seatsMin?: number;\n /**\n * IDs of tables in the combination.\n */\n tableIds?: Array;\n };\n type TableDefinition = {\n /**\n * Table ID.\n */\n _id?: string;\n /**\n * Whether the table is active (available to be reserved).\n */\n isActive?: boolean;\n /**\n * Table name.\n */\n name?: string;\n /**\n * Maximum number of seats.\n */\n seatsMax?: number;\n /**\n * Minimum number of seats.\n */\n seatsMin?: number;\n };\n type TableManagement = {\n /**\n * Deleted table definitions.\n */\n deletedTableDefinitions?: Array;\n /**\n * Table combinations.\n */\n tableCombinations?: Array;\n /**\n * Table definitions.\n */\n tableDefinitions?: Array;\n };\n type TablesDeleted = {\n /**\n * ID of the affected reservation location.\n */\n reservationLocationId?: string;\n /**\n * IDs of deleted tables.\n */\n tableIds?: Array;\n };\n type TermsAndConditions = {\n /**\n * Whether the terms and conditions are shown to the customer.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Terms and conditions text.\n */\n text?: string;\n /**\n * Terms and conditions URL.\n */\n url?: string;\n };\n type TermsAndConditionsValueOneOf = {\n /**\n * Terms and conditions text.\n */\n text?: string;\n /**\n * Terms and conditions URL.\n */\n url?: string;\n };\n type TimePeriod = {\n /**\n * Day of the week this period ends on.\n */\n closeDay?: string;\n /**\n * Time this period ends in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents\n * midnight at the end of the specified day field.\n *\n * This is the last time a reservation can be made at the restaurant, not the time the restaurant closes its doors.\n */\n closeTime?: string;\n /**\n * Day of the week this period starts on.\n */\n openDay?: string;\n /**\n * Time this period starts in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents\n * midnight at the end of the specified day field.\n */\n openTime?: string;\n };\n type TransferredFromAnotherAccountReason = {\n /**\n * Information about a transfer from another account.\n */\n transferredFromAccount?: string;\n };\n type TransferredToAnotherAccountReason = {\n /**\n * Information about a transfer to the account.\n */\n transferredToAccount?: string;\n };\n type TurnoverRule = {\n /**\n * Maximum number of seats to qualify for this rule.\n */\n maxSeats?: number;\n /**\n * Minimum number of seats to qualify for this rule.\n */\n minSeats?: number;\n /**\n * Turnover time in minutes for qualifying parties.\n */\n minutes?: number;\n };\n type TurnoverTimeRule = {\n /**\n * Turnover time in minutes for qualifying parties.\n */\n minutes?: number;\n /**\n * Maximum number of seats to qualify for this rule.\n */\n seatsMax?: number;\n /**\n * Minimum number of seats to qualify for this rule.\n */\n seatsMin?: number;\n };\n type URI = {\n /**\n * the msid the URI is on\n */\n metaSiteId?: string;\n /**\n * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes\n */\n uriPath?: string;\n };\n type UnAssingedToFloatingReason = {};\n type UpdateReservationLocation = {\n /**\n * The date and time this reservation location was created.\n */\n _createdDate?: Date;\n /**\n * Reservation location ID.\n */\n _id?: string;\n /**\n * The date and time this reservation location was last updated.\n */\n _updatedDate?: Date;\n /**\n * Whether this reservation location's `location` is archived.\n */\n archived?: boolean;\n /**\n * Reservation location configuration.\n */\n configuration?: ReservationLocations.Configuration;\n /**\n * Whether this reservation location's `location` is the default location of the business.\n */\n default?: boolean;\n /**\n * Physical location details.\n *\n * Locations can be created and configured using the [Locations API](https://dev.wix.com/docs/rest/api-reference/business-info/locations/introduction)\n * or on the [Business Info](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsettings/business-info) page in the Dashboard.\n */\n location?: ReservationLocations.Location;\n /**\n * Represents the current state of a reservation location. Each time the reservation location is modified, its `revision` changes. For an update operation to succeed, you must pass the latest revision.\n */\n revision?: string;\n };\n type UpdateReservationLocationOptions = {};\n type UpdateReservationLocationRequest = {\n /**\n * ReservationLocation to be updated, may be partial.\n */\n reservationLocation: ReservationLocations.ReservationLocation;\n };\n type UpdateReservationLocationResponse = {\n /**\n * The updated reservation location.\n */\n reservationLocation?: ReservationLocations.ReservationLocation;\n };\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#)\n */\n interface ReservationLocationsQueryBuilder {\n /**\n * Refines a query to match items where the specified property equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): ReservationLocations.ReservationLocationsQueryBuilder;\n /**\n * Returns the query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#find)\n */\n find(): Promise;\n /**\n * Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#in)\n */\n in(propertyName: string, value: any): ReservationLocations.ReservationLocationsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#limit)\n */\n limit(limit: number): ReservationLocations.ReservationLocationsQueryBuilder;\n /**\n * Refines a query to match items where the specified property doesn't equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): ReservationLocations.ReservationLocationsQueryBuilder;\n /**\n * Refines a query that skips to a specific record.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#skipTo)\n */\n skipTo(cursor: string): ReservationLocations.ReservationLocationsQueryBuilder;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#)\n */\n interface ReservationLocationsQueryResult {\n /**\n * Returns the query cursors.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#cursors)\n */\n cursors: ReservationLocations.Cursors;\n /**\n * Returns an array of `reservationLocations` items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#items)\n */\n items: Array;\n /**\n * Returns the number of items in the current page of results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#length)\n */\n length: number;\n /**\n * Returns the requested page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#pageSize)\n */\n pageSize: number;\n /**\n * Returns the `ReservationLocationsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#query)\n */\n query: ReservationLocations.ReservationLocationsQueryBuilder;\n /**\n * Indicates whether the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates whether the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryBuilder.html#)\n */\n namespace ReservationLocationsQueryBuilder {\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.ReservationLocations.ReservationLocationsQueryResult.html#)\n */\n namespace ReservationLocationsQueryResult {\n }\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.html#)\n */\n namespace Reservations {\n type ActionEvent = {\n bodyAsJson?: string;\n };\n type Aggregation = {\n dateHistogram?: Reservations.DateHistogramAggregation;\n fieldPath?: string;\n groupBy?: Reservations.GroupByAggregation;\n name?: string;\n nested?: Reservations.NestedAggregation;\n range?: Reservations.RangeAggregation;\n scalar?: Reservations.ScalarAggregation;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'NESTED'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n value?: Reservations.ValueAggregation;\n };\n type AggregationData = {\n /**\n * key = aggregation name (as derived from search request)\n */\n results?: Array;\n };\n type AggregationKindOneOf = {\n dateHistogram?: Reservations.DateHistogramAggregation;\n nested?: Reservations.NestedAggregation;\n range?: Reservations.RangeAggregation;\n scalar?: Reservations.ScalarAggregation;\n value?: Reservations.ValueAggregation;\n };\n type AggregationResults = {\n dateHistogram?: Reservations.DateHistogramResults;\n fieldPath?: string;\n groupedByValue?: Reservations.GroupByValueResults;\n name?: string;\n nested?: Reservations.NestedResults;\n ranges?: Reservations.RangeResults;\n scalar?: Reservations.ScalarResult;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'NESTED'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n values?: Reservations.ValueResults;\n };\n type AggregationResultsResultOneOf = {\n dateHistogram?: Reservations.DateHistogramResults;\n groupedByValue?: Reservations.GroupByValueResults;\n nested?: Reservations.NestedResults;\n ranges?: Reservations.RangeResults;\n scalar?: Reservations.ScalarResult;\n values?: Reservations.ValueResults;\n };\n type CancelReservationOptions = {\n /**\n * The phone number that was provided when the reservation was created.\n *\n * This is required for reservations with any `source` other than `WALK_IN`.\n *\n * This requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.\n */\n phone?: string;\n };\n type CancelReservationRequest = {\n /**\n * The phone number that was provided when the reservation was created.\n *\n * This is required for reservations with any `source` other than `WALK_IN`.\n *\n * This requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.\n */\n phone?: string;\n /**\n * Reservation ID.\n */\n reservationId: string;\n /**\n * Revision number.\n *\n * Include the existing `revision` to prevent conflicting updates to reservations.\n */\n revision: string;\n };\n type CancelReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type CreateHeldReservationRequest = {\n /**\n * Held reservation information to update.\n */\n reservationDetails: Reservations.HeldReservationDetails;\n };\n type CreateHeldReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type CreateReservationOptions = {\n /**\n * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n * * `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.\n */\n ignoreReservationLocationConflicts?: Array;\n /**\n * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n * * `\"TOO_BIG\"`: The party is too big for the selected table.\n * * `\"TOO_SMALL\"`: The party is too small for the selected table.\n * * `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.\n */\n ignoreTableCombinationConflicts?: Array;\n };\n type CreateReservationRequest = {\n /**\n * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n * * `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.\n */\n ignoreReservationLocationConflicts?: Array;\n /**\n * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n * * `\"TOO_BIG\"`: The party is too big for the selected table.\n * * `\"TOO_SMALL\"`: The party is too small for the selected table.\n * * `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.\n */\n ignoreTableCombinationConflicts?: Array;\n /**\n * Reservation details.\n */\n reservation: Reservations.Reservation;\n };\n type CreateReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type CursorPaging = {\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string;\n /**\n * Number of items to load.\n */\n limit?: number;\n };\n type CursorPagingMetadata = {\n /**\n * Number of items returned in the response.\n */\n count?: number;\n /**\n * Offset that was requested.\n */\n cursors?: Reservations.Cursors;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean;\n };\n type CursorQuery = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Reservations.CursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-and-filtering) article.\n * To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n */\n filter?: Object;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Array;\n };\n type CursorQueryPagingMethodOneOf = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n cursorPaging?: Reservations.CursorPaging;\n };\n type CursorSearch = {\n /**\n * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.\n */\n aggregations?: Array;\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'\n */\n cursorPaging?: Reservations.CursorPaging;\n /**\n * A filter object. See the filter section [here](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/wix-api-basics/1011-wql-wix-query-language)\n */\n filter?: Object;\n /**\n * free text to match in searchable fields\n */\n search?: Reservations.SearchDetails;\n /**\n * Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]\n */\n sort?: Array;\n };\n type CursorSearchPagingMethodOneOf = {\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'\n */\n cursorPaging?: Reservations.CursorPaging;\n };\n type Cursors = {\n /**\n * Cursor pointing to next page in the list of results.\n */\n next?: string;\n /**\n * Cursor pointing to previous page in the list of results.\n */\n prev?: string;\n };\n type DateHistogramAggregation = {\n /**\n * Supported values:\n * - `'DAY'`\n * - `'HOUR'`\n * - `'MINUTE'`\n * - `'MONTH'`\n * - `'SECOND'`\n * - `'UNKNOWN_INTERVAL'`\n * - `'WEEK'`\n * - `'YEAR'`\n */\n interval?: string;\n };\n type DateHistogramResult = {\n count?: number;\n value?: string;\n };\n type DateHistogramResults = {\n results?: Array;\n };\n type DeleteReservationRequest = {\n /**\n * Reservation ID.\n */\n reservationId: string;\n revision?: string;\n };\n type DeleteReservationResponse = {};\n type Details = {\n /**\n * End date and time of the reservation.\n */\n endDate?: Date;\n /**\n * Party size.\n */\n partySize?: number;\n /**\n * ID of the reservation location at which this reservation will be made.\n */\n reservationLocationId?: string;\n /**\n * Start date and time of the reservation.\n */\n startDate?: Date;\n /**\n * IDs of tables used for this reservation.\n */\n tableIds?: Array;\n };\n type DomainEvent = {\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n actionEvent?: Reservations.ActionEvent;\n /**\n * Information about the reservation that was created and event metadata.\n */\n createdEvent?: Reservations.EntityCreatedEvent;\n deletedEvent?: Reservations.EntityDeletedEvent;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * ID of the entity associated with the event.\n */\n entityId?: string;\n /**\n * Event timestamp.\n */\n eventTime?: Date;\n /**\n * If present, indicates the action that triggered the event.\n */\n originatedFrom?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean;\n /**\n * Information about the reservation that was updated and event metadata.\n */\n updatedEvent?: Reservations.EntityUpdatedEvent;\n };\n type DomainEventBodyOneOf = {\n actionEvent?: Reservations.ActionEvent;\n createdEvent?: Reservations.EntityCreatedEvent;\n deletedEvent?: Reservations.EntityDeletedEvent;\n updatedEvent?: Reservations.EntityUpdatedEvent;\n };\n type Empty = {};\n type EntityCreatedEvent = {\n /**\n * Information about the reservation that was created in JSON format.\n */\n entityAsJson?: string;\n };\n type EntityDeletedEvent = {\n /**\n * Entity that was deleted\n */\n deletedEntityAsJson?: string;\n };\n type EntityUpdatedEvent = {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n };\n type GetReservationOptions = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * Supported values: `PUBLIC`, `FULL`.\n *\n * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.\n */\n fieldsets?: Array;\n };\n type GetReservationRequest = {\n /**\n * Array of named, predefined sets of projected fields to be returned.\n *\n * Supported values: `PUBLIC`, `FULL`.\n *\n * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.\n */\n fieldsets?: Array;\n /**\n * Reservation ID.\n */\n reservationId: string;\n };\n type GetReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type GroupByAggregation = {\n fieldPath?: string;\n name?: string;\n value?: Reservations.ValueAggregation;\n };\n type GroupByAggregationKindOneOf = {\n value?: Reservations.ValueAggregation;\n };\n type GroupByValueResults = {\n results?: Array;\n };\n type HeldReservationDetails = {\n /**\n * Party size.\n */\n partySize?: number;\n /**\n * ID of the reservation location where the reservation is made.\n */\n reservationLocationId?: string;\n /**\n * Start date and time of the reservation.\n */\n startDate?: Date;\n };\n type IncludeMissingValuesOptions = {\n /**\n * can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...\n */\n addToBucket?: string;\n };\n type ListReservationsOptions = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n paging?: Reservations.CursorPaging;\n /**\n * Defines how reservations in the response are sorted.\n */\n sort?: Reservations.Sorting;\n /**\n * Only reservations starting after this date are returned.\n */\n startDateFrom?: Date;\n /**\n * Only reservations starting before this date are returned.\n */\n startDateTo?: Date;\n /**\n * Only reservations with this status are returned.\n *\n * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n * * `RESERVED`: The reservation is confirmed.\n * * `SEATED`: The customer is currently occupying the table.\n * * `CANCELED`: The reservation is canceled.\n * * `NO_SHOW`: The customer didn't show up for their reservation.\n * * `FINISHED`: The reservation completed successfully.\n */\n status?: string;\n };\n type ListReservationsRequest = {\n /**\n * Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.\n */\n paging?: Reservations.CursorPaging;\n /**\n * Defines how reservations in the response are sorted.\n */\n sort?: Reservations.Sorting;\n /**\n * Only reservations starting after this date are returned.\n */\n startDateFrom?: Date;\n /**\n * Only reservations starting before this date are returned.\n */\n startDateTo?: Date;\n /**\n * Only reservations with this status are returned.\n *\n * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n * * `RESERVED`: The reservation is confirmed.\n * * `SEATED`: The customer is currently occupying the table.\n * * `CANCELED`: The reservation is canceled.\n * * `NO_SHOW`: The customer didn't show up for their reservation.\n * * `FINISHED`: The reservation completed successfully.\n */\n status?: string;\n };\n type ListReservationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: Reservations.CursorPagingMetadata;\n /**\n * List of reservations.\n */\n reservations?: Array;\n };\n type MigrationNote = {};\n type NestedAggregation = {\n nestedAggregations?: Array;\n };\n type NestedAggregationItem = {\n dateHistogram?: Reservations.DateHistogramAggregation;\n fieldPath?: string;\n name?: string;\n range?: Reservations.RangeAggregation;\n scalar?: Reservations.ScalarAggregation;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n value?: Reservations.ValueAggregation;\n };\n type NestedAggregationItemKindOneOf = {\n dateHistogram?: Reservations.DateHistogramAggregation;\n range?: Reservations.RangeAggregation;\n scalar?: Reservations.ScalarAggregation;\n value?: Reservations.ValueAggregation;\n };\n type NestedAggregationResults = {\n fieldPath?: string;\n name?: string;\n ranges?: Reservations.RangeResults;\n scalar?: Reservations.ScalarResult;\n /**\n * Supported values:\n * - `'DATE_HISTOGRAM'`\n * - `'NESTED'`\n * - `'RANGE'`\n * - `'SCALAR'`\n * - `'UNKNOWN_AGGREGATION_TYPE'`\n * - `'VALUE'`\n */\n type?: string;\n values?: Reservations.ValueResults;\n };\n type NestedAggregationResultsResultOneOf = {\n ranges?: Reservations.RangeResults;\n scalar?: Reservations.ScalarResult;\n values?: Reservations.ValueResults;\n };\n type NestedResultValue = {\n dateHistogram?: Reservations.ValueResult;\n range?: Reservations.RangeResult;\n scalar?: Reservations.NestedResultsScalarResult;\n value?: Reservations.ValueResult;\n };\n type NestedResultValueResultOneOf = {\n dateHistogram?: Reservations.ValueResult;\n range?: Reservations.RangeResult;\n scalar?: Reservations.NestedResultsScalarResult;\n value?: Reservations.ValueResult;\n };\n type NestedResults = {\n results?: Array;\n };\n type NestedResultsScalarResult = {\n value?: number;\n };\n type NestedValueAggregationResult = {\n nestedResults?: Reservations.NestedAggregationResults;\n value?: string;\n };\n type QueryReservationsRequest = {\n /**\n * Query to select reservations.\n */\n query: Reservations.CursorQuery;\n };\n type QueryReservationsResponse = {\n /**\n * Metadata for the paginated results.\n */\n pagingMetadata?: Reservations.CursorPagingMetadata;\n /**\n * List of reservations.\n */\n reservations?: Array;\n };\n type RangeAggregation = {\n buckets?: Array;\n };\n type RangeAggregationResult = {\n count?: number;\n from?: number;\n to?: number;\n };\n type RangeBucket = {\n /**\n * Inclusive lower bound of the range. Required if to is not given.\n */\n from?: number;\n /**\n * Exclusive upper bound of the range. Required if from is not given.\n */\n to?: number;\n };\n type RangeResult = {\n count?: number;\n from?: number;\n to?: number;\n };\n type RangeResults = {\n results?: Array;\n };\n type Reservation = {\n /**\n * Date and time the reservation was created.\n */\n _createdDate?: Date;\n /**\n * Reservation ID.\n */\n _id?: string;\n /**\n * Date and time the reservation was changed.\n */\n _updatedDate?: Date;\n /**\n * The reason the reservation was declined.\n */\n declineReason?: string;\n /**\n * Reservation details.\n */\n details?: Reservations.Details;\n /**\n * Information about the person making the reservation.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n reservedBy?: Reservations.ReservedBy;\n /**\n * Information about the person the reservation is being made for.\n *\n * A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.\n * Attempting to create a reservation without these fields results in an error.\n */\n reservee?: Reservations.Reservee;\n /**\n * Revision number, which increments by 1 each time the reservation is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the reservation.\n *\n * Ignored when creating a reservation.\n */\n revision?: string;\n /**\n * Reservation source.\n *\n * This indicates how the reservation was made.\n * * `ONLINE` indicates that the customer made the reservation through a website or app.\n * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.\n * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.\n */\n source?: string;\n /**\n * Status of the reservation.\n *\n * Supported values:\n *\n * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.\n * * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.\n * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.\n * * `RESERVED`: The reservation is confirmed.\n * * `SEATED`: The customer is currently occupying the table.\n * * `CANCELED`: The reservation is canceled.\n * * `NO_SHOW`: The customer didn't show up for their reservation.\n * * `FINISHED`: The reservation completed successfully.\n *\n *\n * See the article for this API titled \"The Reservation Lifecycle\" in the menu on the left for more details on each of the statuses, and an explanation of the reservation lifecycle.\n */\n status?: string;\n /**\n * Team message.\n *\n * A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.\n */\n teamMessage?: string;\n };\n type ReservationCanceled = {\n /**\n * Reserved reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type ReservationDataUpdated = {\n /**\n * Old reservation.\n */\n oldReservation?: Reservations.Reservation;\n /**\n * Reserved reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type ReservationDetailsConflicts = {\n /**\n * Reservation location conflicts.\n */\n reservationLocationConflicts?: Array;\n /**\n * Table combinations conflicts.\n */\n tableCombinationConflicts?: Array;\n };\n type ReservationLocationConflict = {\n /**\n * Reservation location conflict type.\n */\n type?: string;\n };\n type ReservationReserved = {\n /**\n * Reserved reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type ReserveReservationRequest = {\n /**\n * Reservation ID.\n */\n reservationId: string;\n /**\n * Reservee details.\n */\n reservee: Reservations.Reservee;\n /**\n * Revision number.\n *\n * Include the existing `revision` to prevent conflicting updates to reservations.\n */\n revision: string;\n };\n type ReserveReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type ReservedBy = {\n /**\n * Contact ID for the person who made the reservation. If a contact with this ID does not exist on the site, one will be created.\n */\n contactId?: string;\n };\n type Reservee = {\n /**\n * Contact ID. If a contact with this ID does not exist on the site, one will be created.\n */\n contactId?: string;\n /**\n * Custom fields for the reservee in key-value pairs.\n *\n * The key is the custom field's ID, and the value is the custom field's value. For example, a custom field for allergies might have the key-value pair `f4283b2d-6340-4cf9-bae7-8769e6b62127 : \"Nuts, Seafood\"`.\n *\n * Empty fields are not returned.\n */\n customFields?: Object;\n /**\n * Email address.\n */\n email?: string;\n /**\n * First name.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n firstName?: string;\n /**\n * Last name.\n */\n lastName?: string;\n /**\n * Whether the reservee has given marketing consent.\n */\n marketingConsent?: boolean;\n /**\n * Phone number.\n *\n * This property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `\"+972555555555\"`.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n phone?: string;\n };\n type Results = {\n results?: Record;\n };\n type ScalarAggregation = {\n /**\n * Supported values:\n * - `'AVG'`\n * - `'COUNT_DISTINCT'`\n * - `'MAX'`\n * - `'MIN'`\n * - `'SUM'`\n * - `'UNKNOWN_SCALAR_TYPE'`\n */\n type?: string;\n };\n type ScalarResult = {\n /**\n * Supported values:\n * - `'AVG'`\n * - `'COUNT_DISTINCT'`\n * - `'MAX'`\n * - `'MIN'`\n * - `'SUM'`\n * - `'UNKNOWN_SCALAR_TYPE'`\n */\n type?: string;\n value?: number;\n };\n type SearchDetails = {\n /**\n * search term or expression\n */\n expression?: string;\n /**\n * fields to search in. if empty - server will search in own default fields\n */\n fields?: Array;\n /**\n * flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)\n */\n fuzzy?: boolean;\n /**\n * boolean search mode\n */\n mode?: string;\n };\n type SearchReservationsRequest = {\n /**\n * Search query.\n */\n search: Reservations.CursorSearch;\n };\n type SearchReservationsResponse = {\n /**\n * Aggregation data.\n */\n aggregationData?: Reservations.AggregationData;\n /**\n * Cursor paging metadata.\n */\n pagingMetadata?: Reservations.CursorPagingMetadata;\n /**\n * List of Reservations.\n */\n reservations?: Array;\n };\n type Sorting = {\n /**\n * Name of the field to sort by.\n */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.\n */\n order?: string;\n };\n type TableCombinationConflict = {\n /**\n * Conflict type.\n */\n type?: string;\n };\n type TableWithReservationConflicts = {\n /**\n * List of reservation ids.\n */\n reservationIds?: Array;\n /**\n * Table id.\n */\n tableId?: string;\n };\n type UpdateReservation = {\n /**\n * Date and time the reservation was created.\n */\n _createdDate?: Date;\n /**\n * Reservation ID.\n */\n _id?: string;\n /**\n * Date and time the reservation was changed.\n */\n _updatedDate?: Date;\n /**\n * The reason the reservation was declined.\n */\n declineReason?: string;\n /**\n * Reservation details.\n */\n details?: Reservations.Details;\n /**\n * Information about the person making the reservation.\n *\n * This field is required if the reservation's `status` is anything other than `WALK_IN`.\n */\n reservedBy?: Reservations.ReservedBy;\n /**\n * Information about the person the reservation is being made for.\n *\n * A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.\n * Attempting to create a reservation without these fields results in an error.\n */\n reservee?: Reservations.Reservee;\n /**\n * Revision number, which increments by 1 each time the reservation is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the reservation.\n *\n * Ignored when creating a reservation.\n */\n revision?: string;\n /**\n * Reservation source.\n *\n * This indicates how the reservation was made.\n * * `ONLINE` indicates that the customer made the reservation through a website or app.\n * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.\n * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.\n */\n source?: string;\n /**\n * Status of the reservation.\n *\n * See the article for this API titled \"The Reservation Lifecycle\" in the menu on the left for more details on each of the statuses, and an explanation of the reservation lifecycle.\n */\n status?: string;\n /**\n * Team message.\n *\n * A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.\n */\n teamMessage?: string;\n };\n type UpdateReservationOptions = {\n /**\n * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n * * `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.\n */\n ignoreReservationLocationConflicts?: Array;\n /**\n * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n * * `\"TOO_BIG\"`: The party is too big for the selected table.\n * * `\"TOO_SMALL\"`: The party is too small for the selected table.\n * * `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.\n */\n ignoreTableCombinationConflicts?: Array;\n };\n type UpdateReservationRequest = {\n /**\n * Ignored reservation location conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"PARTY_PACING\"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.\n * * `\"SEAT_PACING\"`: The required number of seats are unavailable according to seat pacing settings.\n */\n ignoreReservationLocationConflicts?: Array;\n /**\n * Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it.\n *\n * Possible values:\n * * `\"RESERVED\"`: One or more of the chosen tables are already reserved.\n * * `\"TOO_BIG\"`: The party is too big for the selected table.\n * * `\"TOO_SMALL\"`: The party is too small for the selected table.\n * * `\"OFFLINE_ONLY\"`: The restaurant does not allow online reservations.\n */\n ignoreTableCombinationConflicts?: Array;\n /**\n * Reservation information to update.\n */\n reservation: Reservations.Reservation;\n };\n type UpdateReservationResponse = {\n /**\n * Reservation.\n */\n reservation?: Reservations.Reservation;\n };\n type ValueAggregation = {\n /**\n * options for including missing values\n */\n includeOptions?: Reservations.IncludeMissingValuesOptions;\n /**\n * How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.\n */\n limit?: number;\n /**\n * should missing values be included or excluded from the aggregation results. Default is EXCLUDE\n */\n missingValues?: string;\n /**\n * Supported values:\n * - `'ASC'`\n * - `'DESC'`\n */\n sortDirection?: string;\n /**\n * Supported values:\n * - `'COUNT'`\n * - `'VALUE'`\n */\n sortType?: string;\n };\n type ValueAggregationOptionsOneOf = {\n /**\n * options for including missing values\n */\n includeOptions?: Reservations.IncludeMissingValuesOptions;\n };\n type ValueAggregationResult = {\n count?: number;\n value?: string;\n };\n type ValueResult = {\n count?: number;\n value?: string;\n };\n type ValueResults = {\n results?: Array;\n };\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#)\n */\n interface ReservationsQueryBuilder {\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#ascending)\n */\n ascending(propertyNames: Array): Reservations.ReservationsQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#descending)\n */\n descending(propertyNames: Array): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query to match items where the specified property equals the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#eq)\n */\n eq(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Returns the query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#find)\n */\n find(): Promise;\n /**\n * Refines a query to match items where the specified property is greater than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#ge)\n */\n ge(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query to match items where the specified property is greater than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#gt)\n */\n gt(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#in)\n */\n in(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query to match items where the specified property is less than or equal to the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#le)\n */\n le(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Limits the number of items the query returns.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#limit)\n */\n limit(limit: number): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query to match items where the specified property is less than the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#lt)\n */\n lt(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query to match items where the specified property doesn't equal the specified value.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#ne)\n */\n ne(propertyName: string, value: any): Reservations.ReservationsQueryBuilder;\n /**\n * Refines a query that skips to a specific record.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#skipTo)\n */\n skipTo(cursor: string): Reservations.ReservationsQueryBuilder;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#)\n */\n interface ReservationsQueryResult {\n /**\n * Returns the query cursors.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#cursors)\n */\n cursors: Reservations.Cursors;\n /**\n * Returns an array of `reservations` items that match the query.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#items)\n */\n items: Array;\n /**\n * Returns the number of items in the current page of results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#length)\n */\n length: number;\n /**\n * Returns the requested page size.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#pageSize)\n */\n pageSize: number;\n /**\n * Returns the `ReservationsQueryBuilder` object used to get the current results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#query)\n */\n query: Reservations.ReservationsQueryBuilder;\n /**\n * Indicates whether the query has more results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#hasNext)\n */\n hasNext(): boolean;\n /**\n * Indicates whether the query has previous results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#hasPrev)\n */\n hasPrev(): boolean;\n /**\n * Retrieves the next page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#next)\n */\n next(): Promise;\n /**\n * Retrieves the previous page of query results.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#prev)\n */\n prev(): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryBuilder.html#)\n */\n namespace ReservationsQueryBuilder {\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.Reservations.ReservationsQueryResult.html#)\n */\n namespace ReservationsQueryResult {\n }\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-table-reservations-v2.TimeSlots.html#)\n */\n namespace TimeSlots {\n type CheckReservationDetailsOptions = {\n /**\n * Date.\n */\n date: Date;\n /**\n * Duration.\n */\n duration: number;\n /**\n * Reservation, that should be ignored during the check.\n */\n excludeReservationId?: string;\n /**\n * Party size.\n */\n partySize: number;\n /**\n * Requested table combination.\n */\n tableIds?: Array;\n };\n type CheckReservationDetailsRequest = {\n /**\n * Date.\n */\n date: Date;\n /**\n * Duration.\n */\n duration: number;\n /**\n * Reservation, that should be ignored during the check.\n */\n excludeReservationId?: string;\n /**\n * Party size.\n */\n partySize: number;\n /**\n * Reservation location ID.\n */\n reservationLocationId: string;\n /**\n * Requested table combination.\n */\n tableIds?: Array;\n };\n type CheckReservationDetailsResponse = {\n /**\n * Requested table combination state.\n */\n requestedTableCombination?: TimeSlots.TableCombination;\n /**\n * Reservation location conflicts.\n */\n reservationLocationConflicts?: Array;\n /**\n * Table combinations states.\n */\n tableCombinations?: Array;\n /**\n * List of reserved tables with corresponding reservation ids.\n */\n tableReservedConflicts?: Array;\n /**\n * Tables states.\n */\n tables?: Array;\n };\n type GetTimeSlotsOptions = {\n /**\n * Duration in minutes of the time slot.\n *\n * Min: `5`\n */\n duration?: number;\n /**\n * The number of time slots to retrieve after the given `date`.\n */\n slotsAfter?: number;\n /**\n * The number of time slots to retrieve before the given `date`.\n */\n slotsBefore?: number;\n };\n type GetTimeSlotsRequest = {\n /**\n * Date and time for which to retrieve a time slot.\n */\n date: Date;\n /**\n * Duration in minutes of the time slot.\n *\n * Min: `5`\n */\n duration?: number;\n /**\n * Size of the party that needs to be seated during this time slot.\n *\n * Min: `1`\n */\n partySize: number;\n /**\n * ID of the reservation location for which to retrieve time slots.\n */\n reservationLocationId: string;\n /**\n * The number of time slots to retrieve after the given `date`.\n */\n slotsAfter?: number;\n /**\n * The number of time slots to retrieve before the given `date`.\n */\n slotsBefore?: number;\n };\n type GetTimeSlotsResponse = {\n /**\n * A list of time slots and their availability according to the given party size.\n */\n timeSlots?: Array;\n };\n type ReservationLocationConflict = {\n /**\n * Reservation location conflict type.\n */\n type?: string;\n };\n type Table = {\n _id?: string;\n /**\n * Table conflicts.\n */\n tableConflicts?: Array;\n };\n type TableCombination = {\n tableCombinationConflicts?: Array;\n tableIds?: Array;\n };\n type TableCombinationConflict = {\n /**\n * Conflict type.\n */\n type?: string;\n };\n type TableConflict = {\n /**\n * Conflict type.\n */\n type?: string;\n };\n type TableReservedConflict = {\n /**\n * List of reservation ids.\n */\n reservationIds?: Array;\n /**\n * Table id.\n */\n tableId?: string;\n };\n type TimeSlot = {\n /**\n * Duration in minutes of this time slot.\n */\n duration?: number;\n /**\n * Whether manual approval is required to make a reservation in this time slot.\n */\n manualApproval?: boolean;\n /**\n * Start date and time of this time slot.\n */\n startDate?: Date;\n /**\n * Availability status of this time slot.\n *\n * * `AVAILABLE`: The restaurant can accommodate a party of the given size in this time slot.\n * * `UNAVAILABLE`: The restaurant can't accommodate a party of the given size in this time slot.\n * * `NON_WORKING_HOURS`: The restaurant is not open during this time slot.\n */\n status?: string;\n };\n type TimeSlotTableCombination = {\n /**\n * Table IDs of the tables in the combination.\n */\n tableIds?: Array;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-urls.v2.d.ts", "content": "/**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls.v2.html#)\n */\ndeclare module 'wix-urls.v2' {\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls-v2.html#editor)\n */\n const editor: Editor;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls-v2.html#site)\n */\n const site: Site;\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls-v2.Editor.html#)\n */\n interface Editor {\n /**\n * Retrieves a site's Editor URLs.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-urls-v2.Editor.html#getEditorUrls)\n */\n getEditorUrls(): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls-v2.Site.html#)\n */\n interface Site {\n /**\n * This function returns a Promise that resolves to an array of the site's published URLs.\n * If a site hasn't been published, the Promise resolves to an empty array.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-urls-v2.Site.html#listPublishedSiteUrls)\n */\n listPublishedSiteUrls(options: Site.ListPublishedSiteUrlsOptions): Promise;\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls-v2.Editor.html#)\n */\n namespace Editor {\n type EditorUrls = {\n /**\n * Editor type.\n * Supported values:\n * - `WIX_EDITOR`: The classic Wix Editor.\n * - `EDITOR_X`: Deprecated. Expected sunset date: July 1, 2024.\n * - `WIX_STUDIO`: Wix's Editor built for agencies and enterprises.\n */\n editorType?: string;\n /**\n * Editor URL.\n */\n editorUrl?: string;\n /**\n * Preview URL.\n */\n previewUrl?: string;\n };\n type GetEditorUrlsRequest = {};\n type GetEditorUrlsResponse = {\n /**\n * Editor URL.\n */\n urls?: Editor.EditorUrls;\n };\n }\n /**\n * [Read more](https://www.wix.com/corvid/reference/wix-urls-v2.Site.html#)\n */\n namespace Site {\n type Filters = {\n /**\n * Whether to return language subdomains hosted by [Wix Multilingual](https://support.wix.com/article/wix-multilingual-adding-and-setting-up-wix-multilingual). Default: `true`.\n */\n multilingual?: boolean;\n /**\n * Whether to return only the site's primary URL. Default: `true`.\n */\n primary?: boolean;\n /**\n * URL type filter. Supported values:\n *\n * - `\"ALL\"`: All URLs.\n * - `\"PREMIUM\"`: Only URLs directing to the Premium version of the site.\n * - `\"FREE\"`: Only URLs including wixsite.com.\n *\n * Default: `\"ALL\"`\n */\n urlType?: string;\n };\n type ListPublishedSiteUrlsOptions = {\n /**\n * Filters for the list.\n */\n filters?: Site.Filters;\n };\n type ListPublishedSiteUrlsRequest = {\n /**\n * Filters for the list.\n */\n filters?: Site.Filters;\n };\n type ListPublishedSiteUrlsResponse = {\n /**\n * List will be empty for non published sites\n */\n urls?: Array;\n };\n type ListSiteUrlsOptions = {\n filters?: Site.Filters;\n };\n type ListSiteUrlsRequest = {\n filters?: Site.Filters;\n };\n type ListSiteUrlsResponse = {\n /**\n * List of published sites. This array will be empty if the site hasn't been published.\n */\n urls?: Array;\n };\n type MultilingualInfo = {\n /**\n * Whether this is the site's default language.\n */\n defaultLanguage?: boolean;\n /**\n * Language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. Typically, this is a lowercase 2-letter language code, followed by a hyphen, followed by an uppercase 2-letter country code. For example, `en-US` for U.S.-English, and `de-DE` for Germany-German.\n */\n languageCode?: string;\n };\n type PublishedSiteUrls = {\n /**\n * List of published sites. This array will be empty if the site hasn't been published.\n */\n urls?: Array;\n };\n type Url = {\n /**\n * Language subdomain info hosted by [Wix multilingual](https://support.wix.com/article/wix-multilingual-adding-and-setting-up-wix-multilingual).\n */\n multilingualInfo?: Site.MultilingualInfo;\n /**\n * Whether this is the site's primary URL.\n */\n primary?: boolean;\n /**\n * Published site URL.\n */\n url?: string;\n /**\n * URL type.\n *\n * Supported values:\n *\n * - `\"PREMIUM\"`: Only URLs directing to the Premium version of the site.\n *\n * - `\"FREE\"`: Only URLs including `wixsite.com`.\n */\n urlType?: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-users-backend.d.ts", "content": "/**\n * **Deprecated.**\n * The wix-users-backend module will continue to work, but a newer version is available at\n * [wix-members-backend](https://www.wix.com/velo/reference/wix-members-backend).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#)\n */\ndeclare module 'wix-users-backend' {\n /**\n * **Deprecated.**\n * This code will continue to work, but a newer version is available at\n * [wix-members-backend.badges](https://www.wix.com/velo/reference/wix-members-backend/badges).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#badges)\n */\n const badges: Badges;\n /**\n * **Deprecated.**\n * This object will continue to work, but a newer version is available at\n * [wix-members-backend.currentMember.getMember()](https://www.wix.com/velo/reference/wix-members-backend/currentmember/getmember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#currentUser)\n */\n const currentUser: User;\n /**\n * **Deprecated.**\n * This code will continue to work, but a newer version is available at\n * [wix-members-backend.authorization](https://www.wix.com/velo/reference/wix-members-backend/authorization).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#roles)\n */\n const roles: Roles;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authentication.approveByEmail()](https://www.wix.com/velo/reference/wix-members-backend/authentication/approvebyemail).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#approveByEmail)\n */\n function approveByEmail(email: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authentication.approveByToken()](https://www.wix.com/velo/reference/wix-members-backend/authentication/approvebytoken).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#approveByToken)\n */\n function approveByToken(token: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authentication.blockByEmail()](https://www.wix.com/velo/reference/wix-members-backend/authentication/blockbyemail).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#blockByEmail)\n */\n function blockByEmail(email: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.members.deleteMember()](https://www.wix.com/velo/reference/wix-members-backend/members/deletemember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#deleteUser)\n */\n function deleteUser(userId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-crm-backend.triggeredEmails.emailMember()](https://www.wix.com/velo/reference/wix-crm-backend/triggeredemails/emailmember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#emailUser)\n */\n function emailUser(emailId: string, toUser: string, options?: TriggeredEmailOptions): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authentication.generateSessionToken()](https://www.wix.com/velo/reference/wix-members-backend/authentication/generatesessiontoken).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#generateSessionToken)\n */\n function generateSessionToken(email: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.members.getMember()](https://www.wix.com/velo/reference/wix-members-backend/members/getmember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#getUser)\n */\n function getUser(userId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authentication.login()](https://www.wix.com/velo/reference/wix-members-backend/authentication/login).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#login)\n */\n function login(email: string, password: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authentication.register()](https://www.wix.com/velo/reference/wix-members-backend/authentication/register).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#register)\n */\n function register(email: string, password: string, options?: RegistrationOptions): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.members.updateMember()](https://www.wix.com/velo/reference/wix-members-backend/members/updatemember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.html#updateUserFields)\n */\n function updateUserFields(userId: string, userInfo: UserInfo): Promise;\n /**\n * An object that contains information about a site member's address.\n */\n type Address = {\n /**\n * Address street address.\n */\n street: string;\n /**\n * Address city.\n */\n city: string;\n /**\n * Address country.\n */\n country: string;\n /**\n * Address postal code.\n */\n postalCode: string;\n };\n /**\n * An object that contains information about a site contact.\n */\n type ContactInfo = {\n /**\n * Contact's first name.\n */\n firstName?: string;\n /**\n * Contact's last name.\n */\n lastName?: string;\n /**\n * Contact's image source.\n */\n picture?: string;\n /**\n * List of contact's email addresses.\n * When creating a contact, if no phone number is\n * provided, at least one email address must be provided.\n */\n emails?: string[];\n /**\n * Email address the contact who is also\n * a member uses to log into the system.\n */\n loginEmail?: string;\n /**\n * List of contact's phone numbers.\n * When creating a contact, if no email is\n * provided, at least one phone number must be provided.\n */\n phones?: string[];\n /**\n * List of contact's labels. [Labels](https://support.wix.com/en/article/creating-contact-labels)\n * are used to organize contacts. When setting the `labels` property, you can\n * only list labels that already exist in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n */\n labels?: string[];\n /**\n * Any\n * number of custom fields. [Customs fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n * are used to store additional information about your site's contacts. When\n * setting a custom field, use key:value pairs where the key matches the names\n * defined in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n * You can only set values for custom fields that already exist in the Contacts\n * application.\n */\n customFields?: string | number | Date;\n };\n /**\n * An object that contains information about a site member's picture.\n */\n type Picture = {\n /**\n * Member's image URL.\n */\n url: string;\n };\n /**\n * An object that contains information about a site registration.\n */\n type RegistrationOptions = {\n /**\n * Contact information.\n */\n contactInfo?: ContactInfo;\n /**\n * Sets the [privacy status](https://support.wix.com/en/article/member-privacy-settings-for-groups) of a new member upon registration.\n * One of:\n *\n * + `\"PUBLIC\"`: Sets the new member status to public. A member whose status is public is a member of the site's community.\n * + `\"PRIVATE\"`: Sets the new member status to private. A member whose status is private is not a member of the site's community. The default is set to private.\n */\n privacyStatus?: string;\n };\n /**\n * An object that contains information about the results of a site registration.\n */\n type RegistrationResult = {\n /**\n * Registration status. Either \"Pending\" or \"Active\".\n */\n status: string;\n /**\n * A token used to log in the current\n * user as a site member. Pass the token from your backend code to client-side\n * code and use it when calling the [applySessionToken()](wix-users.html#applySessionToken)\n * function. The token is only available when `status` is \"Active\".\n */\n sessionToken?: string;\n /**\n * A token for approving the user as\n * a site member using the [approveByToken()](wix-users-backend.html#approveByToken)\n * function. The token is safe to pass via email or from client-side code to\n * backend code. The token is only available when `status` is \"Pending\". The token\n * expires 30 hours after it is created.\n */\n approvalToken?: string;\n /**\n * The user that has been registered.\n */\n user: User;\n };\n /**\n * An object that contains information about a site member.\n */\n type RetrievedUser = {\n /**\n * Member's unique id.\n */\n id: string;\n /**\n * The member's full name. This information is concatenated from the `firstName` and `lastName` properties. This field will not be returned if the member registered with an email but without a name.\n */\n memberName?: string;\n /**\n * Member's first name.\n */\n firstName: string;\n /**\n * Member's last name.\n */\n lastName: string;\n /**\n * The email address the member uses to log in to your site. This is the address they supplied when they signed up.\n */\n loginEmail: string;\n /**\n * The name the member specified on their profile.\n */\n nickname: string;\n /**\n * The member's URL-friendly name that is unique across your site. Typically this is made up of the member's email prefix.\n */\n slug: string;\n /**\n * The member's locale based on their last login.\n */\n language: string;\n /**\n * Indicates the member's current status, between `Applicant`, `Active`, `Blocked`.\n */\n status: string;\n /**\n * The date and time the member registered to the site.\n */\n creationDate: Date;\n /**\n * The last date and time the member's details were updated.\n */\n lastUpdateDate: Date;\n /**\n * The date and time when the member last logged in.\n */\n lastLoginDate: Date;\n /**\n * List of the member's email addresses.\n */\n emails: string[];\n /**\n * List of the member's phone numbers.\n */\n phones: string[];\n /**\n * List of the member's labels. [Labels](https://support.wix.com/en/article/creating-contact-labels)\n * are used to organize contacts. When setting the `labels` property, you can\n * only list labels that already exist in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n */\n labels: string[];\n /**\n * Member's picture.\n */\n picture: Picture;\n /**\n * Any\n * number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n * are used to store additional information about your site's contacts. When\n * setting a custom field, use key:value pairs where the key matches the display names\n * in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n * You can only set values for custom fields that already exist in the Contacts\n * application.\n */\n customFields: string | number | Date;\n };\n /**\n * An object used when sending a Triggered Email.\n */\n type TriggeredEmailOptions = {\n /**\n * An object with `key:value` pairs where each\n * `key` is a variable in the email template created in Triggered Emails and its\n * corresponding `value` is the value to insert into the template in place of\n * variable. The values must be strings.\n */\n variables: any;\n };\n /**\n * An object that contains information about a site member.\n */\n type UserInfo = {\n /**\n * Member's first name.\n */\n firstName?: string;\n /**\n * Member's last name.\n */\n lastName?: string;\n /**\n * The name the member specified on their profile.\n */\n nickname?: string;\n /**\n * The member's URL-friendly name that is unique across your site. Typically this is made up of the member's email prefix.\n */\n slug?: string;\n /**\n * List of the member's email addresses.\n */\n emails?: string[];\n /**\n * List of the member's phone numbers.\n */\n phones?: string[];\n /**\n * List of the member's labels. [Labels](https://support.wix.com/en/article/creating-contact-labels)\n * are used to organize contacts. When setting the `labels` property, you can\n * only list labels that already exist in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n */\n labels?: string[];\n /**\n * Member's picture.\n */\n picture?: Picture;\n /**\n * Any\n * number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n * are used to store additional information about your site's contacts. When\n * setting a custom field, use key:value pairs where the key matches the display names\n * in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n * You can only set values for custom fields that already exist in the Contacts\n * application.\n */\n customFields?: string | number | Date;\n } & AnyProperties;\n /**\n * **Deprecated.**\n * This code will continue to work, but a newer version is available at\n * [wix-members-backend.badges](https://www.wix.com/velo/reference/wix-members-backend/badges).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#)\n */\n interface Badges {\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.assignMembers()](https://www.wix.com/velo/reference/wix-members-backend/badges/assignmembers).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#assignMembers)\n */\n assignMembers(badgeId: string, memberIds: string[]): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.createBadge()](https://www.wix.com/velo/reference/wix-members-backend/badges/createbadge).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#createBadge)\n */\n createBadge(badgeInfo: Badges.BadgeInfo): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.deleteBadge()](https://www.wix.com/velo/reference/wix-members-backend/badges/deletebadge).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#deleteBadge)\n */\n deleteBadge(badgeId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.listMemberBadges()](https://www.wix.com/velo/reference/wix-members-backend/badges/listmemberbadges).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#listMemberBadges)\n */\n listMemberBadges(memberIds: string[]): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.listMembers()](https://www.wix.com/velo/reference/wix-members-backend/badges/listmembers).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#listMembers)\n */\n listMembers(badgeId: string): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.removeMembers()](https://www.wix.com/velo/reference/wix-members-backend/badges/removemembers).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#removeMembers)\n */\n removeMembers(badgeId: string, memberIds: string[]): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.badges.updateBadge()](https://www.wix.com/velo/reference/wix-members-backend/badges/updatebadge).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#updateBadge)\n */\n updateBadge(badgeId: string, badgeInfo: Badges.BadgeInfo): Promise;\n }\n /**\n * **Deprecated.**\n * This code will continue to work, but a newer version is available at\n * [wix-members-backend.authorization](https://www.wix.com/velo/reference/wix-members-backend/authorization).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Roles.html#)\n */\n interface Roles {\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authorization.assignRole()](https://www.wix.com/velo/reference/wix-members-backend/authorization/assignrole).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Roles.html#assignRole)\n */\n assignRole(roleId: string, memberId: string, options?: Roles.WixRolesOptions): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.authorization.removeRole()](https://www.wix.com/velo/reference/wix-members-backend/authorization/removerole).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Roles.html#removeRole)\n */\n removeRole(roleId: string, memberId: string, options?: Roles.WixRolesOptions): Promise;\n }\n /**\n * A site member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#)\n */\n interface User {\n /**\n * **Deprecated.**\n * This property will continue to work, but a newer version is available at\n * [wix-members-backend.currentMember.getMember()](https://www.wix.com/velo/reference/wix-members-backend/currentmember/getmember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#id)\n */\n readonly id: string;\n /**\n * **Deprecated.**\n * This property will continue to work, but a newer version is available at\n * [wix-members-backend.currentMember.getMember()](https://www.wix.com/velo/reference/wix-members-backend/currentmember/getmember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#loggedIn)\n */\n readonly loggedIn: boolean;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.currentMember.getRoles()](https://www.wix.com/velo/reference/wix-members-backend/currentmember/getroles).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#role)\n */\n readonly role: string;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.currentMember.getMember()](https://www.wix.com/velo/reference/wix-members-backend/currentmember/getmember).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#getEmail)\n */\n getEmail(): Promise;\n /**\n * Gets the current member's pricing plan.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#getPricingPlans)\n */\n getPricingPlans(): Promise;\n /**\n * **Deprecated.**\n * This function will continue to work, but a newer version is available at\n * [wix-members-backend.currentMember.getRoles()](https://www.wix.com/velo/reference/wix-members-backend/currentmember/getroles).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#getRoles)\n */\n getRoles(): Promise;\n }\n /**\n * **Deprecated.**\n * This code will continue to work, but a newer version is available at\n * [wix-members-backend.badges](https://www.wix.com/velo/reference/wix-members-backend/badges).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Badges.html#)\n */\n namespace Badges {\n /**\n * An object representing a member badge.\n */\n type Badge = {\n /**\n * Badge ID.\n */\n id: string;\n /**\n * Badge title.\n */\n title: string;\n /**\n * Badge description.\n */\n description: string;\n /**\n * Background color of the badge as a hexadecimal rgb color value. The default color is `#796EFF` (purple).\n */\n backgroundColor: string;\n /**\n * Text color of the badge as a hexadecimal rgb color value. The default color is `#FFFFFF` (white).\n */\n textColor: string;\n /**\n * Badge icon as an SVG image. One of the following:\n *\n * + An external web URL in the following format: `http(s)://`.\n * + The [source URL](wix-media-backend.mediaManager.html#getFileUrl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.\n */\n icon: string;\n /**\n * ID of the role that badge members are assigned to.\n */\n roleId: string;\n /**\n * Badge's unique URL as used in a dynamic page.\n */\n slug: string;\n /**\n * Date and time the badge was created.\n */\n createdDate: Date;\n /**\n * Date and time the badge was last updated.\n */\n updatedDate: Date;\n };\n /**\n * Information to use when creating or updating a badge.\n */\n type BadgeInfo = {\n /**\n * Badge title.\n */\n title: string;\n /**\n * Badge description.\n */\n description?: string;\n /**\n * Background color of the badge as a hexadecimal rgb color value. The default color is `#796EFF` (purple).\n */\n backgroundColor?: string;\n /**\n * Text color of the badge as a hexadecimal rgb color value. The default color is `#FFFFFF` (white).\n */\n textColor?: string;\n /**\n * Badge icon as an SVG image. One of the following:\n *\n * + An external web URL in the following format: `http(s)://`.\n * + The [source URL](wix-media-backend.mediaManager.html#getFileUrl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.\n */\n icon?: string;\n };\n /**\n * An object representing the badges associated with a member.\n */\n type MemberBadges = {\n /**\n * Member ID.\n */\n memberId: string;\n /**\n * IDs of all badges assigned to the specified member.\n */\n badgeIds: string[];\n };\n }\n /**\n * **Deprecated.**\n * This code will continue to work, but a newer version is available at\n * [wix-members-backend.authorization](https://www.wix.com/velo/reference/wix-members-backend/authorization).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.Roles.html#)\n */\n namespace Roles {\n /**\n * An object that you pass as the `options` parameter that modifies how an operation is performed.\n */\n type WixRolesOptions = {\n /**\n * Prevents permission checks from running for the operation. Defaults to `false`.\n */\n suppressAuth: boolean;\n };\n }\n /**\n * A site member.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-users-backend.User.html#)\n */\n namespace User {\n /**\n * An object returned by the `getPricingPlans()` function representing a user's [pricing plans](https://support.wix.com/en/article/adding-and-setting-up-the-paid-plans-app).\n */\n type PricingPlan = {\n /**\n * The pricing plan's name.\n */\n name: string;\n /**\n * The pricing plan's start date.\n */\n startDate?: Date;\n /**\n * The pricing plan's expiry date.\n */\n expiryDate?: Date;\n };\n /**\n * An object returned by the `getRoles()` function representing a user's [roles](https://support.wix.com/en/article/creating-member-roles-6943237).\n */\n type UserRole = {\n /**\n * Role name as defined in the site's dashboard or one of \"Admin\" or \"Member\".\n */\n name: string;\n /**\n * Role description, if defined in the site's dashboard.\n */\n description?: string;\n };\n }\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-widget.d.ts", "content": "/**\n * The wix-widget module contains functionality for working with Blocks widgets from [Blocks Panel](https://support.wix.com/en/article/creating-custom-panels-for-your-widgets-action-bar-buttons) code.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-widget.html#)\n */\ndeclare module 'wix-widget' {\n /**\n * Gets the widget's current design preset.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-widget.html#getDesignPreset)\n */\n function getDesignPreset(): Promise;\n /**\n * Gets the `wix-widget` module scoped to an [inner (nested) widget](https://support.wix.com/en/article/wix-blocks-creating-and-managing-widgets-within-widgets).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-widget.html#getNestedWidget)\n */\n function getNestedWidget(Selector: string): Promise;\n /**\n * Gets the widget's [properties](https://support.wix.com/en/article/wix-blocks-widget-api-properties).\n * \t[Read more](https://www.wix.com/corvid/reference/wix-widget.html#getProps)\n */\n function getProps(): Promise;\n /**\n * Sets the widget's design preset.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-widget.html#setDesignPreset)\n */\n function setDesignPreset(preset: string): Promise;\n /**\n * Sets the widget's [properties](https://support.wix.com/en/article/wix-blocks-widget-api-properties). You can also assign a partial subset of the widget's properties.\n * \t[Read more](https://www.wix.com/corvid/reference/wix-widget.html#setProps)\n */\n function setProps(props: any): Promise;\n}\n" }, { "path": "@wix/wix-code-types/dist/types/backend/docworks-packages.d.ts", "content": "/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// \n/// " }, { "path": "@wix/wix-code-types/dist/types/common/wix-blog-backend.d.ts", "content": "declare module \"wix-blog-backend\" {\n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Category$1 {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category label. Displayed in the Category Menu. */\n label?: string;\n /**\n * Number of posts in the category.\n * @readonly\n */\n postCount?: number;\n /**\n * Category URL.\n *\n *\n * The `url` directs you to a page that lists every post with the specified category.\n *\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /** Category title. */\n title?: string;\n /** Reserved for internal use. */\n coverMedia?: CoverMedia$1;\n /**\n * Reserved for internal use.\n * @readonly\n */\n oldRank?: number;\n /** Reserved for internal use. */\n rank?: number | null;\n /** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */\n displayPosition?: number | null;\n /**\n * ID of the category's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single category will share the same `translationId`.\n * @readonly\n */\n translationId?: string | null;\n /**\n * Category Language.\n *\n * 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).\n */\n language?: string;\n /**\n * Part of a category's URL that refers to a specific category.\n *\n *\n * For example, `'https:/example.com/blog/category/{my-category-slug}'`.\n */\n slug?: string;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$2;\n /** Category cover image. */\n coverImage?: string;\n }\n interface CoverMedia$1 extends CoverMediaMediaOneOf$1 {\n /**\n * Is cover media enabled.\n * Selected by user whether to display cover media on the feed\n */\n enabled?: boolean;\n /** Whether cover media is displayed. */\n displayed?: boolean;\n /** If `false`, the cover image is the first media item appearing in the content. */\n custom?: boolean;\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\n }\n /** @oneof */\n interface CoverMediaMediaOneOf$1 {\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema$2 {\n /** SEO tag information. */\n tags?: Tag$2[];\n /** SEO general settings. */\n settings?: Settings$2;\n }\n interface Keyword$2 {\n /** Keyword value */\n term?: string;\n /** Whether the keyword is the main focused */\n isMain?: boolean;\n }\n interface Tag$2 {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings$2 {\n /**\n * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.\n *\n *\n * Default: enabled\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page */\n keywords?: Keyword$2[];\n }\n interface InitialCategoriesCopied {\n /** Number of categories copied. */\n count?: number;\n }\n interface CreateCategoryRequest {\n /** Category info. */\n category: Category$1;\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n enum Field$2 {\n UNKNOWN = \"UNKNOWN\",\n /** Includes Category url. */\n URL = \"URL\",\n /**\n * Includes internal id field.\n * Reserved for internal use\n */\n INTERNAL_ID = \"INTERNAL_ID\",\n /** Includes SEO data. */\n SEO = \"SEO\"\n }\n interface CreateCategoryResponse {\n /** Category info. */\n category?: Category$1;\n }\n interface BulkCreateCategoriesRequest {\n /** Categories to create. */\n categories: Category$1[];\n /** Whether to return the full created category entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface BulkCreateCategoriesResponse {\n /** Categories created by bulk action. */\n results?: BulkCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkCategoryResult {\n /** Bulk actions metadata for category. */\n itemMetadata?: ItemMetadata$1;\n /** Optional created category. */\n item?: Category$1;\n }\n interface ItemMetadata$1 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$1;\n }\n interface ApplicationError$1 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$1 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkUpdateCategoriesRequest {\n /** Categories to update. */\n categories?: MaskedCategory[];\n /** Whether to return the full created category entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of category fields to be included in the response if the entities are present.\n * Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).\n * For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.\n */\n fieldsets?: Field$2[];\n }\n interface MaskedCategory {\n /** Category */\n category?: Category$1;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n }\n interface BulkUpdateCategoriesResponse {\n /** Categories updated by bulk action. */\n results?: BulkCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface UpdateCategoryRequest {\n /** Category info. */\n category: Category$1;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface UpdateCategoryResponse {\n /** Category info. */\n category?: Category$1;\n }\n interface GetCategoryRequest {\n /** Category ID. */\n categoryId: string;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of category fields to be included in the response.\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface GetCategoryResponse {\n /** Category info. */\n category?: Category$1;\n }\n interface GetCategoryBySlugRequest {\n /** Slug of the category to retrieve. */\n slug: string;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n *\n * This parameter will be removed on June 30, 2023.\n * List of category fields to be included in the response.\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface GetCategoryBySlugResponse {\n /** Category info. */\n category?: Category$1;\n }\n interface ListCategoriesRequest {\n /** Pagination options. */\n paging?: BlogPaging$1;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n *\n * This parameter will be removed on June 30, 2023.\n *\n * List of category fields to be included in the response.\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface BlogPaging$1 {\n /** Number of categories to skip in the list. */\n offset?: number;\n /**\n * Number of items to return.\n *\n * Default: `50`\n *\n * Max: `100`\n */\n limit?: number;\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n }\n interface ListCategoriesResponse {\n /** List of categories. */\n categories?: Category$1[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData$2;\n }\n interface MetaData$2 {\n /** Number of items returned in this response. */\n count?: number;\n /** Number of items skipped. */\n offset?: number;\n /** Total number of items that match the query. */\n total?: number;\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n }\n interface QueryCategoriesRequest {\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Pagination options.\n */\n paging?: BlogPaging$1;\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Filter object.\n */\n filter?: Record | null;\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 3, 2023.\n *\n * Sorting options.\n */\n sort?: Sorting$2[];\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of category fields to be included in the response.\n */\n fieldsToInclude?: Field$2[];\n /** Query options. */\n query?: PlatformQuery$2;\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformQuery$2 extends PlatformQueryPagingMethodOneOf$2 {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$2[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf$2 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n }\n interface Paging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryCategoriesResponse {\n /** List of categories. */\n categories?: Category$1[];\n /**\n * __Deprecated.__ Use `pagingMetadata` instead.\n * This property will be removed on June 30, 2023.\n *\n * Details on the paged set of results returned.\n */\n metaData?: MetaData$2;\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2$2;\n }\n interface PagingMetadataV2$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$2;\n }\n interface Cursors$2 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface DeleteCategoryRequest {\n /** Category ID. */\n categoryId: string;\n }\n interface DeleteCategoryResponse {\n }\n interface CreateCategoryOptions {\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface BulkCreateCategoriesOptions {\n /** Whether to return the full created category entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface BulkUpdateCategoriesOptions {\n /** Categories to update. */\n categories?: MaskedCategory[];\n /** Whether to return the full created category entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of category fields to be included in the response if the entities are present.\n * Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).\n * For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.\n */\n fieldsets?: Field$2[];\n }\n interface UpdateCategory {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category label. Displayed in the Category Menu. */\n label?: string;\n /**\n * Number of posts in the category.\n * @readonly\n */\n postCount?: number;\n /**\n * Category URL.\n *\n *\n * The `url` directs you to a page that lists every post with the specified category.\n *\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /** Category title. */\n title?: string;\n /** Reserved for internal use. */\n coverMedia?: CoverMedia$1;\n /**\n * Reserved for internal use.\n * @readonly\n */\n oldRank?: number;\n /** Reserved for internal use. */\n rank?: number | null;\n /** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */\n displayPosition?: number | null;\n /**\n * ID of the category's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single category will share the same `translationId`.\n * @readonly\n */\n translationId?: string | null;\n /**\n * Category Language.\n *\n * 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).\n */\n language?: string;\n /**\n * Part of a category's URL that refers to a specific category.\n *\n *\n * For example, `'https:/example.com/blog/category/{my-category-slug}'`.\n */\n slug?: string;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$2;\n /** Category cover image. */\n coverImage?: string;\n }\n interface UpdateCategoryOptions {\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /**\n * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the category’s base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Gets a category by the specified ID.\n *\n *\n * The `getCategory()` function returns a Promise that resolves to a category whose ID matches the specified ID.\n *\n * @param categoryId - Category ID.\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @param options - Options specifying which fields to return.\n */\n function getCategory(categoryId: string, options?: GetCategoryOptions): Promise;\n interface GetCategoryOptions {\n /**\n * List of category fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"SEO\"` and `\"URL\"`.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Gets a category by the specified slug.\n *\n *\n * The `getCategoryBySlug()` function returns a Promise that resolves to a category whose slug matches the specified slug.\n *\n * The `slug` is the end of a category's URL that refers to a specific category. For example, if a category's URL is `https://example.com/blog/category/{my-category-slug}`, the slug is `my-post-slug`. The slug is case-sensitive string that is generally derived from the category's `label`, unless specified otherwise.\n *\n * @public\n * @documentationMaturity preview\n * @requiredField GetCategoryBySlugRequest\n * @requiredField slug\n * @param slug - Slug of the category to retrieve.\n *\n * The end of a category's URL. For example, `'https:/example.com/blog/category/{my-category-slug}'`. Case sensitive and generally based on the category `label` if not specified.\n * @param options - Options specifying which fields to return.\n */\n function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise;\n interface GetCategoryBySlugOptions {\n /**\n * List of category fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"SEO\"` and `\"URL\"`.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Retrieves a list of categories.\n *\n *\n * The `listCategories()` function returns a Promise that resolves to a list of up to 100 categories per language in order of their `displayPosition` starting with `0`. The `displayPosition` is the position in which the categories are displayed in the Category Menu page. By default, categories get added to the bottom of the Category Menu with a `displayPosition` of `-1`.\n * @public\n * @documentationMaturity preview\n * @param options - Filter and paging options.\n */\n function listCategories(options?: ListCategoriesOptions): Promise;\n interface ListCategoriesOptions {\n /** Pagination options. */\n paging?: BlogPaging$1;\n /**\n * List of category fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"SEO\"` and `\"URL\"`.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Creates a query to retrieve a list of categories.\n *\n *\n * The `queryCategories()` function builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder) object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/find) function.\n *\n * You can refine the query by chaining `CategoriesQueryBuilder` functions to the query. `CategoriesQueryBuilder` functions enable you to sort, filter, and control the results that `queryCategories` returns. Any functions chained to the `queryCategories()` function are applied in the order that they are called.\n *\n * `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override.\n * - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/limit)\n * - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/ascending)\n *\n * The following `CategoriesQueryBuilder` functions are supported for `queryCategories()`. For a full description of the `Categories` object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).\n * @public\n * @documentationMaturity preview\n * @param options - Options specifying which fields to return.\n */\n function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;\n interface QueryCategoriesOptions {\n /**\n * List of category fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"SEO\"` and `\"URL\"`.\n */\n fieldsets?: Field$2[] | undefined;\n }\n interface QueryOffsetResult$2 {\n currentPage: number;\n totalPages: number;\n totalCount: number;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CategoriesQueryResult extends QueryOffsetResult$2 {\n items: Category$1[];\n query: CategoriesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CategoriesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: string, value: string) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: string, value: any[]) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: string[]) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: string[]) => CategoriesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => CategoriesQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n type blogV3Category_universal_d_InitialCategoriesCopied = InitialCategoriesCopied;\n type blogV3Category_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type blogV3Category_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type blogV3Category_universal_d_BulkCreateCategoriesRequest = BulkCreateCategoriesRequest;\n type blogV3Category_universal_d_BulkCreateCategoriesResponse = BulkCreateCategoriesResponse;\n type blogV3Category_universal_d_BulkCategoryResult = BulkCategoryResult;\n type blogV3Category_universal_d_BulkUpdateCategoriesRequest = BulkUpdateCategoriesRequest;\n type blogV3Category_universal_d_MaskedCategory = MaskedCategory;\n type blogV3Category_universal_d_BulkUpdateCategoriesResponse = BulkUpdateCategoriesResponse;\n type blogV3Category_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type blogV3Category_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type blogV3Category_universal_d_GetCategoryRequest = GetCategoryRequest;\n type blogV3Category_universal_d_GetCategoryResponse = GetCategoryResponse;\n type blogV3Category_universal_d_GetCategoryBySlugRequest = GetCategoryBySlugRequest;\n type blogV3Category_universal_d_GetCategoryBySlugResponse = GetCategoryBySlugResponse;\n type blogV3Category_universal_d_ListCategoriesRequest = ListCategoriesRequest;\n type blogV3Category_universal_d_ListCategoriesResponse = ListCategoriesResponse;\n type blogV3Category_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type blogV3Category_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type blogV3Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type blogV3Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type blogV3Category_universal_d_CreateCategoryOptions = CreateCategoryOptions;\n type blogV3Category_universal_d_BulkCreateCategoriesOptions = BulkCreateCategoriesOptions;\n type blogV3Category_universal_d_BulkUpdateCategoriesOptions = BulkUpdateCategoriesOptions;\n type blogV3Category_universal_d_UpdateCategory = UpdateCategory;\n type blogV3Category_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const blogV3Category_universal_d_getCategory: typeof getCategory;\n type blogV3Category_universal_d_GetCategoryOptions = GetCategoryOptions;\n const blogV3Category_universal_d_getCategoryBySlug: typeof getCategoryBySlug;\n type blogV3Category_universal_d_GetCategoryBySlugOptions = GetCategoryBySlugOptions;\n const blogV3Category_universal_d_listCategories: typeof listCategories;\n type blogV3Category_universal_d_ListCategoriesOptions = ListCategoriesOptions;\n const blogV3Category_universal_d_queryCategories: typeof queryCategories;\n type blogV3Category_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n type blogV3Category_universal_d_CategoriesQueryResult = CategoriesQueryResult;\n type blogV3Category_universal_d_CategoriesQueryBuilder = CategoriesQueryBuilder;\n namespace blogV3Category_universal_d {\n export { __debug$2 as __debug, Category$1 as Category, CoverMedia$1 as CoverMedia, CoverMediaMediaOneOf$1 as CoverMediaMediaOneOf, SeoSchema$2 as SeoSchema, Keyword$2 as Keyword, Tag$2 as Tag, Settings$2 as Settings, blogV3Category_universal_d_InitialCategoriesCopied as InitialCategoriesCopied, blogV3Category_universal_d_CreateCategoryRequest as CreateCategoryRequest, Field$2 as Field, blogV3Category_universal_d_CreateCategoryResponse as CreateCategoryResponse, blogV3Category_universal_d_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest, blogV3Category_universal_d_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse, blogV3Category_universal_d_BulkCategoryResult as BulkCategoryResult, ItemMetadata$1 as ItemMetadata, ApplicationError$1 as ApplicationError, BulkActionMetadata$1 as BulkActionMetadata, blogV3Category_universal_d_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest, blogV3Category_universal_d_MaskedCategory as MaskedCategory, blogV3Category_universal_d_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse, blogV3Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest, blogV3Category_universal_d_UpdateCategoryResponse as UpdateCategoryResponse, blogV3Category_universal_d_GetCategoryRequest as GetCategoryRequest, blogV3Category_universal_d_GetCategoryResponse as GetCategoryResponse, blogV3Category_universal_d_GetCategoryBySlugRequest as GetCategoryBySlugRequest, blogV3Category_universal_d_GetCategoryBySlugResponse as GetCategoryBySlugResponse, blogV3Category_universal_d_ListCategoriesRequest as ListCategoriesRequest, BlogPaging$1 as BlogPaging, blogV3Category_universal_d_ListCategoriesResponse as ListCategoriesResponse, MetaData$2 as MetaData, blogV3Category_universal_d_QueryCategoriesRequest as QueryCategoriesRequest, Sorting$2 as Sorting, SortOrder$2 as SortOrder, PlatformQuery$2 as PlatformQuery, PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf, Paging$2 as Paging, CursorPaging$2 as CursorPaging, blogV3Category_universal_d_QueryCategoriesResponse as QueryCategoriesResponse, PagingMetadataV2$2 as PagingMetadataV2, Cursors$2 as Cursors, blogV3Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest, blogV3Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse, blogV3Category_universal_d_CreateCategoryOptions as CreateCategoryOptions, blogV3Category_universal_d_BulkCreateCategoriesOptions as BulkCreateCategoriesOptions, blogV3Category_universal_d_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions, blogV3Category_universal_d_UpdateCategory as UpdateCategory, blogV3Category_universal_d_UpdateCategoryOptions as UpdateCategoryOptions, blogV3Category_universal_d_getCategory as getCategory, blogV3Category_universal_d_GetCategoryOptions as GetCategoryOptions, blogV3Category_universal_d_getCategoryBySlug as getCategoryBySlug, blogV3Category_universal_d_GetCategoryBySlugOptions as GetCategoryBySlugOptions, blogV3Category_universal_d_listCategories as listCategories, blogV3Category_universal_d_ListCategoriesOptions as ListCategoriesOptions, blogV3Category_universal_d_queryCategories as queryCategories, blogV3Category_universal_d_QueryCategoriesOptions as QueryCategoriesOptions, blogV3Category_universal_d_CategoriesQueryResult as CategoriesQueryResult, blogV3Category_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder, };\n }\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Post {\n /**\n * Post ID.\n * @readonly\n */\n _id?: string;\n /** Post title. */\n title?: string;\n /**\n * Post excerpt.\n * Can be selected by a site contributor. By default, it is extracted from the content text's first characters.\n *\n * Max: 140 characters\n */\n excerpt?: string;\n /**\n * The post's content in plain text.\n * @readonly\n */\n contentText?: string | null;\n /** Date the post was first published. */\n firstPublishedDate?: Date;\n /**\n * Date the post was last published.\n * @readonly\n */\n lastPublishedDate?: Date;\n /** Post URL. */\n url?: string;\n /**\n * Part of a post's URL that refers to a specific post.\n *\n *\n * For example, `'https:/example.com/posts/my-post-slug'`.\n *\n */\n slug?: string;\n /** Whether the post is marked as featured. */\n featured?: boolean;\n /** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */\n pinned?: boolean;\n /**\n * [Category IDs](https://www.wix.com/velo/reference/wix-blog-backend/categories) of the post.\n *\n */\n categoryIds?: string[];\n /** Reserved for internal use. */\n coverMedia?: CoverMedia;\n /**\n * Post owner's [member ID](https://www.wix.com/velo/reference/wix-members-backend).\n *\n */\n memberId?: string;\n /**\n * Hashtags in the post.\n * @readonly\n */\n hashtags?: string[];\n /** Whether commenting on the post is enabled. */\n commentingEnabled?: boolean;\n /** Estimated reading time. */\n minutesToRead?: number;\n /** Image placed at the top of the blog page. Only displays on mobile devices. */\n heroImage?: string;\n /**\n * IDs of [tags](https://www.wix.com/velo/reference/wix-blog-backend/tags) the post is tagged with.\n *\n * @readonly\n */\n tagIds?: string[];\n /**\n * IDs of posts related to the post.\n * @readonly\n */\n relatedPostIds?: string[];\n /**\n * Pricing plan IDs.\n *\n *\n * If a post is assigned to a specific pricing plan.\n * @readonly\n */\n pricingPlanIds?: string[];\n /** ID of the post's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single post will share the same `translationId`. */\n translationId?: string | null;\n /**\n * Language the post is written in.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$1;\n /**\n * Reserved for internal use.\n * @readonly\n */\n content?: string | null;\n /**\n * Post owner's [contact ID](https://www.wix.com/velo/reference/wix-crm-backend/contacts).\n *\n */\n contactId?: string | null;\n /**\n * Post rich content\n * @readonly\n */\n richContent?: RichContent;\n /** Reserved for internal use. */\n contentId?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n mostRecentContributorId?: string | null;\n /**\n * Post moderation details.\n *\n *\n * Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers). Guest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or site owner.\n * @readonly\n */\n moderationDetails?: ModerationDetails;\n /** Post cover media. */\n media?: BlogMedia;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalCategoryIds?: string[];\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalRelatedPostIds?: string[];\n }\n interface CoverMedia extends CoverMediaMediaOneOf {\n /**\n * Is cover media enabled.\n * Selected by user whether to display cover media on the feed\n */\n enabled?: boolean;\n /** Whether cover media is displayed. */\n displayed?: boolean;\n /**\n * Whether the cover media is custom.\n *\n * `false` if the cover media is the first image or video in the post. `true` if set to some other image or video.\n */\n custom?: boolean;\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\n }\n /** @oneof */\n interface CoverMediaMediaOneOf {\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\n }\n interface PostCountInfo {\n /**\n * Total number of post comments\n * @readonly\n */\n comments?: number;\n /**\n * Total number of post likes\n * @readonly\n */\n likes?: number;\n /**\n * Total number of post views\n * @readonly\n */\n views?: number;\n }\n interface Metrics {\n /**\n * Total number of post comments.\n * @readonly\n */\n comments?: number;\n /**\n * Total number of post likes.\n * @readonly\n */\n likes?: number;\n /**\n * Total number of post views.\n * @readonly\n */\n views?: number;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema$1 {\n /** SEO tags information. */\n tags?: Tag$1[];\n /** SEO general settings. */\n settings?: Settings$1;\n }\n interface Keyword$1 {\n /** Keyword value */\n term?: string;\n /** Whether the keyword is the main focused */\n isMain?: boolean;\n }\n interface Tag$1 {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings$1 {\n /**\n * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.\n *\n *\n * Default: enabled\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page */\n keywords?: Keyword$1[];\n }\n interface RichContent {\n /** Node objects representing a rich content document. */\n nodes?: Node[];\n /** Object metadata. */\n metadata?: Metadata;\n /** Global styling for header, paragraph, block quote, and code block nodes in the object. */\n documentStyle?: DocumentStyle;\n }\n interface Node extends NodeDataOneOf {\n /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */\n type?: NodeType;\n /** Node ID. */\n _id?: string;\n /** A list of child nodes. */\n nodes?: Node[];\n /** Padding and background color styling for the node. */\n style?: NodeStyle;\n /** Data for a button node. */\n buttonData?: ButtonData;\n /** Data for a code block node. */\n codeBlockData?: CodeBlockData;\n /** Data for a divider node. */\n dividerData?: DividerData;\n /** Data for a file node. */\n fileData?: FileData;\n /** Data for a gallery node. */\n galleryData?: GalleryData;\n /** Data for a GIF node. */\n gifData?: GIFData;\n /** Data for a heading node. */\n headingData?: HeadingData;\n /** Data for an embedded HTML node. */\n htmlData?: HTMLData;\n /** Data for an image node. */\n imageData?: ImageData;\n /** Data for a link preview node. */\n linkPreviewData?: LinkPreviewData;\n /** Data for a map node. */\n mapData?: MapData;\n /** Data for a paragraph node. */\n paragraphData?: ParagraphData;\n /** Data for a poll node. */\n pollData?: PollData;\n /** Data for a text node. Used to apply decorations to text. */\n textData?: TextData;\n /** Data for an app embed node. */\n appEmbedData?: AppEmbedData;\n /** Data for a video node. */\n videoData?: VideoData;\n /** Data for an oEmbed node. */\n embedData?: EmbedData;\n /** Data for a collapsible list node. */\n collapsibleListData?: CollapsibleListData;\n /** Data for a table node. */\n tableData?: TableData;\n /** Data for a table cell node. */\n tableCellData?: TableCellData;\n /** Data for a custon external node. */\n externalData?: Record | null;\n /** Data for an audio node. */\n audioData?: AudioData;\n /** Data for an ordered list node. */\n orderedListData?: OrderedListData;\n /** Data for a bulleted list node. */\n bulletedListData?: BulletedListData;\n /** Data for a block quote node. */\n blockquoteData?: BlockquoteData;\n }\n /** @oneof */\n interface NodeDataOneOf {\n /** Data for a button node. */\n buttonData?: ButtonData;\n /** Data for a code block node. */\n codeBlockData?: CodeBlockData;\n /** Data for a divider node. */\n dividerData?: DividerData;\n /** Data for a file node. */\n fileData?: FileData;\n /** Data for a gallery node. */\n galleryData?: GalleryData;\n /** Data for a GIF node. */\n gifData?: GIFData;\n /** Data for a heading node. */\n headingData?: HeadingData;\n /** Data for an embedded HTML node. */\n htmlData?: HTMLData;\n /** Data for an image node. */\n imageData?: ImageData;\n /** Data for a link preview node. */\n linkPreviewData?: LinkPreviewData;\n /** Data for a map node. */\n mapData?: MapData;\n /** Data for a paragraph node. */\n paragraphData?: ParagraphData;\n /** Data for a poll node. */\n pollData?: PollData;\n /** Data for a text node. Used to apply decorations to text. */\n textData?: TextData;\n /** Data for an app embed node. */\n appEmbedData?: AppEmbedData;\n /** Data for a video node. */\n videoData?: VideoData;\n /** Data for an oEmbed node. */\n embedData?: EmbedData;\n /** Data for a collapsible list node. */\n collapsibleListData?: CollapsibleListData;\n /** Data for a table node. */\n tableData?: TableData;\n /** Data for a table cell node. */\n tableCellData?: TableCellData;\n /** Data for a custon external node. */\n externalData?: Record | null;\n /** Data for an audio node. */\n audioData?: AudioData;\n /** Data for an ordered list node. */\n orderedListData?: OrderedListData;\n /** Data for a bulleted list node. */\n bulletedListData?: BulletedListData;\n /** Data for a block quote node. */\n blockquoteData?: BlockquoteData;\n }\n enum NodeType {\n PARAGRAPH = \"PARAGRAPH\",\n TEXT = \"TEXT\",\n HEADING = \"HEADING\",\n BULLETED_LIST = \"BULLETED_LIST\",\n ORDERED_LIST = \"ORDERED_LIST\",\n LIST_ITEM = \"LIST_ITEM\",\n BLOCKQUOTE = \"BLOCKQUOTE\",\n CODE_BLOCK = \"CODE_BLOCK\",\n VIDEO = \"VIDEO\",\n DIVIDER = \"DIVIDER\",\n FILE = \"FILE\",\n GALLERY = \"GALLERY\",\n GIF = \"GIF\",\n HTML = \"HTML\",\n IMAGE = \"IMAGE\",\n LINK_PREVIEW = \"LINK_PREVIEW\",\n MAP = \"MAP\",\n POLL = \"POLL\",\n APP_EMBED = \"APP_EMBED\",\n BUTTON = \"BUTTON\",\n COLLAPSIBLE_LIST = \"COLLAPSIBLE_LIST\",\n TABLE = \"TABLE\",\n EMBED = \"EMBED\",\n COLLAPSIBLE_ITEM = \"COLLAPSIBLE_ITEM\",\n COLLAPSIBLE_ITEM_TITLE = \"COLLAPSIBLE_ITEM_TITLE\",\n COLLAPSIBLE_ITEM_BODY = \"COLLAPSIBLE_ITEM_BODY\",\n TABLE_CELL = \"TABLE_CELL\",\n TABLE_ROW = \"TABLE_ROW\",\n EXTERNAL = \"EXTERNAL\",\n AUDIO = \"AUDIO\"\n }\n interface NodeStyle {\n /** The top padding value in pixels. */\n paddingTop?: string | null;\n /** The bottom padding value in pixels. */\n paddingBottom?: string | null;\n /** The background color as a hexadecimal value. */\n backgroundColor?: string | null;\n }\n interface ButtonData {\n /** Styling for the button's container. */\n containerData?: PluginContainerData;\n /** The button type. */\n type?: Type;\n /** Styling for the button. */\n styles?: Styles;\n /** The text to display on the button. */\n text?: string | null;\n /** Button link details. */\n link?: Link;\n }\n interface Border {\n /** Border width in pixels. */\n width?: number | null;\n /** Border radius in pixels. */\n radius?: number | null;\n }\n interface Colors {\n /** The text color as a hexadecimal value. */\n text?: string | null;\n /** The border color as a hexadecimal value. */\n border?: string | null;\n /** The background color as a hexadecimal value. */\n background?: string | null;\n }\n interface PluginContainerData {\n /** The width of the node when it's displayed. */\n width?: PluginContainerDataWidth;\n /** The node's alignment within its container. */\n alignment?: PluginContainerDataAlignment;\n /** Spoiler cover settings for the node. */\n spoiler?: Spoiler;\n /** The height of the node when it's displayed. */\n height?: Height;\n /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. */\n textWrap?: boolean | null;\n }\n enum WidthType {\n /** Width matches the content width */\n CONTENT = \"CONTENT\",\n /** Small Width */\n SMALL = \"SMALL\",\n /** Width will match the original asset width */\n ORIGINAL = \"ORIGINAL\",\n /** coast-to-coast display */\n FULL_WIDTH = \"FULL_WIDTH\"\n }\n interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {\n /**\n * One of the following predefined width options:\n * `CONTENT`: The width of the container matches the content width.\n * `SMALL`: Small width.\n * `ORIGINAL`: The width of the container matches the original asset width.\n * `FULL_WIDTH`: Full width.\n */\n size?: WidthType;\n /** A custom width value in pixels. */\n custom?: string | null;\n }\n /** @oneof */\n interface PluginContainerDataWidthDataOneOf {\n /**\n * One of the following predefined width options:\n * `CONTENT`: The width of the container matches the content width.\n * `SMALL`: Small width.\n * `ORIGINAL`: The width of the container matches the original asset width.\n * `FULL_WIDTH`: Full width.\n */\n size?: WidthType;\n /** A custom width value in pixels. */\n custom?: string | null;\n }\n enum PluginContainerDataAlignment {\n /** Center Alignment */\n CENTER = \"CENTER\",\n /** Left Alignment */\n LEFT = \"LEFT\",\n /** Right Alignment */\n RIGHT = \"RIGHT\"\n }\n interface Spoiler {\n /** Sets whether the spoiler cover is enabled for this node. */\n enabled?: boolean | null;\n /** The description displayed on top of the spoiler cover. */\n description?: string | null;\n /** The text for the button used to remove the spoiler cover. */\n buttonText?: string | null;\n }\n interface Height {\n /** A custom height value in pixels. */\n custom?: string | null;\n }\n enum Type {\n /** Regular link button */\n LINK = \"LINK\",\n /** Triggers custom action that is defined in plugin configuration by the consumer */\n ACTION = \"ACTION\"\n }\n interface Styles {\n /** Border attributes. */\n border?: Border;\n /** Color attributes. */\n colors?: Colors;\n }\n interface Link extends LinkDataOneOf {\n /**\n * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:\n * `SELF` - Default. Opens the linked document in the same frame as the link.\n * `BLANK` - Opens the linked document in a new browser tab or window.\n * `PARENT` - Opens the linked document in the link's parent frame.\n * `TOP` - Opens the linked document in the full body of the link's browser tab or window.\n */\n target?: Target;\n /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */\n rel?: Rel;\n /** A serialized object used for a custom or external link panel. */\n customData?: string | null;\n /** The absolute URL for the linked document. */\n url?: string;\n /** The target node's ID. Used for linking to another node in this object. */\n anchor?: string;\n }\n /** @oneof */\n interface LinkDataOneOf {\n /** The absolute URL for the linked document. */\n url?: string;\n /** The target node's ID. Used for linking to another node in this object. */\n anchor?: string;\n }\n enum Target {\n /** Opens the linked document in the same frame as it was clicked (this is default) */\n SELF = \"SELF\",\n /** Opens the linked document in a new window or tab */\n BLANK = \"BLANK\",\n /** Opens the linked document in the parent frame */\n PARENT = \"PARENT\",\n /** Opens the linked document in the full body of the window */\n TOP = \"TOP\"\n }\n interface Rel {\n /** Indicates to search engine crawlers not to follow the link. */\n nofollow?: boolean | null;\n /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. */\n sponsored?: boolean | null;\n /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. */\n ugc?: boolean | null;\n /** Indicates that this link protect referral information from being passed to the target website. */\n noreferrer?: boolean | null;\n }\n interface CodeBlockData {\n /** Styling for the code block's text. */\n textStyle?: TextStyle;\n }\n interface TextStyle {\n /** Text alignment. Defaults to `AUTO`. */\n textAlignment?: TextAlignment;\n /** A CSS `line-height` value for the text as a unitless ratio. */\n lineHeight?: string | null;\n }\n enum TextAlignment {\n /** browser default, eqivalent to `initial` */\n AUTO = \"AUTO\",\n /** Left align */\n LEFT = \"LEFT\",\n /** Right align */\n RIGHT = \"RIGHT\",\n /** Center align */\n CENTER = \"CENTER\",\n /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */\n JUSTIFY = \"JUSTIFY\"\n }\n interface DividerData {\n /** Styling for the divider's container. */\n containerData?: PluginContainerData;\n /** Divider line style. */\n lineStyle?: LineStyle;\n /** Divider width. */\n width?: Width;\n /** Divider alignment. */\n alignment?: Alignment;\n }\n enum LineStyle {\n /** Single Line */\n SINGLE = \"SINGLE\",\n /** Double Line */\n DOUBLE = \"DOUBLE\",\n /** Dashed Line */\n DASHED = \"DASHED\",\n /** Dotted Line */\n DOTTED = \"DOTTED\"\n }\n enum Width {\n /** Large line */\n LARGE = \"LARGE\",\n /** Medium line */\n MEDIUM = \"MEDIUM\",\n /** Small line */\n SMALL = \"SMALL\"\n }\n enum Alignment {\n /** Center alignment */\n CENTER = \"CENTER\",\n /** Left alignment */\n LEFT = \"LEFT\",\n /** Right alignment */\n RIGHT = \"RIGHT\"\n }\n interface FileData {\n /** Styling for the file's container. */\n containerData?: PluginContainerData;\n /** The source for the file's data. */\n src?: FileSource;\n /** File name. */\n name?: string | null;\n /** File type. */\n type?: string | null;\n /** File size in KB. */\n size?: number | null;\n /** Settings for PDF files. */\n pdfSettings?: PDFSettings;\n /** File MIME type. */\n mimeType?: string | null;\n /** File path. */\n path?: string | null;\n }\n enum ViewMode {\n /** No PDF view */\n NONE = \"NONE\",\n /** Full PDF view */\n FULL = \"FULL\",\n /** Mini PDF view */\n MINI = \"MINI\"\n }\n interface FileSource extends FileSourceDataOneOf {\n /** Indicates whether the file's source is private. */\n private?: boolean | null;\n /** The absolute URL for the file's source. */\n url?: string | null;\n /** Custom ID. Use `id` instead. */\n custom?: string | null;\n /** An ID that's resolved to a URL by a resolver function. */\n _id?: string | null;\n }\n /** @oneof */\n interface FileSourceDataOneOf {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /** Custom ID. Use `id` instead. */\n custom?: string | null;\n /** An ID that's resolved to a URL by a resolver function. */\n _id?: string | null;\n }\n interface PDFSettings {\n /**\n * PDF view mode. One of the following:\n * `NONE` : The PDF isn't displayed.\n * `FULL` : A full page view of the PDF is displayed.\n * `MINI` : A mini view of the PDF is displayed.\n */\n viewMode?: ViewMode;\n /** Sets whether the PDF download button is disabled. */\n disableDownload?: boolean | null;\n /** Sets whether the PDF print button is disabled. */\n disablePrint?: boolean | null;\n }\n interface GalleryData {\n /** Styling for the gallery's container. */\n containerData?: PluginContainerData;\n /** The items in the gallery. */\n items?: Item[];\n /** Options for defining the gallery's appearance. */\n options?: GalleryOptions;\n /** Sets whether the gallery's expand button is disabled. */\n disableExpand?: boolean | null;\n /** Sets whether the gallery's download button is disabled. */\n disableDownload?: boolean | null;\n }\n interface Media {\n /** The source for the media's data. */\n src?: FileSource;\n /** Media width in pixels. */\n width?: number | null;\n /** Media height in pixels. */\n height?: number | null;\n /** Media duration in seconds. Only relevant for audio and video files. */\n duration?: number | null;\n }\n interface Image {\n /** Image file details. */\n media?: Media;\n /** Link details for images that are links. */\n link?: Link;\n }\n interface Video {\n /** Video file details. */\n media?: Media;\n /** Video thumbnail file details. */\n thumbnail?: Media;\n }\n interface Item extends ItemDataOneOf {\n /** Item title. */\n title?: string | null;\n /** Item's alternative text. */\n altText?: string | null;\n /** An image item. */\n image?: Image;\n /** A video item. */\n video?: Video;\n }\n /** @oneof */\n interface ItemDataOneOf {\n /** An image item. */\n image?: Image;\n /** A video item. */\n video?: Video;\n }\n interface GalleryOptions {\n /** Gallery layout. */\n layout?: Layout;\n /** Styling for gallery items. */\n item?: ItemStyle;\n /** Styling for gallery thumbnail images. */\n thumbnails?: Thumbnails;\n }\n enum LayoutType {\n /** Collage type */\n COLLAGE = \"COLLAGE\",\n /** Masonry type */\n MASONRY = \"MASONRY\",\n /** Grid type */\n GRID = \"GRID\",\n /** Thumbnail type */\n THUMBNAIL = \"THUMBNAIL\",\n /** Slider type */\n SLIDER = \"SLIDER\",\n /** Slideshow type */\n SLIDESHOW = \"SLIDESHOW\",\n /** Panorama type */\n PANORAMA = \"PANORAMA\",\n /** Column type */\n COLUMN = \"COLUMN\",\n /** Magic type */\n MAGIC = \"MAGIC\",\n /** Fullsize images type */\n FULLSIZE = \"FULLSIZE\"\n }\n enum Orientation {\n /** Rows Orientation */\n ROWS = \"ROWS\",\n /** Columns Orientation */\n COLUMNS = \"COLUMNS\"\n }\n enum Crop {\n /** Crop to fill */\n FILL = \"FILL\",\n /** Crop to fit */\n FIT = \"FIT\"\n }\n enum ThumbnailsAlignment {\n /** Top alignment */\n TOP = \"TOP\",\n /** Right alignment */\n RIGHT = \"RIGHT\",\n /** Bottom alignment */\n BOTTOM = \"BOTTOM\",\n /** Left alignment */\n LEFT = \"LEFT\",\n /** No thumbnail */\n NONE = \"NONE\"\n }\n interface Layout {\n /** Gallery layout type. */\n type?: LayoutType;\n /** Sets whether horizontal scroll is enabled. */\n horizontalScroll?: boolean | null;\n /** Gallery orientation. */\n orientation?: Orientation;\n /** The number of columns to display on full size screens. */\n numberOfColumns?: number | null;\n /** The number of columns to display on mobile screens. */\n mobileNumberOfColumns?: number | null;\n }\n interface ItemStyle {\n /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */\n targetSize?: number | null;\n /** Item ratio */\n ratio?: number | null;\n /** Sets how item images are cropped. */\n crop?: Crop;\n /** The spacing between items in pixels. */\n spacing?: number | null;\n }\n interface Thumbnails {\n /** Thumbnail alignment. */\n placement?: ThumbnailsAlignment;\n /** Spacing between thumbnails in pixels. */\n spacing?: number | null;\n }\n interface GIFData {\n /** Styling for the GIF's container. */\n containerData?: PluginContainerData;\n /** The source of the full size GIF. */\n original?: GIF;\n /** The source of the downsized GIF. */\n downsized?: GIF;\n /** Height in pixels. */\n height?: number;\n /** Width in pixels. */\n width?: number;\n }\n interface GIF {\n /** GIF format URL. */\n gif?: string | null;\n /** MP4 format URL. */\n mp4?: string | null;\n /** Thumbnail URL. */\n still?: string | null;\n }\n interface HeadingData {\n /** Heading level from 1-6. */\n level?: number;\n /** Styling for the heading text. */\n textStyle?: TextStyle;\n /** Indentation level from 1-6. */\n indentation?: number | null;\n }\n interface HTMLData extends HTMLDataDataOneOf {\n /** Styling for the HTML node's container. */\n containerData?: PluginContainerData;\n /** The type of HTML code. */\n source?: Source;\n /** The URL for the HTML code for the node. */\n url?: string;\n /** The HTML code for the node. */\n html?: string;\n /** Whether this is an AdSense element. Use `source` instead. */\n isAdsense?: boolean | null;\n }\n /** @oneof */\n interface HTMLDataDataOneOf {\n /** The URL for the HTML code for the node. */\n url?: string;\n /** The HTML code for the node. */\n html?: string;\n /** Whether this is an AdSense element. Use `source` instead. */\n isAdsense?: boolean | null;\n }\n enum Source {\n HTML = \"HTML\",\n ADSENSE = \"ADSENSE\"\n }\n interface ImageData {\n /** Styling for the image's container. */\n containerData?: PluginContainerData;\n /** Image file details. */\n image?: Media;\n /** Link details for images that are links. */\n link?: Link;\n /** Sets whether the image expands to full screen when clicked. */\n disableExpand?: boolean | null;\n /** Image's alternative text. */\n altText?: string | null;\n /** Image caption. */\n caption?: string | null;\n /** Sets whether the image's download button is disabled. */\n disableDownload?: boolean | null;\n }\n interface LinkPreviewData {\n /** Styling for the link preview's container. */\n containerData?: PluginContainerData;\n /** Link details. */\n link?: Link;\n /** Preview title. */\n title?: string | null;\n /** Preview thumbnail URL. */\n thumbnailUrl?: string | null;\n /** Preview description. */\n description?: string | null;\n /** The preview content as HTML. */\n html?: string | null;\n }\n interface MapData {\n /** Styling for the map's container. */\n containerData?: PluginContainerData;\n /** Map settings. */\n mapSettings?: MapSettings;\n }\n interface MapSettings {\n /** The address to display on the map. */\n address?: string | null;\n /** Sets whether the map is draggable. */\n draggable?: boolean | null;\n /** Sets whether the location marker is visible. */\n marker?: boolean | null;\n /** Sets whether street view control is enabled. */\n streetViewControl?: boolean | null;\n /** Sets whether zoom control is enabled. */\n zoomControl?: boolean | null;\n /** Location latitude. */\n lat?: number | null;\n /** Location longitude. */\n lng?: number | null;\n /** Location name. */\n locationName?: string | null;\n /** Sets whether view mode control is enabled. */\n viewModeControl?: boolean | null;\n /** Initial zoom value. */\n initialZoom?: number | null;\n /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */\n mapType?: MapType;\n }\n enum MapType {\n /** Roadmap map type */\n ROADMAP = \"ROADMAP\",\n /** Satellite map type */\n SATELITE = \"SATELITE\",\n /** Hybrid map type */\n HYBRID = \"HYBRID\",\n /** Terrain map type */\n TERRAIN = \"TERRAIN\"\n }\n interface ParagraphData {\n /** Styling for the paragraph text. */\n textStyle?: TextStyle;\n /** Indentation level from 1-6. */\n indentation?: number | null;\n }\n interface PollData {\n /** Styling for the poll's container. */\n containerData?: PluginContainerData;\n /** Poll data. */\n poll?: Poll;\n /** Layout settings for the poll and voting options. */\n layout?: PollDataLayout;\n /** Styling for the poll and voting options. */\n design?: Design;\n }\n enum ViewRole {\n /** Only Poll creator can view the results */\n CREATOR = \"CREATOR\",\n /** Anyone who voted can see the results */\n VOTERS = \"VOTERS\",\n /** Anyone can see the results, even if one didn't vote */\n EVERYONE = \"EVERYONE\"\n }\n enum VoteRole {\n /** Logged in member */\n SITE_MEMBERS = \"SITE_MEMBERS\",\n /** Anyone */\n ALL = \"ALL\"\n }\n interface Permissions {\n /** Sets who can view the poll results. */\n view?: ViewRole;\n /** Sets who can vote. */\n vote?: VoteRole;\n /** Sets whether one voter can vote multiple times. */\n allowMultipleVotes?: boolean | null;\n }\n interface Option {\n /** Option ID. */\n _id?: string | null;\n /** Option title. */\n title?: string | null;\n /** The image displayed with the option. */\n image?: Media;\n }\n interface PollSettings {\n /** Permissions settings for voting. */\n permissions?: Permissions;\n /** Sets whether voters are displayed in the vote results. */\n showVoters?: boolean | null;\n /** Sets whether the vote count is displayed. */\n showVotesCount?: boolean | null;\n }\n enum PollLayoutType {\n /** List */\n LIST = \"LIST\",\n /** Grid */\n GRID = \"GRID\"\n }\n enum PollLayoutDirection {\n /** Left-to-right */\n LTR = \"LTR\",\n /** Right-to-left */\n RTL = \"RTL\"\n }\n interface PollLayout {\n /** The layout for displaying the voting options. */\n type?: PollLayoutType;\n /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */\n direction?: PollLayoutDirection;\n /** Sets whether to display the main poll image. */\n enableImage?: boolean | null;\n }\n interface OptionLayout {\n /** Sets whether to display option images. */\n enableImage?: boolean | null;\n }\n enum BackgroundType {\n /** Color background type */\n COLOR = \"COLOR\",\n /** Image background type */\n IMAGE = \"IMAGE\",\n /** Gradiant background type */\n GRADIENT = \"GRADIENT\"\n }\n interface Gradient {\n /** The gradient angle in degrees. */\n angle?: number | null;\n /** The start color as a hexademical value. */\n startColor?: string | null;\n /** The end color as a hexademical value. */\n lastColor?: string | null;\n }\n interface Background extends BackgroundBackgroundOneOf {\n /** Background type. For each option, include the relevant details. */\n type?: BackgroundType;\n /** The background color as a hexademical value. */\n color?: string | null;\n /** An image to use for the background. */\n image?: Media;\n /** Details for a gradient background. */\n gradient?: Gradient;\n }\n /** @oneof */\n interface BackgroundBackgroundOneOf {\n /** The background color as a hexademical value. */\n color?: string | null;\n /** An image to use for the background. */\n image?: Media;\n /** Details for a gradient background. */\n gradient?: Gradient;\n }\n interface PollDesign {\n /** Background styling. */\n background?: Background;\n /** Border radius in pixels. */\n borderRadius?: number | null;\n }\n interface OptionDesign {\n /** Border radius in pixels. */\n borderRadius?: number | null;\n }\n interface Poll {\n /** Poll ID. */\n _id?: string | null;\n /** Poll title. */\n title?: string | null;\n /** Poll creator ID. */\n creatorId?: string | null;\n /** Main poll image. */\n image?: Media;\n /** Voting options. */\n options?: Option[];\n /** The poll's permissions and display settings. */\n settings?: PollSettings;\n }\n interface PollDataLayout {\n /** Poll layout settings. */\n poll?: PollLayout;\n /** Voting otpions layout settings. */\n options?: OptionLayout;\n }\n interface Design {\n /** Styling for the poll. */\n poll?: PollDesign;\n /** Styling for voting options. */\n options?: OptionDesign;\n }\n interface TextData {\n /** The text to apply decorations to. */\n text?: string;\n /** The decorations to apply. */\n decorations?: Decoration[];\n }\n /** Adds appearence changes to text */\n interface Decoration extends DecorationDataOneOf {\n /** The type of decoration to apply. */\n type?: DecorationType;\n /** Data for an anchor link decoration. */\n anchorData?: AnchorData;\n /** Data for a color decoration. */\n colorData?: ColorData;\n /** Data for an external link decoration. */\n linkData?: LinkData;\n /** Data for a mention decoration. */\n mentionData?: MentionData;\n /** Data for a font size decoration. */\n fontSizeData?: FontSizeData;\n /** Font weight for a bold decoration. */\n fontWeightValue?: number | null;\n /** Data for an italic decoration. */\n italicData?: boolean | null;\n /** Data for an underline decoration. */\n underlineData?: boolean | null;\n }\n /** @oneof */\n interface DecorationDataOneOf {\n /** Data for an anchor link decoration. */\n anchorData?: AnchorData;\n /** Data for a color decoration. */\n colorData?: ColorData;\n /** Data for an external link decoration. */\n linkData?: LinkData;\n /** Data for a mention decoration. */\n mentionData?: MentionData;\n /** Data for a font size decoration. */\n fontSizeData?: FontSizeData;\n /** Font weight for a bold decoration. */\n fontWeightValue?: number | null;\n /** Data for an italic decoration. */\n italicData?: boolean | null;\n /** Data for an underline decoration. */\n underlineData?: boolean | null;\n }\n enum DecorationType {\n BOLD = \"BOLD\",\n ITALIC = \"ITALIC\",\n UNDERLINE = \"UNDERLINE\",\n SPOILER = \"SPOILER\",\n ANCHOR = \"ANCHOR\",\n MENTION = \"MENTION\",\n LINK = \"LINK\",\n COLOR = \"COLOR\",\n FONT_SIZE = \"FONT_SIZE\",\n EXTERNAL = \"EXTERNAL\"\n }\n interface AnchorData {\n /** The target node's ID. */\n anchor?: string;\n }\n interface ColorData {\n /** The text's background color as a hexadecimal value. */\n background?: string | null;\n /** The text's foreground color as a hexadecimal value. */\n foreground?: string | null;\n }\n interface LinkData {\n /** Link details. */\n link?: Link;\n }\n interface MentionData {\n /** The mentioned user's name. */\n name?: string;\n /** The version of the user's name that appears after the `@` character in the mention. */\n slug?: string;\n /** Mentioned user's ID. */\n _id?: string | null;\n }\n interface FontSizeData {\n /** The units used for the font size. */\n unit?: FontType;\n /** Font size value. */\n value?: number | null;\n }\n enum FontType {\n PX = \"PX\",\n EM = \"EM\"\n }\n interface AppEmbedData extends AppEmbedDataAppDataOneOf {\n /** The type of Wix App content being embedded. */\n type?: AppType;\n /** The ID of the embedded content. */\n itemId?: string | null;\n /** The name of the embedded content. */\n name?: string | null;\n /** Deprecated: Use `image` instead. */\n imageSrc?: string | null;\n /** The URL for the embedded content. */\n url?: string | null;\n /** An image for the embedded content. */\n image?: Media;\n /** Data for embedded Wix Bookings content. */\n bookingData?: BookingData;\n /** Data for embedded Wix Events content. */\n eventData?: EventData;\n }\n /** @oneof */\n interface AppEmbedDataAppDataOneOf {\n /** Data for embedded Wix Bookings content. */\n bookingData?: BookingData;\n /** Data for embedded Wix Events content. */\n eventData?: EventData;\n }\n enum AppType {\n PRODUCT = \"PRODUCT\",\n EVENT = \"EVENT\",\n BOOKING = \"BOOKING\"\n }\n interface BookingData {\n /** Booking duration in minutes. */\n durations?: string | null;\n }\n interface EventData {\n /** Event schedule. */\n scheduling?: string | null;\n /** Event location. */\n location?: string | null;\n }\n interface VideoData {\n /** Styling for the video's container. */\n containerData?: PluginContainerData;\n /** Video details. */\n video?: Media;\n /** Video thumbnail details. */\n thumbnail?: Media;\n /** Sets whether the video's download button is disabled. */\n disableDownload?: boolean | null;\n /** Video title. */\n title?: string | null;\n /** Video options. */\n options?: PlaybackOptions;\n }\n interface PlaybackOptions {\n /** Sets whether the media will automatically start playing. */\n autoPlay?: boolean | null;\n /** Sets whether media's will be looped. */\n playInLoop?: boolean | null;\n /** Sets whether media's controls will be shown. */\n showControls?: boolean | null;\n }\n interface EmbedData {\n /** Styling for the oEmbed node's container. */\n containerData?: PluginContainerData;\n /** An [oEmbed](https://www.oembed.com) object. */\n oembed?: Oembed;\n /** Origin asset source. */\n src?: string | null;\n }\n interface Oembed {\n /** The resource type. */\n type?: string | null;\n /** The width of the resource specified in the `url` property in pixels. */\n width?: number | null;\n /** The height of the resource specified in the `url` property in pixels. */\n height?: number | null;\n /** Resource title. */\n title?: string | null;\n /** The source URL for the resource. */\n url?: string | null;\n /** HTML for embedding a video player. The HTML should have no padding or margins. */\n html?: string | null;\n /** The name of the author or owner of the resource. */\n authorName?: string | null;\n /** The URL for the author or owner of the resource. */\n authorUrl?: string | null;\n /** The name of the resource provider. */\n providerName?: string | null;\n /** The URL for the resource provider. */\n providerUrl?: string | null;\n /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */\n thumbnailUrl?: string | null;\n /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */\n thumbnailWidth?: string | null;\n /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */\n thumbnailHeight?: string | null;\n /** The URL for an embedded viedo. */\n videoUrl?: string | null;\n /** The oEmbed version number. This value must be `1.0`. */\n version?: string | null;\n }\n interface CollapsibleListData {\n /** Styling for the collapsible list's container. */\n containerData?: PluginContainerData;\n /** If `true`, only one item can be expanded at a time. */\n expandOnlyOne?: boolean | null;\n /** Sets which items are expanded when the page loads. */\n initialExpandedItems?: InitialExpandedItems;\n /** The direction of the text in the list. Either left-to-right or right-to-left. */\n direction?: Direction;\n /** If `true`, The collapsible item will appear in search results as an FAQ. */\n isQapageData?: boolean | null;\n }\n enum InitialExpandedItems {\n /** First item will be expended initally */\n FIRST = \"FIRST\",\n /** All items will expended initally */\n ALL = \"ALL\",\n /** All items collapsed initally */\n NONE = \"NONE\"\n }\n enum Direction {\n /** Left-to-right */\n LTR = \"LTR\",\n /** Right-to-left */\n RTL = \"RTL\"\n }\n interface TableData {\n /** Styling for the table's container. */\n containerData?: PluginContainerData;\n /** The table's dimensions. */\n dimensions?: Dimensions;\n /** Deprecated: Use `rowHeader` and `columnHeader` instead. */\n header?: boolean | null;\n /** Sets whether the table's first row is a header. */\n rowHeader?: boolean | null;\n /** Sets whether the table's first column is a header. */\n columnHeader?: boolean | null;\n }\n interface Dimensions {\n /** An array representing relative width of each column in relation to the other columns. */\n colsWidthRatio?: number[];\n /** An array representing the height of each row in pixels. */\n rowsHeight?: number[];\n /** An array representing the minimum width of each column in pixels. */\n colsMinWidth?: number[];\n }\n interface TableCellData {\n /** Styling for the cell's background color and text alignment. */\n cellStyle?: CellStyle;\n /** The cell's border colors. */\n borderColors?: BorderColors;\n }\n enum VerticalAlignment {\n /** Top alignment */\n TOP = \"TOP\",\n /** Middle alignment */\n MIDDLE = \"MIDDLE\",\n /** Bottom alignment */\n BOTTOM = \"BOTTOM\"\n }\n interface CellStyle {\n /** Vertical alignment for the cell's text. */\n verticalAlignment?: VerticalAlignment;\n /** Cell background color as a hexadecimal value. */\n backgroundColor?: string | null;\n }\n interface BorderColors {\n /** Left border color as a hexadecimal value. */\n left?: string | null;\n /** Right border color as a hexadecimal value. */\n right?: string | null;\n /** Top border color as a hexadecimal value. */\n top?: string | null;\n /** Bottom border color as a hexadecimal value. */\n bottom?: string | null;\n }\n /**\n * `NullValue` is a singleton enumeration to represent the null value for the\n * `Value` type union.\n *\n * The JSON representation for `NullValue` is JSON `null`.\n */\n enum NullValue {\n /** Null value. */\n NULL_VALUE = \"NULL_VALUE\"\n }\n /**\n * `ListValue` is a wrapper around a repeated field of values.\n *\n * The JSON representation for `ListValue` is JSON array.\n */\n interface ListValue {\n /** Repeated field of dynamically typed values. */\n values?: any[];\n }\n interface AudioData {\n /** Styling for the audio node's container. */\n containerData?: PluginContainerData;\n /** Audio file details. */\n audio?: Media;\n /** Sets whether the audio node's download button is disabled. */\n disableDownload?: boolean | null;\n /** Cover image. */\n coverImage?: Media;\n /** Track name. */\n name?: string | null;\n /** Author name. */\n authorName?: string | null;\n /** An HTML version of the audio node. */\n html?: string | null;\n }\n interface OrderedListData {\n /** Indentation level. */\n indentation?: number;\n }\n interface BulletedListData {\n /** Indentation level. */\n indentation?: number;\n }\n interface BlockquoteData {\n /** Indentation level. */\n indentation?: number;\n }\n interface Metadata {\n /** Schema version. */\n version?: number;\n /**\n * When the object was created.\n * @readonly\n */\n createdTimestamp?: Date;\n /** When the object was most recently updated. */\n updatedTimestamp?: Date;\n /** Object ID. */\n _id?: string | null;\n }\n interface DocumentStyle {\n /** Styling for H1 nodes. */\n headerOne?: TextNodeStyle;\n /** Styling for H2 nodes. */\n headerTwo?: TextNodeStyle;\n /** Styling for H3 nodes. */\n headerThree?: TextNodeStyle;\n /** Styling for H4 nodes. */\n headerFour?: TextNodeStyle;\n /** Styling for H5 nodes. */\n headerFive?: TextNodeStyle;\n /** Styling for H6 nodes. */\n headerSix?: TextNodeStyle;\n /** Styling for paragraph nodes. */\n paragraph?: TextNodeStyle;\n /** Styling for block quote nodes. */\n blockquote?: TextNodeStyle;\n /** Styling for code block nodes. */\n codeBlock?: TextNodeStyle;\n }\n interface TextNodeStyle {\n /** The decorations to apply to the node. */\n decorations?: Decoration[];\n /** Padding and background color for the node. */\n nodeStyle?: NodeStyle;\n /** Line height for text in the node. */\n lineHeight?: string | null;\n }\n interface ModerationDetails {\n /** Member ID of the person who submitted the post. */\n submittedBy?: string;\n /** Date and time the post was submitted for moderation. */\n submittedDate?: Date;\n /**\n * Status indicating whether the submission was approved or rejected by the moderator.\n *\n * Supported values: `'APPROVED'`, `'REJECTED'`, `'PENDING'`.\n */\n status?: ModerationStatusStatus;\n /** Member ID of the person who approved or rejected the post. */\n moderatedBy?: string | null;\n /** Date and time the post was approved or rejected by a moderator. */\n moderationDate?: Date;\n }\n enum ModerationStatusStatus {\n UNKNOWN = \"UNKNOWN\",\n APPROVED = \"APPROVED\",\n REJECTED = \"REJECTED\"\n }\n interface BlogMedia extends BlogMediaMediaOneOf {\n /** Whether cover media is displayed. */\n displayed?: boolean;\n /**\n * Whether the media is custom.\n *\n *\n * `false` if the media is the first image or video in the post. `true` if set to some other image or video.\",\n */\n custom?: boolean;\n /** Wix Media details. */\n wixMedia?: WixMedia;\n /** Embed media details. */\n embedMedia?: EmbedMedia;\n }\n /** @oneof */\n interface BlogMediaMediaOneOf {\n /** Wix Media details. */\n wixMedia?: WixMedia;\n /** Embed media details. */\n embedMedia?: EmbedMedia;\n }\n interface WixMedia {\n /** Thumbnail or image details. */\n image?: string;\n /** Video details. Optional */\n videoV2?: string;\n }\n interface VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /** Video format for example, mp4, hls. */\n format?: string;\n }\n interface EmbedMedia {\n /** Thumbnail details. */\n thumbnail?: EmbedThumbnail;\n /** Video details. */\n video?: EmbedVideo;\n }\n interface EmbedThumbnail {\n /** Thumbnail url. */\n url?: string;\n /** Thumbnail width. */\n width?: number;\n /** Thumbnail height. */\n height?: number;\n }\n interface EmbedVideo {\n /** Video url. */\n url?: string;\n /** Video width. */\n width?: number;\n /** Video height. */\n height?: number;\n }\n interface ListTemplatesRequest {\n /** Filter post templates by given template category ids */\n categoryIds?: string[];\n /** Filter post templates by provided language */\n language?: string | null;\n /** Returns post template categories when set to TRUE */\n listTemplateCategories?: boolean;\n /** Sort order by ascending/descending publish date. Default is ascending publish date sort */\n sort?: GetPostTemplatesSort;\n /** Pagination options. */\n paging?: BlogPaging;\n }\n enum GetPostTemplatesSort {\n /** Sorting by publishing date ascending */\n PUBLISHED_DATE_ASC = \"PUBLISHED_DATE_ASC\",\n /** Sorting by publishing date descending */\n PUBLISHED_DATE_DESC = \"PUBLISHED_DATE_DESC\"\n }\n interface BlogPaging {\n /**\n * Number of items to skip in the current sort order.\n *\n *\n * Default: `0`\n */\n offset?: number;\n /**\n * Number of items to return.\n *\n *\n * Default:`50`\n */\n limit?: number;\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n }\n interface ListTemplatesResponse {\n /** Available post templates */\n postTemplates?: Post[];\n /** Details on the paged set of posts templates returned. */\n postTemplatesMetaData?: MetaData$1;\n /** Post template categories. This value is returned empty unless asked explicitly */\n templateCategories?: Category[];\n }\n interface MetaData$1 {\n /** Number of items returned in this response. */\n count?: number;\n /**\n * Number of items skipped in the current sort order.\n *\n *\n */\n offset?: number;\n /** Total number of items that match the query. */\n total?: number;\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n }\n interface Category {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category label. Displayed in the Category Menu. */\n label?: string;\n /**\n * Number of posts in the category.\n * @readonly\n */\n postCount?: number;\n /**\n * Category URL.\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /** Category title. */\n title?: string;\n /**\n * __Deprecated.__ Use `coverImage` instead.\n * This property will be removed on June 30, 2023.\n *\n * Category cover image or video.\n */\n coverMedia?: CoverMedia;\n /**\n * Reserved for internal use.\n * @readonly\n */\n oldRank?: number;\n /**\n * __Deprecated.__ Use `displayPosition` instead.\n * This property will be removed on June 30, 2023.\n *\n * Category position in sequence.\n */\n rank?: number | null;\n /**\n * Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.\n *\n * Default: `-1`\n */\n displayPosition?: number | null;\n /**\n * ID of the category's translations. All translations of a single category share the same `translationId`.\n * @readonly\n */\n translationId?: string | null;\n /**\n * Category language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string;\n /** Category slug. For example, `'category-slug'`. */\n slug?: string;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$1;\n /** Category cover image. */\n coverImage?: string;\n }\n interface GetTemplateRequest {\n /** Post template id */\n postTemplateId: string;\n }\n interface GetTemplateResponse {\n /** Post template */\n postTemplate?: Post;\n }\n interface CreateDraftPostFromTemplateRequest {\n /** Post template id */\n postTemplateId: string;\n }\n interface CreateDraftPostFromTemplateResponse {\n /** Created draft post */\n draftPost?: DraftPost;\n }\n interface DraftPost {\n /**\n * Draft post ID.\n * @readonly\n */\n _id?: string;\n /** Draft post title. */\n title?: string;\n /**\n * Draft post excerpt.\n *\n * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.\n * This can be retrieved using the `GENERATED_EXCERPT` fieldset.\n */\n excerpt?: string | null;\n /** Whether the draft post is marked as featured. */\n featured?: boolean | null;\n /** Category IDs of the draft post. */\n categoryIds?: string[];\n /** Draft post owner's member ID. */\n memberId?: string | null;\n /** Hashtags in the post. */\n hashtags?: string[];\n /** Whether commenting on the draft post is enabled. */\n commentingEnabled?: boolean | null;\n /**\n * Estimated reading time of the draft post (calculated automatically).\n * @readonly\n */\n minutesToRead?: number;\n /** Image placed at the top of the blog page. */\n heroImage?: string;\n /** Tag IDs the draft post is tagged with. */\n tagIds?: string[];\n /** IDs of posts related to this draft post. */\n relatedPostIds?: string[];\n /** [Pricing plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan. */\n pricingPlanIds?: string[];\n /**\n * ID of the draft post's translations.\n *\n * All translations of a single post share the same `translationId`.\n */\n translationId?: string | null;\n /**\n * Language the draft post is written in.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n changeOrigin?: Origin;\n /**\n * Reserved for internal use.\n * @readonly\n */\n contentId?: string | null;\n /** Reserved for internal use. */\n editingSessionId?: string | null;\n /** Draft Post rich content. */\n richContent?: RichContent;\n /**\n * Status of the draft post.\n * @readonly\n */\n status?: Status;\n /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */\n moderationDetails?: ModerationDetails;\n /**\n * Reserved for internal use.\n * @readonly\n */\n mostRecentContributorId?: string | null;\n /**\n * Indicates if there are changes made to the draft post that have not yet been published.\n * @readonly\n */\n hasUnpublishedChanges?: boolean;\n /**\n * Date the draft post was last edited.\n * @readonly\n */\n editedDate?: Date;\n /**\n * Date the draft post is scheduled to be published.\n * @readonly\n */\n scheduledPublishDate?: Date;\n /** Reserved for internal use. */\n content?: Record | null;\n /** Date the post was first published. */\n firstPublishedDate?: Date;\n /** SEO data. */\n seoData?: SeoSchema$1;\n /** Reserved for internal use. */\n paidContentParagraph?: number | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n slugs?: string[];\n /**\n * Draft post URL preview. What the URL will look like once the post is published.\n * @readonly\n */\n url?: string;\n /**\n * Date the draft post was first created.\n * @readonly\n */\n _createdDate?: Date;\n /** SEO slug. */\n seoSlug?: string | null;\n /** Post cover media. */\n media?: BlogMedia;\n /** Number of paragraphs to display in a paid content preview for non-paying users. */\n previewTextParagraph?: number | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n }\n enum Origin {\n UNKNOWN = \"UNKNOWN\",\n /** Changed by admin */\n ADMIN = \"ADMIN\",\n /** Categories were changed */\n ADD_CATEGORIES = \"ADD_CATEGORIES\",\n /** Saved automatically */\n AUTO_SAVE = \"AUTO_SAVE\",\n /** Copied from template */\n COPY_TEMPLATE = \"COPY_TEMPLATE\",\n /** Imported */\n IMPORT = \"IMPORT\",\n /** Imported in bulk */\n IMPORT_BULK = \"IMPORT_BULK\",\n /** Imported with html import */\n IMPORT_HTML = \"IMPORT_HTML\",\n /** Patch import */\n IMPORT_PATCH = \"IMPORT_PATCH\",\n /** Changed language */\n LANGUAGE_CHANGE = \"LANGUAGE_CHANGE\",\n /** Saved manually */\n MANUAL_SAVE = \"MANUAL_SAVE\",\n /** Affected by migration */\n MIGRATION = \"MIGRATION\",\n /** Affected by moderation */\n MODERATION = \"MODERATION\",\n /** Moved to trash */\n MOVE_TO_TRASH = \"MOVE_TO_TRASH\",\n /** Pricing plans were changed */\n PRICING_PLANS_CHANGE = \"PRICING_PLANS_CHANGE\",\n /** Was provisioned */\n PROVISION = \"PROVISION\",\n /** Was published */\n PUBLISH = \"PUBLISH\",\n /** Owner was reassigned */\n REASSIGN_OWNER = \"REASSIGN_OWNER\",\n /** Was reblogged */\n REBLOG = \"REBLOG\",\n /** Was restored */\n RESTORE = \"RESTORE\",\n /** Reverted to draft */\n REVERT_TO_DRAFT = \"REVERT_TO_DRAFT\",\n /** Was translated */\n TRANSLATION = \"TRANSLATION\",\n /** Was unpublished */\n UNPUBLISH = \"UNPUBLISH\",\n /** Was unscheduled */\n UNSCHEDULE = \"UNSCHEDULE\",\n /** New edit session started which updated editing_session_id id */\n NEW_EDIT_SESSION = \"NEW_EDIT_SESSION\",\n /** Was scheduled by Later */\n SCHEDULING_SERVICE_SCHEDULE = \"SCHEDULING_SERVICE_SCHEDULE\",\n /** Was unscheduled by Later */\n SCHEDULING_SERVICE_UNSCHEDULE = \"SCHEDULING_SERVICE_UNSCHEDULE\",\n /** Was published by Later */\n SCHEDULING_SERVICE_PUBLISH = \"SCHEDULING_SERVICE_PUBLISH\",\n /** Was scheduled */\n SCHEDULE = \"SCHEDULE\",\n /** Was removed from moderation */\n REMOVE_FROM_MODERATION = \"REMOVE_FROM_MODERATION\",\n /** Was rejected from moderation */\n REJECT_FROM_MODERATION = \"REJECT_FROM_MODERATION\",\n /** Was approved in moderation */\n APPROVE_IN_MODERATION = \"APPROVE_IN_MODERATION\",\n /** Tag was deleted */\n DELETE_TAG = \"DELETE_TAG\"\n }\n enum Status {\n UNKNOWN = \"UNKNOWN\",\n /** Status indicating the draft post is published. */\n PUBLISHED = \"PUBLISHED\",\n /** Status indicating the draft post is unpublished. */\n UNPUBLISHED = \"UNPUBLISHED\",\n /** Status indicating the draft post is scheduled for publication. */\n SCHEDULED = \"SCHEDULED\",\n /** Status indicating the draft post is deleted. */\n DELETED = \"DELETED\",\n /**\n * Deprecated. Use `IN_REVIEW` instead. Status indicating the draft post is in review.\n * Target removal date 2023-06-30\n * Reserved for internal use.\n */\n IN_MODERATION = \"IN_MODERATION\",\n /** Status indicating the draft post is in review. */\n IN_REVIEW = \"IN_REVIEW\"\n }\n interface DraftPostTranslation {\n /** Post ID. */\n _id?: string;\n /** Post status. */\n status?: Status;\n /** Language the post is written in. */\n language?: string | null;\n /** Post slug. For example, 'post-slug'. */\n slug?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$1;\n /** Post URL. */\n url?: string;\n }\n interface GetTotalLikesPerMemberRequest {\n /** Member ID. */\n memberId: string;\n }\n interface GetTotalLikesPerMemberResponse {\n /** The total number of likes of the member. */\n total?: number;\n }\n interface PostLiked extends PostLikedInitiatorOneOf {\n /** ID of the liked post. */\n postId?: string;\n /** Member ID of person who liked the post (only returned when the member was logged in when liking the post). */\n memberId?: string | null;\n /** Visitor ID of person who liked the post when they are not logged in. */\n anonymousVisitorId?: string | null;\n }\n /** @oneof */\n interface PostLikedInitiatorOneOf {\n /** Member ID of person who liked the post (only returned when the member was logged in when liking the post). */\n memberId?: string | null;\n /** Visitor ID of person who liked the post when they are not logged in. */\n anonymousVisitorId?: string | null;\n }\n interface PostUnliked extends PostUnlikedInitiatorOneOf {\n /** ID of the unliked post. */\n postId?: string;\n /** Member ID of person who unliked the post (returned when the member was logged in when unliking the post). */\n memberId?: string | null;\n /** Visitor ID of person who unliked the post when they are not logged in. */\n anonymousVisitorId?: string | null;\n }\n /** @oneof */\n interface PostUnlikedInitiatorOneOf {\n /** Member ID of person who unliked the post (returned when the member was logged in when unliking the post). */\n memberId?: string | null;\n /** Visitor ID of person who unliked the post when they are not logged in. */\n anonymousVisitorId?: string | null;\n }\n interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {\n /** ID of the post which counters were updated. */\n postId?: string;\n /** Field of the updated counter. */\n updatedCounterField?: Field$1;\n /** New counter value. */\n counter?: number;\n /** Member ID of person who triggered the counter update */\n memberId?: string | null;\n /** Visitor ID if person that liked the post is not logged in */\n anonymousVisitorId?: string | null;\n }\n /** @oneof */\n interface PostCountersUpdatedInitiatorOneOf {\n /** Member ID of person who triggered the counter update */\n memberId?: string | null;\n /** Visitor ID if person that liked the post is not logged in */\n anonymousVisitorId?: string | null;\n }\n enum Field$1 {\n UNKNOWN = \"UNKNOWN\",\n /** Total comments field. */\n TOTAL_COMMENTS = \"TOTAL_COMMENTS\",\n /** Like count field. */\n LIKE_COUNT = \"LIKE_COUNT\",\n /** View count field. */\n VIEW_COUNT = \"VIEW_COUNT\",\n /** Rating count field */\n RATING_COUNT = \"RATING_COUNT\"\n }\n interface PostOwnerChanged {\n }\n interface InitialPostsCopied {\n /** Number of posts copied. */\n count?: number;\n }\n interface GetPostRequest {\n /** Post ID. */\n postId: string;\n /** Reserved for internal use. */\n fieldsToInclude?: PostFieldField[];\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n enum PostFieldField {\n UNKNOWN = \"UNKNOWN\",\n /** Deprecated use `METRICS` instead */\n COUNTERS = \"COUNTERS\",\n /** Includes Post url when present */\n URL = \"URL\",\n /** Includes Post content text string when present */\n CONTENT_TEXT = \"CONTENT_TEXT\",\n /** Includes Post metrics when present */\n METRICS = \"METRICS\",\n /** Includes SEO data */\n SEO = \"SEO\",\n /**\n * Includes Post content as a stringified DraftJS document\n * Reserved for internal use\n */\n CONTENT = \"CONTENT\",\n /**\n * Includes internal id field\n * Reserved for internal use\n */\n INTERNAL_ID = \"INTERNAL_ID\",\n /** Includes post owners Contact Id */\n CONTACT_ID = \"CONTACT_ID\",\n /** Includes post rich content */\n RICH_CONTENT = \"RICH_CONTENT\"\n }\n interface GetPostResponse {\n /** Post info. */\n post?: Post;\n }\n interface GetPostBySlugRequest {\n /** Slug of the post to retrieve. */\n slug: string;\n /** Reserved for internal use. */\n fieldsToInclude?: PostFieldField[];\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n interface GetPostBySlugResponse {\n /** Post info. */\n post?: Post;\n }\n interface ListPostsRequest {\n /**\n * Whether to return only featured posts.\n *\n * Default: `false`\n */\n featured?: boolean;\n /**\n * Hashtag filter.\n *\n * Pass an array of hashtags to return only posts containing any of the provided hashtags.\n * If omitted, all posts with or without hashtags are returned.\n */\n hashtags?: string[];\n /**\n * Category filter.\n *\n * Pass an array of category IDs to return only posts with any of the provided categories.\n * If omitted, all posts with or without associated categories are returned.\n */\n categoryIds?: string[];\n /**\n * Tag filter.\n *\n * Pass an array of tag IDs to return only posts with any of the provided tags.\n * If omitted, all posts with or without tags are returned.\n */\n tagIds?: string[];\n /** Sort order by descending view count, ascending or descending publish date, or default to descending by publish date with pinned posts first. */\n sort?: GetPostsSort;\n /** Pagination options. */\n paging?: BlogPaging;\n /** Reserved for internal use. */\n fieldsToInclude?: PostFieldField[];\n /**\n * Language filter.\n *\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /** Post owner's member ID. */\n memberId?: string | null;\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n enum GetPostsSort {\n /** Sorting by publishing date descending with pinned posts first. The default value */\n FEED = \"FEED\",\n /** Sorting by publishing date ascending */\n PUBLISHED_DATE_ASC = \"PUBLISHED_DATE_ASC\",\n /** Sorting by publishing date descending */\n PUBLISHED_DATE_DESC = \"PUBLISHED_DATE_DESC\",\n /** Sorting by view count descending */\n VIEW_COUNT = \"VIEW_COUNT\",\n /** Sorting by like count descending */\n LIKE_COUNT = \"LIKE_COUNT\",\n /** Sorting by title ascending */\n TITLE_ASC = \"TITLE_ASC\",\n /** Sorting by title descending */\n TITLE_DESC = \"TITLE_DESC\",\n /** Sorting by post rating descending. */\n RATING = \"RATING\"\n }\n interface ListPostsResponse {\n /** List of posts. */\n posts?: Post[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData$1;\n }\n interface QueryPostsRequest {\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Pagination options.\n */\n paging?: BlogPaging;\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Filter object.\n */\n filter?: Record | null;\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/wix-blog/blog/filter-and-sort).\n */\n sort?: Sorting$1[];\n /** Reserved for internal use. */\n fieldsToInclude?: PostFieldField[];\n /** Query options. */\n query?: PlatformQuery$1;\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformQuery$1 extends PlatformQueryPagingMethodOneOf$1 {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$1[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryPostsResponse {\n /** List of posts. */\n posts?: Post[];\n /**\n * __Deprecated.__ Use `pagingMetadata` instead.\n * This property will be removed on June 30, 2023.\n *\n * Details on the paged set of results returned.\n */\n metaData?: MetaData$1;\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface GetPostMetricsRequest {\n /** Post ID. */\n postId: string;\n }\n interface GetPostMetricsResponse {\n /** Post metrics. */\n metrics?: Metrics;\n }\n interface BulkGetPostMetricsRequest {\n /** Post IDs. */\n postIds: string[];\n }\n interface BulkGetPostMetricsResponse {\n /** Map of post.id to metrics */\n metrics?: Record;\n }\n interface BulkGetPostReactionsRequest {\n /** Post IDs. */\n postIds: string[];\n }\n interface BulkGetPostReactionsResponse {\n /** Map of post.id to reactions */\n reactionsMap?: Record;\n }\n interface Reactions {\n /**\n * Is post liked by the current user\n * @readonly\n */\n liked?: boolean;\n }\n interface ListDemoPostsRequest {\n /**\n * Whether to return only featured posts.\n *\n * Default: `false`\n */\n featured?: boolean;\n /**\n * Hashtag filter.\n *\n * Pass an array of hashtags to return only posts containing any of the provided hashtags.\n * If omitted, all posts with or without hashtags are returned.\n */\n hashtags?: string[];\n /**\n * Category filter.\n *\n * Pass an array of category IDs to return only posts with any of the provided categories.\n * If omitted, all posts with or without associated categories are returned.\n */\n categoryIds?: string[];\n /**\n * Tag filter.\n *\n * Pass an array of tag IDs to return only posts with any of the provided tags.\n * If omitted, all posts with or without tags are returned.\n */\n tagIds?: string[];\n /**\n * Sorting options.\n *\n * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.\n * - `VIEW_COUNT`: Ordered by total number of views in descending order.\n * - `LIKE_COUNT`: Ordered by total number of likes in descending order.\n * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.\n * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.\n * - `TITLE_ASC`: Ordered by `title` in ascening order.\n * - `TITLE_DESC`: Ordered by `title` in descending order.\n * - `RATING`: reserved for internal use.\n *\n * Default: `FEED`\n */\n sort?: GetPostsSort;\n /** Pagination options. */\n paging?: BlogPaging;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of post fields to be included in the response.\n */\n fieldsToInclude?: PostFieldField[];\n /**\n * Language filter.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * Pass a language to only receive posts that are in that language.\n * If omitted, posts in all languages are returned.\n */\n language?: string | null;\n /** Post owner's member ID. */\n memberId?: string | null;\n /**\n * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the post’s base fields are returned.\n */\n fieldsets?: PostFieldField[];\n }\n interface ListDemoPostsResponse {\n /** List of posts. */\n posts?: Post[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData$1;\n }\n interface OldBlogMigratedEvent {\n /** Instance id of new version of blog */\n newBlogInstanceId?: string;\n /** Instance id of old version of blog */\n oldBlogInstanceId?: string;\n }\n interface ListMigratedPostsRequest {\n /** New blog version instance id */\n instanceId: string;\n /** Cursor pointing to page of results */\n paging?: BlogCursorPaging;\n }\n interface BlogCursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n }\n interface ListMigratedPostsResponse {\n /** List of posts */\n posts?: Post[];\n /** Data of post in old blog by post id */\n postsMigrationMeta?: Record;\n /** Pagination */\n pagingMetaData?: CursorMetaData;\n }\n interface PostMigrationMetaData {\n /** Old blog instance id */\n instanceId?: string;\n /** Post id in old blog */\n postId?: string;\n /** Post author in old blog */\n author?: string | null;\n /** Post slug in old blog */\n slug?: string | null;\n }\n interface CursorMetaData {\n /** Cursor pointing to next result page. */\n next?: string | null;\n }\n /** Get Blog Publications Count Stats request */\n interface QueryPublicationsCountStatsRequest {\n /** Start of time range to return, in ISO 8601 date and time format. */\n rangeStart?: Date;\n /** Non-inclusive end of time range to return, in ISO 8601 date and time format. */\n rangeEnd?: Date;\n /** Order of the returned results. */\n order?: QueryPublicationsCountStatsRequestOrder;\n /** Number of months to include in the response. */\n months?: number;\n /**\n * Language filter\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /** Timezone of the client. */\n timeZone?: string | null;\n }\n enum QueryPublicationsCountStatsRequestOrder {\n UNKNOWN = \"UNKNOWN\",\n OLDEST = \"OLDEST\",\n NEWEST = \"NEWEST\"\n }\n /** Get Blog Publications Count Stats response */\n interface QueryPublicationsCountStatsResponse {\n /** Chronologically ordered list of publications. */\n stats?: PeriodPublicationsCount[];\n }\n /** Publications count for a specific time period */\n interface PeriodPublicationsCount {\n /** Start of time range in ISO 8601 date and time format. */\n periodStart?: Date;\n /** Number of posts published during this month. */\n publicationsCount?: number;\n }\n /** Get Blog Post Count Stats request */\n interface QueryPostCountStatsRequest {\n /** Start of time range to return, in ISO 8601 date and time format. */\n rangeStart?: Date;\n /**\n * __Deprecated.__ Use `months` instead.\n * This property will be removed on June 30, 2023.\n *\n * Non-inclusive end of time range to return, in ISO 8601 date and time format.\n */\n rangeEnd?: Date;\n /**\n * Order of returned results.\n *\n * - `OLDEST`: posts by date in ascending order.\n * - `NEWEST`: posts by date in descending order.\n *\n * Default: `OLDEST`\n */\n order?: Order;\n /** Number of months to include in response. */\n months?: number;\n /**\n * Language filter.\n *\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Time zone to use when calculating the start of the month.\n *\n * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.\n */\n timeZone?: string | null;\n }\n enum Order {\n UNKNOWN = \"UNKNOWN\",\n OLDEST = \"OLDEST\",\n NEWEST = \"NEWEST\"\n }\n /** Get Blog Post Count Stats response */\n interface QueryPostCountStatsResponse {\n /** List of posts in specified order. */\n stats?: PeriodPostCount[];\n }\n /** Post count for a specific time period */\n interface PeriodPostCount {\n /** Start of time range in ISO 8601 date and time format. */\n periodStart?: Date;\n /** Number of posts published during this month. */\n postCount?: number;\n }\n interface GetTotalPublicationsRequest {\n /** Language filter */\n language?: string | null;\n }\n interface GetTotalPublicationsResponse {\n /** Total amount of publications. */\n total?: number;\n }\n interface GetTotalPostsRequest {\n /**\n * Language filter.\n *\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n }\n interface GetTotalPostsResponse {\n /** Total amount of published posts. */\n total?: number;\n }\n interface SendActionEventRequest extends SendActionEventRequestActionOneOf {\n entityId?: string;\n postLikedAction?: PostLiked;\n postCountersUpdated?: PostCountersUpdated;\n }\n /** @oneof */\n interface SendActionEventRequestActionOneOf {\n postLikedAction?: PostLiked;\n postCountersUpdated?: PostCountersUpdated;\n }\n interface SendActionEventResponse {\n }\n interface ListTemplatesOptions {\n /** Filter post templates by given template category ids */\n categoryIds?: string[];\n /** Filter post templates by provided language */\n language?: string | null;\n /** Returns post template categories when set to TRUE */\n listTemplateCategories?: boolean;\n /** Sort order by ascending/descending publish date. Default is ascending publish date sort */\n sort?: GetPostTemplatesSort;\n /** Pagination options. */\n paging?: BlogPaging;\n }\n /**\n * Gets a post by the specified ID.\n *\n *\n * The `getPost()` function returns a Promise that resolves to a post whose ID matches the given ID.\n *\n * @param postId - Post ID.\n * @public\n * @documentationMaturity preview\n * @requiredField postId\n * @param options - Options specifying which fields to return.\n * @returns Fulfilled - The requested post.\n */\n function getPost(postId: string, options?: GetPostOptions): Promise;\n interface GetPostOptions {\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n /**\n * Gets a post by the provided slug.\n *\n *\n * The `getPostBySlug()` function returns a Promise that resolves to a post whose slug matches the given slug.\n *\n * The `slug` is the end of a post's URL that refers to a specific post. For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`, the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title, unless specified otherwise.\n * @public\n * @documentationMaturity preview\n * @requiredField GetPostBySlugRequest\n * @requiredField slug\n * @param options - Options specifying which fields to return.\n * @param slug - Slug of the post to retrieve.\n *\n * The end of a post's URL, for example, `https:/example.com/blog/post/my-post-slug`. Case sensitive and generally based on the post title if not specified.\n * @returns Fulfilled - The requested post.\n */\n function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise;\n interface GetPostBySlugOptions {\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n /**\n * Retrieves a list of published posts.\n *\n *\n * The `listPosts()` function returns a Promise that resolves to a list of up to 100 published posts.\n *\n * Using the `options` parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.\n *\n * By default, the list is sorted by `firstPublishedDate` in descending order, and the amount of posts returned is 50.\n * @public\n * @documentationMaturity preview\n * @param options - Sort, filter, and paging options.\n * @returns Fulfilled - List of retrieved posts.\n */\n function listPosts(options?: ListPostsOptions): Promise;\n interface ListPostsOptions {\n /** Featured filter. Whether to return only featured posts. */\n featured?: boolean;\n /**\n * List of hashtags to filter for.\n *\n *\n * Default: All hashtags\n */\n hashtags?: string[];\n /**\n * List of category IDs to filter for.\n *\n *\n * Default: All categories\n */\n categoryIds?: string[];\n /**\n * List of [tag IDs](https://www.wix.com/velo/reference/wix-blog-backend/tags) to filter for.\n *\n *\n * Default: All tags\n */\n tagIds?: string[];\n /**\n * Sort order.\n *\n * Sort by one of the following:\n * - `'VIEW_COUNT'` descending view count\n * - `'LIKE_COUNT'` descending like count\n * - `'PUBLISHED_DATE_ASC'` ascending published date\n * - `'PUBLISHED_DATE_DESC'` descending published date\n * - `'TITLE_ASC'` ascending title\n * - `'TITLE_DESC'` descending title\n *\n * Default: `'PUBLISHED_DATE_DESC'`\n */\n sort?: GetPostsSort;\n /** Pagination options. */\n paging?: BlogPaging;\n /**\n * Language filter.\n *\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Member ID to filter for.\n *\n *\n * Default: All members\n */\n memberId?: string | null;\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[];\n }\n /**\n * Creates a query to retrieve a list of posts.\n *\n *\n * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder) object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/find) function.\n *\n * You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.\n *\n * `queryPosts()` runs with these `PostsQueryBuilder` defaults that can be overridden:\n * + [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/limit)\n * + [`descending('firstPublishedDate')`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/descending)\n *\n * Note that the default limit is `'50'`, but the max limit is `'100'`.\n *\n * To learn how to query posts, refer to the table below.\n *\n * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult/items) property in [`PostsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult).\n * @public\n * @documentationMaturity preview\n * @param options - Options specifying which fields to return.\n */\n function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;\n interface QueryPostsOptions {\n /**\n * List of post fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"CONTACT_ID\"`, `\"CONTENT_TEXT\"`, `\"METRICS\"`, `\"SEO\"`, and `\"URL\"`.\n */\n fieldsets?: PostFieldField[] | undefined;\n }\n interface QueryOffsetResult$1 {\n currentPage: number;\n totalPages: number;\n totalCount: number;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PostsQueryResult extends QueryOffsetResult$1 {\n items: Post[];\n query: PostsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface PostsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: string, value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: string, value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: string, value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: string, value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: string, value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: string, value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: string, value: string) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: string, value: any[]) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasAll: (propertyName: string, value: any[]) => PostsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: string[]) => PostsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: string[]) => PostsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => PostsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => PostsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Gets a specified post's metrics.\n *\n *\n * The `getPostMetrics()` function returns a Promise that resolves to the specified post's metrics.\n *\n * A post's metrics include the comments, likes, and views the post receives.\n * @param postId - Post ID.\n * @public\n * @documentationMaturity preview\n * @requiredField postId\n * @returns Fulfilled - Post metrics.\n */\n function getPostMetrics(postId: string): Promise;\n interface ListDemoPostsOptions {\n /**\n * Whether to return only featured posts.\n *\n * Default: `false`\n */\n featured?: boolean;\n /**\n * Hashtag filter.\n *\n * Pass an array of hashtags to return only posts containing any of the provided hashtags.\n * If omitted, all posts with or without hashtags are returned.\n */\n hashtags?: string[];\n /**\n * Category filter.\n *\n * Pass an array of category IDs to return only posts with any of the provided categories.\n * If omitted, all posts with or without associated categories are returned.\n */\n categoryIds?: string[];\n /**\n * Tag filter.\n *\n * Pass an array of tag IDs to return only posts with any of the provided tags.\n * If omitted, all posts with or without tags are returned.\n */\n tagIds?: string[];\n /**\n * Sorting options.\n *\n * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.\n * - `VIEW_COUNT`: Ordered by total number of views in descending order.\n * - `LIKE_COUNT`: Ordered by total number of likes in descending order.\n * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.\n * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.\n * - `TITLE_ASC`: Ordered by `title` in ascening order.\n * - `TITLE_DESC`: Ordered by `title` in descending order.\n * - `RATING`: reserved for internal use.\n *\n * Default: `FEED`\n */\n sort?: GetPostsSort;\n /** Pagination options. */\n paging?: BlogPaging;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of post fields to be included in the response.\n */\n fieldsToInclude?: PostFieldField[];\n /**\n * Language filter.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * Pass a language to only receive posts that are in that language.\n * If omitted, posts in all languages are returned.\n */\n language?: string | null;\n /** Post owner's member ID. */\n memberId?: string | null;\n /**\n * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the post’s base fields are returned.\n */\n fieldsets?: PostFieldField[];\n }\n interface ListMigratedPostsOptions {\n /** Cursor pointing to page of results */\n paging?: BlogCursorPaging;\n }\n interface QueryPublicationsCountStatsOptions {\n /** Start of time range to return, in ISO 8601 date and time format. */\n rangeStart?: Date;\n /** Non-inclusive end of time range to return, in ISO 8601 date and time format. */\n rangeEnd?: Date;\n /** Order of the returned results. */\n order?: QueryPublicationsCountStatsRequestOrder;\n /** Number of months to include in the response. */\n months?: number;\n /**\n * Language filter\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /** Timezone of the client. */\n timeZone?: string | null;\n }\n /**\n * Retrieves the number of published posts per month within a specified time range.\n *\n *\n * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.\n *\n * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.\n *\n * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.\n * @public\n * @documentationMaturity preview\n * @param options - Options specifying time frame, sort, and filter.\n * @returns Fulfilled - Post count stats.\n */\n function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise;\n interface QueryPostCountStatsOptions {\n /** Start of time range to return, in ISO 8601 date and time format. */\n rangeStart?: Date;\n /** Reserved for internal use. */\n rangeEnd?: Date;\n /**\n * Sort order.\n * Use `'ASC'` for ascending order or `'DESC'` for descending order.\n *\n * Default: `ASC`\n */\n order?: Order;\n /** Number of months to include in response. */\n months?: number;\n /**\n * Language filter.\n *\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Time zone to use when calculating the start of the month.\n *\n * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.\n */\n timeZone?: string | null;\n }\n interface GetTotalPublicationsOptions {\n /** Language filter */\n language?: string | null;\n }\n /**\n * Gets the total amount of published posts on the blog.\n *\n *\n * The `getTotalPosts()` function returns a Promise that resolves to the total amount of published posts on your blog's site.\n *\n *\n * You can use the `language` option to filter posts for a specified language.\n * @public\n * @documentationMaturity preview\n * @param options - Language Options.\n * @returns Fulfilled - Total number of posts.\n */\n function getTotalPosts(options?: GetTotalPostsOptions): Promise;\n interface GetTotalPostsOptions {\n /**\n * Language filter.\n *\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n }\n interface SendActionEventOptions {\n entityId?: string;\n postLikedAction?: PostLiked;\n postCountersUpdated?: PostCountersUpdated;\n }\n type blogV3Post_universal_d_Post = Post;\n type blogV3Post_universal_d_CoverMedia = CoverMedia;\n type blogV3Post_universal_d_CoverMediaMediaOneOf = CoverMediaMediaOneOf;\n type blogV3Post_universal_d_PostCountInfo = PostCountInfo;\n type blogV3Post_universal_d_Metrics = Metrics;\n type blogV3Post_universal_d_RichContent = RichContent;\n type blogV3Post_universal_d_Node = Node;\n type blogV3Post_universal_d_NodeDataOneOf = NodeDataOneOf;\n type blogV3Post_universal_d_NodeType = NodeType;\n const blogV3Post_universal_d_NodeType: typeof NodeType;\n type blogV3Post_universal_d_NodeStyle = NodeStyle;\n type blogV3Post_universal_d_ButtonData = ButtonData;\n type blogV3Post_universal_d_Border = Border;\n type blogV3Post_universal_d_Colors = Colors;\n type blogV3Post_universal_d_PluginContainerData = PluginContainerData;\n type blogV3Post_universal_d_WidthType = WidthType;\n const blogV3Post_universal_d_WidthType: typeof WidthType;\n type blogV3Post_universal_d_PluginContainerDataWidth = PluginContainerDataWidth;\n type blogV3Post_universal_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;\n type blogV3Post_universal_d_PluginContainerDataAlignment = PluginContainerDataAlignment;\n const blogV3Post_universal_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;\n type blogV3Post_universal_d_Spoiler = Spoiler;\n type blogV3Post_universal_d_Height = Height;\n type blogV3Post_universal_d_Type = Type;\n const blogV3Post_universal_d_Type: typeof Type;\n type blogV3Post_universal_d_Styles = Styles;\n type blogV3Post_universal_d_Link = Link;\n type blogV3Post_universal_d_LinkDataOneOf = LinkDataOneOf;\n type blogV3Post_universal_d_Target = Target;\n const blogV3Post_universal_d_Target: typeof Target;\n type blogV3Post_universal_d_Rel = Rel;\n type blogV3Post_universal_d_CodeBlockData = CodeBlockData;\n type blogV3Post_universal_d_TextStyle = TextStyle;\n type blogV3Post_universal_d_TextAlignment = TextAlignment;\n const blogV3Post_universal_d_TextAlignment: typeof TextAlignment;\n type blogV3Post_universal_d_DividerData = DividerData;\n type blogV3Post_universal_d_LineStyle = LineStyle;\n const blogV3Post_universal_d_LineStyle: typeof LineStyle;\n type blogV3Post_universal_d_Width = Width;\n const blogV3Post_universal_d_Width: typeof Width;\n type blogV3Post_universal_d_Alignment = Alignment;\n const blogV3Post_universal_d_Alignment: typeof Alignment;\n type blogV3Post_universal_d_FileData = FileData;\n type blogV3Post_universal_d_ViewMode = ViewMode;\n const blogV3Post_universal_d_ViewMode: typeof ViewMode;\n type blogV3Post_universal_d_FileSource = FileSource;\n type blogV3Post_universal_d_FileSourceDataOneOf = FileSourceDataOneOf;\n type blogV3Post_universal_d_PDFSettings = PDFSettings;\n type blogV3Post_universal_d_GalleryData = GalleryData;\n type blogV3Post_universal_d_Media = Media;\n type blogV3Post_universal_d_Image = Image;\n type blogV3Post_universal_d_Video = Video;\n type blogV3Post_universal_d_Item = Item;\n type blogV3Post_universal_d_ItemDataOneOf = ItemDataOneOf;\n type blogV3Post_universal_d_GalleryOptions = GalleryOptions;\n type blogV3Post_universal_d_LayoutType = LayoutType;\n const blogV3Post_universal_d_LayoutType: typeof LayoutType;\n type blogV3Post_universal_d_Orientation = Orientation;\n const blogV3Post_universal_d_Orientation: typeof Orientation;\n type blogV3Post_universal_d_Crop = Crop;\n const blogV3Post_universal_d_Crop: typeof Crop;\n type blogV3Post_universal_d_ThumbnailsAlignment = ThumbnailsAlignment;\n const blogV3Post_universal_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;\n type blogV3Post_universal_d_Layout = Layout;\n type blogV3Post_universal_d_ItemStyle = ItemStyle;\n type blogV3Post_universal_d_Thumbnails = Thumbnails;\n type blogV3Post_universal_d_GIFData = GIFData;\n type blogV3Post_universal_d_GIF = GIF;\n type blogV3Post_universal_d_HeadingData = HeadingData;\n type blogV3Post_universal_d_HTMLData = HTMLData;\n type blogV3Post_universal_d_HTMLDataDataOneOf = HTMLDataDataOneOf;\n type blogV3Post_universal_d_Source = Source;\n const blogV3Post_universal_d_Source: typeof Source;\n type blogV3Post_universal_d_ImageData = ImageData;\n type blogV3Post_universal_d_LinkPreviewData = LinkPreviewData;\n type blogV3Post_universal_d_MapData = MapData;\n type blogV3Post_universal_d_MapSettings = MapSettings;\n type blogV3Post_universal_d_MapType = MapType;\n const blogV3Post_universal_d_MapType: typeof MapType;\n type blogV3Post_universal_d_ParagraphData = ParagraphData;\n type blogV3Post_universal_d_PollData = PollData;\n type blogV3Post_universal_d_ViewRole = ViewRole;\n const blogV3Post_universal_d_ViewRole: typeof ViewRole;\n type blogV3Post_universal_d_VoteRole = VoteRole;\n const blogV3Post_universal_d_VoteRole: typeof VoteRole;\n type blogV3Post_universal_d_Permissions = Permissions;\n type blogV3Post_universal_d_Option = Option;\n type blogV3Post_universal_d_PollSettings = PollSettings;\n type blogV3Post_universal_d_PollLayoutType = PollLayoutType;\n const blogV3Post_universal_d_PollLayoutType: typeof PollLayoutType;\n type blogV3Post_universal_d_PollLayoutDirection = PollLayoutDirection;\n const blogV3Post_universal_d_PollLayoutDirection: typeof PollLayoutDirection;\n type blogV3Post_universal_d_PollLayout = PollLayout;\n type blogV3Post_universal_d_OptionLayout = OptionLayout;\n type blogV3Post_universal_d_BackgroundType = BackgroundType;\n const blogV3Post_universal_d_BackgroundType: typeof BackgroundType;\n type blogV3Post_universal_d_Gradient = Gradient;\n type blogV3Post_universal_d_Background = Background;\n type blogV3Post_universal_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;\n type blogV3Post_universal_d_PollDesign = PollDesign;\n type blogV3Post_universal_d_OptionDesign = OptionDesign;\n type blogV3Post_universal_d_Poll = Poll;\n type blogV3Post_universal_d_PollDataLayout = PollDataLayout;\n type blogV3Post_universal_d_Design = Design;\n type blogV3Post_universal_d_TextData = TextData;\n type blogV3Post_universal_d_Decoration = Decoration;\n type blogV3Post_universal_d_DecorationDataOneOf = DecorationDataOneOf;\n type blogV3Post_universal_d_DecorationType = DecorationType;\n const blogV3Post_universal_d_DecorationType: typeof DecorationType;\n type blogV3Post_universal_d_AnchorData = AnchorData;\n type blogV3Post_universal_d_ColorData = ColorData;\n type blogV3Post_universal_d_LinkData = LinkData;\n type blogV3Post_universal_d_MentionData = MentionData;\n type blogV3Post_universal_d_FontSizeData = FontSizeData;\n type blogV3Post_universal_d_FontType = FontType;\n const blogV3Post_universal_d_FontType: typeof FontType;\n type blogV3Post_universal_d_AppEmbedData = AppEmbedData;\n type blogV3Post_universal_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;\n type blogV3Post_universal_d_AppType = AppType;\n const blogV3Post_universal_d_AppType: typeof AppType;\n type blogV3Post_universal_d_BookingData = BookingData;\n type blogV3Post_universal_d_EventData = EventData;\n type blogV3Post_universal_d_VideoData = VideoData;\n type blogV3Post_universal_d_PlaybackOptions = PlaybackOptions;\n type blogV3Post_universal_d_EmbedData = EmbedData;\n type blogV3Post_universal_d_Oembed = Oembed;\n type blogV3Post_universal_d_CollapsibleListData = CollapsibleListData;\n type blogV3Post_universal_d_InitialExpandedItems = InitialExpandedItems;\n const blogV3Post_universal_d_InitialExpandedItems: typeof InitialExpandedItems;\n type blogV3Post_universal_d_Direction = Direction;\n const blogV3Post_universal_d_Direction: typeof Direction;\n type blogV3Post_universal_d_TableData = TableData;\n type blogV3Post_universal_d_Dimensions = Dimensions;\n type blogV3Post_universal_d_TableCellData = TableCellData;\n type blogV3Post_universal_d_VerticalAlignment = VerticalAlignment;\n const blogV3Post_universal_d_VerticalAlignment: typeof VerticalAlignment;\n type blogV3Post_universal_d_CellStyle = CellStyle;\n type blogV3Post_universal_d_BorderColors = BorderColors;\n type blogV3Post_universal_d_NullValue = NullValue;\n const blogV3Post_universal_d_NullValue: typeof NullValue;\n type blogV3Post_universal_d_ListValue = ListValue;\n type blogV3Post_universal_d_AudioData = AudioData;\n type blogV3Post_universal_d_OrderedListData = OrderedListData;\n type blogV3Post_universal_d_BulletedListData = BulletedListData;\n type blogV3Post_universal_d_BlockquoteData = BlockquoteData;\n type blogV3Post_universal_d_Metadata = Metadata;\n type blogV3Post_universal_d_DocumentStyle = DocumentStyle;\n type blogV3Post_universal_d_TextNodeStyle = TextNodeStyle;\n type blogV3Post_universal_d_ModerationDetails = ModerationDetails;\n type blogV3Post_universal_d_ModerationStatusStatus = ModerationStatusStatus;\n const blogV3Post_universal_d_ModerationStatusStatus: typeof ModerationStatusStatus;\n type blogV3Post_universal_d_BlogMedia = BlogMedia;\n type blogV3Post_universal_d_BlogMediaMediaOneOf = BlogMediaMediaOneOf;\n type blogV3Post_universal_d_WixMedia = WixMedia;\n type blogV3Post_universal_d_VideoResolution = VideoResolution;\n type blogV3Post_universal_d_EmbedMedia = EmbedMedia;\n type blogV3Post_universal_d_EmbedThumbnail = EmbedThumbnail;\n type blogV3Post_universal_d_EmbedVideo = EmbedVideo;\n type blogV3Post_universal_d_ListTemplatesRequest = ListTemplatesRequest;\n type blogV3Post_universal_d_GetPostTemplatesSort = GetPostTemplatesSort;\n const blogV3Post_universal_d_GetPostTemplatesSort: typeof GetPostTemplatesSort;\n type blogV3Post_universal_d_BlogPaging = BlogPaging;\n type blogV3Post_universal_d_ListTemplatesResponse = ListTemplatesResponse;\n type blogV3Post_universal_d_Category = Category;\n type blogV3Post_universal_d_GetTemplateRequest = GetTemplateRequest;\n type blogV3Post_universal_d_GetTemplateResponse = GetTemplateResponse;\n type blogV3Post_universal_d_CreateDraftPostFromTemplateRequest = CreateDraftPostFromTemplateRequest;\n type blogV3Post_universal_d_CreateDraftPostFromTemplateResponse = CreateDraftPostFromTemplateResponse;\n type blogV3Post_universal_d_DraftPost = DraftPost;\n type blogV3Post_universal_d_Origin = Origin;\n const blogV3Post_universal_d_Origin: typeof Origin;\n type blogV3Post_universal_d_Status = Status;\n const blogV3Post_universal_d_Status: typeof Status;\n type blogV3Post_universal_d_DraftPostTranslation = DraftPostTranslation;\n type blogV3Post_universal_d_GetTotalLikesPerMemberRequest = GetTotalLikesPerMemberRequest;\n type blogV3Post_universal_d_GetTotalLikesPerMemberResponse = GetTotalLikesPerMemberResponse;\n type blogV3Post_universal_d_PostLiked = PostLiked;\n type blogV3Post_universal_d_PostLikedInitiatorOneOf = PostLikedInitiatorOneOf;\n type blogV3Post_universal_d_PostUnliked = PostUnliked;\n type blogV3Post_universal_d_PostUnlikedInitiatorOneOf = PostUnlikedInitiatorOneOf;\n type blogV3Post_universal_d_PostCountersUpdated = PostCountersUpdated;\n type blogV3Post_universal_d_PostCountersUpdatedInitiatorOneOf = PostCountersUpdatedInitiatorOneOf;\n type blogV3Post_universal_d_PostOwnerChanged = PostOwnerChanged;\n type blogV3Post_universal_d_InitialPostsCopied = InitialPostsCopied;\n type blogV3Post_universal_d_GetPostRequest = GetPostRequest;\n type blogV3Post_universal_d_PostFieldField = PostFieldField;\n const blogV3Post_universal_d_PostFieldField: typeof PostFieldField;\n type blogV3Post_universal_d_GetPostResponse = GetPostResponse;\n type blogV3Post_universal_d_GetPostBySlugRequest = GetPostBySlugRequest;\n type blogV3Post_universal_d_GetPostBySlugResponse = GetPostBySlugResponse;\n type blogV3Post_universal_d_ListPostsRequest = ListPostsRequest;\n type blogV3Post_universal_d_GetPostsSort = GetPostsSort;\n const blogV3Post_universal_d_GetPostsSort: typeof GetPostsSort;\n type blogV3Post_universal_d_ListPostsResponse = ListPostsResponse;\n type blogV3Post_universal_d_QueryPostsRequest = QueryPostsRequest;\n type blogV3Post_universal_d_QueryPostsResponse = QueryPostsResponse;\n type blogV3Post_universal_d_GetPostMetricsRequest = GetPostMetricsRequest;\n type blogV3Post_universal_d_GetPostMetricsResponse = GetPostMetricsResponse;\n type blogV3Post_universal_d_BulkGetPostMetricsRequest = BulkGetPostMetricsRequest;\n type blogV3Post_universal_d_BulkGetPostMetricsResponse = BulkGetPostMetricsResponse;\n type blogV3Post_universal_d_BulkGetPostReactionsRequest = BulkGetPostReactionsRequest;\n type blogV3Post_universal_d_BulkGetPostReactionsResponse = BulkGetPostReactionsResponse;\n type blogV3Post_universal_d_Reactions = Reactions;\n type blogV3Post_universal_d_ListDemoPostsRequest = ListDemoPostsRequest;\n type blogV3Post_universal_d_ListDemoPostsResponse = ListDemoPostsResponse;\n type blogV3Post_universal_d_OldBlogMigratedEvent = OldBlogMigratedEvent;\n type blogV3Post_universal_d_ListMigratedPostsRequest = ListMigratedPostsRequest;\n type blogV3Post_universal_d_BlogCursorPaging = BlogCursorPaging;\n type blogV3Post_universal_d_ListMigratedPostsResponse = ListMigratedPostsResponse;\n type blogV3Post_universal_d_PostMigrationMetaData = PostMigrationMetaData;\n type blogV3Post_universal_d_CursorMetaData = CursorMetaData;\n type blogV3Post_universal_d_QueryPublicationsCountStatsRequest = QueryPublicationsCountStatsRequest;\n type blogV3Post_universal_d_QueryPublicationsCountStatsRequestOrder = QueryPublicationsCountStatsRequestOrder;\n const blogV3Post_universal_d_QueryPublicationsCountStatsRequestOrder: typeof QueryPublicationsCountStatsRequestOrder;\n type blogV3Post_universal_d_QueryPublicationsCountStatsResponse = QueryPublicationsCountStatsResponse;\n type blogV3Post_universal_d_PeriodPublicationsCount = PeriodPublicationsCount;\n type blogV3Post_universal_d_QueryPostCountStatsRequest = QueryPostCountStatsRequest;\n type blogV3Post_universal_d_Order = Order;\n const blogV3Post_universal_d_Order: typeof Order;\n type blogV3Post_universal_d_QueryPostCountStatsResponse = QueryPostCountStatsResponse;\n type blogV3Post_universal_d_PeriodPostCount = PeriodPostCount;\n type blogV3Post_universal_d_GetTotalPublicationsRequest = GetTotalPublicationsRequest;\n type blogV3Post_universal_d_GetTotalPublicationsResponse = GetTotalPublicationsResponse;\n type blogV3Post_universal_d_GetTotalPostsRequest = GetTotalPostsRequest;\n type blogV3Post_universal_d_GetTotalPostsResponse = GetTotalPostsResponse;\n type blogV3Post_universal_d_SendActionEventRequest = SendActionEventRequest;\n type blogV3Post_universal_d_SendActionEventRequestActionOneOf = SendActionEventRequestActionOneOf;\n type blogV3Post_universal_d_SendActionEventResponse = SendActionEventResponse;\n type blogV3Post_universal_d_ListTemplatesOptions = ListTemplatesOptions;\n const blogV3Post_universal_d_getPost: typeof getPost;\n type blogV3Post_universal_d_GetPostOptions = GetPostOptions;\n const blogV3Post_universal_d_getPostBySlug: typeof getPostBySlug;\n type blogV3Post_universal_d_GetPostBySlugOptions = GetPostBySlugOptions;\n const blogV3Post_universal_d_listPosts: typeof listPosts;\n type blogV3Post_universal_d_ListPostsOptions = ListPostsOptions;\n const blogV3Post_universal_d_queryPosts: typeof queryPosts;\n type blogV3Post_universal_d_QueryPostsOptions = QueryPostsOptions;\n type blogV3Post_universal_d_PostsQueryResult = PostsQueryResult;\n type blogV3Post_universal_d_PostsQueryBuilder = PostsQueryBuilder;\n const blogV3Post_universal_d_getPostMetrics: typeof getPostMetrics;\n type blogV3Post_universal_d_ListDemoPostsOptions = ListDemoPostsOptions;\n type blogV3Post_universal_d_ListMigratedPostsOptions = ListMigratedPostsOptions;\n type blogV3Post_universal_d_QueryPublicationsCountStatsOptions = QueryPublicationsCountStatsOptions;\n const blogV3Post_universal_d_queryPostCountStats: typeof queryPostCountStats;\n type blogV3Post_universal_d_QueryPostCountStatsOptions = QueryPostCountStatsOptions;\n type blogV3Post_universal_d_GetTotalPublicationsOptions = GetTotalPublicationsOptions;\n const blogV3Post_universal_d_getTotalPosts: typeof getTotalPosts;\n type blogV3Post_universal_d_GetTotalPostsOptions = GetTotalPostsOptions;\n type blogV3Post_universal_d_SendActionEventOptions = SendActionEventOptions;\n namespace blogV3Post_universal_d {\n export { __debug$1 as __debug, blogV3Post_universal_d_Post as Post, blogV3Post_universal_d_CoverMedia as CoverMedia, blogV3Post_universal_d_CoverMediaMediaOneOf as CoverMediaMediaOneOf, blogV3Post_universal_d_PostCountInfo as PostCountInfo, blogV3Post_universal_d_Metrics as Metrics, SeoSchema$1 as SeoSchema, Keyword$1 as Keyword, Tag$1 as Tag, Settings$1 as Settings, blogV3Post_universal_d_RichContent as RichContent, blogV3Post_universal_d_Node as Node, blogV3Post_universal_d_NodeDataOneOf as NodeDataOneOf, blogV3Post_universal_d_NodeType as NodeType, blogV3Post_universal_d_NodeStyle as NodeStyle, blogV3Post_universal_d_ButtonData as ButtonData, blogV3Post_universal_d_Border as Border, blogV3Post_universal_d_Colors as Colors, blogV3Post_universal_d_PluginContainerData as PluginContainerData, blogV3Post_universal_d_WidthType as WidthType, blogV3Post_universal_d_PluginContainerDataWidth as PluginContainerDataWidth, blogV3Post_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf, blogV3Post_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment, blogV3Post_universal_d_Spoiler as Spoiler, blogV3Post_universal_d_Height as Height, blogV3Post_universal_d_Type as Type, blogV3Post_universal_d_Styles as Styles, blogV3Post_universal_d_Link as Link, blogV3Post_universal_d_LinkDataOneOf as LinkDataOneOf, blogV3Post_universal_d_Target as Target, blogV3Post_universal_d_Rel as Rel, blogV3Post_universal_d_CodeBlockData as CodeBlockData, blogV3Post_universal_d_TextStyle as TextStyle, blogV3Post_universal_d_TextAlignment as TextAlignment, blogV3Post_universal_d_DividerData as DividerData, blogV3Post_universal_d_LineStyle as LineStyle, blogV3Post_universal_d_Width as Width, blogV3Post_universal_d_Alignment as Alignment, blogV3Post_universal_d_FileData as FileData, blogV3Post_universal_d_ViewMode as ViewMode, blogV3Post_universal_d_FileSource as FileSource, blogV3Post_universal_d_FileSourceDataOneOf as FileSourceDataOneOf, blogV3Post_universal_d_PDFSettings as PDFSettings, blogV3Post_universal_d_GalleryData as GalleryData, blogV3Post_universal_d_Media as Media, blogV3Post_universal_d_Image as Image, blogV3Post_universal_d_Video as Video, blogV3Post_universal_d_Item as Item, blogV3Post_universal_d_ItemDataOneOf as ItemDataOneOf, blogV3Post_universal_d_GalleryOptions as GalleryOptions, blogV3Post_universal_d_LayoutType as LayoutType, blogV3Post_universal_d_Orientation as Orientation, blogV3Post_universal_d_Crop as Crop, blogV3Post_universal_d_ThumbnailsAlignment as ThumbnailsAlignment, blogV3Post_universal_d_Layout as Layout, blogV3Post_universal_d_ItemStyle as ItemStyle, blogV3Post_universal_d_Thumbnails as Thumbnails, blogV3Post_universal_d_GIFData as GIFData, blogV3Post_universal_d_GIF as GIF, blogV3Post_universal_d_HeadingData as HeadingData, blogV3Post_universal_d_HTMLData as HTMLData, blogV3Post_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf, blogV3Post_universal_d_Source as Source, blogV3Post_universal_d_ImageData as ImageData, blogV3Post_universal_d_LinkPreviewData as LinkPreviewData, blogV3Post_universal_d_MapData as MapData, blogV3Post_universal_d_MapSettings as MapSettings, blogV3Post_universal_d_MapType as MapType, blogV3Post_universal_d_ParagraphData as ParagraphData, blogV3Post_universal_d_PollData as PollData, blogV3Post_universal_d_ViewRole as ViewRole, blogV3Post_universal_d_VoteRole as VoteRole, blogV3Post_universal_d_Permissions as Permissions, blogV3Post_universal_d_Option as Option, blogV3Post_universal_d_PollSettings as PollSettings, blogV3Post_universal_d_PollLayoutType as PollLayoutType, blogV3Post_universal_d_PollLayoutDirection as PollLayoutDirection, blogV3Post_universal_d_PollLayout as PollLayout, blogV3Post_universal_d_OptionLayout as OptionLayout, blogV3Post_universal_d_BackgroundType as BackgroundType, blogV3Post_universal_d_Gradient as Gradient, blogV3Post_universal_d_Background as Background, blogV3Post_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf, blogV3Post_universal_d_PollDesign as PollDesign, blogV3Post_universal_d_OptionDesign as OptionDesign, blogV3Post_universal_d_Poll as Poll, blogV3Post_universal_d_PollDataLayout as PollDataLayout, blogV3Post_universal_d_Design as Design, blogV3Post_universal_d_TextData as TextData, blogV3Post_universal_d_Decoration as Decoration, blogV3Post_universal_d_DecorationDataOneOf as DecorationDataOneOf, blogV3Post_universal_d_DecorationType as DecorationType, blogV3Post_universal_d_AnchorData as AnchorData, blogV3Post_universal_d_ColorData as ColorData, blogV3Post_universal_d_LinkData as LinkData, blogV3Post_universal_d_MentionData as MentionData, blogV3Post_universal_d_FontSizeData as FontSizeData, blogV3Post_universal_d_FontType as FontType, blogV3Post_universal_d_AppEmbedData as AppEmbedData, blogV3Post_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf, blogV3Post_universal_d_AppType as AppType, blogV3Post_universal_d_BookingData as BookingData, blogV3Post_universal_d_EventData as EventData, blogV3Post_universal_d_VideoData as VideoData, blogV3Post_universal_d_PlaybackOptions as PlaybackOptions, blogV3Post_universal_d_EmbedData as EmbedData, blogV3Post_universal_d_Oembed as Oembed, blogV3Post_universal_d_CollapsibleListData as CollapsibleListData, blogV3Post_universal_d_InitialExpandedItems as InitialExpandedItems, blogV3Post_universal_d_Direction as Direction, blogV3Post_universal_d_TableData as TableData, blogV3Post_universal_d_Dimensions as Dimensions, blogV3Post_universal_d_TableCellData as TableCellData, blogV3Post_universal_d_VerticalAlignment as VerticalAlignment, blogV3Post_universal_d_CellStyle as CellStyle, blogV3Post_universal_d_BorderColors as BorderColors, blogV3Post_universal_d_NullValue as NullValue, blogV3Post_universal_d_ListValue as ListValue, blogV3Post_universal_d_AudioData as AudioData, blogV3Post_universal_d_OrderedListData as OrderedListData, blogV3Post_universal_d_BulletedListData as BulletedListData, blogV3Post_universal_d_BlockquoteData as BlockquoteData, blogV3Post_universal_d_Metadata as Metadata, blogV3Post_universal_d_DocumentStyle as DocumentStyle, blogV3Post_universal_d_TextNodeStyle as TextNodeStyle, blogV3Post_universal_d_ModerationDetails as ModerationDetails, blogV3Post_universal_d_ModerationStatusStatus as ModerationStatusStatus, blogV3Post_universal_d_BlogMedia as BlogMedia, blogV3Post_universal_d_BlogMediaMediaOneOf as BlogMediaMediaOneOf, blogV3Post_universal_d_WixMedia as WixMedia, blogV3Post_universal_d_VideoResolution as VideoResolution, blogV3Post_universal_d_EmbedMedia as EmbedMedia, blogV3Post_universal_d_EmbedThumbnail as EmbedThumbnail, blogV3Post_universal_d_EmbedVideo as EmbedVideo, blogV3Post_universal_d_ListTemplatesRequest as ListTemplatesRequest, blogV3Post_universal_d_GetPostTemplatesSort as GetPostTemplatesSort, blogV3Post_universal_d_BlogPaging as BlogPaging, blogV3Post_universal_d_ListTemplatesResponse as ListTemplatesResponse, MetaData$1 as MetaData, blogV3Post_universal_d_Category as Category, blogV3Post_universal_d_GetTemplateRequest as GetTemplateRequest, blogV3Post_universal_d_GetTemplateResponse as GetTemplateResponse, blogV3Post_universal_d_CreateDraftPostFromTemplateRequest as CreateDraftPostFromTemplateRequest, blogV3Post_universal_d_CreateDraftPostFromTemplateResponse as CreateDraftPostFromTemplateResponse, blogV3Post_universal_d_DraftPost as DraftPost, blogV3Post_universal_d_Origin as Origin, blogV3Post_universal_d_Status as Status, blogV3Post_universal_d_DraftPostTranslation as DraftPostTranslation, blogV3Post_universal_d_GetTotalLikesPerMemberRequest as GetTotalLikesPerMemberRequest, blogV3Post_universal_d_GetTotalLikesPerMemberResponse as GetTotalLikesPerMemberResponse, blogV3Post_universal_d_PostLiked as PostLiked, blogV3Post_universal_d_PostLikedInitiatorOneOf as PostLikedInitiatorOneOf, blogV3Post_universal_d_PostUnliked as PostUnliked, blogV3Post_universal_d_PostUnlikedInitiatorOneOf as PostUnlikedInitiatorOneOf, blogV3Post_universal_d_PostCountersUpdated as PostCountersUpdated, blogV3Post_universal_d_PostCountersUpdatedInitiatorOneOf as PostCountersUpdatedInitiatorOneOf, Field$1 as Field, blogV3Post_universal_d_PostOwnerChanged as PostOwnerChanged, blogV3Post_universal_d_InitialPostsCopied as InitialPostsCopied, blogV3Post_universal_d_GetPostRequest as GetPostRequest, blogV3Post_universal_d_PostFieldField as PostFieldField, blogV3Post_universal_d_GetPostResponse as GetPostResponse, blogV3Post_universal_d_GetPostBySlugRequest as GetPostBySlugRequest, blogV3Post_universal_d_GetPostBySlugResponse as GetPostBySlugResponse, blogV3Post_universal_d_ListPostsRequest as ListPostsRequest, blogV3Post_universal_d_GetPostsSort as GetPostsSort, blogV3Post_universal_d_ListPostsResponse as ListPostsResponse, blogV3Post_universal_d_QueryPostsRequest as QueryPostsRequest, Sorting$1 as Sorting, SortOrder$1 as SortOrder, PlatformQuery$1 as PlatformQuery, PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf, Paging$1 as Paging, CursorPaging$1 as CursorPaging, blogV3Post_universal_d_QueryPostsResponse as QueryPostsResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, blogV3Post_universal_d_GetPostMetricsRequest as GetPostMetricsRequest, blogV3Post_universal_d_GetPostMetricsResponse as GetPostMetricsResponse, blogV3Post_universal_d_BulkGetPostMetricsRequest as BulkGetPostMetricsRequest, blogV3Post_universal_d_BulkGetPostMetricsResponse as BulkGetPostMetricsResponse, blogV3Post_universal_d_BulkGetPostReactionsRequest as BulkGetPostReactionsRequest, blogV3Post_universal_d_BulkGetPostReactionsResponse as BulkGetPostReactionsResponse, blogV3Post_universal_d_Reactions as Reactions, blogV3Post_universal_d_ListDemoPostsRequest as ListDemoPostsRequest, blogV3Post_universal_d_ListDemoPostsResponse as ListDemoPostsResponse, blogV3Post_universal_d_OldBlogMigratedEvent as OldBlogMigratedEvent, blogV3Post_universal_d_ListMigratedPostsRequest as ListMigratedPostsRequest, blogV3Post_universal_d_BlogCursorPaging as BlogCursorPaging, blogV3Post_universal_d_ListMigratedPostsResponse as ListMigratedPostsResponse, blogV3Post_universal_d_PostMigrationMetaData as PostMigrationMetaData, blogV3Post_universal_d_CursorMetaData as CursorMetaData, blogV3Post_universal_d_QueryPublicationsCountStatsRequest as QueryPublicationsCountStatsRequest, blogV3Post_universal_d_QueryPublicationsCountStatsRequestOrder as QueryPublicationsCountStatsRequestOrder, blogV3Post_universal_d_QueryPublicationsCountStatsResponse as QueryPublicationsCountStatsResponse, blogV3Post_universal_d_PeriodPublicationsCount as PeriodPublicationsCount, blogV3Post_universal_d_QueryPostCountStatsRequest as QueryPostCountStatsRequest, blogV3Post_universal_d_Order as Order, blogV3Post_universal_d_QueryPostCountStatsResponse as QueryPostCountStatsResponse, blogV3Post_universal_d_PeriodPostCount as PeriodPostCount, blogV3Post_universal_d_GetTotalPublicationsRequest as GetTotalPublicationsRequest, blogV3Post_universal_d_GetTotalPublicationsResponse as GetTotalPublicationsResponse, blogV3Post_universal_d_GetTotalPostsRequest as GetTotalPostsRequest, blogV3Post_universal_d_GetTotalPostsResponse as GetTotalPostsResponse, blogV3Post_universal_d_SendActionEventRequest as SendActionEventRequest, blogV3Post_universal_d_SendActionEventRequestActionOneOf as SendActionEventRequestActionOneOf, blogV3Post_universal_d_SendActionEventResponse as SendActionEventResponse, blogV3Post_universal_d_ListTemplatesOptions as ListTemplatesOptions, blogV3Post_universal_d_getPost as getPost, blogV3Post_universal_d_GetPostOptions as GetPostOptions, blogV3Post_universal_d_getPostBySlug as getPostBySlug, blogV3Post_universal_d_GetPostBySlugOptions as GetPostBySlugOptions, blogV3Post_universal_d_listPosts as listPosts, blogV3Post_universal_d_ListPostsOptions as ListPostsOptions, blogV3Post_universal_d_queryPosts as queryPosts, blogV3Post_universal_d_QueryPostsOptions as QueryPostsOptions, blogV3Post_universal_d_PostsQueryResult as PostsQueryResult, blogV3Post_universal_d_PostsQueryBuilder as PostsQueryBuilder, blogV3Post_universal_d_getPostMetrics as getPostMetrics, blogV3Post_universal_d_ListDemoPostsOptions as ListDemoPostsOptions, blogV3Post_universal_d_ListMigratedPostsOptions as ListMigratedPostsOptions, blogV3Post_universal_d_QueryPublicationsCountStatsOptions as QueryPublicationsCountStatsOptions, blogV3Post_universal_d_queryPostCountStats as queryPostCountStats, blogV3Post_universal_d_QueryPostCountStatsOptions as QueryPostCountStatsOptions, blogV3Post_universal_d_GetTotalPublicationsOptions as GetTotalPublicationsOptions, blogV3Post_universal_d_getTotalPosts as getTotalPosts, blogV3Post_universal_d_GetTotalPostsOptions as GetTotalPostsOptions, blogV3Post_universal_d_SendActionEventOptions as SendActionEventOptions, };\n }\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Tag {\n /**\n * Tag ID.\n * @readonly\n */\n _id?: string;\n /**\n * Tag label.\n *\n * A blog can't have two tags with the same label.\n */\n label?: string;\n /**\n * Part of a tag's URL that refers to a specific tag.\n *\n *\n * For example, `'https:/example.com/tags/{my-tag-slug}'`.\n */\n slug?: string;\n /**\n * Date the tag was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date the tag was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Reserved for internal use.\n * @readonly\n */\n publicationCount?: number;\n /**\n * Number of posts with this tag, including unpublished draft posts.\n * @readonly\n */\n postCount?: number;\n /**\n * Tag URL.\n *\n *\n * The `url` directs you to a page that lists every post with the specified tag.\n * @readonly\n */\n url?: string;\n /**\n * Number of published posts with this tag.\n * @readonly\n */\n publishedPostCount?: number;\n /**\n * ID of the tag's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single tag will share the same `translationId`.\n * @readonly\n */\n translationId?: string | null;\n /**\n * Tag language.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema {\n /** SEO tags information. */\n tags?: SeoSchemaTag[];\n /** SEO general settings. */\n settings?: Settings;\n }\n interface Keyword {\n /** Keyword value */\n term?: string;\n /** Whether the keyword is the main focused */\n isMain?: boolean;\n }\n interface SeoSchemaTag {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings {\n /**\n * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.\n *\n *\n * Default: enabled\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page */\n keywords?: Keyword[];\n }\n interface InitialTagsCopied {\n /** Number of tags copied. */\n count?: number;\n }\n interface GetOrCreateTagRequest {\n /** Tag name. Unique per blog. */\n label: string;\n /** Tag language. */\n language?: string;\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n enum Field {\n UNKNOWN = \"UNKNOWN\",\n /** Includes Tag URL when present. */\n URL = \"URL\",\n /** Includes SEO data. */\n SEO = \"SEO\"\n }\n interface GetOrCreateTagResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface CreateTagRequest {\n /** Tag label. The label for each tag in a blog must be unique. */\n label: string;\n /**\n * Tag language.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string;\n /** Preferred tag slug. For example, `'tag-slug'`. */\n slug?: string | null;\n /**\n * List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the tag's base fields are returned.\n */\n fieldsets?: Field[];\n }\n interface CreateTagResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface UpdateTagRequest {\n /** Tag info. */\n tag?: Tag;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n interface UpdateTagResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface BulkCreateTagsRequest {\n /** Tags to create. */\n tags: Tag[];\n /** Whether to return the full created tag entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n interface BulkCreateTagsResponse {\n /** Tags created by bulk action. */\n results?: BulkTagResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkTagResult {\n /** Bulk actions metadata for tag. */\n itemMetadata?: ItemMetadata;\n /** Optional created tag. */\n item?: Tag;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetTagByLabelRequest {\n /** Tag label. */\n label: string;\n /**\n * Tag language.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * If omitted, tags in all languages are returned.\n */\n language?: string | null;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of tag fields to be included in the response.\n */\n fieldsToInclude?: Field[];\n /**\n * List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the tag's base fields are returned.\n */\n fieldsets?: Field[];\n }\n interface GetTagByLabelResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface GetTagRequest {\n /** Tag ID. */\n tagId: string;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of tag fields to be included in the response.\n */\n fieldsToInclude?: Field[];\n /**\n * List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the tag's base fields are returned.\n */\n fieldsets?: Field[];\n }\n interface GetTagResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface GetTagBySlugRequest {\n /** Slug of the tag to retrieve. */\n slug: string;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of tag fields to be included in the response.\n */\n fieldsToInclude?: Field[];\n /**\n * List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the tag's base fields are returned.\n */\n fieldsets?: Field[];\n }\n interface GetTagBySlugResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface QueryTagsRequest {\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Filter object.\n * For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).\n */\n filter?: Record | null;\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).\n */\n sort?: Sorting[];\n /**\n * __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Pagination options.\n */\n paging?: Paging;\n /**\n * __Deprecated.__ Use `fieldsets` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * List of tag fields to be included in the response.\n */\n fieldsToInclude?: Field[];\n /** Query options. */\n query?: PlatformQuery;\n /**\n * List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the tag's base fields are returned.\n */\n fieldsets?: Field[];\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface TagsFieldSet {\n /** Includes tag URL when TRUE. Defaults to FALSE. */\n includeUrl?: boolean;\n }\n interface PlatformQuery extends PlatformQueryPagingMethodOneOf {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryTagsResponse {\n /** List of tags. */\n tags?: Tag[];\n /**\n * __Deprecated.__ Use `pagingMetadata` instead.\n * This property will be removed on June 30, 2023.\n *\n * Details on the paged set of results returned.\n */\n metaData?: MetaData;\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface MetaData {\n /** Number of items returned in this response. */\n count?: number;\n /** Requested offset. */\n offset?: number;\n /** Total number of items that match the query. */\n total?: number;\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface ListTagsRequest extends ListTagsRequestPagingMethodOneOf {\n /** Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort). */\n sort?: Sorting[];\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `sort`. */\n cursorPaging?: CursorPaging;\n }\n /** @oneof */\n interface ListTagsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface ListTagsResponse {\n /** List of tags. */\n tags?: Tag[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData;\n }\n interface DeleteTagRequest {\n /** Tag ID. */\n tagId: string;\n }\n interface DeleteTagResponse {\n }\n interface GetOrCreateTagOptions {\n /** Tag language. */\n language?: string;\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n interface CreateTagOptions {\n /**\n * Tag language.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string;\n /** Preferred tag slug. For example, `'tag-slug'`. */\n slug?: string | null;\n /**\n * List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\n * the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the tag's base fields are returned.\n */\n fieldsets?: Field[];\n }\n interface UpdateTagOptions {\n tag: {\n /**\n * Tag ID.\n * @readonly\n */\n _id?: string;\n /**\n * Tag label.\n *\n * A blog can't have two tags with the same label.\n */\n label?: string;\n /**\n * Part of a tag's URL that refers to a specific tag.\n *\n *\n * For example, `'https:/example.com/tags/{my-tag-slug}'`.\n */\n slug?: string;\n /**\n * Date the tag was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date the tag was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Reserved for internal use.\n * @readonly\n */\n publicationCount?: number;\n /**\n * Number of posts with this tag, including unpublished draft posts.\n * @readonly\n */\n postCount?: number;\n /**\n * Tag URL.\n *\n *\n * The `url` directs you to a page that lists every post with the specified tag.\n * @readonly\n */\n url?: string;\n /**\n * Number of published posts with this tag.\n * @readonly\n */\n publishedPostCount?: number;\n /**\n * ID of the tag's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single tag will share the same `translationId`.\n * @readonly\n */\n translationId?: string | null;\n /**\n * Tag language.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n };\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n interface BulkCreateTagsOptions {\n /** Whether to return the full created tag entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n /**\n * Gets a tag by the specified label.\n *\n * The `getTagByLabel()` function returns a Promise that resolves to a tag whose label matches the specified label.\n * @param label - Tag label.\n * @public\n * @requiredField GetTagByLabelRequest\n * @requiredField label\n * @param options - Options specifying which additional fields to return.\n */\n function getTagByLabel(label: string, options?: GetTagByLabelOptions): Promise;\n interface GetTagByLabelOptions {\n /**\n * Tag language.\n *\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * If omitted, tags in all languages are returned.\n */\n language?: string | null;\n /**\n * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"URL\"`\n */\n fieldsets?: Field[];\n }\n /**\n * Gets a tag by the specified ID.\n *\n *\n * The `getTag()` function returns a Promise that resolves to a tag whose ID matches the specified ID.\n * @param tagId - Tag ID.\n * @public\n * @requiredField tagId\n * @param options - Options specifying which additional fields to return.\n */\n function getTag(tagId: string, options?: GetTagOptions): Promise;\n interface GetTagOptions {\n /**\n * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"URL\"`\n */\n fieldsets?: Field[];\n }\n /**\n * Gets a tag by the specified slug.\n *\n *\n * The `getTagBySlug()` function returns a Promise that resolves to a tag whose slug matches the specified slug.\n *\n * The `slug` is the end of a tag's URL that refers to a specific tag. For example, if a tag's URL is `https://example.com/blog/tag/{my-tag-slug}`, the slug is `my-tag-slug`. The slug is case-sensitive and derived from the tag's `label`.\n * @param slug - Slug of the tag to retrieve.\n * @public\n * @requiredField slug\n * @param options - Options specifying which additional fields to return.\n */\n function getTagBySlug(slug: string, options?: GetTagBySlugOptions): Promise;\n interface GetTagBySlugOptions {\n /**\n * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"URL\"`\n */\n fieldsets?: Field[];\n }\n /**\n * Creates a query to retrieve a list of tags.\n *\n *\n * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder) object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/find) function.\n *\n * You can refine the query by chaining `TagsQueryBuilder` functions onto the query. `TagsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTags()` returns.\n *\n * `queryTags()` runs with these `TagsQueryBuilder` defaults that can be overridden:\n * - [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/limit)\n * - [`ascending('_id')`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/ascending)\n *\n * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult).\n * @public\n * @param options - Options specifying which fields to return.\n */\n function queryTags(options?: QueryTagsOptions): TagsQueryBuilder;\n interface QueryTagsOptions {\n /**\n * List of additional tag fields to be included in the response. By default, any fields not passed are not returned.\n *\n * Supported Values:\n * `\"URL\"`\n */\n fieldsets?: Field[] | undefined;\n }\n interface QueryOffsetResult {\n currentPage: number;\n totalPages: number;\n totalCount: number;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TagsQueryResult extends QueryOffsetResult {\n items: Tag[];\n query: TagsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface TagsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: string, value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: string, value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: string, value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: string, value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: string, value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: string, value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: string, value: string) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: string, value: any[]) => TagsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: string[]) => TagsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: string[]) => TagsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => TagsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => TagsQueryBuilder;\n find: () => Promise;\n }\n interface ListTagsOptions {\n /** Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort). */\n sort?: Sorting[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * List of tag fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core tag properties.\n * Example: When URL fieldset is selected, returned tag will have a set of base properties and tag url.\n */\n fieldsets?: Field[];\n }\n const blogV3Tag_universal_d___debug: typeof __debug;\n type blogV3Tag_universal_d_Tag = Tag;\n type blogV3Tag_universal_d_SeoSchema = SeoSchema;\n type blogV3Tag_universal_d_Keyword = Keyword;\n type blogV3Tag_universal_d_SeoSchemaTag = SeoSchemaTag;\n type blogV3Tag_universal_d_Settings = Settings;\n type blogV3Tag_universal_d_InitialTagsCopied = InitialTagsCopied;\n type blogV3Tag_universal_d_GetOrCreateTagRequest = GetOrCreateTagRequest;\n type blogV3Tag_universal_d_Field = Field;\n const blogV3Tag_universal_d_Field: typeof Field;\n type blogV3Tag_universal_d_GetOrCreateTagResponse = GetOrCreateTagResponse;\n type blogV3Tag_universal_d_CreateTagRequest = CreateTagRequest;\n type blogV3Tag_universal_d_CreateTagResponse = CreateTagResponse;\n type blogV3Tag_universal_d_UpdateTagRequest = UpdateTagRequest;\n type blogV3Tag_universal_d_UpdateTagResponse = UpdateTagResponse;\n type blogV3Tag_universal_d_BulkCreateTagsRequest = BulkCreateTagsRequest;\n type blogV3Tag_universal_d_BulkCreateTagsResponse = BulkCreateTagsResponse;\n type blogV3Tag_universal_d_BulkTagResult = BulkTagResult;\n type blogV3Tag_universal_d_ItemMetadata = ItemMetadata;\n type blogV3Tag_universal_d_ApplicationError = ApplicationError;\n type blogV3Tag_universal_d_BulkActionMetadata = BulkActionMetadata;\n type blogV3Tag_universal_d_GetTagByLabelRequest = GetTagByLabelRequest;\n type blogV3Tag_universal_d_GetTagByLabelResponse = GetTagByLabelResponse;\n type blogV3Tag_universal_d_GetTagRequest = GetTagRequest;\n type blogV3Tag_universal_d_GetTagResponse = GetTagResponse;\n type blogV3Tag_universal_d_GetTagBySlugRequest = GetTagBySlugRequest;\n type blogV3Tag_universal_d_GetTagBySlugResponse = GetTagBySlugResponse;\n type blogV3Tag_universal_d_QueryTagsRequest = QueryTagsRequest;\n type blogV3Tag_universal_d_Sorting = Sorting;\n type blogV3Tag_universal_d_SortOrder = SortOrder;\n const blogV3Tag_universal_d_SortOrder: typeof SortOrder;\n type blogV3Tag_universal_d_Paging = Paging;\n type blogV3Tag_universal_d_TagsFieldSet = TagsFieldSet;\n type blogV3Tag_universal_d_PlatformQuery = PlatformQuery;\n type blogV3Tag_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type blogV3Tag_universal_d_CursorPaging = CursorPaging;\n type blogV3Tag_universal_d_QueryTagsResponse = QueryTagsResponse;\n type blogV3Tag_universal_d_MetaData = MetaData;\n type blogV3Tag_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type blogV3Tag_universal_d_Cursors = Cursors;\n type blogV3Tag_universal_d_ListTagsRequest = ListTagsRequest;\n type blogV3Tag_universal_d_ListTagsRequestPagingMethodOneOf = ListTagsRequestPagingMethodOneOf;\n type blogV3Tag_universal_d_ListTagsResponse = ListTagsResponse;\n type blogV3Tag_universal_d_DeleteTagRequest = DeleteTagRequest;\n type blogV3Tag_universal_d_DeleteTagResponse = DeleteTagResponse;\n type blogV3Tag_universal_d_GetOrCreateTagOptions = GetOrCreateTagOptions;\n type blogV3Tag_universal_d_CreateTagOptions = CreateTagOptions;\n type blogV3Tag_universal_d_UpdateTagOptions = UpdateTagOptions;\n type blogV3Tag_universal_d_BulkCreateTagsOptions = BulkCreateTagsOptions;\n const blogV3Tag_universal_d_getTagByLabel: typeof getTagByLabel;\n type blogV3Tag_universal_d_GetTagByLabelOptions = GetTagByLabelOptions;\n const blogV3Tag_universal_d_getTag: typeof getTag;\n type blogV3Tag_universal_d_GetTagOptions = GetTagOptions;\n const blogV3Tag_universal_d_getTagBySlug: typeof getTagBySlug;\n type blogV3Tag_universal_d_GetTagBySlugOptions = GetTagBySlugOptions;\n const blogV3Tag_universal_d_queryTags: typeof queryTags;\n type blogV3Tag_universal_d_QueryTagsOptions = QueryTagsOptions;\n type blogV3Tag_universal_d_TagsQueryResult = TagsQueryResult;\n type blogV3Tag_universal_d_TagsQueryBuilder = TagsQueryBuilder;\n type blogV3Tag_universal_d_ListTagsOptions = ListTagsOptions;\n namespace blogV3Tag_universal_d {\n export { blogV3Tag_universal_d___debug as __debug, blogV3Tag_universal_d_Tag as Tag, blogV3Tag_universal_d_SeoSchema as SeoSchema, blogV3Tag_universal_d_Keyword as Keyword, blogV3Tag_universal_d_SeoSchemaTag as SeoSchemaTag, blogV3Tag_universal_d_Settings as Settings, blogV3Tag_universal_d_InitialTagsCopied as InitialTagsCopied, blogV3Tag_universal_d_GetOrCreateTagRequest as GetOrCreateTagRequest, blogV3Tag_universal_d_Field as Field, blogV3Tag_universal_d_GetOrCreateTagResponse as GetOrCreateTagResponse, blogV3Tag_universal_d_CreateTagRequest as CreateTagRequest, blogV3Tag_universal_d_CreateTagResponse as CreateTagResponse, blogV3Tag_universal_d_UpdateTagRequest as UpdateTagRequest, blogV3Tag_universal_d_UpdateTagResponse as UpdateTagResponse, blogV3Tag_universal_d_BulkCreateTagsRequest as BulkCreateTagsRequest, blogV3Tag_universal_d_BulkCreateTagsResponse as BulkCreateTagsResponse, blogV3Tag_universal_d_BulkTagResult as BulkTagResult, blogV3Tag_universal_d_ItemMetadata as ItemMetadata, blogV3Tag_universal_d_ApplicationError as ApplicationError, blogV3Tag_universal_d_BulkActionMetadata as BulkActionMetadata, blogV3Tag_universal_d_GetTagByLabelRequest as GetTagByLabelRequest, blogV3Tag_universal_d_GetTagByLabelResponse as GetTagByLabelResponse, blogV3Tag_universal_d_GetTagRequest as GetTagRequest, blogV3Tag_universal_d_GetTagResponse as GetTagResponse, blogV3Tag_universal_d_GetTagBySlugRequest as GetTagBySlugRequest, blogV3Tag_universal_d_GetTagBySlugResponse as GetTagBySlugResponse, blogV3Tag_universal_d_QueryTagsRequest as QueryTagsRequest, blogV3Tag_universal_d_Sorting as Sorting, blogV3Tag_universal_d_SortOrder as SortOrder, blogV3Tag_universal_d_Paging as Paging, blogV3Tag_universal_d_TagsFieldSet as TagsFieldSet, blogV3Tag_universal_d_PlatformQuery as PlatformQuery, blogV3Tag_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf, blogV3Tag_universal_d_CursorPaging as CursorPaging, blogV3Tag_universal_d_QueryTagsResponse as QueryTagsResponse, blogV3Tag_universal_d_MetaData as MetaData, blogV3Tag_universal_d_PagingMetadataV2 as PagingMetadataV2, blogV3Tag_universal_d_Cursors as Cursors, blogV3Tag_universal_d_ListTagsRequest as ListTagsRequest, blogV3Tag_universal_d_ListTagsRequestPagingMethodOneOf as ListTagsRequestPagingMethodOneOf, blogV3Tag_universal_d_ListTagsResponse as ListTagsResponse, blogV3Tag_universal_d_DeleteTagRequest as DeleteTagRequest, blogV3Tag_universal_d_DeleteTagResponse as DeleteTagResponse, blogV3Tag_universal_d_GetOrCreateTagOptions as GetOrCreateTagOptions, blogV3Tag_universal_d_CreateTagOptions as CreateTagOptions, blogV3Tag_universal_d_UpdateTagOptions as UpdateTagOptions, blogV3Tag_universal_d_BulkCreateTagsOptions as BulkCreateTagsOptions, blogV3Tag_universal_d_getTagByLabel as getTagByLabel, blogV3Tag_universal_d_GetTagByLabelOptions as GetTagByLabelOptions, blogV3Tag_universal_d_getTag as getTag, blogV3Tag_universal_d_GetTagOptions as GetTagOptions, blogV3Tag_universal_d_getTagBySlug as getTagBySlug, blogV3Tag_universal_d_GetTagBySlugOptions as GetTagBySlugOptions, blogV3Tag_universal_d_queryTags as queryTags, blogV3Tag_universal_d_QueryTagsOptions as QueryTagsOptions, blogV3Tag_universal_d_TagsQueryResult as TagsQueryResult, blogV3Tag_universal_d_TagsQueryBuilder as TagsQueryBuilder, blogV3Tag_universal_d_ListTagsOptions as ListTagsOptions, };\n }\n export { blogV3Category_universal_d as categories, blogV3Post_universal_d as posts, blogV3Tag_universal_d as tags };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-ecom-backend.d.ts", "content": "declare module \"wix-ecom-backend\" {\n interface Cart$1 {\n /** Cart ID. */\n _id?: string | null;\n /**\n * Line items.\n * @readonly\n */\n lineItems?: LineItem$6[];\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$6;\n /**\n * Currency used for pricing.\n * @readonly\n */\n currency?: string;\n /**\n * Currency code used for all the converted prices that are returned.\n * For a site that supports multiple currencies, this is the currency the buyer selected.\n * @readonly\n */\n conversionCurrency?: string;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n * @readonly\n */\n buyerLanguage?: string | null;\n /**\n * Site language in which original values are displayed.\n * @readonly\n */\n siteLanguage?: string | null;\n /**\n * Whether tax is included in line item prices.\n * @readonly\n */\n taxIncludedInPrices?: boolean | null;\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$5;\n /**\n * ID of the checkout that originated from this cart.\n * @readonly\n */\n checkoutId?: string | null;\n /**\n * Cart discounts.\n * @readonly\n */\n appliedDiscounts?: CartDiscount$1[];\n /**\n * Date and time the cart was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the cart was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Contact info. */\n contactInfo?: AddressWithContact$4;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n /**\n * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.\n * @readonly\n */\n purchaseFlowId?: string | null;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n }\n interface LineItem$6 {\n /**\n * Line item ID.\n * @readonly\n */\n _id?: string | null;\n /** Item quantity. */\n quantity?: number;\n /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$7;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n * @readonly\n */\n productName?: ProductName$4;\n /**\n * URL to the item's page on the site.\n * @readonly\n */\n url?: string;\n /**\n * Item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n price?: MultiCurrencyPrice$4;\n /**\n * Item price **before** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n fullPrice?: MultiCurrencyPrice$4;\n /**\n * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: MultiCurrencyPrice$4;\n /**\n * Line item description lines. Used for displaying the cart, checkout and order.\n * @readonly\n */\n descriptionLines?: DescriptionLine$4[];\n /**\n * Line item image details.\n * @readonly\n */\n image?: string;\n /**\n * Item availability details.\n * @readonly\n */\n availability?: ItemAvailabilityInfo$3;\n /**\n * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.\n * @readonly\n */\n physicalProperties?: PhysicalProperties$4;\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$4;\n /**\n * Type of selected payment option for current item. Defaults to `\"FULL_PAYMENT_ONLINE\"`.\n * + `\"FULL_PAYMENT_ONLINE\"` - The entire payment for this item happens as part of the checkout.\n * + `\"FULL_PAYMENT_OFFLINE\"` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `\"MEMBERSHIP\"` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` will be 0.\n * @readonly\n */\n paymentOption?: PaymentOptionType$4;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * @readonly\n */\n serviceProperties?: ServiceProperties$4;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + in most cases, this field is the same as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\".\n * @readonly\n */\n priceDescription?: PriceDescription$4;\n /**\n * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.\n * @readonly\n */\n depositAmount?: MultiCurrencyPrice$4;\n /** Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`. */\n selectedMembership?: SelectedMembership$3;\n /**\n * Tax group ID for this line item.\n * @readonly\n */\n taxGroupId?: string | null;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Overriding values for catalog item properties.\n *\n * To override catalog fields, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n catalogOverrideFields?: CatalogOverrideFields$3;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$7 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs.\n *\n * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).\n */\n options?: Record | null;\n }\n interface ProductName$4 {\n /** **Required** - Original product name (in site's default language). */\n original?: string;\n /** Description product name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface MultiCurrencyPrice$4 {\n /** Amount. */\n amount?: string;\n /**\n * Converted amount.\n * @readonly\n */\n convertedAmount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n /**\n * Converted amount formatted with currency symbol.\n * @readonly\n */\n formattedConvertedAmount?: string;\n }\n interface DescriptionLine$4 extends DescriptionLineValueOneOf$4, DescriptionLineDescriptionLineValueOneOf$4 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$4;\n /** Description line color value. */\n colorInfo?: Color$4;\n /** Description line name. */\n name?: DescriptionLineName$4;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf$4 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$4;\n /** Description line color value. */\n colorInfo?: Color$4;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf$4 {\n }\n interface DescriptionLineName$4 {\n /** Description line name in site's default language. */\n original?: string;\n /** Description line name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface PlainTextValue$4 {\n /** Description line plain text value in site's default language. */\n original?: string;\n /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface Color$4 {\n /** Description line color name in site's default language. */\n original?: string;\n /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n /**\n * HEX or RGB color code for display.\n *\n */\n code?: string | null;\n }\n enum DescriptionLineType$4 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n COLOR = \"COLOR\"\n }\n interface ItemAvailabilityInfo$3 {\n /**\n * Item availability status.\n *\n * NOT_FOUND - Item does not exist.\n * NOT_AVAILABLE - Not in stock.\n * PARTIALLY_AVAILABLE - Available quantity is less than requested.\n */\n status?: ItemAvailabilityStatus$3;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus$3 {\n AVAILABLE = \"AVAILABLE\",\n NOT_FOUND = \"NOT_FOUND\",\n /** Not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface PhysicalProperties$4 {\n /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface Scope$4 {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */\n namespace?: string;\n /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */\n group?: Group$3;\n }\n interface Group$3 {\n /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n name?: string;\n /** Item ID (when the coupon scope is limited to just one item). */\n entityId?: string | null;\n }\n interface ItemType$4 extends ItemTypeItemTypeDataOneOf$4 {\n /** Preset item type. */\n preset?: ItemTypeItemType$4;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n /** @oneof */\n interface ItemTypeItemTypeDataOneOf$4 {\n /** Preset item type. */\n preset?: ItemTypeItemType$4;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$4 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PHYSICAL = \"PHYSICAL\",\n DIGITAL = \"DIGITAL\",\n GIFT_CARD = \"GIFT_CARD\",\n SERVICE = \"SERVICE\"\n }\n interface SubscriptionOptionInfo$4 {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings$5;\n /** Subscription option title. */\n title?: Title$3;\n /** Subscription option description. */\n description?: Description$3;\n }\n interface SubscriptionSettings$5 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$5;\n /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n */\n interval?: number | null;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$5 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface Title$3 {\n /** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Subscription option name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Description$3 {\n /** Subscription option description. */\n original?: string;\n /** Translated subscription option description. */\n translated?: string | null;\n }\n interface SecuredMedia$3 {\n /** Media ID in Wix Media Manager. */\n _id?: string;\n /** Original filename. */\n fileName?: string;\n /** File type. */\n fileType?: FileType$3;\n }\n enum FileType$3 {\n UNSPECIFIED = \"UNSPECIFIED\",\n SECURE_PICTURE = \"SECURE_PICTURE\",\n SECURE_VIDEO = \"SECURE_VIDEO\",\n SECURE_DOCUMENT = \"SECURE_DOCUMENT\",\n SECURE_MUSIC = \"SECURE_MUSIC\",\n SECURE_ARCHIVE = \"SECURE_ARCHIVE\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType$4 {\n /** The entire payment for this item happens as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\",\n /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface ServiceProperties$4 {\n /** The date and time for which the service is supposed to be provided. For example, the time of the class. */\n scheduledDate?: Date;\n /** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface PriceDescription$4 {\n /**\n * **Required** - Original price description (in site's default language).\n *\n */\n original?: string;\n /** Product name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n /** Selected Membership */\n interface SelectedMembership$3 {\n /** Membership ID. */\n _id?: string;\n /** ID of the app providing this payment option. */\n appId?: string;\n }\n interface CatalogOverrideFields$3 {\n /** Item name. */\n productName?: ProductName$4;\n /** Item price **after** discounts. */\n price?: string | null;\n /** Item price **before** discounts. */\n fullPrice?: string | null;\n /** Item description lines. Used when displaying the line item to customers. */\n descriptionLines?: DescriptionLine$4[];\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$4;\n /** Item image. */\n image?: string;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface TaxableAddress$2 extends TaxableAddressTaxableAddressDataOneOf$2 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$2;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$2 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$2;\n }\n enum TaxableAddressType$2 {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n /** Buyer Info */\n interface BuyerInfo$6 extends BuyerInfoIdOneOf$4 {\n /**\n * Visitor ID - if the buyer is **not** a site member.\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID - if the buyer is a site member.\n * @readonly\n */\n memberId?: string;\n /**\n * User ID - if the cart owner is a Wix user.\n * @readonly\n */\n userId?: string;\n /** Contact ID. For more information, see the Contacts API. */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf$4 {\n /**\n * Visitor ID - if the buyer is **not** a site member.\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID - if the buyer is a site member.\n * @readonly\n */\n memberId?: string;\n /**\n * User ID - if the cart owner is a Wix user.\n * @readonly\n */\n userId?: string;\n }\n enum WeightUnit$5 {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface CartDiscount$1 extends CartDiscountDiscountSourceOneOf$1 {\n /** Coupon details. */\n coupon?: Coupon$4;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$4;\n }\n /** @oneof */\n interface CartDiscountDiscountSourceOneOf$1 {\n /** Coupon details. */\n coupon?: Coupon$4;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$4;\n }\n interface Coupon$4 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n }\n interface MerchantDiscount$4 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$4;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$4 {\n /** Address. */\n address?: Address$5;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$4;\n }\n /** Physical address */\n interface Address$5 {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. */\n streetAddress?: StreetAddress$4;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n interface StreetAddress$4 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$4 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails$4 {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Company name. */\n company?: string | null;\n /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */\n vatId?: VatId$5;\n }\n interface VatId$5 {\n /** Customer's tax ID. */\n _id?: string;\n /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\n type?: VatType$5;\n }\n /** tax info types */\n enum VatType$5 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface SelectedShippingOption$1 {\n /** Carrier ID. */\n carrierId?: string | null;\n /** Selected shipping option code. For example, \"usps_std_overnight\". */\n code?: string;\n }\n interface ExtendedFields$5 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface GetCurrentCartRequest$1 {\n }\n interface GetCurrentCartResponse$1 {\n /** Current session's active cart. */\n cart?: Cart$1;\n }\n interface UpdateCartRequest$1 {\n /** Cart info. */\n cartInfo?: Cart$1;\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput$2[];\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n interface MerchantDiscountInput$2 {\n /** Discount amount. */\n amount?: string;\n /** IDs of the line items the discount applies to. */\n lineItemIds?: string[];\n }\n interface CustomLineItem$3 {\n /**\n * Custom line item quantity.\n *\n * Min: `1`\n * Max: `100000`\n */\n quantity?: number;\n /**\n * Custom line item price.\n *\n * Must be a number or a decimal without symbols.\n */\n price?: string;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription$4;\n /** Custom line item description lines. Used for displaying the cart, checkout and order. */\n descriptionLines?: DescriptionLine$4[];\n /**\n * Custom line item media. Supported formats:\n * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `\"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000\"`.\n * + An image from the web - `\"http(s)://\"`.\n */\n media?: string;\n /**\n * Custom line item ID. If passed, `id` must be unique.\n *\n * Default: auto-generated ID\n */\n _id?: string | null;\n /** Tax group ID for this custom line item. */\n taxGroupId?: string | null;\n /** Name of the item or product. */\n productName?: ProductName$4;\n /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */\n url?: string;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$4;\n /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: string | null;\n /**\n * Item quantity available for purchase. Only return this if inventory is managed.\n * Not returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart.\n */\n quantityAvailable?: number | null;\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$4;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n *\n * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType$4;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * Used, among other things, when checking for valid memberships.\n */\n serviceProperties?: ServiceProperties$4;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n *\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field is the same as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n */\n rootCatalogItemId?: string | null;\n /**\n * Partial payment for the given item to be paid upfront during the checkout.\n *\n * Eligible for catalog items with type `DEPOSIT_ONLINE`.\n * When omitted, the item's price will not be split and is expected to be paid in a single installment.\n */\n depositAmount?: string | null;\n /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$7;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n interface UpdateCartResponse$1 {\n /** Updated Cart. */\n cart?: Cart$1;\n }\n interface AddToCurrentCartRequest$1 {\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n interface AddToCartResponse$1 {\n /** Updated cart. */\n cart?: Cart$1;\n }\n interface AddToCurrentCartAndEstimateTotalsRequest$1 {\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$3;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n interface SelectedMemberships$3 {\n /** Selected memberships. */\n memberships?: HostSelectedMembership$1[];\n }\n interface HostSelectedMembership$1 {\n /** Membership ID. */\n _id?: string;\n /** ID of the app providing this payment option. */\n appId?: string;\n /** IDs of the line items this membership applies to. */\n lineItemIds?: string[];\n }\n interface EstimateTotalsResponse$1 {\n /** Cart. */\n cart?: Cart$1;\n /** Calculated line items. */\n calculatedLineItems?: CalculatedLineItem$1[];\n /** Price summary. */\n priceSummary?: PriceSummary$4;\n /** Applied gift card. */\n giftCard?: GiftCard$4;\n /** Tax summary. */\n taxSummary?: TaxSummary$4;\n /** Shipping information. */\n shippingInfo?: ShippingInformation$2;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$5[];\n /** Calculation errors. */\n calculationErrors?: CalculationErrors$3;\n /** Weight measurement unit - defaults to site's weight unit. */\n weightUnit?: WeightUnit$5;\n /** Currency used for pricing in this store. */\n currency?: string;\n /**\n * Minimal amount to pay in order to place the order.\n * @readonly\n */\n payNow?: PriceSummary$4;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$4;\n /** Information about valid and invalid memberships, and which ones are selected for usage. */\n membershipOptions?: MembershipOptions$3;\n /** Additional fees */\n additionalFees?: AdditionalFee$4[];\n /**\n * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).\n * @readonly\n */\n violations?: Violation$3[];\n }\n interface CalculatedLineItem$1 {\n /** Line item ID. */\n lineItemId?: string;\n /** Price breakdown for this line item. */\n pricesBreakdown?: LineItemPricesData$1;\n /**\n * Type of selected payment option for current item. Defaults to `\"FULL_PAYMENT_ONLINE\"`.\n * + `\"FULL_PAYMENT_ONLINE\"` - The entire payment for this item happens as part of the checkout.\n * + `\"FULL_PAYMENT_OFFLINE\"` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `\"MEMBERSHIP\"` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` will be 0.\n */\n paymentOption?: PaymentOptionType$4;\n }\n interface LineItemPricesData$1 {\n /** Total price after discounts and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$4;\n /** Total price after discounts, and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$4;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$4;\n /** Total discount for all line items. */\n totalDiscount?: MultiCurrencyPrice$4;\n /** Catalog price after catalog discount and automatic discounts. */\n price?: MultiCurrencyPrice$4;\n /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: MultiCurrencyPrice$4;\n /** Total price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: MultiCurrencyPrice$4;\n /** Item price **before** line item discounts and **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: MultiCurrencyPrice$4;\n }\n interface ItemTaxFullDetails$4 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$4;\n /** Tax rate %, as a decimal point between 0 and 1. */\n taxRate?: string;\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n totalTax?: MultiCurrencyPrice$4;\n /**\n * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.\n * @readonly\n * @deprecated\n */\n rateBreakdown?: TaxRateBreakdown$3[];\n }\n interface TaxRateBreakdown$3 {\n /** Name of tax against which the calculation was performed. */\n name?: string;\n /** Rate at which this tax detail was calculated. */\n rate?: string;\n /** Amount of tax for this tax detail. */\n tax?: MultiCurrencyPrice$4;\n }\n /**\n * TaxBreakdown represents tax information for a line item.\n * It holds the tax amount and the tax rate for each tax authority that apply on the line item.\n */\n interface TaxBreakdown$3 {\n /** The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\". */\n jurisdiction?: string | null;\n /** The amount of this line item price that was considered nontaxable. (Decimal value) */\n nonTaxableAmount?: MultiCurrencyPrice$4;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */\n rate?: string | null;\n /** The amount of tax estimated for this line item. (Decimal value) */\n taxAmount?: MultiCurrencyPrice$4;\n /** The taxable amount of this line item. */\n taxableAmount?: MultiCurrencyPrice$4;\n /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc. */\n taxType?: string | null;\n /**\n * The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\n * This name should be explicit enough to allow the merchant to understand what tax was calculated.\n */\n taxName?: string | null;\n /** The type of the jurisdiction in which this tax detail applies. */\n jurisdictionType?: JurisdictionType$4;\n }\n /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n enum JurisdictionType$4 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface PriceSummary$4 {\n /** Subtotal of all line items, before discounts and before tax. */\n subtotal?: MultiCurrencyPrice$4;\n /** Total shipping price, before discounts and before tax. */\n shipping?: MultiCurrencyPrice$4;\n /** Total tax. */\n tax?: MultiCurrencyPrice$4;\n /** Total calculated discount value. */\n discount?: MultiCurrencyPrice$4;\n /** Total price after discounts, gift cards, and tax. */\n total?: MultiCurrencyPrice$4;\n /** Total additional fees price before tax. */\n additionalFees?: MultiCurrencyPrice$4;\n }\n interface GiftCard$4 {\n /**\n * Gift Card ID.\n * @deprecated\n */\n _id?: string;\n /** Gift card obfuscated code. */\n obfuscatedCode?: string;\n /** Gift card value. */\n amount?: MultiCurrencyPrice$4;\n /** App ID of the gift card provider. */\n appId?: string;\n /**\n * External ID in the gift card provider's system.\n * Used for integration and tracking across different platforms.\n */\n externalId?: string | null;\n }\n interface TaxSummary$4 {\n /**\n * Amount for which tax is calculated, added from line items.\n * @readonly\n */\n taxableAmount?: MultiCurrencyPrice$4;\n /**\n * Calculated tax, added from line items.\n * @readonly\n */\n totalTax?: MultiCurrencyPrice$4;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$3;\n }\n interface TaxCalculationDetails$3 extends TaxCalculationDetailsCalculationDetailsOneOf$3 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$3;\n /** Error details and reason for tax rate fallback. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$3;\n /**\n * Rate calculation type. Supported values:\n * + `\"AUTO_RATE\"`\n * + `\"FALLBACK_RATE\"`\n * + `\"MANUAL_RATE\"`\n * + `\"NO_TAX_COLLECTED\"`\n */\n rateType?: RateType$3;\n }\n /** @oneof */\n interface TaxCalculationDetailsCalculationDetailsOneOf$3 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$3;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$3;\n }\n enum RateType$3 {\n /** no tax being collected for this request due to location of purchase */\n NO_TAX_COLLECTED = \"NO_TAX_COLLECTED\",\n /** manual rate used for calculation */\n MANUAL_RATE = \"MANUAL_RATE\",\n /** autotax rate used for calculation */\n AUTO_RATE = \"AUTO_RATE\",\n /** fallback rate used for calculation */\n FALLBACK_RATE = \"FALLBACK_RATE\"\n }\n enum ManualCalculationReason$3 {\n /** user set calculator in Business Manager to be Manual */\n GLOBAL_SETTING_TO_MANUAL = \"GLOBAL_SETTING_TO_MANUAL\",\n /** specific region is on manual even though Global setting is Auto-tax */\n REGION_SETTING_TO_MANUAL = \"REGION_SETTING_TO_MANUAL\"\n }\n interface AutoTaxFallbackCalculationDetails$3 {\n /**\n * Reason for fallback. Supported values:\n * + `\"AUTO_TAX_FAILED\"`\n * + `\"AUTO_TAX_DEACTIVATED\"`\n */\n fallbackReason?: FallbackReason$3;\n /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */\n error?: ApplicationError$7;\n }\n enum FallbackReason$3 {\n /** auto-tax failed to be calculated */\n AUTO_TAX_FAILED = \"AUTO_TAX_FAILED\",\n /** auto-tax was temporarily deactivated on a system-level */\n AUTO_TAX_DEACTIVATED = \"AUTO_TAX_DEACTIVATED\"\n }\n interface ApplicationError$7 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n /**\n * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.\n * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.\n */\n interface AggregatedTaxBreakdown$3 {\n /** The name of the tax against which this tax amount was calculated. */\n taxName?: string;\n /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */\n taxType?: string;\n /** The name of the jurisdiction in which this tax detail applies. */\n jurisdiction?: string;\n /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n jurisdictionTypeEnum?: JurisdictionType$4;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */\n rate?: string;\n /** The sum of all the tax from line items that calculated by the tax identifiers. */\n aggregatedTaxAmount?: MultiCurrencyPrice$4;\n }\n interface ShippingInformation$2 {\n /** Shipping region. */\n region?: ShippingRegion$4;\n /** Selected shipping option. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption$3;\n /** All shipping options. */\n carrierServiceOptions?: CarrierServiceOption$3[];\n }\n interface ShippingRegion$4 {\n /**\n * Shipping region ID.\n * @readonly\n */\n _id?: string;\n /** Shipping region name. */\n name?: string;\n }\n interface SelectedCarrierServiceOption$3 {\n /** Unique identifier of selected option. For example, \"usps_std_overnight\". */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n * @readonly\n */\n title?: string;\n /**\n * Delivery logistics.\n * @readonly\n */\n logistics?: DeliveryLogistics$4;\n /**\n * Shipping costs.\n * @readonly\n */\n cost?: SelectedCarrierServiceOptionPrices$3;\n /**\n * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)\n * @readonly\n */\n requestedShippingOption?: boolean;\n /** Other charges */\n otherCharges?: SelectedCarrierServiceOptionOtherCharge$3[];\n /** This carrier's unique ID */\n carrierId?: string | null;\n }\n interface DeliveryLogistics$4 {\n /** Expected delivery time, in free text. For example, \"3-5 business days\". */\n deliveryTime?: string | null;\n /** Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\". */\n instructions?: string | null;\n /** Pickup details. */\n pickupDetails?: PickupDetails$5;\n }\n interface PickupDetails$5 {\n /** Pickup address. */\n address?: Address$5;\n /**\n * Whether the pickup address is that of a business - this may effect tax calculation.\n * @deprecated\n */\n businessLocation?: boolean;\n /** Pickup method */\n pickupMethod?: PickupMethod$4;\n }\n enum PickupMethod$4 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$4 {\n /** starting time of the delivery time slot */\n from?: Date;\n /** ending time of the delivery time slot */\n to?: Date;\n }\n interface SelectedCarrierServiceOptionPrices$3 {\n /** Total shipping price, after discount and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$4;\n /** Total price of shipping after discounts (when relevant), and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$4;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$4;\n /** Shipping discount before tax. */\n totalDiscount?: MultiCurrencyPrice$4;\n /** Shipping price before discount and before tax. */\n price?: MultiCurrencyPrice$4;\n }\n interface SelectedCarrierServiceOptionOtherCharge$3 {\n /** Type of additional cost. */\n type?: ChargeType$3;\n /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */\n details?: string | null;\n /** Price of added charge. */\n cost?: SelectedCarrierServiceOptionPrices$3;\n }\n enum ChargeType$3 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface CarrierServiceOption$3 {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption$3[];\n }\n interface ShippingOption$3 {\n /**\n * Unique code of provided shipping option like \"usps_std_overnight\".\n * For legacy calculators this would be the UUID of the option.\n */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics$4;\n /** Sipping price information. */\n cost?: ShippingPrice$4;\n }\n interface ShippingPrice$4 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$4;\n /** Other costs such as insurance, handling & packaging for fragile items, etc. */\n otherCharges?: OtherCharge$3[];\n }\n interface OtherCharge$3 {\n /** Type of additional cost. */\n type?: ChargeType$3;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$4;\n }\n interface AppliedDiscount$5 extends AppliedDiscountDiscountSourceOneOf$4 {\n /** Coupon details. */\n coupon?: V1Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount$1;\n /** Discount rule */\n discountRule?: DiscountRule$5;\n /** Discount type. */\n discountType?: DiscountType$5;\n /**\n * IDs of the line items the discount applies to.\n * @deprecated IDs of line items the discount applies to.\n * @replacedBy line_items_discounts\n * @targetRemovalDate 2024-06-01\n */\n lineItemIds?: string[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$4 {\n /** Coupon details. */\n coupon?: V1Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount$1;\n /** Discount rule */\n discountRule?: DiscountRule$5;\n }\n enum DiscountType$5 {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface V1Coupon$1 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon value. */\n amount?: MultiCurrencyPrice$4;\n /** Coupon name. */\n name?: string;\n }\n interface V1MerchantDiscount$1 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$4;\n /** Discount Percentage. Will be calculated from items price before other discounts. */\n percentage?: number | null;\n }\n interface DiscountRule$5 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$5;\n /** Discount value. */\n amount?: MultiCurrencyPrice$4;\n }\n interface DiscountRuleName$5 {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /** Discount rule name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface LineItemDiscount$4 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$4;\n }\n interface CalculationErrors$3 extends CalculationErrorsShippingCalculationErrorOneOf$3 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$3;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$3;\n /** Tax calculation error. */\n taxCalculationError?: Details$3;\n /** Coupon calculation error. */\n couponCalculationError?: Details$3;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details$3;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$7[];\n /**\n * Membership payment methods calculation errors\n * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid\n */\n membershipError?: Details$3;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details$3;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$3 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$3;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$3;\n }\n interface Details$3 extends DetailsKindOneOf$3 {\n applicationError?: ApplicationError$7;\n validationError?: ValidationError$3;\n systemError?: SystemError$3;\n /**\n * Deprecated in APIs. Used to enable migration from rendering arbitrary tracing to rest response.\n * @deprecated\n */\n tracing?: Record;\n }\n /** @oneof */\n interface DetailsKindOneOf$3 {\n applicationError?: ApplicationError$7;\n validationError?: ValidationError$3;\n systemError?: SystemError$3;\n }\n /**\n * example result:\n * {\n * \"fieldViolations\": [\n * {\n * \"field\": \"fieldA\",\n * \"description\": \"invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]\",\n * \"violatedRule\": \"OTHER\",\n * \"ruleName\": \"INVALID_NOTE\",\n * \"data\": {\n * \"value\": \"FI\"\n * }\n * },\n * {\n * \"field\": \"fieldB\",\n * \"description\": \"field value out of range. supported range: [0-20]\",\n * \"violatedRule\": \"MAX\",\n * \"data\": {\n * \"threshold\": 20\n * }\n * },\n * {\n * \"field\": \"fieldC\",\n * \"description\": \"invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]\",\n * \"violatedRule\": \"FORMAT\",\n * \"data\": {\n * \"type\": \"PHONE\"\n * }\n * }\n * ]\n * }\n */\n interface ValidationError$3 {\n fieldViolations?: FieldViolation$3[];\n }\n enum RuleType$3 {\n VALIDATION = \"VALIDATION\",\n OTHER = \"OTHER\",\n MAX = \"MAX\",\n MIN = \"MIN\",\n MAX_LENGTH = \"MAX_LENGTH\",\n MIN_LENGTH = \"MIN_LENGTH\",\n MAX_SIZE = \"MAX_SIZE\",\n MIN_SIZE = \"MIN_SIZE\",\n FORMAT = \"FORMAT\",\n DECIMAL_LTE = \"DECIMAL_LTE\",\n DECIMAL_GTE = \"DECIMAL_GTE\",\n DECIMAL_LT = \"DECIMAL_LT\",\n DECIMAL_GT = \"DECIMAL_GT\",\n DECIMAL_MAX_SCALE = \"DECIMAL_MAX_SCALE\",\n INVALID_ENUM_VALUE = \"INVALID_ENUM_VALUE\",\n REQUIRED_FIELD = \"REQUIRED_FIELD\",\n FIELD_NOT_ALLOWED = \"FIELD_NOT_ALLOWED\",\n ONE_OF_ALIGNMENT = \"ONE_OF_ALIGNMENT\"\n }\n interface FieldViolation$3 {\n field?: string;\n description?: string;\n violatedRule?: RuleType$3;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError$3 {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors$3 {\n /** Carrier errors. */\n errors?: CarrierError$3[];\n }\n interface CarrierError$3 {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details$3;\n }\n interface MembershipOptions$3 {\n /** List of payment options that can be used. */\n eligibleMemberships?: Membership$3[];\n /** List of payment options that are owned by the member, but cannot be used due to reason provided. */\n invalidMemberships?: InvalidMembership$3[];\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: HostSelectedMembership$1[];\n }\n interface Membership$3 {\n /** Membership ID. */\n _id?: string;\n /** ID of the application providing this payment option. */\n appId?: string;\n /** The name of this membership. */\n name?: MembershipName$5;\n /** Line item IDs which are \"paid\" for by this membership. */\n lineItemIds?: string[];\n /** Optional - For a membership that has limited credits, information about credit usage. */\n credits?: MembershipPaymentCredits$3;\n /** Optional - TMembership expiry date. */\n expirationDate?: Date;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$5 {\n /** The name of this membership */\n original?: string;\n /** Membership name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface MembershipPaymentCredits$3 {\n /** How much credit this membership has in total */\n total?: number;\n /** How much credit remained for this membership */\n remaining?: number;\n }\n interface InvalidMembership$3 {\n /** Membership details. */\n membership?: Membership$3;\n /** Reason why this membership is invalid and cannot be used. */\n reason?: string;\n }\n interface AdditionalFee$4 {\n /** Additional fee's unique code (or ID) for future processing. */\n code?: string | null;\n /** Translated additional fee's name. */\n name?: string;\n /** Additional fee's price. */\n price?: MultiCurrencyPrice$4;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$4;\n /** Provider's app id. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: MultiCurrencyPrice$4;\n /** Additional fee's price after tax. */\n priceAfterTax?: MultiCurrencyPrice$4;\n /**\n * Optional - Line items associated with this additional fee.\n * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.\n */\n lineItemIds?: string[];\n }\n interface Violation$3 {\n /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */\n severity?: Severity$3;\n /** Target location on a checkout or cart page where the violation will be displayed. */\n target?: Target$3;\n /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`. */\n description?: string | null;\n }\n enum Severity$3 {\n /** The user is allowed to move forward in the flow. */\n WARNING = \"WARNING\",\n /**\n * The user is blocked from moving forward in the flow.\n * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.\n */\n ERROR = \"ERROR\"\n }\n interface Target$3 extends TargetTargetTypeOneOf$3 {\n /** General (other) violation. */\n other?: Other$3;\n /** Specific line item violation. */\n lineItem?: TargetLineItem$3;\n }\n /** @oneof */\n interface TargetTargetTypeOneOf$3 {\n /** General (other) violation. */\n other?: Other$3;\n /** Specific line item violation. */\n lineItem?: TargetLineItem$3;\n }\n /** Available locations on the webpage */\n enum NameInOther$3 {\n /** default location, in case no specific location is specified */\n OTHER_DEFAULT = \"OTHER_DEFAULT\"\n }\n /** Available locations on the line item */\n enum NameInLineItem$3 {\n /** default location, in case no specific location is specified */\n LINE_ITEM_DEFAULT = \"LINE_ITEM_DEFAULT\"\n }\n /** General (other) violation. */\n interface Other$3 {\n /** Location on a checkout or a cart page where a general (other) violation will be displayed. */\n name?: NameInOther$3;\n }\n /** Specific line item violation. */\n interface TargetLineItem$3 {\n /** Location on a checkout or a cart page where the specific line item violation will be displayed. */\n name?: NameInLineItem$3;\n /** ID of the line item containing the violation. */\n _id?: string | null;\n }\n interface RemoveLineItemsFromCurrentCartRequest$1 {\n /** IDs of the line items to remove from the cart. */\n lineItemIds: string[];\n }\n interface RemoveLineItemsResponse$2 {\n /** Updated cart. */\n cart?: Cart$1;\n }\n interface CreateCheckoutFromCurrentCartRequest$1 {\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$5;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */\n email?: string | null;\n }\n enum ChannelType$5 {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n POS = \"POS\",\n EBAY = \"EBAY\",\n AMAZON = \"AMAZON\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\",\n WIX_INVOICES = \"WIX_INVOICES\",\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n WISH = \"WISH\",\n CLASS_PASS = \"CLASS_PASS\",\n GLOBAL_E = \"GLOBAL_E\",\n FACEBOOK = \"FACEBOOK\",\n ETSY = \"ETSY\",\n TIKTOK = \"TIKTOK\",\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreateCheckoutResponse$2 {\n /** The newly created checkout's ID. */\n checkoutId?: string;\n }\n interface RemoveCouponFromCurrentCartRequest$1 {\n }\n interface RemoveCouponResponse$2 {\n /** Updated cart. */\n cart?: Cart$1;\n }\n interface UpdateCurrentCartLineItemQuantityRequest$1 {\n /** Line item IDs and their new quantity. */\n lineItems: LineItemQuantityUpdate$2[];\n }\n interface LineItemQuantityUpdate$2 {\n /** Line item ID. Required. */\n _id?: string;\n /** New quantity. Number must be 1 or higher. Required. */\n quantity?: number;\n }\n interface UpdateLineItemsQuantityResponse$2 {\n /** Updated cart. */\n cart?: Cart$1;\n }\n interface EstimateCurrentCartTotalsRequest$1 {\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$3;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n interface DeleteCurrentCartRequest$1 {\n }\n interface DeleteCartResponse$1 {\n }\n interface DomainEvent$b extends DomainEventBodyOneOf$b {\n createdEvent?: EntityCreatedEvent$b;\n updatedEvent?: EntityUpdatedEvent$b;\n deletedEvent?: EntityDeletedEvent$b;\n actionEvent?: ActionEvent$b;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$b {\n createdEvent?: EntityCreatedEvent$b;\n updatedEvent?: EntityUpdatedEvent$b;\n deletedEvent?: EntityDeletedEvent$b;\n actionEvent?: ActionEvent$b;\n }\n interface EntityCreatedEvent$b {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$7;\n }\n interface RestoreInfo$7 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$b {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$b {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$b {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$b {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$b;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$b extends IdentificationDataIdOneOf$b {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$b;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$b {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$b {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface CreateCartRequest$1 {\n /** Cart info. */\n cartInfo?: Cart$1;\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput$2[];\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n interface CreateCartResponse$1 {\n /** Cart. */\n cart?: Cart$1;\n }\n interface GetCartRequest$1 {\n /** ID of the cart to retrieve. */\n _id: string;\n }\n interface GetCartResponse$1 {\n /** The requested cart. */\n cart?: Cart$1;\n }\n interface GetCartByCheckoutIdRequest$1 {\n /** Checkout ID. */\n _id: string;\n }\n interface GetCartByCheckoutIdResponse$1 {\n /** The requested cart. */\n cart?: Cart$1;\n }\n interface AddToCartRequest$1 {\n /** Cart ID. */\n _id: string;\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n interface RemoveLineItemsRequest$2 {\n /** Cart ID. */\n _id: string;\n /** IDs of the line items to remove from the cart. */\n lineItemIds: string[];\n }\n interface CreateCheckoutRequest$2 {\n /** Cart ID. */\n _id: string;\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$5;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */\n email?: string | null;\n }\n interface RemoveCouponRequest$2 {\n /** Cart ID. */\n _id: string;\n }\n interface UpdateLineItemsQuantityRequest$2 {\n /** Cart ID. */\n _id: string;\n /** Line item IDs and their new quantity. */\n lineItems: LineItemQuantityUpdate$2[];\n }\n interface EstimateTotalsRequest$1 {\n /** Cart ID. */\n _id: string;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$3;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n interface DeleteCartRequest$1 {\n /** ID of the cart to delete. */\n _id: string;\n }\n interface Empty$7 {\n }\n /**\n * Creates a new cart.\n *\n *\n * The `createCart()` function returns a Promise that resolves to the new cart when it's created.\n *\n * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.\n * @public\n * @requiredField options.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.productName\n * @requiredField options.lineItems.catalogReference\n * @requiredField options.lineItems.quantity\n * @requiredField options.lineItems.selectedMembership._id\n * @requiredField options.lineItems.selectedMembership.appId\n * @param options - Cart creation options.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionId ECOM.ADMIN_MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - Admin Permissions\n * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Cart.\n */\n function createCart(options?: CreateCartOptions): Promise;\n interface CreateCartOptions {\n /** Cart info. */\n cartInfo?: Cart$1;\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput$2[];\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n /**\n * Updates a specified cart's properties.\n *\n *\n * The `updateCart()` function returns a Promise that resolves when the specified cart's properties are updated.\n *\n * > **Note:** When updating catalog items, `options.lineItems.catalogReference` is required.\n * @public\n * @requiredField _id\n * @requiredField options.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.productName\n * @requiredField options.lineItems.catalogReference\n * @param options - Available options to use when updating a cart.\n * @param _id - ID of the cart to be updated.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionId ECOM.ADMIN_MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - Admin Permissions\n * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Updated cart.\n */\n function updateCart(_id: string | null, options?: UpdateCartOptions): Promise;\n interface UpdateCartOptions {\n /** The information for the cart being updated. */\n cartInfo: {\n /** ID of the cart to be updated. */\n _id?: string | null;\n /**\n * Line items.\n * @readonly\n */\n lineItems?: LineItem$6[];\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$6;\n /**\n * Currency used for pricing.\n * @readonly\n */\n currency?: string;\n /**\n * Currency code used for all the converted prices that are returned.\n * For a site that supports multiple currencies, this is the currency the buyer selected.\n * @readonly\n */\n conversionCurrency?: string;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n * @readonly\n */\n buyerLanguage?: string | null;\n /**\n * Site language in which original values are displayed.\n * @readonly\n */\n siteLanguage?: string | null;\n /**\n * Whether tax is included in line item prices.\n * @readonly\n */\n taxIncludedInPrices?: boolean | null;\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$5;\n /**\n * ID of the checkout that originated from this cart.\n * @readonly\n */\n checkoutId?: string | null;\n /**\n * Cart discounts.\n * @readonly\n */\n appliedDiscounts?: CartDiscount$1[];\n /**\n * Date and time the cart was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the cart was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Contact info. */\n contactInfo?: AddressWithContact$4;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n /**\n * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.\n * @readonly\n */\n purchaseFlowId?: string | null;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n };\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput$2[];\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n /**\n * Retrieves a cart.\n *\n *\n * The `getCart()` function returns a Promise that resolves when the specified cart is retrieved.\n * @param _id - ID of the cart to retrieve.\n * @public\n * @requiredField _id\n * @permissionId ECOM.READ_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - The specified cart.\n */\n function getCart(_id: string): Promise;\n /**\n * Adds catalog line items to a cart.\n *\n *\n * The `addToCart()` function returns a Promise that resolves to the updated cart when the specified items have been added.\n *\n * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.\n * @param _id - Cart ID.\n * @public\n * @requiredField _id\n * @requiredField options.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.productName\n * @requiredField options.lineItems.catalogReference\n * @requiredField options.lineItems.selectedMembership._id\n * @requiredField options.lineItems.selectedMembership.appId\n * @param options - Items to be added to cart.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionId ECOM.ADMIN_MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - Admin Permissions\n * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Cart.\n */\n function addToCart(_id: string, options?: AddToCartOptions): Promise;\n interface AddToCartOptions {\n /** Catalog line items. */\n lineItems?: LineItem$6[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$3[];\n }\n /**\n * Removes line items from the specified cart.\n *\n *\n * The `removeLineItems()` function returns a Promise that resolves to the updated cart when the line items are removed from the specified cart.\n * @public\n * @requiredField _id\n * @requiredField lineItemIds\n * @param lineItemIds - IDs of the line items to remove from the cart.\n * @param _id - ID of the cart to remove line items from.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Updated cart.\n */\n function removeLineItems$1(_id: string, lineItemIds: string[]): Promise;\n /**\n * Creates a checkout from a cart.\n *\n *\n * The `createCheckout()` function returns a Promise that resolves to the new checkout's ID when it's created.\n *\n * If a checkout was already created from the specified cart, that checkout will be\n * updated with any new information from the cart.\n *\n * > **Note:** `options.channelType` is a required field.\n * @param _id - Cart ID.\n * @public\n * @requiredField _id\n * @param options - Checkout creation options.\n * @permissionId ECOM.CREATE_CHECKOUT_FROM_CART\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - ID of the newly created checkout.\n */\n function createCheckout$1(_id: string, options?: CreateCheckoutOptions$1): Promise;\n interface CreateCheckoutOptions$1 {\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$5;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */\n email?: string | null;\n }\n /**\n * Removes the coupon from a specified cart.\n *\n *\n * The `removeCoupon()` function returns a Promise that resolves to the updated cart when the coupon is removed from the specified cart.\n * @param _id - Cart ID.\n * @public\n * @requiredField _id\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Updated cart.\n */\n function removeCoupon$1(_id: string): Promise;\n /**\n * Updates the quantity of one or more line items in a specified cart.\n *\n *\n * The `updateLineItemsQuantity()` function returns a Promise that resolves when the quantities of the specified cart's line items are updated.\n *\n * This endpoint is only for updating the quantity of line items. To entirely remove a line item from the cart, use [`removeLineItems()`](#removelineitems). To add a new line item to the cart, use [`addToCart()`](#addtocart).\n *\n * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.\n * @param _id - Cart ID.\n * @param lineItems - Line item IDs and their new quantity.\n * @public\n * @requiredField _id\n * @requiredField lineItems\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Updated cart.\n */\n function updateLineItemsQuantity$1(_id: string, lineItems: LineItemQuantityUpdate$2[]): Promise;\n /**\n * Estimates the subtotal and total for current site visitor’s cart. Totals include tax and are based on the selected carrier service, shipping address, and billing information.\n *\n *\n * The `estimateTotals()` function returns a Promise that resolves when the estimated totals are generated.\n *\n * > **Note:** Not passing any `options` properties will only estimate the cart items price totals.\n * @param _id - Cart ID.\n * @public\n * @requiredField _id\n * @param options - Total estimation options.\n * @permissionId ECOM.READ_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Cart's estimated totals.\n */\n function estimateTotals(_id: string, options?: EstimateTotalsOptions): Promise;\n interface EstimateTotalsOptions {\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$5;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$5;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$3;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n /**\n * Deletes a cart.\n *\n *\n * The `deleteCart()` function returns a Promise that resolves when the specified cart is deleted.\n * @public\n * @requiredField _id\n * @param _id - ID of the cart to delete.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - When the cart is deleted. Rejected - Error message.\n */\n function deleteCart(_id: string): Promise;\n const ecomV1CartCart_universal_d_createCart: typeof createCart;\n type ecomV1CartCart_universal_d_CreateCartOptions = CreateCartOptions;\n const ecomV1CartCart_universal_d_updateCart: typeof updateCart;\n type ecomV1CartCart_universal_d_UpdateCartOptions = UpdateCartOptions;\n const ecomV1CartCart_universal_d_getCart: typeof getCart;\n const ecomV1CartCart_universal_d_addToCart: typeof addToCart;\n type ecomV1CartCart_universal_d_AddToCartOptions = AddToCartOptions;\n const ecomV1CartCart_universal_d_estimateTotals: typeof estimateTotals;\n type ecomV1CartCart_universal_d_EstimateTotalsOptions = EstimateTotalsOptions;\n const ecomV1CartCart_universal_d_deleteCart: typeof deleteCart;\n namespace ecomV1CartCart_universal_d {\n export { Cart$1 as Cart, LineItem$6 as LineItem, CatalogReference$7 as CatalogReference, ProductName$4 as ProductName, MultiCurrencyPrice$4 as MultiCurrencyPrice, DescriptionLine$4 as DescriptionLine, DescriptionLineValueOneOf$4 as DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf$4 as DescriptionLineDescriptionLineValueOneOf, DescriptionLineName$4 as DescriptionLineName, PlainTextValue$4 as PlainTextValue, Color$4 as Color, DescriptionLineType$4 as DescriptionLineType, ItemAvailabilityInfo$3 as ItemAvailabilityInfo, ItemAvailabilityStatus$3 as ItemAvailabilityStatus, PhysicalProperties$4 as PhysicalProperties, Scope$4 as Scope, Group$3 as Group, ItemType$4 as ItemType, ItemTypeItemTypeDataOneOf$4 as ItemTypeItemTypeDataOneOf, ItemTypeItemType$4 as ItemTypeItemType, SubscriptionOptionInfo$4 as SubscriptionOptionInfo, SubscriptionSettings$5 as SubscriptionSettings, SubscriptionFrequency$5 as SubscriptionFrequency, Title$3 as Title, Description$3 as Description, SecuredMedia$3 as SecuredMedia, FileType$3 as FileType, PaymentOptionType$4 as PaymentOptionType, ServiceProperties$4 as ServiceProperties, PriceDescription$4 as PriceDescription, SelectedMembership$3 as SelectedMembership, CatalogOverrideFields$3 as CatalogOverrideFields, TaxableAddress$2 as TaxableAddress, TaxableAddressTaxableAddressDataOneOf$2 as TaxableAddressTaxableAddressDataOneOf, TaxableAddressType$2 as TaxableAddressType, BuyerInfo$6 as BuyerInfo, BuyerInfoIdOneOf$4 as BuyerInfoIdOneOf, WeightUnit$5 as WeightUnit, CartDiscount$1 as CartDiscount, CartDiscountDiscountSourceOneOf$1 as CartDiscountDiscountSourceOneOf, Coupon$4 as Coupon, MerchantDiscount$4 as MerchantDiscount, AddressWithContact$4 as AddressWithContact, Address$5 as Address, StreetAddress$4 as StreetAddress, AddressLocation$4 as AddressLocation, FullAddressContactDetails$4 as FullAddressContactDetails, VatId$5 as VatId, VatType$5 as VatType, SelectedShippingOption$1 as SelectedShippingOption, ExtendedFields$5 as ExtendedFields, GetCurrentCartRequest$1 as GetCurrentCartRequest, GetCurrentCartResponse$1 as GetCurrentCartResponse, UpdateCartRequest$1 as UpdateCartRequest, MerchantDiscountInput$2 as MerchantDiscountInput, CustomLineItem$3 as CustomLineItem, UpdateCartResponse$1 as UpdateCartResponse, AddToCurrentCartRequest$1 as AddToCurrentCartRequest, AddToCartResponse$1 as AddToCartResponse, AddToCurrentCartAndEstimateTotalsRequest$1 as AddToCurrentCartAndEstimateTotalsRequest, SelectedMemberships$3 as SelectedMemberships, HostSelectedMembership$1 as HostSelectedMembership, EstimateTotalsResponse$1 as EstimateTotalsResponse, CalculatedLineItem$1 as CalculatedLineItem, LineItemPricesData$1 as LineItemPricesData, ItemTaxFullDetails$4 as ItemTaxFullDetails, TaxRateBreakdown$3 as TaxRateBreakdown, TaxBreakdown$3 as TaxBreakdown, JurisdictionType$4 as JurisdictionType, PriceSummary$4 as PriceSummary, GiftCard$4 as GiftCard, TaxSummary$4 as TaxSummary, TaxCalculationDetails$3 as TaxCalculationDetails, TaxCalculationDetailsCalculationDetailsOneOf$3 as TaxCalculationDetailsCalculationDetailsOneOf, RateType$3 as RateType, ManualCalculationReason$3 as ManualCalculationReason, AutoTaxFallbackCalculationDetails$3 as AutoTaxFallbackCalculationDetails, FallbackReason$3 as FallbackReason, ApplicationError$7 as ApplicationError, AggregatedTaxBreakdown$3 as AggregatedTaxBreakdown, ShippingInformation$2 as ShippingInformation, ShippingRegion$4 as ShippingRegion, SelectedCarrierServiceOption$3 as SelectedCarrierServiceOption, DeliveryLogistics$4 as DeliveryLogistics, PickupDetails$5 as PickupDetails, PickupMethod$4 as PickupMethod, DeliveryTimeSlot$4 as DeliveryTimeSlot, SelectedCarrierServiceOptionPrices$3 as SelectedCarrierServiceOptionPrices, SelectedCarrierServiceOptionOtherCharge$3 as SelectedCarrierServiceOptionOtherCharge, ChargeType$3 as ChargeType, CarrierServiceOption$3 as CarrierServiceOption, ShippingOption$3 as ShippingOption, ShippingPrice$4 as ShippingPrice, OtherCharge$3 as OtherCharge, AppliedDiscount$5 as AppliedDiscount, AppliedDiscountDiscountSourceOneOf$4 as AppliedDiscountDiscountSourceOneOf, DiscountType$5 as DiscountType, V1Coupon$1 as V1Coupon, V1MerchantDiscount$1 as V1MerchantDiscount, DiscountRule$5 as DiscountRule, DiscountRuleName$5 as DiscountRuleName, LineItemDiscount$4 as LineItemDiscount, CalculationErrors$3 as CalculationErrors, CalculationErrorsShippingCalculationErrorOneOf$3 as CalculationErrorsShippingCalculationErrorOneOf, Details$3 as Details, DetailsKindOneOf$3 as DetailsKindOneOf, ValidationError$3 as ValidationError, RuleType$3 as RuleType, FieldViolation$3 as FieldViolation, SystemError$3 as SystemError, CarrierErrors$3 as CarrierErrors, CarrierError$3 as CarrierError, MembershipOptions$3 as MembershipOptions, Membership$3 as Membership, MembershipName$5 as MembershipName, MembershipPaymentCredits$3 as MembershipPaymentCredits, InvalidMembership$3 as InvalidMembership, AdditionalFee$4 as AdditionalFee, Violation$3 as Violation, Severity$3 as Severity, Target$3 as Target, TargetTargetTypeOneOf$3 as TargetTargetTypeOneOf, NameInOther$3 as NameInOther, NameInLineItem$3 as NameInLineItem, Other$3 as Other, TargetLineItem$3 as TargetLineItem, RemoveLineItemsFromCurrentCartRequest$1 as RemoveLineItemsFromCurrentCartRequest, RemoveLineItemsResponse$2 as RemoveLineItemsResponse, CreateCheckoutFromCurrentCartRequest$1 as CreateCheckoutFromCurrentCartRequest, ChannelType$5 as ChannelType, CreateCheckoutResponse$2 as CreateCheckoutResponse, RemoveCouponFromCurrentCartRequest$1 as RemoveCouponFromCurrentCartRequest, RemoveCouponResponse$2 as RemoveCouponResponse, UpdateCurrentCartLineItemQuantityRequest$1 as UpdateCurrentCartLineItemQuantityRequest, LineItemQuantityUpdate$2 as LineItemQuantityUpdate, UpdateLineItemsQuantityResponse$2 as UpdateLineItemsQuantityResponse, EstimateCurrentCartTotalsRequest$1 as EstimateCurrentCartTotalsRequest, DeleteCurrentCartRequest$1 as DeleteCurrentCartRequest, DeleteCartResponse$1 as DeleteCartResponse, DomainEvent$b as DomainEvent, DomainEventBodyOneOf$b as DomainEventBodyOneOf, EntityCreatedEvent$b as EntityCreatedEvent, RestoreInfo$7 as RestoreInfo, EntityUpdatedEvent$b as EntityUpdatedEvent, EntityDeletedEvent$b as EntityDeletedEvent, ActionEvent$b as ActionEvent, MessageEnvelope$b as MessageEnvelope, IdentificationData$b as IdentificationData, IdentificationDataIdOneOf$b as IdentificationDataIdOneOf, WebhookIdentityType$b as WebhookIdentityType, CreateCartRequest$1 as CreateCartRequest, CreateCartResponse$1 as CreateCartResponse, GetCartRequest$1 as GetCartRequest, GetCartResponse$1 as GetCartResponse, GetCartByCheckoutIdRequest$1 as GetCartByCheckoutIdRequest, GetCartByCheckoutIdResponse$1 as GetCartByCheckoutIdResponse, AddToCartRequest$1 as AddToCartRequest, RemoveLineItemsRequest$2 as RemoveLineItemsRequest, CreateCheckoutRequest$2 as CreateCheckoutRequest, RemoveCouponRequest$2 as RemoveCouponRequest, UpdateLineItemsQuantityRequest$2 as UpdateLineItemsQuantityRequest, EstimateTotalsRequest$1 as EstimateTotalsRequest, DeleteCartRequest$1 as DeleteCartRequest, Empty$7 as Empty, ecomV1CartCart_universal_d_createCart as createCart, ecomV1CartCart_universal_d_CreateCartOptions as CreateCartOptions, ecomV1CartCart_universal_d_updateCart as updateCart, ecomV1CartCart_universal_d_UpdateCartOptions as UpdateCartOptions, ecomV1CartCart_universal_d_getCart as getCart, ecomV1CartCart_universal_d_addToCart as addToCart, ecomV1CartCart_universal_d_AddToCartOptions as AddToCartOptions, removeLineItems$1 as removeLineItems, createCheckout$1 as createCheckout, CreateCheckoutOptions$1 as CreateCheckoutOptions, removeCoupon$1 as removeCoupon, updateLineItemsQuantity$1 as updateLineItemsQuantity, ecomV1CartCart_universal_d_estimateTotals as estimateTotals, ecomV1CartCart_universal_d_EstimateTotalsOptions as EstimateTotalsOptions, ecomV1CartCart_universal_d_deleteCart as deleteCart, };\n }\n interface Checkout$1 {\n /**\n * Checkout ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Line items.\n *\n * Max: 300 items\n * @readonly\n */\n lineItems?: LineItem$5[];\n /** Billing information. */\n billingInfo?: AddressWithContact$3;\n /** Shipping information. */\n shippingInfo?: ShippingInfo$2;\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$5;\n /**\n * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * @readonly\n */\n conversionCurrency?: string;\n /**\n * Calculated price summary for the checkout.\n * @readonly\n */\n priceSummary?: PriceSummary$3;\n /**\n * Errors when calculating totals.\n * @readonly\n */\n calculationErrors?: CalculationErrors$2;\n /**\n * Applied gift card details.\n *\n * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).\n * @readonly\n */\n giftCard?: GiftCard$3;\n /**\n * Applied discounts.\n * @readonly\n */\n appliedDiscounts?: AppliedDiscount$4[];\n /** Custom fields. */\n customFields?: CustomField$3[];\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$4;\n /**\n * Tax summary.\n * @readonly\n */\n taxSummary?: TaxSummary$3;\n /**\n * The currency used when submitting the order.\n * @readonly\n */\n currency?: string;\n /**\n * Sales channel that submitted the order.\n * + `\"UNSPECIFIED\"`: Unspecified sales channel. This value is not supported.\n * + `\"WEB\"`: A web client.\n * + `\"POS\"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)\n * + `\"EBAY\"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)\n * + `\"AMAZON\"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)\n * + `\"WISH\"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)\n * + `\"WIX_INVOICES\"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)\n * + `\"WIX_APP_STORE\"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)\n * + `\"BACKOFFICE_MERCHANT\"`: Wix merchant backoffice\n * + `\"OTHER_PLATFORM\"`: Other sales platform.\n * @readonly\n */\n channelType?: ChannelType$4;\n /**\n * Site language in which original values are shown.\n * @readonly\n */\n siteLanguage?: string;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n * @readonly\n */\n buyerLanguage?: string;\n /**\n * Whether an order was successfully created from this checkout.\n * For an order to be successful, it must be successfully paid for (unless the total is 0).\n * @readonly\n */\n completed?: boolean;\n /**\n * Whether tax is included in line item prices.\n * @readonly\n */\n taxIncludedInPrice?: boolean;\n /**\n * ID of the checkout's initiator.\n * @readonly\n */\n createdBy?: CreatedBy$2;\n /**\n * Date and time the checkout was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the checkout was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Minimal amount to pay in order to place the order.\n * @readonly\n */\n payNow?: PriceSummary$3;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$3;\n /** Memberships to apply when creating the order. */\n membershipOptions?: MembershipOptions$2;\n /** Additional Fees. */\n additionalFees?: AdditionalFee$3[];\n /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */\n cartId?: string | null;\n /**\n * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).\n * @readonly\n */\n violations?: Violation$2[];\n /**\n * Custom field data for the checkout object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$4;\n /**\n * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.\n * @readonly\n */\n purchaseFlowId?: string | null;\n /**\n * Additional settings for customization of the checkout process.\n *\n * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).\n */\n customSettings?: CustomSettings$1;\n /**\n * Reference IDs for the app and component providing custom checkout page content.\n *\n * To access and manage custom checkout page content, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customContentReference?: CustomContentReference$1;\n }\n interface LineItem$5 {\n /**\n * Line item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Item quantity.\n *\n * Min: `\"1\"`\n * Max: `\"100000\"`\n */\n quantity?: number;\n /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$6;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n * @readonly\n */\n productName?: ProductName$3;\n /**\n * URL to the item's page on the site.\n * @readonly\n */\n url?: string;\n /**\n * Item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n price?: MultiCurrencyPrice$3;\n /**\n * Total line item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n lineItemPrice?: MultiCurrencyPrice$3;\n /**\n * Item price **before** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n fullPrice?: MultiCurrencyPrice$3;\n /**\n * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: MultiCurrencyPrice$3;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: MultiCurrencyPrice$3;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: MultiCurrencyPrice$3;\n /**\n * Tax details for this line item.\n * @readonly\n */\n taxDetails?: ItemTaxFullDetails$3;\n /**\n * Discount for this line item's entire quantity.\n * @readonly\n */\n discount?: MultiCurrencyPrice$3;\n /**\n * Line item description lines. Used for displaying the cart, checkout and order.\n * @readonly\n */\n descriptionLines?: DescriptionLine$3[];\n /**\n * Line item image details.\n * @readonly\n */\n media?: string;\n /**\n * Item availability details.\n * @readonly\n */\n availability?: ItemAvailabilityInfo$2;\n /**\n * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.\n * @readonly\n */\n physicalProperties?: PhysicalProperties$3;\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$3;\n /**\n * Type of selected payment option for current item. Defaults to `\"FULL_PAYMENT_ONLINE\"`.\n * + `\"FULL_PAYMENT_ONLINE\"`: The entire payment for this item happens as part of the checkout.\n * + `\"FULL_PAYMENT_OFFLINE\"`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `\"MEMBERSHIP\"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `\"DEPOSIT_ONLINE\"`: Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n * @readonly\n */\n paymentOption?: PaymentOptionType$3;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * @readonly\n */\n serviceProperties?: ServiceProperties$3;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field has the same value as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\".\n * @readonly\n */\n priceDescription?: PriceDescription$3;\n /**\n * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.\n * @readonly\n */\n depositAmount?: MultiCurrencyPrice$3;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @readonly\n */\n customLineItem?: boolean;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Overriding values for catalog item properties.\n *\n * To override catalog fields, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n catalogOverrideFields?: CatalogOverrideFields$2;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$6 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs.\n *\n * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).\n */\n options?: Record | null;\n }\n interface ProductName$3 {\n /**\n * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n *\n * Min: 1 character.\n * Max: 200 characters.\n */\n original?: string;\n /**\n * Item name translated into the buyer's language.\n *\n * Min: 1 character.\n * Max: 400 characters.\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface MultiCurrencyPrice$3 {\n /** Amount. */\n amount?: string;\n /**\n * Converted amount.\n * @readonly\n */\n convertedAmount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n /**\n * Converted amount formatted with currency symbol.\n * @readonly\n */\n formattedConvertedAmount?: string;\n }\n interface ItemTaxFullDetails$3 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$3;\n /** Tax rate %, as a decimal point between 0 and 1. */\n taxRate?: string;\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n totalTax?: MultiCurrencyPrice$3;\n /**\n * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.\n * @readonly\n * @deprecated\n */\n rateBreakdown?: TaxRateBreakdown$2[];\n }\n interface TaxRateBreakdown$2 {\n /** Name of tax against which the calculation was performed. */\n name?: string;\n /** Rate at which this tax detail was calculated. */\n rate?: string;\n /** Amount of tax for this tax detail. */\n tax?: MultiCurrencyPrice$3;\n }\n /**\n * TaxBreakdown represents tax information for a line item.\n * It holds the tax amount and the tax rate for each tax authority that apply on the line item.\n */\n interface TaxBreakdown$2 {\n /** The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\". */\n jurisdiction?: string | null;\n /** The amount of this line item price that was considered nontaxable. (Decimal value) */\n nonTaxableAmount?: MultiCurrencyPrice$3;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */\n rate?: string | null;\n /** The amount of tax estimated for this line item. (Decimal value) */\n taxAmount?: MultiCurrencyPrice$3;\n /** The taxable amount of this line item. */\n taxableAmount?: MultiCurrencyPrice$3;\n /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc. */\n taxType?: string | null;\n /**\n * The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\n * This name should be explicit enough to allow the merchant to understand what tax was calculated.\n */\n taxName?: string | null;\n /** The type of the jurisdiction in which this tax detail applies. */\n jurisdictionType?: JurisdictionType$3;\n }\n /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n enum JurisdictionType$3 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface DescriptionLine$3 extends DescriptionLineValueOneOf$3, DescriptionLineDescriptionLineValueOneOf$3 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$3;\n /** Description line color value. */\n colorInfo?: Color$3;\n /** Description line name. */\n name?: DescriptionLineName$3;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf$3 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$3;\n /** Description line color value. */\n colorInfo?: Color$3;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf$3 {\n }\n interface DescriptionLineName$3 {\n /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface PlainTextValue$3 {\n /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line plain text value translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Color$3 {\n /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line color name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n /** HEX or RGB color code for display. */\n code?: string | null;\n }\n enum DescriptionLineType$3 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n COLOR = \"COLOR\"\n }\n interface ItemAvailabilityInfo$2 {\n /**\n * Item availability status.\n * + `\"NOT_FOUND\"`: Item does not exist\n * + `\"NOT_AVAILABLE\"`: Item not in stock\n * + `\"PARTIALLY_AVAILABLE\"`: Available quantity is less than requested\n */\n status?: ItemAvailabilityStatus$2;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus$2 {\n AVAILABLE = \"AVAILABLE\",\n NOT_FOUND = \"NOT_FOUND\",\n /** Not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface PhysicalProperties$3 {\n /** Line item weight. Measurement unit (`\"KG\"` or `\"LB\"`) is taken from `order.weightUnit`. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface Scope$3 {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */\n namespace?: string;\n /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */\n group?: Group$2;\n }\n interface Group$2 {\n /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n name?: string;\n /** Item ID (when the coupon scope is limited to just one item). */\n entityId?: string | null;\n }\n interface ItemType$3 extends ItemTypeItemTypeDataOneOf$3 {\n /** Preset item type. */\n preset?: ItemTypeItemType$3;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n /** @oneof */\n interface ItemTypeItemTypeDataOneOf$3 {\n /** Preset item type. */\n preset?: ItemTypeItemType$3;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$3 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PHYSICAL = \"PHYSICAL\",\n DIGITAL = \"DIGITAL\",\n GIFT_CARD = \"GIFT_CARD\",\n SERVICE = \"SERVICE\"\n }\n interface SubscriptionOptionInfo$3 {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings$4;\n /** Subscription option title. */\n title?: Title$2;\n /** Subscription option description. */\n description?: Description$2;\n }\n interface SubscriptionSettings$4 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$4;\n /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n */\n interval?: number | null;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$4 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface Title$2 {\n /** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Subscription option name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Description$2 {\n /** Subscription option description. */\n original?: string;\n /** Translated subscription option description. */\n translated?: string | null;\n }\n interface SecuredMedia$2 {\n /** Media ID in Wix Media Manager. */\n _id?: string;\n /** Original filename. */\n fileName?: string;\n /** File type. */\n fileType?: FileType$2;\n }\n enum FileType$2 {\n UNSPECIFIED = \"UNSPECIFIED\",\n SECURE_PICTURE = \"SECURE_PICTURE\",\n SECURE_VIDEO = \"SECURE_VIDEO\",\n SECURE_DOCUMENT = \"SECURE_DOCUMENT\",\n SECURE_MUSIC = \"SECURE_MUSIC\",\n SECURE_ARCHIVE = \"SECURE_ARCHIVE\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType$3 {\n /** The entire payment for this item happens as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\",\n /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface ServiceProperties$3 {\n /**\n * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * For example, the start time of a class.\n */\n scheduledDate?: Date;\n /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface PriceDescription$3 {\n /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Price description translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface CatalogOverrideFields$2 {\n /** Item name. */\n productName?: ProductName$3;\n /** Item price **after** discounts. */\n price?: string | null;\n /** Item price **before** discounts. */\n fullPrice?: string | null;\n /** Item description lines. Used when displaying the line item to customers. */\n descriptionLines?: DescriptionLine$3[];\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$3;\n /** Item image. */\n image?: string;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface TaxableAddress$1 extends TaxableAddressTaxableAddressDataOneOf$1 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$1;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$1 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$1;\n }\n enum TaxableAddressType$1 {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$3 {\n /** Address. */\n address?: ApiAddress;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$3;\n }\n /** Physical address */\n interface ApiAddress {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. */\n streetAddress?: StreetAddress$3;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n interface StreetAddress$3 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$3 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails$3 {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Company name. */\n company?: string | null;\n /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */\n vatId?: CommonVatId;\n }\n interface CommonVatId {\n /** Customer's tax ID. */\n _id?: string;\n /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\n type?: CommonVatType;\n }\n /** tax info types */\n enum CommonVatType {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface ShippingInfo$2 {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact$3;\n /** Selected option out of the options allowed for the `region`. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption$2;\n /**\n * Shipping region. Based on the address provided.\n * @readonly\n */\n region?: ShippingRegion$3;\n /**\n * All carrier options for this shipping rule.\n * @readonly\n */\n carrierServiceOptions?: CarrierServiceOption$2[];\n }\n interface SelectedCarrierServiceOption$2 {\n /** Unique identifier of selected option. For example, \"usps_std_overnight\". */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n * @readonly\n */\n title?: string;\n /**\n * Delivery logistics.\n * @readonly\n */\n logistics?: DeliveryLogistics$3;\n /**\n * Shipping costs.\n * @readonly\n */\n cost?: SelectedCarrierServiceOptionPrices$2;\n /**\n * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)\n * @readonly\n */\n requestedShippingOption?: boolean;\n /** Other charges */\n otherCharges?: SelectedCarrierServiceOptionOtherCharge$2[];\n /** This carrier's unique ID */\n carrierId?: string | null;\n }\n interface DeliveryLogistics$3 {\n /** Expected delivery time, in free text. For example, \"3-5 business days\". */\n deliveryTime?: string | null;\n /** Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\". */\n instructions?: string | null;\n /** Pickup details. */\n pickupDetails?: PickupDetails$4;\n }\n interface PickupDetails$4 {\n /** Pickup address. */\n address?: ApiAddress;\n /**\n * Whether the pickup address is that of a business - this may effect tax calculation.\n * @deprecated\n */\n businessLocation?: boolean;\n /** Pickup method */\n pickupMethod?: PickupMethod$3;\n }\n enum PickupMethod$3 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$3 {\n /** starting time of the delivery time slot */\n from?: Date;\n /** ending time of the delivery time slot */\n to?: Date;\n }\n interface SelectedCarrierServiceOptionPrices$2 {\n /** Total shipping price, after discount and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$3;\n /** Total price of shipping after discounts (when relevant), and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$3;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$3;\n /** Shipping discount before tax. */\n totalDiscount?: MultiCurrencyPrice$3;\n /** Shipping price before discount and before tax. */\n price?: MultiCurrencyPrice$3;\n }\n interface SelectedCarrierServiceOptionOtherCharge$2 {\n /** Type of additional cost. */\n type?: ChargeType$2;\n /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */\n details?: string | null;\n /** Price of added charge. */\n cost?: SelectedCarrierServiceOptionPrices$2;\n }\n enum ChargeType$2 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface ShippingRegion$3 {\n /**\n * Shipping region ID.\n * @readonly\n */\n _id?: string;\n /** Shipping region name. */\n name?: string;\n }\n interface CarrierServiceOption$2 {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption$2[];\n }\n interface ShippingOption$2 {\n /**\n * Unique code of provided shipping option like \"usps_std_overnight\".\n * For legacy calculators this would be the UUID of the option.\n */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics$3;\n /** Sipping price information. */\n cost?: ShippingPrice$3;\n }\n interface ShippingPrice$3 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$3;\n /** Other costs such as insurance, handling & packaging for fragile items, etc. */\n otherCharges?: OtherCharge$2[];\n }\n interface OtherCharge$2 {\n /** Type of additional cost. */\n type?: ChargeType$2;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$3;\n }\n interface BuyerInfo$5 extends BuyerInfoIdOneOf$3 {\n /**\n * Visitor ID - if the buyer is **not** a site member.\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID - If the buyer is a site member.\n * @readonly\n */\n memberId?: string;\n /**\n * Contact ID. For more information, see the Contacts API.\n * @readonly\n */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf$3 {\n /**\n * Visitor ID - if the buyer is **not** a site member.\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID - If the buyer is a site member.\n * @readonly\n */\n memberId?: string;\n }\n interface PriceSummary$3 {\n /** Subtotal of all line items, before discounts and before tax. */\n subtotal?: MultiCurrencyPrice$3;\n /** Total shipping price, before discounts and before tax. */\n shipping?: MultiCurrencyPrice$3;\n /** Total tax. */\n tax?: MultiCurrencyPrice$3;\n /** Total calculated discount value. */\n discount?: MultiCurrencyPrice$3;\n /** Total price after discounts, gift cards, and tax. */\n total?: MultiCurrencyPrice$3;\n /** Total additional fees price before tax. */\n additionalFees?: MultiCurrencyPrice$3;\n }\n interface CalculationErrors$2 extends CalculationErrorsShippingCalculationErrorOneOf$2 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$2;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$2;\n /** Tax calculation error. */\n taxCalculationError?: Details$2;\n /** Coupon calculation error. */\n couponCalculationError?: Details$2;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details$2;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$6[];\n /**\n * Membership payment methods calculation errors\n * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid\n */\n membershipError?: Details$2;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details$2;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$2 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$2;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$2;\n }\n interface Details$2 extends DetailsKindOneOf$2 {\n applicationError?: ApplicationError$6;\n validationError?: ValidationError$2;\n systemError?: SystemError$2;\n /**\n * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response\n * @deprecated\n */\n tracing?: Record;\n }\n /** @oneof */\n interface DetailsKindOneOf$2 {\n applicationError?: ApplicationError$6;\n validationError?: ValidationError$2;\n systemError?: SystemError$2;\n }\n interface ApplicationError$6 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n /**\n * example result:\n * {\n * \"fieldViolations\": [\n * {\n * \"field\": \"fieldA\",\n * \"description\": \"invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]\",\n * \"violatedRule\": \"OTHER\",\n * \"ruleName\": \"INVALID_NOTE\",\n * \"data\": {\n * \"value\": \"FI\"\n * }\n * },\n * {\n * \"field\": \"fieldB\",\n * \"description\": \"field value out of range. supported range: [0-20]\",\n * \"violatedRule\": \"MAX\",\n * \"data\": {\n * \"threshold\": 20\n * }\n * },\n * {\n * \"field\": \"fieldC\",\n * \"description\": \"invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]\",\n * \"violatedRule\": \"FORMAT\",\n * \"data\": {\n * \"type\": \"PHONE\"\n * }\n * }\n * ]\n * }\n */\n interface ValidationError$2 {\n fieldViolations?: FieldViolation$2[];\n }\n enum RuleType$2 {\n VALIDATION = \"VALIDATION\",\n OTHER = \"OTHER\",\n MAX = \"MAX\",\n MIN = \"MIN\",\n MAX_LENGTH = \"MAX_LENGTH\",\n MIN_LENGTH = \"MIN_LENGTH\",\n MAX_SIZE = \"MAX_SIZE\",\n MIN_SIZE = \"MIN_SIZE\",\n FORMAT = \"FORMAT\",\n DECIMAL_LTE = \"DECIMAL_LTE\",\n DECIMAL_GTE = \"DECIMAL_GTE\",\n DECIMAL_LT = \"DECIMAL_LT\",\n DECIMAL_GT = \"DECIMAL_GT\",\n DECIMAL_MAX_SCALE = \"DECIMAL_MAX_SCALE\",\n INVALID_ENUM_VALUE = \"INVALID_ENUM_VALUE\",\n REQUIRED_FIELD = \"REQUIRED_FIELD\",\n FIELD_NOT_ALLOWED = \"FIELD_NOT_ALLOWED\",\n ONE_OF_ALIGNMENT = \"ONE_OF_ALIGNMENT\"\n }\n interface FieldViolation$2 {\n field?: string;\n description?: string;\n violatedRule?: RuleType$2;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError$2 {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors$2 {\n /** Carrier errors. */\n errors?: CarrierError$2[];\n }\n interface CarrierError$2 {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details$2;\n }\n interface GiftCard$3 {\n /**\n * Gift Card ID.\n * @deprecated\n */\n _id?: string;\n /** Gift card obfuscated code. */\n obfuscatedCode?: string;\n /** Gift card value. */\n amount?: MultiCurrencyPrice$3;\n /** App ID of the gift card provider. */\n appId?: string;\n /**\n * External ID in the gift card provider's system.\n * Used for integration and tracking across different platforms.\n */\n externalId?: string | null;\n }\n interface AppliedDiscount$4 extends AppliedDiscountDiscountSourceOneOf$3 {\n /** Coupon details. */\n coupon?: Coupon$3;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$3;\n /** Discount rule */\n discountRule?: DiscountRule$4;\n /** Discount type. */\n discountType?: DiscountType$4;\n /**\n * IDs of the line items the discount applies to.\n * @deprecated IDs of line items the discount applies to.\n * @replacedBy line_items_discounts\n * @targetRemovalDate 2024-06-01\n */\n lineItemIds?: string[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$3 {\n /** Coupon details. */\n coupon?: Coupon$3;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$3;\n /** Discount rule */\n discountRule?: DiscountRule$4;\n }\n enum DiscountType$4 {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface Coupon$3 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon value. */\n amount?: MultiCurrencyPrice$3;\n /** Coupon name. */\n name?: string;\n }\n interface MerchantDiscount$3 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$3;\n /** Discount Percentage. Will be calculated from items price before other discounts. */\n percentage?: number | null;\n }\n interface DiscountRule$4 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$4;\n /** Discount value. */\n amount?: MultiCurrencyPrice$3;\n }\n interface DiscountRuleName$4 {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface LineItemDiscount$3 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$3;\n }\n interface CustomField$3 {\n /** Custom field value. */\n value?: any;\n /** Custom field title. */\n title?: string;\n /** Translated custom field title. */\n translatedTitle?: string | null;\n }\n enum WeightUnit$4 {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface TaxSummary$3 {\n /**\n * Amount for which tax is calculated, added from line items.\n * @readonly\n */\n taxableAmount?: MultiCurrencyPrice$3;\n /**\n * Calculated tax, added from line items.\n * @readonly\n */\n totalTax?: MultiCurrencyPrice$3;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$2;\n }\n interface TaxCalculationDetails$2 extends TaxCalculationDetailsCalculationDetailsOneOf$2 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$2;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$2;\n /** Rate calculation type. */\n rateType?: RateType$2;\n }\n /** @oneof */\n interface TaxCalculationDetailsCalculationDetailsOneOf$2 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$2;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$2;\n }\n enum RateType$2 {\n /** no tax being collected for this request due to location of purchase */\n NO_TAX_COLLECTED = \"NO_TAX_COLLECTED\",\n /** manual rate used for calculation */\n MANUAL_RATE = \"MANUAL_RATE\",\n /** autotax rate used for calculation */\n AUTO_RATE = \"AUTO_RATE\",\n /** fallback rate used for calculation */\n FALLBACK_RATE = \"FALLBACK_RATE\"\n }\n enum ManualCalculationReason$2 {\n /** user set calculator in Business Manager to be Manual */\n GLOBAL_SETTING_TO_MANUAL = \"GLOBAL_SETTING_TO_MANUAL\",\n /** specific region is on manual even though Global setting is Auto-tax */\n REGION_SETTING_TO_MANUAL = \"REGION_SETTING_TO_MANUAL\"\n }\n interface AutoTaxFallbackCalculationDetails$2 {\n /** reason for fallback */\n fallbackReason?: FallbackReason$2;\n /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */\n error?: ApplicationError$6;\n }\n enum FallbackReason$2 {\n /** auto-tax failed to be calculated */\n AUTO_TAX_FAILED = \"AUTO_TAX_FAILED\",\n /** auto-tax was temporarily deactivated on a system-level */\n AUTO_TAX_DEACTIVATED = \"AUTO_TAX_DEACTIVATED\"\n }\n /**\n * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.\n * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.\n */\n interface AggregatedTaxBreakdown$2 {\n /** The name of the tax against which this tax amount was calculated. */\n taxName?: string;\n /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */\n taxType?: string;\n /** The name of the jurisdiction in which this tax detail applies. */\n jurisdiction?: string;\n /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n jurisdictionTypeEnum?: JurisdictionType$3;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */\n rate?: string;\n /** The sum of all the tax from line items that calculated by the tax identifiers. */\n aggregatedTaxAmount?: MultiCurrencyPrice$3;\n }\n enum ChannelType$4 {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n POS = \"POS\",\n EBAY = \"EBAY\",\n AMAZON = \"AMAZON\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\",\n WIX_INVOICES = \"WIX_INVOICES\",\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n WISH = \"WISH\",\n CLASS_PASS = \"CLASS_PASS\",\n GLOBAL_E = \"GLOBAL_E\",\n FACEBOOK = \"FACEBOOK\",\n ETSY = \"ETSY\",\n TIKTOK = \"TIKTOK\",\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreatedBy$2 extends CreatedByIdOneOf$1 {\n /**\n * User ID - when the order was created by a Wix user on behalf of a buyer.\n * For example, via POS (point of service).\n */\n userId?: string;\n /** Member ID - when the order was created by a **logged in** site visitor. */\n memberId?: string;\n /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */\n visitorId?: string;\n /** App ID - when the order was created by an external application or Wix service. */\n appId?: string;\n }\n /** @oneof */\n interface CreatedByIdOneOf$1 {\n /**\n * User ID - when the order was created by a Wix user on behalf of a buyer.\n * For example, via POS (point of service).\n */\n userId?: string;\n /** Member ID - when the order was created by a **logged in** site visitor. */\n memberId?: string;\n /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */\n visitorId?: string;\n /** App ID - when the order was created by an external application or Wix service. */\n appId?: string;\n }\n /** Reserved for internal use. */\n interface MembershipOptions$2 {\n /**\n * Reserved for internal use.\n * @readonly\n */\n eligibleMemberships?: Membership$2[];\n /**\n * Reserved for internal use.\n * @readonly\n */\n invalidMemberships?: InvalidMembership$2[];\n /** Selected membership to apply to this checkout. */\n selectedMemberships?: SelectedMemberships$2;\n }\n interface Membership$2 {\n /** Membership ID. */\n _id?: string;\n /** ID of the application providing this payment option. */\n appId?: string;\n /** The name of this membership. */\n name?: MembershipName$4;\n /** Line item IDs which are \"paid for\" by this membership. */\n lineItemIds?: string[];\n /** Optional - For a membership that has limited credits, information about credit usage. */\n credits?: MembershipPaymentCredits$2;\n /** Optional - TMembership expiry date. */\n expirationDate?: Date;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$4 {\n /** The name of this membership */\n original?: string;\n /** Optional - Translated name of this membership. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface MembershipPaymentCredits$2 {\n /** How much credit this membership has in total */\n total?: number;\n /** How much credit remained for this membership */\n remaining?: number;\n }\n interface InvalidMembership$2 {\n /** Membership details. */\n membership?: Membership$2;\n /** Reason why this membership is invalid and cannot be used. */\n reason?: string;\n }\n interface SelectedMemberships$2 {\n /** Selected memberships. */\n memberships?: SelectedMembership$2[];\n }\n interface SelectedMembership$2 {\n /** Membership ID. */\n _id?: string;\n /** ID of the app providing this payment option. */\n appId?: string;\n /** IDs of the line items this membership applies to. */\n lineItemIds?: string[];\n }\n interface AdditionalFee$3 {\n /** Additional fee's unique code (or ID) for future processing. */\n code?: string | null;\n /** Translated additional fee's name. */\n name?: string;\n /** Additional fee's price. */\n price?: MultiCurrencyPrice$3;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$3;\n /** Provider's app id. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: MultiCurrencyPrice$3;\n /** Additional fee's price after tax. */\n priceAfterTax?: MultiCurrencyPrice$3;\n /**\n * Optional - Line items associated with this additional fee.\n * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.\n */\n lineItemIds?: string[];\n }\n interface ConversionInfo$1 {\n /**\n * The site currency.\n * @readonly\n */\n siteCurrency?: string;\n /**\n * The rate used when converting from the site currency to the checkout currency.\n * @readonly\n */\n conversionRate?: string;\n }\n interface Violation$2 {\n /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */\n severity?: Severity$2;\n /** Target location on a checkout or cart page where the violation will be displayed. */\n target?: Target$2;\n /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`. */\n description?: string | null;\n }\n enum Severity$2 {\n /** The user is allowed to move forward in the flow. */\n WARNING = \"WARNING\",\n /**\n * The user is blocked from moving forward in the flow.\n * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.\n */\n ERROR = \"ERROR\"\n }\n interface Target$2 extends TargetTargetTypeOneOf$2 {\n /** General (other) violation. */\n other?: Other$2;\n /** Specific line item violation. */\n lineItem?: TargetLineItem$2;\n }\n /** @oneof */\n interface TargetTargetTypeOneOf$2 {\n /** General (other) violation. */\n other?: Other$2;\n /** Specific line item violation. */\n lineItem?: TargetLineItem$2;\n }\n /** Available locations on the webpage */\n enum NameInOther$2 {\n /** default location, in case no specific location is specified */\n OTHER_DEFAULT = \"OTHER_DEFAULT\"\n }\n /** Available locations on the line item */\n enum NameInLineItem$2 {\n /** default location, in case no specific location is specified */\n LINE_ITEM_DEFAULT = \"LINE_ITEM_DEFAULT\"\n }\n /** General (other) violation. */\n interface Other$2 {\n /** Location on a checkout or a cart page where a general (other) violation will be displayed. */\n name?: NameInOther$2;\n }\n /** Specific line item violation. */\n interface TargetLineItem$2 {\n /** Location on a checkout or a cart page where the specific line item violation will be displayed. */\n name?: NameInLineItem$2;\n /** ID of the line item containing the violation. */\n _id?: string | null;\n }\n interface ExtendedFields$4 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface CustomSettings$1 {\n /**\n * Whether to restrict the option to add or remove a gift card on the checkout page.\n *\n * Default: `false`\n */\n lockGiftCard?: boolean;\n /**\n * Whether to restrict the option to add or remove a coupon code on the checkout page.\n *\n * Default: `false`\n */\n lockCouponCode?: boolean;\n /**\n * Whether to disable policy agreement checkout in the checkout page\n *\n * Default: `false`\n */\n disabledPolicyAgreementCheckbox?: boolean;\n /**\n * Whether to disable manual payment option for this checkout.\n *\n * Default: `false`\n */\n disabledManualPayment?: boolean;\n }\n interface CustomContentReference$1 {\n /**\n * ID of the app providing the content.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n */\n appId?: string;\n /**\n * ID of the component within the app it belongs to.\n *\n * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n */\n componentId?: string;\n }\n interface ExternalReference$1 {\n /**\n * ID of the app associated with the purchase flow.\n * For example, the Wix Pay Links app ID.\n */\n appId?: string;\n /**\n * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\n * For example, a Wix Pay Link ID.\n */\n resourceId?: string | null;\n }\n interface UpdatedCheckoutMessage {\n /** Previous checkout. */\n oldCheckout?: Checkout$1;\n /** Updated checkout. */\n updatedCheckout?: Checkout$1;\n }\n interface CreateCheckoutRequest$1 {\n /** Checkout information. */\n checkoutInfo?: Checkout$1;\n /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Catalog line items to add to the checkout. */\n lineItems?: LineItem$5[];\n /**\n * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$2[];\n /**\n * **Required**\n * Sales channel type.\n */\n channelType: ChannelType$4;\n /**\n * Gift card code.\n *\n * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.\n *\n * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).\n */\n giftCardCode?: string | null;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n }\n interface CustomLineItem$2 {\n /**\n * Custom line item quantity.\n *\n * Min: `1`\n * Max: `100000`\n */\n quantity?: number;\n /** Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend. */\n price?: string;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription$3;\n /** Custom line item description lines. Used for displaying the cart, checkout and order. */\n descriptionLines?: DescriptionLine$3[];\n /**\n * Custom line item media.\n * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `\"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000\"`.\n * + An image from the web - `\"http(s)://\"`.\n */\n media?: string;\n /**\n * Custom line item ID. If passed, `id` must be unique.\n *\n * Default: auto-generated ID\n */\n _id?: string | null;\n /** Tax group ID for this custom line item. */\n taxGroupId?: string | null;\n /** Name of the item or product. */\n productName?: ProductName$3;\n /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */\n url?: string;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$3;\n /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: string | null;\n /**\n * Item quantity available for purchase. Only return this if inventory is managed.\n * Not returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart.\n */\n quantityAvailable?: number | null;\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$3;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n *\n * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType$3;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * Used, among other things, when checking for valid memberships.\n */\n serviceProperties?: ServiceProperties$3;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n *\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field is the same as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n */\n rootCatalogItemId?: string | null;\n /**\n * Partial payment for the given item to be paid upfront during the checkout.\n *\n * Eligible for catalog items with type `DEPOSIT_ONLINE`.\n * When omitted, the item's price will not be split and is expected to be paid in a single installment.\n */\n depositAmount?: string | null;\n /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$6;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n interface MerchantDiscountInput$1 {\n /** Discount amount. */\n amount?: string;\n /** IDs of the line items the discount applies to. */\n lineItemIds?: string[];\n }\n interface CreateCheckoutResponse$1 {\n /** Newly created checkout. */\n checkout?: Checkout$1;\n }\n interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {\n generalShippingCalculationError?: Details$2;\n carrierErrors?: CarrierErrors$2;\n }\n /** @oneof */\n interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {\n generalShippingCalculationError?: Details$2;\n carrierErrors?: CarrierErrors$2;\n }\n interface GetCheckoutRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface GetCheckoutResponse {\n /** The requested checkout. */\n checkout?: Checkout$1;\n }\n interface GetCheckoutWithAllExtendedFieldsRequest {\n /** Checkout ID. */\n _id?: string;\n }\n interface GetCheckoutWithAllExtendedFieldsResponse {\n /** The requested checkout. */\n checkout?: Checkout$1;\n }\n interface GetCheckoutByCartIdRequest {\n /** Cart ID. */\n _id: string;\n }\n interface GetCheckoutByCartIdResponse {\n /** The requested checkout. */\n checkout?: Checkout$1;\n }\n interface GetWixCheckoutURLRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface GetWixCheckoutURLResponse {\n /** Checkout URL. */\n checkoutUrl?: string;\n }\n interface GetCheckoutURLRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface GetCheckoutURLResponse {\n /** Checkout URL. */\n checkoutUrl?: string;\n }\n interface UpdateCheckoutRequest {\n /** Checkout information. */\n checkout: Checkout$1;\n /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Gift card code. */\n giftCardCode?: string | null;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n /** Catalog line items. */\n lineItems?: LineItem$5[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$2[];\n }\n interface UpdateCheckoutResponse {\n /** Updated checkout. */\n checkout?: Checkout$1;\n }\n interface RemoveCouponRequest$1 {\n /** ID of the checkout to remove the coupon from. */\n _id: string;\n }\n interface RemoveCouponResponse$1 {\n /** Updated checkout after removal of coupon. */\n checkout?: Checkout$1;\n }\n interface RemoveGiftCardRequest {\n /** ID of the checkout to remove the gift card from. */\n _id: string;\n }\n interface RemoveGiftCardResponse {\n /** Updated checkout after removal of gift card. */\n checkout?: Checkout$1;\n }\n interface RemoveOverrideCheckoutUrlRequest {\n /** ID of the checkout to remove the override checkout url from. */\n _id: string;\n }\n interface RemoveOverrideCheckoutUrlResponse {\n /** Updated checkout after removal of override checkout url. */\n checkout?: Checkout$1;\n }\n interface AddToCheckoutRequest {\n /** Checkout ID. */\n _id: string;\n /** Catalog line items. */\n lineItems?: LineItem$5[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$2[];\n }\n interface AddToCheckoutResponse {\n /** Updated checkout. */\n checkout?: Checkout$1;\n }\n interface RemoveLineItemsRequest$1 {\n /** ID of the checkout to remove line items from. */\n _id: string;\n /** IDs of the line items to remove from the checkout. */\n lineItemIds: string[];\n }\n interface RemoveLineItemsResponse$1 {\n /** Updated checkout after removal of line items. */\n checkout?: Checkout$1;\n }\n interface CreateOrderRequest$1 {\n /** Checkout ID. */\n _id: string;\n /** Indicates the payment method should be saved on the order */\n savePaymentMethod?: boolean;\n /** Indicates whether to authorize the payment and delay the capture */\n delayCapture?: boolean;\n }\n interface CreateOrderResponse$1 extends CreateOrderResponseIdOneOf {\n /** ID of the newly created order. */\n orderId?: string;\n /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */\n subscriptionId?: string;\n /**\n * Payment gateway order ID.\n *\n * For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.\n *\n * This field will be returned if money needs to be charged. In some cases, money cannot be charged:\n * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0. For example, in the case of a free item or an item with a 100% discount.\n * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.\n */\n paymentGatewayOrderId?: string | null;\n }\n /** @oneof */\n interface CreateOrderResponseIdOneOf {\n /** ID of newly created order. */\n orderId?: string;\n /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */\n subscriptionId?: string;\n }\n interface PaymentErrorResponseData {\n paymentResponseToken?: string | null;\n transactionStatus?: string;\n failureDetails?: string | null;\n }\n interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {\n orderId?: string;\n subscriptionId?: string;\n }\n /** @oneof */\n interface DoublePaymentErrorDataIdOneOf {\n orderId?: string;\n subscriptionId?: string;\n }\n interface RedeemErrorData {\n reason?: string;\n }\n interface ViolationsList {\n /** Violations risen by ValidationsSPI implementers. */\n violations?: Violation$2[];\n }\n interface CreateOrderAndChargeRequest {\n /** Checkout ID. */\n _id: string;\n /** Payment token. */\n paymentToken?: string | null;\n /** Indicates the payment method should be saved on the order */\n savePaymentMethod?: boolean;\n /** Indicates whether to authorize the payment and delay the capture */\n delayCapture?: boolean;\n }\n interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {\n /** ID of newly created order. */\n orderId?: string;\n /** ID of newly created subscription. */\n subscriptionId?: string;\n /** Payment response token. */\n paymentResponseToken?: string | null;\n /**\n * For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay/startpayment) function to enable your buyer to pay for the order.\n * `paymentGatewayOrderId` will be returned if money needs to be charged.\n *\n * In some cases, money should not be charged:\n * + If the total price is 0. For example, in the case of a free item or an item with 100% discount.\n * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.\n */\n paymentGatewayOrderId?: string | null;\n }\n /** @oneof */\n interface CreateOrderAndChargeResponseIdOneOf {\n /** ID of newly created order. */\n orderId?: string;\n /** ID of newly created subscription. */\n subscriptionId?: string;\n }\n interface MarkCheckoutAsCompletedRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface MarkCheckoutAsCompletedResponse {\n }\n /** Triggered when buyer successfully completed checkout flow */\n interface CheckoutMarkedAsCompleted {\n checkout?: Checkout$1;\n }\n interface UpdateLineItemsQuantityRequest$1 {\n /** Checkout ID. */\n _id: string;\n /** Line item info to update. */\n lineItems: LineItemQuantityUpdate$1[];\n }\n interface LineItemQuantityUpdate$1 {\n /** ID of the line item to update. */\n _id?: string;\n /**\n * New total amount of the line item,\n * not the amount to add to the current `quantity`.\n *\n * Min: `1`\n *\n * Max: `100000`\n */\n quantity?: number;\n }\n interface UpdateLineItemsQuantityResponse$1 {\n /** Updated checkout. */\n checkout?: Checkout$1;\n }\n interface GetCheckoutPaymentSettingsRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface GetCheckoutPaymentSettingsResponse {\n blockedPaymentOptions?: PaymentOption[];\n }\n enum PaymentOption {\n UNKNOWN_PAYMENT_OPTION = \"UNKNOWN_PAYMENT_OPTION\",\n MANUAL = \"MANUAL\"\n }\n interface SubscriptionCreated {\n subscription?: Subscription;\n }\n interface Subscription {\n /**\n * Subscription id (auto-generated upon subscription creation)\n * @readonly\n */\n _id?: string;\n /** id of subscription in external system */\n externalId?: string | null;\n /**\n * Subscription creation date\n * @readonly\n */\n dateCreated?: Date;\n /** The id of the cart this order was created from */\n cartId?: string | null;\n /** The id of the checkout this subscriptions was created from */\n checkoutId?: string | null;\n /** member or contact */\n buyerInfo?: V1BuyerInfo;\n /** Line items ordered */\n lineItems?: V1LineItem$1[];\n /** Totals for subscription's line items */\n totals?: Totals$1;\n /** site settings at the moment when subscription created */\n storeSettings?: StoreSettings;\n /** Full billing address */\n billingAddress?: Address$4;\n /** Delivery information */\n shippingInfo?: V1ShippingInfo;\n /** Coupon that was applied to subscription */\n appliedCoupon?: AppliedCoupon$1;\n /** Message from the customer (e.g., customization request) */\n buyerNote?: string | null;\n /** Custom field */\n customField?: V1CustomField;\n /** Information about subscription option from which subscription was created */\n subscriptionOptionInfo?: V1SubscriptionOptionInfo;\n /** Sales channel that submitted this subscription */\n channelInfo?: ChannelInfo$2;\n /** defines when subscriber will be charged: for frequency=MONTH, billingCycles=6, interval=2 payment will be done every 2 month during one year */\n subscriptionSettings?: V1SubscriptionSettings;\n /**\n * information about first subscription payment\n * @readonly\n */\n billingInfo?: BillingInfo$1;\n }\n /** Buyer Info */\n interface V1BuyerInfo {\n /** Wix customer ID */\n _id?: string;\n /** Customer type */\n identityType?: IdentityType$2;\n }\n enum IdentityType$2 {\n UNSPECIFIED_IDENTITY_TYPE = \"UNSPECIFIED_IDENTITY_TYPE\",\n /** Site member */\n MEMBER = \"MEMBER\",\n /** Contact */\n CONTACT = \"CONTACT\"\n }\n interface V1LineItem$1 {\n /** Line item ID (auto-generated) */\n index?: number;\n /** Line item quantity */\n quantity?: number;\n /** Line item variantId (from Stores Catalog) */\n variantId?: string | null;\n /** Line item options ordered */\n options?: OptionSelection$1[];\n /** Line item custom text field selections */\n customTextFields?: CustomTextFieldSelection$1[];\n /** Charges details */\n chargeDetails?: ChargeDetails;\n /** Product details */\n productDetails?: ProductDetails;\n }\n interface OptionSelection$1 {\n /** Option name */\n option?: string;\n /** Selected choice for this option */\n selection?: string;\n }\n interface CustomTextFieldSelection$1 {\n /** Custom text field name */\n title?: string;\n /** Custom text field value */\n value?: string;\n }\n interface ChargeDetails {\n /** price of line item (depends on subscription option) */\n price?: number;\n /** Total price charged to the customer (for this line items) after computation of quantity and discount */\n totalPrice?: number | null;\n /** Discount applied for this line item */\n discount?: number | null;\n /** Tax applied for this line item */\n tax?: number | null;\n /** Is tax applied for this line item */\n taxIncludedInPrice?: boolean;\n /** Tax rate %, as a decimal point >= 0 */\n taxRate?: string | null;\n }\n interface ProductDetails {\n /** Line item product ID (optional for POS orders) */\n productId?: string | null;\n /** Line item name */\n name?: string;\n /** Line item name translated to buyer's language */\n translatedName?: string | null;\n /** Line item type (may be extended) */\n lineItemType?: LineItemType$1;\n /** Line item primary media for preview */\n mediaItem?: MediaItem$1;\n /** Line item SKU */\n sku?: string | null;\n /** Line item weight */\n weight?: number | null;\n /** Line item notes */\n notes?: string | null;\n /** Line item fulfillerId from stores fulfillers. No value means self fulfilled */\n fulfillerId?: string | null;\n /** Tax group id */\n taxGroupId?: string | null;\n /** App id from the catalog reference */\n appId?: string | null;\n }\n enum LineItemType$1 {\n /** Line item type can't be classified, due to an error */\n UNSPECIFIED_LINE_ITEM_TYPE = \"UNSPECIFIED_LINE_ITEM_TYPE\",\n /** Physical item type */\n PHYSICAL = \"PHYSICAL\",\n /** Digital item type */\n DIGITAL = \"DIGITAL\",\n /** Custom item price */\n CUSTOM_AMOUNT_ITEM = \"CUSTOM_AMOUNT_ITEM\"\n }\n interface MediaItem$1 {\n /**\n * Media type\n * @readonly\n */\n mediaType?: MediaItemType$1;\n /**\n * Media URL\n * @readonly\n */\n url?: string;\n /**\n * Media item width\n * @readonly\n */\n width?: number;\n /**\n * Media item height\n * @readonly\n */\n height?: number;\n /** Media ID (for media items previously saved in Wix Media) */\n _id?: string | null;\n /** Media external URL */\n externalImageUrl?: string | null;\n /** Alternative text for presentation when media cannot be displayed */\n altText?: string | null;\n }\n enum MediaItemType$1 {\n /** Media item type can't be classified, due to an error */\n UNSPECIFIED_MEDIA_TYPE_ITEM = \"UNSPECIFIED_MEDIA_TYPE_ITEM\",\n /** Image item type */\n IMAGE = \"IMAGE\"\n }\n interface Totals$1 {\n /** Subtotal of all line items, before tax */\n subtotal?: number;\n /** Total shipping price, including tax */\n shipping?: number;\n /** Total tax */\n tax?: number;\n /** Total calculated discount value */\n discount?: number;\n /** Total price */\n total?: number;\n /** Total weight */\n weight?: number | null;\n /**\n * Total line items quantity\n * @readonly\n */\n quantity?: number;\n }\n interface StoreSettings {\n /** Currency used for pricing in this store */\n currency?: string | null;\n /** Weight unit used in this store */\n weightUnit?: WeightUnit$4;\n /**\n * The language to be used when communicating with the buyer\n * For a site that support multiple languages, this would be the language the buyer selected\n * Otherwise this would be the site language\n */\n buyerLanguage?: string | null;\n }\n interface Address$4 extends AddressAddressLine1OptionsOneOf$1 {\n /** Address line 1 (free text) */\n addressLine1?: string;\n /** Address line 1 (street) */\n street?: Street$1;\n /** Addressee name */\n fullName?: FullName$1;\n /** Country code (2 letters) */\n country?: string | null;\n /** State or district */\n subdivision?: string | null;\n /** City name */\n city?: string | null;\n /** ZIP/postal code */\n zipCode?: string | null;\n /** Phone number */\n phone?: string | null;\n /** Company name */\n company?: string | null;\n /** Email address */\n email?: string | null;\n /** address line */\n addressLine2?: string | null;\n /** Tax information (for Brazil only) */\n vatId?: VatId$4;\n }\n /** @oneof */\n interface AddressAddressLine1OptionsOneOf$1 {\n /** Address line 1 (free text) */\n addressLine1?: string;\n /** Address line 1 (street) */\n street?: Street$1;\n }\n interface FullName$1 {\n /** Customer's first name */\n firstName?: string;\n /** Customer's last name */\n lastName?: string;\n }\n interface Street$1 {\n /** Street number */\n number?: string;\n /** Street name */\n name?: string;\n }\n interface VatId$4 {\n /** Customer's tax ID. */\n number?: string;\n /**\n * Tax type.\n * + `CPF`: For individual tax payers.\n * + `CNPJ`: For corporations.\n */\n type?: VatType$4;\n }\n /** Brazilian tax info types */\n enum VatType$4 {\n /** When the tax info type can't be classified, due to an error */\n UNSPECIFIED_TAX_TYPE = \"UNSPECIFIED_TAX_TYPE\",\n /** CPF - for individual tax payers */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {\n /** Shipment details (when this object describes shipment) */\n shipmentDetails?: ShipmentDetails$1;\n /** Pickup details (when this object describes pickup) */\n pickupDetails?: V1PickupDetails;\n /** Delivery option name */\n deliveryOption?: string;\n /** Delivery option delivery time */\n estimatedDeliveryTime?: string | null;\n }\n /** @oneof */\n interface V1ShippingInfoDetailsOneOf {\n /** Shipment details (when this object describes shipment) */\n shipmentDetails?: ShipmentDetails$1;\n /** Pickup details (when this object describes pickup) */\n pickupDetails?: V1PickupDetails;\n }\n interface ShipmentDetails$1 {\n /** Shipping destination address */\n address?: Address$4;\n /** Discount applied for shipping */\n discount?: number | null;\n /** Tax applied for shipping */\n tax?: number | null;\n /** Whether tax is included in the price */\n taxIncludedInPrice?: boolean;\n /** Tax rate % for shipping, as a decimal point >= 0 */\n taxRate?: string | null;\n }\n interface V1PickupDetails {\n /** Pickup address */\n address?: PickupAddress$2;\n /** Store owner's pickup instructions */\n pickupInstructions?: string | null;\n }\n interface PickupAddress$2 {\n /** Country code (2 letters) */\n country?: string;\n /** State/District */\n subdivision?: string | null;\n /** Address */\n addressLine?: string;\n /** City */\n city?: string;\n /** ZIP/postal code */\n zipCode?: string;\n }\n interface AppliedCoupon$1 {\n /** Coupon ID */\n couponId?: string;\n /** Coupon name */\n name?: string;\n /** Coupon code */\n code?: string;\n }\n /** Custom field */\n interface V1CustomField {\n /** Free text that the customer entered in the custom field during the checkout process */\n value?: string;\n /** Title for the custom field */\n title?: string;\n /** The title translated according to the buyer language */\n translatedTitle?: string;\n }\n interface V1SubscriptionOptionInfo {\n _id?: string | null;\n title?: string;\n description?: string | null;\n discount?: Discount$3;\n }\n interface Discount$3 {\n /** Discount type. */\n type?: DiscountDiscountType;\n /** Discount value. */\n value?: number;\n }\n enum DiscountDiscountType {\n UNDEFINED = \"UNDEFINED\",\n /** No discount */\n AMOUNT = \"AMOUNT\",\n PERCENT = \"PERCENT\"\n }\n interface ChannelInfo$2 {\n /** Sales channel that submitted the subscription */\n type?: ChannelInfoChannelType;\n }\n enum ChannelInfoChannelType {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\"\n }\n interface V1SubscriptionSettings {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$4;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */\n billingCycles?: number | null;\n }\n interface BillingInfo$1 {\n /** Payment method used for this order */\n paymentMethod?: string | null;\n /** Transaction ID from payment gateway (e.g., Wix Payments) */\n paymentGatewayTransactionId?: string | null;\n /** Order ID from payment gateway (e.g., Wix Payments) */\n paymentGatewayOrderId?: string | null;\n }\n interface Empty$6 {\n }\n interface DomainEvent$a extends DomainEventBodyOneOf$a {\n createdEvent?: EntityCreatedEvent$a;\n updatedEvent?: EntityUpdatedEvent$a;\n deletedEvent?: EntityDeletedEvent$a;\n actionEvent?: ActionEvent$a;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$a {\n createdEvent?: EntityCreatedEvent$a;\n updatedEvent?: EntityUpdatedEvent$a;\n deletedEvent?: EntityDeletedEvent$a;\n actionEvent?: ActionEvent$a;\n }\n interface EntityCreatedEvent$a {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$6;\n }\n interface RestoreInfo$6 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$a {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$a {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$a {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$a {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$a;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$a extends IdentificationDataIdOneOf$a {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$a;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$a {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$a {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a checkout.\n *\n *\n * The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.\n *\n * > **Notes:**\n * > + Checkout must include at least 1 item in the `options.lineItems` array.\n * > + `options.channelType` is required.\n * > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.\n * > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.\n * @public\n * @requiredField options.channelType\n * @requiredField options.checkoutInfo.customFields.value\n * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id\n * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId\n * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds\n * @requiredField options.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.productName\n * @requiredField options.customLineItems.quantity\n * @requiredField options.lineItems.catalogReference\n * @requiredField options.lineItems.catalogReference.appId\n * @requiredField options.lineItems.catalogReference.catalogItemId\n * @requiredField options.lineItems.quantity\n * @param options - Checkout creation options.\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - Admin Permissions\n * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - the newly created checkout.\n */\n function createCheckout(options?: CreateCheckoutOptions): Promise;\n interface CreateCheckoutOptions {\n /** Checkout information. */\n checkoutInfo?: Checkout$1;\n /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Catalog line items to add to the checkout. */\n lineItems?: LineItem$5[];\n /**\n * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$2[];\n /**\n * **Required**\n * Sales channel type.\n */\n channelType: ChannelType$4;\n /**\n * Gift card code.\n *\n * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.\n *\n * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).\n */\n giftCardCode?: string | null;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n }\n /**\n * Retrieves a checkout.\n *\n *\n * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.\n * @param _id - Checkout ID.\n * @public\n * @requiredField _id\n * @permissionId ECOM.READ_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - the requested checkout.\n */\n function getCheckout(_id: string, options?: GetCheckoutOptions): Promise;\n interface GetCheckoutOptions {\n }\n /**\n * Retrieves the checkout associated with a specified cart.\n * @param _id - Cart ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getCheckoutByCartId(_id: string): Promise;\n interface GetWixCheckoutUrlOptions {\n }\n /**\n * Retrieves the checkout page URL of a specified checkout.\n *\n * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.\n * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n * @param _id - Checkout ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getCheckoutUrl(_id: string, options?: GetCheckoutUrlOptions): Promise;\n interface GetCheckoutUrlOptions {\n }\n /**\n * Updates a checkout.\n *\n *\n * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.\n *\n * >**Notes:**\n * > + If nothing is passed in the request, the call will fail.\n * > + The `checkout.buyerInfo.email` may not be removed once it is set.\n * @param _id - Checkout ID.\n * @public\n * @requiredField _id\n * @requiredField checkout\n * @requiredField checkout.customFields.value\n * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id\n * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId\n * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds\n * @requiredField options.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.productName\n * @requiredField options.customLineItems.quantity\n * @requiredField options.lineItems.catalogReference\n * @requiredField options.lineItems.catalogReference.appId\n * @requiredField options.lineItems.catalogReference.catalogItemId\n * @requiredField options.lineItems.quantity\n * @param options - Checkout update options.\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - Admin Permissions\n * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Updated checkout.\n */\n function updateCheckout(_id: string | null, checkout: UpdateCheckout, options?: UpdateCheckoutOptions): Promise;\n interface UpdateCheckout {\n /**\n * Checkout ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Line items.\n *\n * Max: 300 items\n * @readonly\n */\n lineItems?: LineItem$5[];\n /** Billing information. */\n billingInfo?: AddressWithContact$3;\n /** Shipping information. */\n shippingInfo?: ShippingInfo$2;\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$5;\n /**\n * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * @readonly\n */\n conversionCurrency?: string;\n /**\n * Calculated price summary for the checkout.\n * @readonly\n */\n priceSummary?: PriceSummary$3;\n /**\n * Errors when calculating totals.\n * @readonly\n */\n calculationErrors?: CalculationErrors$2;\n /**\n * Applied gift card details.\n *\n * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).\n * @readonly\n */\n giftCard?: GiftCard$3;\n /**\n * Applied discounts.\n * @readonly\n */\n appliedDiscounts?: AppliedDiscount$4[];\n /** Custom fields. */\n customFields?: CustomField$3[];\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$4;\n /**\n * Tax summary.\n * @readonly\n */\n taxSummary?: TaxSummary$3;\n /**\n * The currency used when submitting the order.\n * @readonly\n */\n currency?: string;\n /**\n * Sales channel that submitted the order.\n * + `\"UNSPECIFIED\"`: Unspecified sales channel. This value is not supported.\n * + `\"WEB\"`: A web client.\n * + `\"POS\"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)\n * + `\"EBAY\"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)\n * + `\"AMAZON\"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)\n * + `\"WISH\"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)\n * + `\"WIX_INVOICES\"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)\n * + `\"WIX_APP_STORE\"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)\n * + `\"BACKOFFICE_MERCHANT\"`: Wix merchant backoffice\n * + `\"OTHER_PLATFORM\"`: Other sales platform.\n * @readonly\n */\n channelType?: ChannelType$4;\n /**\n * Site language in which original values are shown.\n * @readonly\n */\n siteLanguage?: string;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n * @readonly\n */\n buyerLanguage?: string;\n /**\n * Whether an order was successfully created from this checkout.\n * For an order to be successful, it must be successfully paid for (unless the total is 0).\n * @readonly\n */\n completed?: boolean;\n /**\n * Whether tax is included in line item prices.\n * @readonly\n */\n taxIncludedInPrice?: boolean;\n /**\n * ID of the checkout's initiator.\n * @readonly\n */\n createdBy?: CreatedBy$2;\n /**\n * Date and time the checkout was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the checkout was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Minimal amount to pay in order to place the order.\n * @readonly\n */\n payNow?: PriceSummary$3;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$3;\n /** Memberships to apply when creating the order. */\n membershipOptions?: MembershipOptions$2;\n /** Additional Fees. */\n additionalFees?: AdditionalFee$3[];\n /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */\n cartId?: string | null;\n /**\n * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).\n * @readonly\n */\n violations?: Violation$2[];\n /**\n * Custom field data for the checkout object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$4;\n /**\n * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.\n * @readonly\n */\n purchaseFlowId?: string | null;\n /**\n * Additional settings for customization of the checkout process.\n *\n * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).\n */\n customSettings?: CustomSettings$1;\n /**\n * Reference IDs for the app and component providing custom checkout page content.\n *\n * To access and manage custom checkout page content, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customContentReference?: CustomContentReference$1;\n }\n interface UpdateCheckoutOptions {\n /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Gift card code. */\n giftCardCode?: string | null;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n /** Catalog line items. */\n lineItems?: LineItem$5[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$2[];\n }\n /**\n * Removes the coupon from a specified checkout.\n *\n *\n * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.\n *\n * >**Note:** A checkout can only hold 1 coupon.\n * @param _id - ID of the checkout to remove the coupon from.\n * @public\n * @requiredField _id\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function removeCoupon(_id: string): Promise;\n /**\n * Removes the gift card from a specified checkout.\n *\n *\n * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.\n *\n * >**Note:** A checkout can only hold 1 gift card.\n * @param _id - ID of the checkout to remove the gift card from.\n * @public\n * @requiredField _id\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function removeGiftCard(_id: string): Promise;\n /**\n * Removes the `overrideCheckoutUrl` from a specified checkout.\n *\n * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard\n * Wix checkout page URL.\n * @param _id - ID of the checkout to remove the override checkout url from.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function removeOverrideCheckoutUrl(_id: string): Promise;\n /**\n * Adds catalog line items and/or custom line items to a checkout.\n *\n *\n * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.\n * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.\n * @param _id - Checkout ID.\n * @public\n * @requiredField _id\n * @requiredField options.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.productName\n * @requiredField options.customLineItems.quantity\n * @requiredField options.lineItems.catalogReference\n * @requiredField options.lineItems.catalogReference.appId\n * @requiredField options.lineItems.catalogReference.catalogItemId\n * @requiredField options.lineItems.quantity\n * @param options - Items to be added to checkout.\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - Admin Permissions\n * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function addToCheckout(_id: string, options?: AddToCheckoutOptions): Promise;\n interface AddToCheckoutOptions {\n /** Catalog line items. */\n lineItems?: LineItem$5[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$2[];\n }\n /**\n * Removes line items from the specified checkout.\n *\n *\n * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.\n * @param _id - ID of the checkout to remove line items from.\n * @public\n * @requiredField _id\n * @requiredField lineItemIds\n * @param lineItemIds - IDs of the line items to be removed.\n * To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function removeLineItems(_id: string, lineItemIds: string[]): Promise;\n /**\n * Creates an order from a specified checkout.\n *\n * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.\n * Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.\n *\n * > **Note:** The following requirements must be met for an order to be created from a checkout.\n * > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.\n * > + A checkout must have at least 1 line item.\n * > + All of the line Items have an `availability.status` of `\"AVAILABLE\"` or `\"PARTIALLY_AVAILABLE\"`.\n * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.\n * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.\n * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.\n * @param _id - Checkout ID.\n * @public\n * @requiredField _id\n * @param options - Further order creation options.\n * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function createOrder$1(_id: string, options?: CreateOrderOptions$1): Promise;\n interface CreateOrderOptions$1 {\n /** Indicates the payment method should be saved on the order */\n savePaymentMethod?: boolean;\n /** Indicates whether to authorize the payment and delay the capture */\n delayCapture?: boolean;\n }\n interface CreateOrderAndChargeOptions {\n /** Payment token. */\n paymentToken?: string | null;\n /** Indicates the payment method should be saved on the order */\n savePaymentMethod?: boolean;\n /** Indicates whether to authorize the payment and delay the capture */\n delayCapture?: boolean;\n }\n /**\n * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.\n *\n *\n * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.\n * @param _id - Checkout ID.\n * @public\n * @requiredField _id\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function markCheckoutAsCompleted(_id: string): Promise;\n /**\n * Updates the quantity of one or more line items in a checkout.\n *\n * This endpoint is only for updating the quantity of line items. To entirely remove a line item from\n * the checkout, use [`removeLineItems()`](#removelineitems).\n * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).\n *\n * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`\n * is greater than the remaining stock, then the `quantity` returned in the response is the total amount\n * of remaining stock.\n * @param _id - Checkout ID.\n * @param lineItems - Line item info to update.\n * @public\n * @requiredField _id\n * @requiredField lineItems\n * @requiredField lineItems._id\n * @requiredField lineItems.quantity\n * @permissionId ECOM.MODIFY_CHECKOUTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function updateLineItemsQuantity(_id: string, lineItems: LineItemQuantityUpdate$1[]): Promise;\n /** @param _id - Checkout ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_PAYMENT_SETTINGS\n * @adminMethod\n */\n function getCheckoutPaymentSettings(_id: string): Promise;\n type ecomV1CheckoutCheckout_universal_d_ApiAddress = ApiAddress;\n type ecomV1CheckoutCheckout_universal_d_CommonVatId = CommonVatId;\n type ecomV1CheckoutCheckout_universal_d_CommonVatType = CommonVatType;\n const ecomV1CheckoutCheckout_universal_d_CommonVatType: typeof CommonVatType;\n type ecomV1CheckoutCheckout_universal_d_UpdatedCheckoutMessage = UpdatedCheckoutMessage;\n type ecomV1CheckoutCheckout_universal_d_ShippingCalculationErrorData = ShippingCalculationErrorData;\n type ecomV1CheckoutCheckout_universal_d_ShippingCalculationErrorDataShippingCalculationErrorOneOf = ShippingCalculationErrorDataShippingCalculationErrorOneOf;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutRequest = GetCheckoutRequest;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutResponse = GetCheckoutResponse;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutWithAllExtendedFieldsRequest = GetCheckoutWithAllExtendedFieldsRequest;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutWithAllExtendedFieldsResponse = GetCheckoutWithAllExtendedFieldsResponse;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutByCartIdRequest = GetCheckoutByCartIdRequest;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutByCartIdResponse = GetCheckoutByCartIdResponse;\n type ecomV1CheckoutCheckout_universal_d_GetWixCheckoutURLRequest = GetWixCheckoutURLRequest;\n type ecomV1CheckoutCheckout_universal_d_GetWixCheckoutURLResponse = GetWixCheckoutURLResponse;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutURLRequest = GetCheckoutURLRequest;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutURLResponse = GetCheckoutURLResponse;\n type ecomV1CheckoutCheckout_universal_d_UpdateCheckoutRequest = UpdateCheckoutRequest;\n type ecomV1CheckoutCheckout_universal_d_UpdateCheckoutResponse = UpdateCheckoutResponse;\n type ecomV1CheckoutCheckout_universal_d_RemoveGiftCardRequest = RemoveGiftCardRequest;\n type ecomV1CheckoutCheckout_universal_d_RemoveGiftCardResponse = RemoveGiftCardResponse;\n type ecomV1CheckoutCheckout_universal_d_RemoveOverrideCheckoutUrlRequest = RemoveOverrideCheckoutUrlRequest;\n type ecomV1CheckoutCheckout_universal_d_RemoveOverrideCheckoutUrlResponse = RemoveOverrideCheckoutUrlResponse;\n type ecomV1CheckoutCheckout_universal_d_AddToCheckoutRequest = AddToCheckoutRequest;\n type ecomV1CheckoutCheckout_universal_d_AddToCheckoutResponse = AddToCheckoutResponse;\n type ecomV1CheckoutCheckout_universal_d_CreateOrderResponseIdOneOf = CreateOrderResponseIdOneOf;\n type ecomV1CheckoutCheckout_universal_d_PaymentErrorResponseData = PaymentErrorResponseData;\n type ecomV1CheckoutCheckout_universal_d_DoublePaymentErrorData = DoublePaymentErrorData;\n type ecomV1CheckoutCheckout_universal_d_DoublePaymentErrorDataIdOneOf = DoublePaymentErrorDataIdOneOf;\n type ecomV1CheckoutCheckout_universal_d_RedeemErrorData = RedeemErrorData;\n type ecomV1CheckoutCheckout_universal_d_ViolationsList = ViolationsList;\n type ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeRequest = CreateOrderAndChargeRequest;\n type ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeResponse = CreateOrderAndChargeResponse;\n type ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeResponseIdOneOf = CreateOrderAndChargeResponseIdOneOf;\n type ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedRequest = MarkCheckoutAsCompletedRequest;\n type ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedResponse = MarkCheckoutAsCompletedResponse;\n type ecomV1CheckoutCheckout_universal_d_CheckoutMarkedAsCompleted = CheckoutMarkedAsCompleted;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsRequest = GetCheckoutPaymentSettingsRequest;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsResponse = GetCheckoutPaymentSettingsResponse;\n type ecomV1CheckoutCheckout_universal_d_PaymentOption = PaymentOption;\n const ecomV1CheckoutCheckout_universal_d_PaymentOption: typeof PaymentOption;\n type ecomV1CheckoutCheckout_universal_d_SubscriptionCreated = SubscriptionCreated;\n type ecomV1CheckoutCheckout_universal_d_Subscription = Subscription;\n type ecomV1CheckoutCheckout_universal_d_V1BuyerInfo = V1BuyerInfo;\n type ecomV1CheckoutCheckout_universal_d_ChargeDetails = ChargeDetails;\n type ecomV1CheckoutCheckout_universal_d_ProductDetails = ProductDetails;\n type ecomV1CheckoutCheckout_universal_d_StoreSettings = StoreSettings;\n type ecomV1CheckoutCheckout_universal_d_V1ShippingInfo = V1ShippingInfo;\n type ecomV1CheckoutCheckout_universal_d_V1ShippingInfoDetailsOneOf = V1ShippingInfoDetailsOneOf;\n type ecomV1CheckoutCheckout_universal_d_V1PickupDetails = V1PickupDetails;\n type ecomV1CheckoutCheckout_universal_d_V1CustomField = V1CustomField;\n type ecomV1CheckoutCheckout_universal_d_V1SubscriptionOptionInfo = V1SubscriptionOptionInfo;\n type ecomV1CheckoutCheckout_universal_d_DiscountDiscountType = DiscountDiscountType;\n const ecomV1CheckoutCheckout_universal_d_DiscountDiscountType: typeof DiscountDiscountType;\n type ecomV1CheckoutCheckout_universal_d_ChannelInfoChannelType = ChannelInfoChannelType;\n const ecomV1CheckoutCheckout_universal_d_ChannelInfoChannelType: typeof ChannelInfoChannelType;\n type ecomV1CheckoutCheckout_universal_d_V1SubscriptionSettings = V1SubscriptionSettings;\n const ecomV1CheckoutCheckout_universal_d_createCheckout: typeof createCheckout;\n type ecomV1CheckoutCheckout_universal_d_CreateCheckoutOptions = CreateCheckoutOptions;\n const ecomV1CheckoutCheckout_universal_d_getCheckout: typeof getCheckout;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutOptions = GetCheckoutOptions;\n const ecomV1CheckoutCheckout_universal_d_getCheckoutByCartId: typeof getCheckoutByCartId;\n type ecomV1CheckoutCheckout_universal_d_GetWixCheckoutUrlOptions = GetWixCheckoutUrlOptions;\n const ecomV1CheckoutCheckout_universal_d_getCheckoutUrl: typeof getCheckoutUrl;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutUrlOptions = GetCheckoutUrlOptions;\n const ecomV1CheckoutCheckout_universal_d_updateCheckout: typeof updateCheckout;\n type ecomV1CheckoutCheckout_universal_d_UpdateCheckout = UpdateCheckout;\n type ecomV1CheckoutCheckout_universal_d_UpdateCheckoutOptions = UpdateCheckoutOptions;\n const ecomV1CheckoutCheckout_universal_d_removeCoupon: typeof removeCoupon;\n const ecomV1CheckoutCheckout_universal_d_removeGiftCard: typeof removeGiftCard;\n const ecomV1CheckoutCheckout_universal_d_removeOverrideCheckoutUrl: typeof removeOverrideCheckoutUrl;\n const ecomV1CheckoutCheckout_universal_d_addToCheckout: typeof addToCheckout;\n type ecomV1CheckoutCheckout_universal_d_AddToCheckoutOptions = AddToCheckoutOptions;\n const ecomV1CheckoutCheckout_universal_d_removeLineItems: typeof removeLineItems;\n type ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeOptions = CreateOrderAndChargeOptions;\n const ecomV1CheckoutCheckout_universal_d_markCheckoutAsCompleted: typeof markCheckoutAsCompleted;\n const ecomV1CheckoutCheckout_universal_d_updateLineItemsQuantity: typeof updateLineItemsQuantity;\n const ecomV1CheckoutCheckout_universal_d_getCheckoutPaymentSettings: typeof getCheckoutPaymentSettings;\n namespace ecomV1CheckoutCheckout_universal_d {\n export { Checkout$1 as Checkout, LineItem$5 as LineItem, CatalogReference$6 as CatalogReference, ProductName$3 as ProductName, MultiCurrencyPrice$3 as MultiCurrencyPrice, ItemTaxFullDetails$3 as ItemTaxFullDetails, TaxRateBreakdown$2 as TaxRateBreakdown, TaxBreakdown$2 as TaxBreakdown, JurisdictionType$3 as JurisdictionType, DescriptionLine$3 as DescriptionLine, DescriptionLineValueOneOf$3 as DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf$3 as DescriptionLineDescriptionLineValueOneOf, DescriptionLineName$3 as DescriptionLineName, PlainTextValue$3 as PlainTextValue, Color$3 as Color, DescriptionLineType$3 as DescriptionLineType, ItemAvailabilityInfo$2 as ItemAvailabilityInfo, ItemAvailabilityStatus$2 as ItemAvailabilityStatus, PhysicalProperties$3 as PhysicalProperties, Scope$3 as Scope, Group$2 as Group, ItemType$3 as ItemType, ItemTypeItemTypeDataOneOf$3 as ItemTypeItemTypeDataOneOf, ItemTypeItemType$3 as ItemTypeItemType, SubscriptionOptionInfo$3 as SubscriptionOptionInfo, SubscriptionSettings$4 as SubscriptionSettings, SubscriptionFrequency$4 as SubscriptionFrequency, Title$2 as Title, Description$2 as Description, SecuredMedia$2 as SecuredMedia, FileType$2 as FileType, PaymentOptionType$3 as PaymentOptionType, ServiceProperties$3 as ServiceProperties, PriceDescription$3 as PriceDescription, CatalogOverrideFields$2 as CatalogOverrideFields, TaxableAddress$1 as TaxableAddress, TaxableAddressTaxableAddressDataOneOf$1 as TaxableAddressTaxableAddressDataOneOf, TaxableAddressType$1 as TaxableAddressType, AddressWithContact$3 as AddressWithContact, ecomV1CheckoutCheckout_universal_d_ApiAddress as ApiAddress, StreetAddress$3 as StreetAddress, AddressLocation$3 as AddressLocation, FullAddressContactDetails$3 as FullAddressContactDetails, ecomV1CheckoutCheckout_universal_d_CommonVatId as CommonVatId, ecomV1CheckoutCheckout_universal_d_CommonVatType as CommonVatType, ShippingInfo$2 as ShippingInfo, SelectedCarrierServiceOption$2 as SelectedCarrierServiceOption, DeliveryLogistics$3 as DeliveryLogistics, PickupDetails$4 as PickupDetails, PickupMethod$3 as PickupMethod, DeliveryTimeSlot$3 as DeliveryTimeSlot, SelectedCarrierServiceOptionPrices$2 as SelectedCarrierServiceOptionPrices, SelectedCarrierServiceOptionOtherCharge$2 as SelectedCarrierServiceOptionOtherCharge, ChargeType$2 as ChargeType, ShippingRegion$3 as ShippingRegion, CarrierServiceOption$2 as CarrierServiceOption, ShippingOption$2 as ShippingOption, ShippingPrice$3 as ShippingPrice, OtherCharge$2 as OtherCharge, BuyerInfo$5 as BuyerInfo, BuyerInfoIdOneOf$3 as BuyerInfoIdOneOf, PriceSummary$3 as PriceSummary, CalculationErrors$2 as CalculationErrors, CalculationErrorsShippingCalculationErrorOneOf$2 as CalculationErrorsShippingCalculationErrorOneOf, Details$2 as Details, DetailsKindOneOf$2 as DetailsKindOneOf, ApplicationError$6 as ApplicationError, ValidationError$2 as ValidationError, RuleType$2 as RuleType, FieldViolation$2 as FieldViolation, SystemError$2 as SystemError, CarrierErrors$2 as CarrierErrors, CarrierError$2 as CarrierError, GiftCard$3 as GiftCard, AppliedDiscount$4 as AppliedDiscount, AppliedDiscountDiscountSourceOneOf$3 as AppliedDiscountDiscountSourceOneOf, DiscountType$4 as DiscountType, Coupon$3 as Coupon, MerchantDiscount$3 as MerchantDiscount, DiscountRule$4 as DiscountRule, DiscountRuleName$4 as DiscountRuleName, LineItemDiscount$3 as LineItemDiscount, CustomField$3 as CustomField, WeightUnit$4 as WeightUnit, TaxSummary$3 as TaxSummary, TaxCalculationDetails$2 as TaxCalculationDetails, TaxCalculationDetailsCalculationDetailsOneOf$2 as TaxCalculationDetailsCalculationDetailsOneOf, RateType$2 as RateType, ManualCalculationReason$2 as ManualCalculationReason, AutoTaxFallbackCalculationDetails$2 as AutoTaxFallbackCalculationDetails, FallbackReason$2 as FallbackReason, AggregatedTaxBreakdown$2 as AggregatedTaxBreakdown, ChannelType$4 as ChannelType, CreatedBy$2 as CreatedBy, CreatedByIdOneOf$1 as CreatedByIdOneOf, MembershipOptions$2 as MembershipOptions, Membership$2 as Membership, MembershipName$4 as MembershipName, MembershipPaymentCredits$2 as MembershipPaymentCredits, InvalidMembership$2 as InvalidMembership, SelectedMemberships$2 as SelectedMemberships, SelectedMembership$2 as SelectedMembership, AdditionalFee$3 as AdditionalFee, ConversionInfo$1 as ConversionInfo, Violation$2 as Violation, Severity$2 as Severity, Target$2 as Target, TargetTargetTypeOneOf$2 as TargetTargetTypeOneOf, NameInOther$2 as NameInOther, NameInLineItem$2 as NameInLineItem, Other$2 as Other, TargetLineItem$2 as TargetLineItem, ExtendedFields$4 as ExtendedFields, CustomSettings$1 as CustomSettings, CustomContentReference$1 as CustomContentReference, ExternalReference$1 as ExternalReference, ecomV1CheckoutCheckout_universal_d_UpdatedCheckoutMessage as UpdatedCheckoutMessage, CreateCheckoutRequest$1 as CreateCheckoutRequest, CustomLineItem$2 as CustomLineItem, MerchantDiscountInput$1 as MerchantDiscountInput, CreateCheckoutResponse$1 as CreateCheckoutResponse, ecomV1CheckoutCheckout_universal_d_ShippingCalculationErrorData as ShippingCalculationErrorData, ecomV1CheckoutCheckout_universal_d_ShippingCalculationErrorDataShippingCalculationErrorOneOf as ShippingCalculationErrorDataShippingCalculationErrorOneOf, ecomV1CheckoutCheckout_universal_d_GetCheckoutRequest as GetCheckoutRequest, ecomV1CheckoutCheckout_universal_d_GetCheckoutResponse as GetCheckoutResponse, ecomV1CheckoutCheckout_universal_d_GetCheckoutWithAllExtendedFieldsRequest as GetCheckoutWithAllExtendedFieldsRequest, ecomV1CheckoutCheckout_universal_d_GetCheckoutWithAllExtendedFieldsResponse as GetCheckoutWithAllExtendedFieldsResponse, ecomV1CheckoutCheckout_universal_d_GetCheckoutByCartIdRequest as GetCheckoutByCartIdRequest, ecomV1CheckoutCheckout_universal_d_GetCheckoutByCartIdResponse as GetCheckoutByCartIdResponse, ecomV1CheckoutCheckout_universal_d_GetWixCheckoutURLRequest as GetWixCheckoutURLRequest, ecomV1CheckoutCheckout_universal_d_GetWixCheckoutURLResponse as GetWixCheckoutURLResponse, ecomV1CheckoutCheckout_universal_d_GetCheckoutURLRequest as GetCheckoutURLRequest, ecomV1CheckoutCheckout_universal_d_GetCheckoutURLResponse as GetCheckoutURLResponse, ecomV1CheckoutCheckout_universal_d_UpdateCheckoutRequest as UpdateCheckoutRequest, ecomV1CheckoutCheckout_universal_d_UpdateCheckoutResponse as UpdateCheckoutResponse, RemoveCouponRequest$1 as RemoveCouponRequest, RemoveCouponResponse$1 as RemoveCouponResponse, ecomV1CheckoutCheckout_universal_d_RemoveGiftCardRequest as RemoveGiftCardRequest, ecomV1CheckoutCheckout_universal_d_RemoveGiftCardResponse as RemoveGiftCardResponse, ecomV1CheckoutCheckout_universal_d_RemoveOverrideCheckoutUrlRequest as RemoveOverrideCheckoutUrlRequest, ecomV1CheckoutCheckout_universal_d_RemoveOverrideCheckoutUrlResponse as RemoveOverrideCheckoutUrlResponse, ecomV1CheckoutCheckout_universal_d_AddToCheckoutRequest as AddToCheckoutRequest, ecomV1CheckoutCheckout_universal_d_AddToCheckoutResponse as AddToCheckoutResponse, RemoveLineItemsRequest$1 as RemoveLineItemsRequest, RemoveLineItemsResponse$1 as RemoveLineItemsResponse, CreateOrderRequest$1 as CreateOrderRequest, CreateOrderResponse$1 as CreateOrderResponse, ecomV1CheckoutCheckout_universal_d_CreateOrderResponseIdOneOf as CreateOrderResponseIdOneOf, ecomV1CheckoutCheckout_universal_d_PaymentErrorResponseData as PaymentErrorResponseData, ecomV1CheckoutCheckout_universal_d_DoublePaymentErrorData as DoublePaymentErrorData, ecomV1CheckoutCheckout_universal_d_DoublePaymentErrorDataIdOneOf as DoublePaymentErrorDataIdOneOf, ecomV1CheckoutCheckout_universal_d_RedeemErrorData as RedeemErrorData, ecomV1CheckoutCheckout_universal_d_ViolationsList as ViolationsList, ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeRequest as CreateOrderAndChargeRequest, ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeResponse as CreateOrderAndChargeResponse, ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeResponseIdOneOf as CreateOrderAndChargeResponseIdOneOf, ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedRequest as MarkCheckoutAsCompletedRequest, ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedResponse as MarkCheckoutAsCompletedResponse, ecomV1CheckoutCheckout_universal_d_CheckoutMarkedAsCompleted as CheckoutMarkedAsCompleted, UpdateLineItemsQuantityRequest$1 as UpdateLineItemsQuantityRequest, LineItemQuantityUpdate$1 as LineItemQuantityUpdate, UpdateLineItemsQuantityResponse$1 as UpdateLineItemsQuantityResponse, ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsRequest as GetCheckoutPaymentSettingsRequest, ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsResponse as GetCheckoutPaymentSettingsResponse, ecomV1CheckoutCheckout_universal_d_PaymentOption as PaymentOption, ecomV1CheckoutCheckout_universal_d_SubscriptionCreated as SubscriptionCreated, ecomV1CheckoutCheckout_universal_d_Subscription as Subscription, ecomV1CheckoutCheckout_universal_d_V1BuyerInfo as V1BuyerInfo, IdentityType$2 as IdentityType, V1LineItem$1 as V1LineItem, OptionSelection$1 as OptionSelection, CustomTextFieldSelection$1 as CustomTextFieldSelection, ecomV1CheckoutCheckout_universal_d_ChargeDetails as ChargeDetails, ecomV1CheckoutCheckout_universal_d_ProductDetails as ProductDetails, LineItemType$1 as LineItemType, MediaItem$1 as MediaItem, MediaItemType$1 as MediaItemType, Totals$1 as Totals, ecomV1CheckoutCheckout_universal_d_StoreSettings as StoreSettings, Address$4 as Address, AddressAddressLine1OptionsOneOf$1 as AddressAddressLine1OptionsOneOf, FullName$1 as FullName, Street$1 as Street, VatId$4 as VatId, VatType$4 as VatType, ecomV1CheckoutCheckout_universal_d_V1ShippingInfo as V1ShippingInfo, ecomV1CheckoutCheckout_universal_d_V1ShippingInfoDetailsOneOf as V1ShippingInfoDetailsOneOf, ShipmentDetails$1 as ShipmentDetails, ecomV1CheckoutCheckout_universal_d_V1PickupDetails as V1PickupDetails, PickupAddress$2 as PickupAddress, AppliedCoupon$1 as AppliedCoupon, ecomV1CheckoutCheckout_universal_d_V1CustomField as V1CustomField, ecomV1CheckoutCheckout_universal_d_V1SubscriptionOptionInfo as V1SubscriptionOptionInfo, Discount$3 as Discount, ecomV1CheckoutCheckout_universal_d_DiscountDiscountType as DiscountDiscountType, ChannelInfo$2 as ChannelInfo, ecomV1CheckoutCheckout_universal_d_ChannelInfoChannelType as ChannelInfoChannelType, ecomV1CheckoutCheckout_universal_d_V1SubscriptionSettings as V1SubscriptionSettings, BillingInfo$1 as BillingInfo, Empty$6 as Empty, DomainEvent$a as DomainEvent, DomainEventBodyOneOf$a as DomainEventBodyOneOf, EntityCreatedEvent$a as EntityCreatedEvent, RestoreInfo$6 as RestoreInfo, EntityUpdatedEvent$a as EntityUpdatedEvent, EntityDeletedEvent$a as EntityDeletedEvent, ActionEvent$a as ActionEvent, MessageEnvelope$a as MessageEnvelope, IdentificationData$a as IdentificationData, IdentificationDataIdOneOf$a as IdentificationDataIdOneOf, WebhookIdentityType$a as WebhookIdentityType, ecomV1CheckoutCheckout_universal_d_createCheckout as createCheckout, ecomV1CheckoutCheckout_universal_d_CreateCheckoutOptions as CreateCheckoutOptions, ecomV1CheckoutCheckout_universal_d_getCheckout as getCheckout, ecomV1CheckoutCheckout_universal_d_GetCheckoutOptions as GetCheckoutOptions, ecomV1CheckoutCheckout_universal_d_getCheckoutByCartId as getCheckoutByCartId, ecomV1CheckoutCheckout_universal_d_GetWixCheckoutUrlOptions as GetWixCheckoutUrlOptions, ecomV1CheckoutCheckout_universal_d_getCheckoutUrl as getCheckoutUrl, ecomV1CheckoutCheckout_universal_d_GetCheckoutUrlOptions as GetCheckoutUrlOptions, ecomV1CheckoutCheckout_universal_d_updateCheckout as updateCheckout, ecomV1CheckoutCheckout_universal_d_UpdateCheckout as UpdateCheckout, ecomV1CheckoutCheckout_universal_d_UpdateCheckoutOptions as UpdateCheckoutOptions, ecomV1CheckoutCheckout_universal_d_removeCoupon as removeCoupon, ecomV1CheckoutCheckout_universal_d_removeGiftCard as removeGiftCard, ecomV1CheckoutCheckout_universal_d_removeOverrideCheckoutUrl as removeOverrideCheckoutUrl, ecomV1CheckoutCheckout_universal_d_addToCheckout as addToCheckout, ecomV1CheckoutCheckout_universal_d_AddToCheckoutOptions as AddToCheckoutOptions, ecomV1CheckoutCheckout_universal_d_removeLineItems as removeLineItems, createOrder$1 as createOrder, CreateOrderOptions$1 as CreateOrderOptions, ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeOptions as CreateOrderAndChargeOptions, ecomV1CheckoutCheckout_universal_d_markCheckoutAsCompleted as markCheckoutAsCompleted, ecomV1CheckoutCheckout_universal_d_updateLineItemsQuantity as updateLineItemsQuantity, ecomV1CheckoutCheckout_universal_d_getCheckoutPaymentSettings as getCheckoutPaymentSettings, };\n }\n /**\n * The back in stock notification request allows a customer to receive a notifiction when a specific item\n * is available again. The request includes information about the person making the request, the item\n * they want to receive a notification for, and the status of the notification.\n */\n interface BackInStockNotificationRequest {\n /**\n * Request ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Catalog and item reference that the notification request is for.\n *\n * Includes IDs for the catalog and item it came from, as well as additional, optional information.\n */\n catalogReference?: CatalogReference$5;\n /** Email address to send notification to about item being back in stock. */\n email?: string;\n /**\n * Contact ID for the contact with this `email`.\n *\n * If a contact does not already exist with the email address submitted when creating this request, then a new contact is created.\n * For more information about contacts, see the Contacts API.\n * @readonly\n */\n contactId?: string | null;\n /**\n * Status of the notification.\n *\n * `status` is set to `RECEIVED` when the notification request is created. The `status` changes once a notification email is sent for this request object:\n * + When a notification email is sent through the site, either automatically or with the `reportItemsBackInStock()` function, then the `status` is briefly set to `PROCESSING` and then set to `NOTIFICATION_SENT` if the email is successul, and `FAILED` if it fails.\n * + When a notification email is sent offline, use the `markAsNotificationSent()` function to set `status` to `NOTIFICATION_SENT`.\n * @readonly\n */\n status?: Status$2;\n /**\n * Whether a notification was sent automatically.\n *\n * `autoNotified` is empty when the notification request is created and is not returned until the field has a value. `autoNotified` receives a value when a notification email is sent for this request object.\n *\n * `autoNotified` sets to `true` if the notification is sent through the site, either automatically or with the `reportItemsBackInStock()` function. If the notification email is sent offline but the `status` is updated with the `markAsNotificationSent()` function, then `autoNotified` sets to `false`.\n * @readonly\n */\n autoNotified?: boolean | null;\n /**\n * Date and time the notification request was created.\n * @readonly\n */\n _createdDate?: Date;\n /** Item URL for this request. */\n itemUrl?: string | null;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$5 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).\n */\n options?: Record | null;\n }\n enum Status$2 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** initial status of all new requests */\n RECEIVED = \"RECEIVED\",\n PROCESSING = \"PROCESSING\",\n NOTIFICATION_SENT = \"NOTIFICATION_SENT\",\n FAILED = \"FAILED\"\n }\n interface InvalidateCache extends InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$1;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$1;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n }\n interface App$1 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface CreateBackInStockNotificationRequestRequest {\n /**\n * Notification request information.\n *\n * Includes details for the out of stock item and the email address\n * requesting to be notified when it's back in stock.\n */\n request: BackInStockNotificationRequest;\n /** Item details to include in the notification when the item is back in stock. */\n itemDetails: BackInStockItemDetails;\n }\n interface BackInStockItemDetails {\n /** Item name. */\n name?: string;\n /** Item price. */\n price?: string;\n /** Item image. */\n image?: string;\n }\n interface CreateBackInStockNotificationRequestResponse {\n /** Created back in stock notification request. */\n request?: BackInStockNotificationRequest;\n }\n interface GetBackInStockNotificationRequestRequest {\n /** ID of the notification request to retrieve. */\n _id: string;\n }\n interface GetBackInStockNotificationRequestResponse {\n /** Retrieved back in stock notification request. */\n request?: BackInStockNotificationRequest;\n }\n interface DeleteBackInStockNotificationRequestRequest {\n /** ID of the notification request to delete. */\n _id: string;\n }\n interface DeleteBackInStockNotificationRequestResponse {\n }\n interface MarkAsNotificationSentRequest {\n /** ID of the notification request to mark. */\n _id: string;\n }\n interface MarkAsNotificationSentResponse {\n /** Marked back in stock notification request. */\n request?: BackInStockNotificationRequest;\n }\n interface QueryBackInStockNotificationRequestsRequest {\n /** Query options. */\n query: PlatformQuery$2;\n }\n interface PlatformQuery$2 extends PlatformQueryPagingMethodOneOf$2 {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging$2;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging$3;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting$3[];\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf$2 {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging$2;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging$3;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n }\n enum SortOrder$3 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformPaging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$3 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryBackInStockNotificationRequestsResponse {\n /** Retrieved back in stock requests. */\n requests?: BackInStockNotificationRequest[];\n /** Details on the paged set of results returned. */\n metadata?: PlatformPagingMetadata$2;\n }\n interface PlatformPagingMetadata$2 {\n /** The number of items returned in this response. */\n count?: number | null;\n /** The offset which was requested. Returned if offset paging was used. */\n offset?: number | null;\n /** The total number of items that match the query. Returned if offset paging was used. */\n total?: number | null;\n /** Cursors to navigate through result pages. Returned if cursor paging was used. */\n cursors?: Cursors$3;\n }\n interface Cursors$3 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface GetBackInStockNotificationRequestsCountByCatalogReferencesRequest {\n /** `catalogReference` items to retrieve the notification request for. */\n catalogReferences: CatalogReference$5[];\n }\n interface GetBackInStockNotificationRequestsCountByCatalogReferencesResponse {\n /** Amount of back in stock notifications for each of the retrieved `catalogReference` items. */\n countsPerCatalogReference?: BackInStockNotificationRequestsCount[];\n }\n /** Maps each back in stock CatalogReference to the results (the number of unique occurrences). */\n interface BackInStockNotificationRequestsCount {\n /**\n * Catalog and item reference.\n *\n * Includes IDs and additional, optional information related to the item.\n */\n catalogReference?: CatalogReference$5;\n /** The number of unique back in stock requests for given `catalogReference`. */\n count?: number;\n }\n interface ReportItemsBackInStockRequest {\n /**\n * `catalogReference` item to send notifications for.\n *\n * Cannot be used with `requestIds`.\n */\n catalogReference?: CatalogReference$5;\n /**\n * IDs of requests to send notifications for.\n *\n * Cannot be used with `catalogReference`.\n */\n requestIds?: string[];\n /**\n * Item details to use in notifications.\n *\n * `itemDetails` may populate dynamic valyes in the notification template, as follows:\n * + `itemDetails.name` passes to the template as `item.name`\n * + `itemDetails.price` passes to the template as `item.price`\n * + `itemDetails.image.url` passes to the template as `item.image.url`\n *\n * Use `extraAutomationTemplateParameters` to pass additional dynamic values.\n */\n itemDetails: BackInStockItemDetails;\n /** Additional key-value pairs to pass to the back in stock notification template. */\n extraAutomationTemplateParameters?: Record;\n }\n interface ReportItemsBackInStockResponse {\n }\n interface DomainEvent$9 extends DomainEventBodyOneOf$9 {\n createdEvent?: EntityCreatedEvent$9;\n updatedEvent?: EntityUpdatedEvent$9;\n deletedEvent?: EntityDeletedEvent$9;\n actionEvent?: ActionEvent$9;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$9 {\n createdEvent?: EntityCreatedEvent$9;\n updatedEvent?: EntityUpdatedEvent$9;\n deletedEvent?: EntityDeletedEvent$9;\n actionEvent?: ActionEvent$9;\n }\n interface EntityCreatedEvent$9 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$9 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$9 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$9 {\n bodyAsJson?: string;\n }\n interface Empty$5 {\n }\n interface MessageEnvelope$9 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$9;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$9 extends IdentificationDataIdOneOf$9 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$9;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$9 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$9 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a back in stock notification request.\n *\n * If a notification request already exists for the same `catalogReference` and `email`,\n * then a new one isn't created and the existing request is returned.\n * @param request - Notification request information.\n *\n * Includes details for the out of stock item and the email address\n * requesting to be notified when it's back in stock.\n * @param itemDetails - Item details to include in the notification when the item is back in stock.\n * @public\n * @documentationMaturity preview\n * @requiredField itemDetails\n * @requiredField itemDetails.name\n * @requiredField itemDetails.price\n * @requiredField request\n * @requiredField request.catalogReference\n * @requiredField request.catalogReference.appId\n * @requiredField request.catalogReference.catalogItemId\n * @requiredField request.email\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns Created back in stock notification request.\n */\n function createBackInStockNotificationRequest(request: BackInStockNotificationRequest, itemDetails: BackInStockItemDetails): Promise;\n /**\n * Retrieves a back in stock notification request.\n * @param _id - ID of the notification request to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved back in stock notification request.\n */\n function getBackInStockNotificationRequest(_id: string): Promise;\n /**\n * Deletes a back in stock notification request.\n * @param _id - ID of the notification request to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteBackInStockNotificationRequest(_id: string): Promise;\n /**\n * Sets `status` of a back in stock request to `NOTIFICATION_SENT`.\n *\n * Use this function if the notification is sent manually offline. If the notification is sent automatically or with the `reportItemsBackInStock()` function, then `status` updates on its own.\n * @param _id - ID of the notification request to mark.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function markAsNotificationSent(_id: string): Promise;\n /**\n * Creates a query to retrieve a list of back in stock notification requests.\n *\n * The `queryBackInStockNotificationRequests()` method builds a query to retrieve a list of back in stock notification requests and returns a `RequestsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the `find()` method.\n *\n * You can refine the query by chaining `RequestsQueryBuilder` methods onto the query. `RequestsQueryBuilder` methods enable you to sort, filter, and control the results that `queryBackInStockNotificationRequests()` returns.\n *\n * The following `RequestsQueryBuilder` methods are supported for `queryBackInStockNotificationRequests()`. For a full description of the Requests object, see the object returned for the `items` property in `RequestsQueryResult`.\"\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryBackInStockNotificationRequests(): RequestsQueryBuilder;\n interface QueryCursorResult$3 {\n cursors: Cursors$3;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface RequestsQueryResult extends QueryCursorResult$3 {\n items: BackInStockNotificationRequest[];\n query: RequestsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface RequestsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\", value: any) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\", value: any) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"_createdDate\", value: any) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\", value: any) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\", value: any) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\", value: any) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"contactId\" | \"itemUrl\", value: string) => RequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\", value: any[]) => RequestsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\", value: any) => RequestsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\", value: boolean) => RequestsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\">) => RequestsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"contactId\" | \"status\" | \"autoNotified\" | \"_createdDate\" | \"itemUrl\">) => RequestsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => RequestsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => RequestsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves the amount of back in stock requests for a given `catalogReference` item.\n * @param catalogReferences - `catalogReference` items to retrieve the notification request for.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogReferences\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences: CatalogReference$5[]): Promise;\n /**\n * Sends notifications for back in stock requests.\n *\n * > **Important:**\n * > Automations must be turned on in a [site's dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Go%20to%20Back-in-Stock&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/back-in-stock) for notifications to send.\n *\n * This endpoint triggers notifications for requests in 1 of 2 ways:\n * 1. For a specific item, with the `catalogReference` information.\n * 2. For specific requests, with `requestIds`.\n *\n * `itemDetails` are required and may populate dynamic values in the notification template, as follows:\n * + `itemDetails.name` passes to the template as `item.name`\n * + `itemDetails.price` passes to the template as `item.price`\n * + `itemDetails.image.url` passes to the template as `item.image.url`\n *\n * If the notification template doesn't include `item.price`, `item.name`, or `item.image.url`, values should\n * be passed in `extraAutomationTemplateParameters`.\n *\n * After this endpoint is called, the `status` for the request will update to `NOTIFICATION_SENT` if it sends\n * successfully, or to `FAILED` if it fails to send.\n * @param itemDetails - Item details to use in notifications.\n *\n * `itemDetails` may populate dynamic valyes in the notification template, as follows:\n * + `itemDetails.name` passes to the template as `item.name`\n * + `itemDetails.price` passes to the template as `item.price`\n * + `itemDetails.image.url` passes to the template as `item.image.url`\n *\n * Use `extraAutomationTemplateParameters` to pass additional dynamic values.\n * @public\n * @documentationMaturity preview\n * @requiredField itemDetails\n * @requiredField itemDetails.name\n * @requiredField itemDetails.price\n * @param options - Report options.\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function reportItemsBackInStock(itemDetails: BackInStockItemDetails, options?: ReportItemsBackInStockOptions): Promise;\n interface ReportItemsBackInStockOptions {\n /**\n * `catalogReference` item to send notifications for.\n *\n * Cannot be used with `requestIds`.\n */\n catalogReference?: CatalogReference$5;\n /**\n * IDs of requests to send notifications for.\n *\n * Cannot be used with `catalogReference`.\n */\n requestIds?: string[];\n /** Additional key-value pairs to pass to the back in stock notification template. */\n extraAutomationTemplateParameters?: Record;\n }\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_BackInStockNotificationRequest = BackInStockNotificationRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_InvalidateCache = InvalidateCache;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_Page = Page;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_URI = URI;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_File = File;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_CreateBackInStockNotificationRequestRequest = CreateBackInStockNotificationRequestRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_BackInStockItemDetails = BackInStockItemDetails;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_CreateBackInStockNotificationRequestResponse = CreateBackInStockNotificationRequestResponse;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestRequest = GetBackInStockNotificationRequestRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestResponse = GetBackInStockNotificationRequestResponse;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_DeleteBackInStockNotificationRequestRequest = DeleteBackInStockNotificationRequestRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_DeleteBackInStockNotificationRequestResponse = DeleteBackInStockNotificationRequestResponse;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_MarkAsNotificationSentRequest = MarkAsNotificationSentRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_MarkAsNotificationSentResponse = MarkAsNotificationSentResponse;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_QueryBackInStockNotificationRequestsRequest = QueryBackInStockNotificationRequestsRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_QueryBackInStockNotificationRequestsResponse = QueryBackInStockNotificationRequestsResponse;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesRequest = GetBackInStockNotificationRequestsCountByCatalogReferencesRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesResponse = GetBackInStockNotificationRequestsCountByCatalogReferencesResponse;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_BackInStockNotificationRequestsCount = BackInStockNotificationRequestsCount;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_ReportItemsBackInStockRequest = ReportItemsBackInStockRequest;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_ReportItemsBackInStockResponse = ReportItemsBackInStockResponse;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_createBackInStockNotificationRequest: typeof createBackInStockNotificationRequest;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_getBackInStockNotificationRequest: typeof getBackInStockNotificationRequest;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_deleteBackInStockNotificationRequest: typeof deleteBackInStockNotificationRequest;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_markAsNotificationSent: typeof markAsNotificationSent;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_queryBackInStockNotificationRequests: typeof queryBackInStockNotificationRequests;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_RequestsQueryResult = RequestsQueryResult;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_RequestsQueryBuilder = RequestsQueryBuilder;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_getBackInStockNotificationRequestsCountByCatalogReferences: typeof getBackInStockNotificationRequestsCountByCatalogReferences;\n const ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_reportItemsBackInStock: typeof reportItemsBackInStock;\n type ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_ReportItemsBackInStockOptions = ReportItemsBackInStockOptions;\n namespace ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d {\n export { ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_BackInStockNotificationRequest as BackInStockNotificationRequest, CatalogReference$5 as CatalogReference, Status$2 as Status, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_InvalidateCache as InvalidateCache, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, App$1 as App, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_Page as Page, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_URI as URI, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_File as File, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_CreateBackInStockNotificationRequestRequest as CreateBackInStockNotificationRequestRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_BackInStockItemDetails as BackInStockItemDetails, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_CreateBackInStockNotificationRequestResponse as CreateBackInStockNotificationRequestResponse, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestRequest as GetBackInStockNotificationRequestRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestResponse as GetBackInStockNotificationRequestResponse, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_DeleteBackInStockNotificationRequestRequest as DeleteBackInStockNotificationRequestRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_DeleteBackInStockNotificationRequestResponse as DeleteBackInStockNotificationRequestResponse, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_MarkAsNotificationSentRequest as MarkAsNotificationSentRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_MarkAsNotificationSentResponse as MarkAsNotificationSentResponse, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_QueryBackInStockNotificationRequestsRequest as QueryBackInStockNotificationRequestsRequest, PlatformQuery$2 as PlatformQuery, PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf, Sorting$3 as Sorting, SortOrder$3 as SortOrder, PlatformPaging$2 as PlatformPaging, CursorPaging$3 as CursorPaging, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_QueryBackInStockNotificationRequestsResponse as QueryBackInStockNotificationRequestsResponse, PlatformPagingMetadata$2 as PlatformPagingMetadata, Cursors$3 as Cursors, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesRequest as GetBackInStockNotificationRequestsCountByCatalogReferencesRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesResponse as GetBackInStockNotificationRequestsCountByCatalogReferencesResponse, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_BackInStockNotificationRequestsCount as BackInStockNotificationRequestsCount, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_ReportItemsBackInStockRequest as ReportItemsBackInStockRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_ReportItemsBackInStockResponse as ReportItemsBackInStockResponse, DomainEvent$9 as DomainEvent, DomainEventBodyOneOf$9 as DomainEventBodyOneOf, EntityCreatedEvent$9 as EntityCreatedEvent, EntityUpdatedEvent$9 as EntityUpdatedEvent, EntityDeletedEvent$9 as EntityDeletedEvent, ActionEvent$9 as ActionEvent, Empty$5 as Empty, MessageEnvelope$9 as MessageEnvelope, IdentificationData$9 as IdentificationData, IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, WebhookIdentityType$9 as WebhookIdentityType, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_createBackInStockNotificationRequest as createBackInStockNotificationRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_getBackInStockNotificationRequest as getBackInStockNotificationRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_deleteBackInStockNotificationRequest as deleteBackInStockNotificationRequest, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_markAsNotificationSent as markAsNotificationSent, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_queryBackInStockNotificationRequests as queryBackInStockNotificationRequests, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_RequestsQueryResult as RequestsQueryResult, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_RequestsQueryBuilder as RequestsQueryBuilder, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_getBackInStockNotificationRequestsCountByCatalogReferences as getBackInStockNotificationRequestsCountByCatalogReferences, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_reportItemsBackInStock as reportItemsBackInStock, ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d_ReportItemsBackInStockOptions as ReportItemsBackInStockOptions, };\n }\n interface Cart {\n /** Cart ID. */\n _id?: string | null;\n /**\n * Line items.\n * @readonly\n */\n lineItems?: LineItem$4[];\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$4;\n /**\n * Currency used for pricing.\n * @readonly\n */\n currency?: string;\n /**\n * Currency code used for all the converted prices that are returned.\n * For a site that supports multiple currencies, this is the currency the buyer selected.\n * @readonly\n */\n conversionCurrency?: string;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n * @readonly\n */\n buyerLanguage?: string | null;\n /**\n * Site language in which original values are displayed.\n * @readonly\n */\n siteLanguage?: string | null;\n /**\n * Whether tax is included in line item prices.\n * @readonly\n */\n taxIncludedInPrices?: boolean | null;\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$3;\n /**\n * ID of the checkout that originated from this cart.\n * @readonly\n */\n checkoutId?: string | null;\n /**\n * Cart discounts.\n * @readonly\n */\n appliedDiscounts?: CartDiscount[];\n /**\n * Date and time the cart was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the cart was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Contact info. */\n contactInfo?: AddressWithContact$2;\n /**\n * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n *\n * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.\n */\n overrideCheckoutUrl?: string | null;\n /**\n * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.\n * @readonly\n */\n purchaseFlowId?: string | null;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n }\n interface LineItem$4 {\n /**\n * Line item ID.\n * @readonly\n */\n _id?: string | null;\n /** Item quantity. */\n quantity?: number;\n /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$4;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n * @readonly\n */\n productName?: ProductName$2;\n /**\n * URL to the item's page on the site.\n * @readonly\n */\n url?: string;\n /**\n * Item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n price?: MultiCurrencyPrice$2;\n /**\n * Item price **before** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n fullPrice?: MultiCurrencyPrice$2;\n /**\n * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: MultiCurrencyPrice$2;\n /**\n * Line item description lines. Used for displaying the cart, checkout and order.\n * @readonly\n */\n descriptionLines?: DescriptionLine$2[];\n /**\n * Line item image details.\n * @readonly\n */\n image?: string;\n /**\n * Item availability details.\n * @readonly\n */\n availability?: ItemAvailabilityInfo$1;\n /**\n * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.\n * @readonly\n */\n physicalProperties?: PhysicalProperties$2;\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$2;\n /**\n * Type of selected payment option for current item. Defaults to `\"FULL_PAYMENT_ONLINE\"`.\n * + `\"FULL_PAYMENT_ONLINE\"` - The entire payment for this item happens as part of the checkout.\n * + `\"FULL_PAYMENT_OFFLINE\"` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `\"MEMBERSHIP\"` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` will be 0.\n * @readonly\n */\n paymentOption?: PaymentOptionType$2;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * @readonly\n */\n serviceProperties?: ServiceProperties$2;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + in most cases, this field is the same as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\".\n * @readonly\n */\n priceDescription?: PriceDescription$2;\n /**\n * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.\n * @readonly\n */\n depositAmount?: MultiCurrencyPrice$2;\n /** Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`. */\n selectedMembership?: SelectedMembership$1;\n /**\n * Tax group ID for this line item.\n * @readonly\n */\n taxGroupId?: string | null;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Overriding values for catalog item properties.\n *\n * To override catalog fields, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n catalogOverrideFields?: CatalogOverrideFields$1;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$4 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs.\n *\n * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).\n */\n options?: Record | null;\n }\n interface ProductName$2 {\n /** **Required** - Original product name (in site's default language). */\n original?: string;\n /** Description product name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface MultiCurrencyPrice$2 {\n /** Amount. */\n amount?: string;\n /**\n * Converted amount.\n * @readonly\n */\n convertedAmount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n /**\n * Converted amount formatted with currency symbol.\n * @readonly\n */\n formattedConvertedAmount?: string;\n }\n interface DescriptionLine$2 extends DescriptionLineValueOneOf$2, DescriptionLineDescriptionLineValueOneOf$2 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$2;\n /** Description line color value. */\n colorInfo?: Color$2;\n /** Description line name. */\n name?: DescriptionLineName$2;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf$2 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$2;\n /** Description line color value. */\n colorInfo?: Color$2;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf$2 {\n }\n interface DescriptionLineName$2 {\n /** Description line name in site's default language. */\n original?: string;\n /** Description line name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface PlainTextValue$2 {\n /** Description line plain text value in site's default language. */\n original?: string;\n /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface Color$2 {\n /** Description line color name in site's default language. */\n original?: string;\n /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n /**\n * HEX or RGB color code for display.\n *\n */\n code?: string | null;\n }\n enum DescriptionLineType$2 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n COLOR = \"COLOR\"\n }\n interface ItemAvailabilityInfo$1 {\n /**\n * Item availability status.\n *\n * NOT_FOUND - Item does not exist.\n * NOT_AVAILABLE - Not in stock.\n * PARTIALLY_AVAILABLE - Available quantity is less than requested.\n */\n status?: ItemAvailabilityStatus$1;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus$1 {\n AVAILABLE = \"AVAILABLE\",\n NOT_FOUND = \"NOT_FOUND\",\n /** Not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface PhysicalProperties$2 {\n /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface Scope$2 {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */\n namespace?: string;\n /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */\n group?: Group$1;\n }\n interface Group$1 {\n /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n name?: string;\n /** Item ID (when the coupon scope is limited to just one item). */\n entityId?: string | null;\n }\n interface ItemType$2 extends ItemTypeItemTypeDataOneOf$2 {\n /** Preset item type. */\n preset?: ItemTypeItemType$2;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n /** @oneof */\n interface ItemTypeItemTypeDataOneOf$2 {\n /** Preset item type. */\n preset?: ItemTypeItemType$2;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$2 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PHYSICAL = \"PHYSICAL\",\n DIGITAL = \"DIGITAL\",\n GIFT_CARD = \"GIFT_CARD\",\n SERVICE = \"SERVICE\"\n }\n interface SubscriptionOptionInfo$2 {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings$3;\n /** Subscription option title. */\n title?: Title$1;\n /** Subscription option description. */\n description?: Description$1;\n }\n interface SubscriptionSettings$3 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$3;\n /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n */\n interval?: number | null;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$3 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface Title$1 {\n /** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Subscription option name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Description$1 {\n /** Subscription option description. */\n original?: string;\n /** Translated subscription option description. */\n translated?: string | null;\n }\n interface SecuredMedia$1 {\n /** Media ID in Wix Media Manager. */\n _id?: string;\n /** Original filename. */\n fileName?: string;\n /** File type. */\n fileType?: FileType$1;\n }\n enum FileType$1 {\n UNSPECIFIED = \"UNSPECIFIED\",\n SECURE_PICTURE = \"SECURE_PICTURE\",\n SECURE_VIDEO = \"SECURE_VIDEO\",\n SECURE_DOCUMENT = \"SECURE_DOCUMENT\",\n SECURE_MUSIC = \"SECURE_MUSIC\",\n SECURE_ARCHIVE = \"SECURE_ARCHIVE\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType$2 {\n /** The entire payment for this item happens as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\",\n /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface ServiceProperties$2 {\n /** The date and time for which the service is supposed to be provided. For example, the time of the class. */\n scheduledDate?: Date | null;\n /** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface PriceDescription$2 {\n /**\n * **Required** - Original price description (in site's default language).\n *\n */\n original?: string;\n /** Product name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n /** Selected Membership */\n interface SelectedMembership$1 {\n /** Membership ID. */\n _id?: string;\n /** ID of the app providing this payment option. */\n appId?: string;\n }\n interface CatalogOverrideFields$1 {\n /** Item name. */\n productName?: ProductName$2;\n /** Item price **after** discounts. */\n price?: string | null;\n /** Item price **before** discounts. */\n fullPrice?: string | null;\n /** Item description lines. Used when displaying the line item to customers. */\n descriptionLines?: DescriptionLine$2[];\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$2;\n /** Item image. */\n image?: string;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType;\n }\n enum TaxableAddressType {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n /** Buyer Info */\n interface BuyerInfo$4 extends BuyerInfoIdOneOf$2 {\n /**\n * Visitor ID - if the buyer is **not** a site member.\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID - if the buyer is a site member.\n * @readonly\n */\n memberId?: string;\n /**\n * User ID - if the cart owner is a Wix user.\n * @readonly\n */\n userId?: string;\n /** Contact ID. For more information, see the Contacts API. */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf$2 {\n /**\n * Visitor ID - if the buyer is **not** a site member.\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID - if the buyer is a site member.\n * @readonly\n */\n memberId?: string;\n /**\n * User ID - if the cart owner is a Wix user.\n * @readonly\n */\n userId?: string;\n }\n enum WeightUnit$3 {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface CartDiscount extends CartDiscountDiscountSourceOneOf {\n /** Coupon details. */\n coupon?: Coupon$2;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$2;\n }\n /** @oneof */\n interface CartDiscountDiscountSourceOneOf {\n /** Coupon details. */\n coupon?: Coupon$2;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$2;\n }\n interface Coupon$2 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n }\n interface MerchantDiscount$2 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$2;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$2 {\n /** Address. */\n address?: Address$3;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$2;\n }\n /** Physical address */\n interface Address$3 {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. */\n streetAddress?: StreetAddress$2;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n interface StreetAddress$2 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$2 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails$2 {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Company name. */\n company?: string | null;\n /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */\n vatId?: VatId$3;\n }\n interface VatId$3 {\n /** Customer's tax ID. */\n _id?: string;\n /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\n type?: VatType$3;\n }\n /** tax info types */\n enum VatType$3 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface SelectedShippingOption {\n /** Carrier ID. */\n carrierId?: string | null;\n /** Selected shipping option code. For example, \"usps_std_overnight\". */\n code?: string;\n }\n interface ExtendedFields$3 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface GetCurrentCartRequest {\n }\n interface GetCurrentCartResponse {\n /** Current session's active cart. */\n cart?: Cart;\n }\n interface UpdateCartRequest {\n /** Cart info. */\n cartInfo?: Cart;\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput[];\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n }\n interface MerchantDiscountInput {\n /** Discount amount. */\n amount?: string;\n /** IDs of the line items the discount applies to. */\n lineItemIds?: string[];\n }\n interface CustomLineItem$1 {\n /**\n * Custom line item quantity.\n *\n * Min: `1`\n * Max: `100000`\n */\n quantity?: number;\n /**\n * Custom line item price.\n *\n * Must be a number or a decimal without symbols.\n */\n price?: string;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription$2;\n /** Custom line item description lines. Used for displaying the cart, checkout and order. */\n descriptionLines?: DescriptionLine$2[];\n /**\n * Custom line item media. Supported formats:\n * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `\"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000\"`.\n * + An image from the web - `\"http(s)://\"`.\n */\n media?: string;\n /**\n * Custom line item ID. If passed, `id` must be unique.\n *\n * Default: auto-generated ID\n */\n _id?: string | null;\n /** Tax group ID for this custom line item. */\n taxGroupId?: string | null;\n /** Name of the item or product. */\n productName?: ProductName$2;\n /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */\n url?: string;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$2;\n /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: string | null;\n /**\n * Item quantity available for purchase. Only return this if inventory is managed.\n * Not returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart.\n */\n quantityAvailable?: number | null;\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$2;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n *\n * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType$2;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * Used, among other things, when checking for valid memberships.\n */\n serviceProperties?: ServiceProperties$2;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n *\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field is the same as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n */\n rootCatalogItemId?: string | null;\n /**\n * Partial payment for the given item to be paid upfront during the checkout.\n *\n * Eligible for catalog items with type `DEPOSIT_ONLINE`.\n * When omitted, the item's price will not be split and is expected to be paid in a single installment.\n */\n depositAmount?: string | null;\n /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$4;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n interface UpdateCartResponse {\n /** Updated Cart. */\n cart?: Cart;\n }\n interface AddToCurrentCartRequest {\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n }\n interface AddToCartResponse {\n /** Updated cart. */\n cart?: Cart;\n }\n interface AddToCurrentCartAndEstimateTotalsRequest {\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$1;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n interface SelectedMemberships$1 {\n /** Selected memberships. */\n memberships?: HostSelectedMembership[];\n }\n interface HostSelectedMembership {\n /** Membership ID. */\n _id?: string;\n /** ID of the app providing this payment option. */\n appId?: string;\n /** IDs of the line items this membership applies to. */\n lineItemIds?: string[];\n }\n interface EstimateTotalsResponse {\n /** Cart. */\n cart?: Cart;\n /** Calculated line items. */\n calculatedLineItems?: CalculatedLineItem[];\n /** Price summary. */\n priceSummary?: PriceSummary$2;\n /** Applied gift card. */\n giftCard?: GiftCard$2;\n /** Tax summary. */\n taxSummary?: TaxSummary$2;\n /** Shipping information. */\n shippingInfo?: ShippingInformation$1;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$3[];\n /** Calculation errors. */\n calculationErrors?: CalculationErrors$1;\n /** Weight measurement unit - defaults to site's weight unit. */\n weightUnit?: WeightUnit$3;\n /** Currency used for pricing in this store. */\n currency?: string;\n /**\n * Minimal amount to pay in order to place the order.\n * @readonly\n */\n payNow?: PriceSummary$2;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$2;\n /** Information about valid and invalid memberships, and which ones are selected for usage. */\n membershipOptions?: MembershipOptions$1;\n /** Additional fees */\n additionalFees?: AdditionalFee$2[];\n /**\n * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).\n * @readonly\n */\n violations?: Violation$1[];\n }\n interface CalculatedLineItem {\n /** Line item ID. */\n lineItemId?: string;\n /** Price breakdown for this line item. */\n pricesBreakdown?: LineItemPricesData;\n /**\n * Type of selected payment option for current item. Defaults to `\"FULL_PAYMENT_ONLINE\"`.\n * + `\"FULL_PAYMENT_ONLINE\"` - The entire payment for this item happens as part of the checkout.\n * + `\"FULL_PAYMENT_OFFLINE\"` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `\"MEMBERSHIP\"` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` will be 0.\n */\n paymentOption?: PaymentOptionType$2;\n }\n interface LineItemPricesData {\n /** Total price after discounts and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$2;\n /** Total price after discounts, and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$2;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$2;\n /** Total discount for all line items. */\n totalDiscount?: MultiCurrencyPrice$2;\n /** Catalog price after catalog discount and automatic discounts. */\n price?: MultiCurrencyPrice$2;\n /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: MultiCurrencyPrice$2;\n /** Total price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: MultiCurrencyPrice$2;\n /** Item price **before** line item discounts and **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: MultiCurrencyPrice$2;\n }\n interface ItemTaxFullDetails$2 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$2;\n /** Tax rate %, as a decimal point between 0 and 1. */\n taxRate?: string;\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n totalTax?: MultiCurrencyPrice$2;\n /**\n * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.\n * @readonly\n * @deprecated\n */\n rateBreakdown?: TaxRateBreakdown$1[];\n }\n interface TaxRateBreakdown$1 {\n /** Name of tax against which the calculation was performed. */\n name?: string;\n /** Rate at which this tax detail was calculated. */\n rate?: string;\n /** Amount of tax for this tax detail. */\n tax?: MultiCurrencyPrice$2;\n }\n /**\n * TaxBreakdown represents tax information for a line item.\n * It holds the tax amount and the tax rate for each tax authority that apply on the line item.\n */\n interface TaxBreakdown$1 {\n /** The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\". */\n jurisdiction?: string | null;\n /** The amount of this line item price that was considered nontaxable. (Decimal value) */\n nonTaxableAmount?: MultiCurrencyPrice$2;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */\n rate?: string | null;\n /** The amount of tax estimated for this line item. (Decimal value) */\n taxAmount?: MultiCurrencyPrice$2;\n /** The taxable amount of this line item. */\n taxableAmount?: MultiCurrencyPrice$2;\n /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc. */\n taxType?: string | null;\n /**\n * The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\n * This name should be explicit enough to allow the merchant to understand what tax was calculated.\n */\n taxName?: string | null;\n /** The type of the jurisdiction in which this tax detail applies. */\n jurisdictionType?: JurisdictionType$2;\n }\n /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n enum JurisdictionType$2 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface PriceSummary$2 {\n /** Subtotal of all line items, before discounts and before tax. */\n subtotal?: MultiCurrencyPrice$2;\n /** Total shipping price, before discounts and before tax. */\n shipping?: MultiCurrencyPrice$2;\n /** Total tax. */\n tax?: MultiCurrencyPrice$2;\n /** Total calculated discount value. */\n discount?: MultiCurrencyPrice$2;\n /** Total price after discounts, gift cards, and tax. */\n total?: MultiCurrencyPrice$2;\n /** Total additional fees price before tax. */\n additionalFees?: MultiCurrencyPrice$2;\n }\n interface GiftCard$2 {\n /**\n * Gift Card ID.\n * @deprecated\n */\n _id?: string;\n /** Gift card obfuscated code. */\n obfuscatedCode?: string;\n /** Gift card value. */\n amount?: MultiCurrencyPrice$2;\n /** App ID of the gift card provider. */\n appId?: string;\n /**\n * External ID in the gift card provider's system.\n * Used for integration and tracking across different platforms.\n */\n externalId?: string | null;\n }\n interface TaxSummary$2 {\n /**\n * Amount for which tax is calculated, added from line items.\n * @readonly\n */\n taxableAmount?: MultiCurrencyPrice$2;\n /**\n * Calculated tax, added from line items.\n * @readonly\n */\n totalTax?: MultiCurrencyPrice$2;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$1;\n }\n interface TaxCalculationDetails$1 extends TaxCalculationDetailsCalculationDetailsOneOf$1 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$1;\n /** Error details and reason for tax rate fallback. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$1;\n /**\n * Rate calculation type. Supported values:\n * + `\"AUTO_RATE\"`\n * + `\"FALLBACK_RATE\"`\n * + `\"MANUAL_RATE\"`\n * + `\"NO_TAX_COLLECTED\"`\n */\n rateType?: RateType$1;\n }\n /** @oneof */\n interface TaxCalculationDetailsCalculationDetailsOneOf$1 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$1;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$1;\n }\n enum RateType$1 {\n /** no tax being collected for this request due to location of purchase */\n NO_TAX_COLLECTED = \"NO_TAX_COLLECTED\",\n /** manual rate used for calculation */\n MANUAL_RATE = \"MANUAL_RATE\",\n /** autotax rate used for calculation */\n AUTO_RATE = \"AUTO_RATE\",\n /** fallback rate used for calculation */\n FALLBACK_RATE = \"FALLBACK_RATE\"\n }\n enum ManualCalculationReason$1 {\n /** user set calculator in Business Manager to be Manual */\n GLOBAL_SETTING_TO_MANUAL = \"GLOBAL_SETTING_TO_MANUAL\",\n /** specific region is on manual even though Global setting is Auto-tax */\n REGION_SETTING_TO_MANUAL = \"REGION_SETTING_TO_MANUAL\"\n }\n interface AutoTaxFallbackCalculationDetails$1 {\n /**\n * Reason for fallback. Supported values:\n * + `\"AUTO_TAX_FAILED\"`\n * + `\"AUTO_TAX_DEACTIVATED\"`\n */\n fallbackReason?: FallbackReason$1;\n /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */\n error?: ApplicationError$5;\n }\n enum FallbackReason$1 {\n /** auto-tax failed to be calculated */\n AUTO_TAX_FAILED = \"AUTO_TAX_FAILED\",\n /** auto-tax was temporarily deactivated on a system-level */\n AUTO_TAX_DEACTIVATED = \"AUTO_TAX_DEACTIVATED\"\n }\n interface ApplicationError$5 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n /**\n * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.\n * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.\n */\n interface AggregatedTaxBreakdown$1 {\n /** The name of the tax against which this tax amount was calculated. */\n taxName?: string;\n /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */\n taxType?: string;\n /** The name of the jurisdiction in which this tax detail applies. */\n jurisdiction?: string;\n /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n jurisdictionTypeEnum?: JurisdictionType$2;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */\n rate?: string;\n /** The sum of all the tax from line items that calculated by the tax identifiers. */\n aggregatedTaxAmount?: MultiCurrencyPrice$2;\n }\n interface ShippingInformation$1 {\n /** Shipping region. */\n region?: ShippingRegion$2;\n /** Selected shipping option. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption$1;\n /** All shipping options. */\n carrierServiceOptions?: CarrierServiceOption$1[];\n }\n interface ShippingRegion$2 {\n /**\n * Shipping region ID.\n * @readonly\n */\n _id?: string;\n /** Shipping region name. */\n name?: string;\n }\n interface SelectedCarrierServiceOption$1 {\n /** Unique identifier of selected option. For example, \"usps_std_overnight\". */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n * @readonly\n */\n title?: string;\n /**\n * Delivery logistics.\n * @readonly\n */\n logistics?: DeliveryLogistics$2;\n /**\n * Shipping costs.\n * @readonly\n */\n cost?: SelectedCarrierServiceOptionPrices$1;\n /**\n * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)\n * @readonly\n */\n requestedShippingOption?: boolean;\n /** Other charges */\n otherCharges?: SelectedCarrierServiceOptionOtherCharge$1[];\n /** This carrier's unique ID */\n carrierId?: string | null;\n }\n interface DeliveryLogistics$2 {\n /** Expected delivery time, in free text. For example, \"3-5 business days\". */\n deliveryTime?: string | null;\n /** Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\". */\n instructions?: string | null;\n /** Pickup details. */\n pickupDetails?: PickupDetails$3;\n }\n interface PickupDetails$3 {\n /** Pickup address. */\n address?: Address$3;\n /**\n * Whether the pickup address is that of a business - this may effect tax calculation.\n * @deprecated\n */\n businessLocation?: boolean;\n /** Pickup method */\n pickupMethod?: PickupMethod$2;\n }\n enum PickupMethod$2 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$2 {\n /** starting time of the delivery time slot */\n from?: Date | null;\n /** ending time of the delivery time slot */\n to?: Date | null;\n }\n interface SelectedCarrierServiceOptionPrices$1 {\n /** Total shipping price, after discount and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$2;\n /** Total price of shipping after discounts (when relevant), and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$2;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$2;\n /** Shipping discount before tax. */\n totalDiscount?: MultiCurrencyPrice$2;\n /** Shipping price before discount and before tax. */\n price?: MultiCurrencyPrice$2;\n }\n interface SelectedCarrierServiceOptionOtherCharge$1 {\n /** Type of additional cost. */\n type?: ChargeType$1;\n /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */\n details?: string | null;\n /** Price of added charge. */\n cost?: SelectedCarrierServiceOptionPrices$1;\n }\n enum ChargeType$1 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface CarrierServiceOption$1 {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption$1[];\n }\n interface ShippingOption$1 {\n /**\n * Unique code of provided shipping option like \"usps_std_overnight\".\n * For legacy calculators this would be the UUID of the option.\n */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics$2;\n /** Sipping price information. */\n cost?: ShippingPrice$2;\n }\n interface ShippingPrice$2 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$2;\n /** Other costs such as insurance, handling & packaging for fragile items, etc. */\n otherCharges?: OtherCharge$1[];\n }\n interface OtherCharge$1 {\n /** Type of additional cost. */\n type?: ChargeType$1;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$2;\n }\n interface AppliedDiscount$3 extends AppliedDiscountDiscountSourceOneOf$2 {\n /** Coupon details. */\n coupon?: V1Coupon;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount;\n /** Discount rule */\n discountRule?: DiscountRule$3;\n /** Discount type. */\n discountType?: DiscountType$3;\n /**\n * IDs of the line items the discount applies to.\n * @deprecated IDs of line items the discount applies to.\n * @replacedBy line_items_discounts\n * @targetRemovalDate 2024-06-01\n */\n lineItemIds?: string[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$2 {\n /** Coupon details. */\n coupon?: V1Coupon;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount;\n /** Discount rule */\n discountRule?: DiscountRule$3;\n }\n enum DiscountType$3 {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface V1Coupon {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon value. */\n amount?: MultiCurrencyPrice$2;\n /** Coupon name. */\n name?: string;\n }\n interface V1MerchantDiscount {\n /** Discount value. */\n amount?: MultiCurrencyPrice$2;\n /** Discount Percentage. Will be calculated from items price before other discounts. */\n percentage?: number | null;\n }\n interface DiscountRule$3 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$3;\n /** Discount value. */\n amount?: MultiCurrencyPrice$2;\n }\n interface DiscountRuleName$3 {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /** Discount rule name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface LineItemDiscount$2 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$2;\n }\n interface CalculationErrors$1 extends CalculationErrorsShippingCalculationErrorOneOf$1 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$1;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$1;\n /** Tax calculation error. */\n taxCalculationError?: Details$1;\n /** Coupon calculation error. */\n couponCalculationError?: Details$1;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details$1;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$5[];\n /**\n * Membership payment methods calculation errors\n * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid\n */\n membershipError?: Details$1;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details$1;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$1 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$1;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$1;\n }\n interface Details$1 extends DetailsKindOneOf$1 {\n applicationError?: ApplicationError$5;\n validationError?: ValidationError$1;\n systemError?: SystemError$1;\n /**\n * Deprecated in APIs. Used to enable migration from rendering arbitrary tracing to rest response.\n * @deprecated\n */\n tracing?: Record;\n }\n /** @oneof */\n interface DetailsKindOneOf$1 {\n applicationError?: ApplicationError$5;\n validationError?: ValidationError$1;\n systemError?: SystemError$1;\n }\n /**\n * example result:\n * {\n * \"fieldViolations\": [\n * {\n * \"field\": \"fieldA\",\n * \"description\": \"invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]\",\n * \"violatedRule\": \"OTHER\",\n * \"ruleName\": \"INVALID_NOTE\",\n * \"data\": {\n * \"value\": \"FI\"\n * }\n * },\n * {\n * \"field\": \"fieldB\",\n * \"description\": \"field value out of range. supported range: [0-20]\",\n * \"violatedRule\": \"MAX\",\n * \"data\": {\n * \"threshold\": 20\n * }\n * },\n * {\n * \"field\": \"fieldC\",\n * \"description\": \"invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]\",\n * \"violatedRule\": \"FORMAT\",\n * \"data\": {\n * \"type\": \"PHONE\"\n * }\n * }\n * ]\n * }\n */\n interface ValidationError$1 {\n fieldViolations?: FieldViolation$1[];\n }\n enum RuleType$1 {\n VALIDATION = \"VALIDATION\",\n OTHER = \"OTHER\",\n MAX = \"MAX\",\n MIN = \"MIN\",\n MAX_LENGTH = \"MAX_LENGTH\",\n MIN_LENGTH = \"MIN_LENGTH\",\n MAX_SIZE = \"MAX_SIZE\",\n MIN_SIZE = \"MIN_SIZE\",\n FORMAT = \"FORMAT\",\n DECIMAL_LTE = \"DECIMAL_LTE\",\n DECIMAL_GTE = \"DECIMAL_GTE\",\n DECIMAL_LT = \"DECIMAL_LT\",\n DECIMAL_GT = \"DECIMAL_GT\",\n DECIMAL_MAX_SCALE = \"DECIMAL_MAX_SCALE\",\n INVALID_ENUM_VALUE = \"INVALID_ENUM_VALUE\",\n REQUIRED_FIELD = \"REQUIRED_FIELD\",\n FIELD_NOT_ALLOWED = \"FIELD_NOT_ALLOWED\",\n ONE_OF_ALIGNMENT = \"ONE_OF_ALIGNMENT\"\n }\n interface FieldViolation$1 {\n field?: string;\n description?: string;\n violatedRule?: RuleType$1;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError$1 {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors$1 {\n /** Carrier errors. */\n errors?: CarrierError$1[];\n }\n interface CarrierError$1 {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details$1;\n }\n interface MembershipOptions$1 {\n /** List of payment options that can be used. */\n eligibleMemberships?: Membership$1[];\n /** List of payment options that are owned by the member, but cannot be used due to reason provided. */\n invalidMemberships?: InvalidMembership$1[];\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: HostSelectedMembership[];\n }\n interface Membership$1 {\n /** Membership ID. */\n _id?: string;\n /** ID of the application providing this payment option. */\n appId?: string;\n /** The name of this membership. */\n name?: MembershipName$3;\n /** Line item IDs which are \"paid\" for by this membership. */\n lineItemIds?: string[];\n /** Optional - For a membership that has limited credits, information about credit usage. */\n credits?: MembershipPaymentCredits$1;\n /** Optional - TMembership expiry date. */\n expirationDate?: Date | null;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$3 {\n /** Membership name. */\n original?: string;\n /** Membership name translated into buyer's language. Defaults to `original` when not defined. */\n translated?: string | null;\n }\n interface MembershipPaymentCredits$1 {\n /** Membership's total amount of credits. */\n total?: number;\n /** Membership's remaining amount of credits. */\n remaining?: number;\n }\n interface InvalidMembership$1 {\n /** Membership details. */\n membership?: Membership$1;\n /** Reason why this membership is invalid and cannot be used. */\n reason?: string;\n }\n interface AdditionalFee$2 {\n /** Additional fee's unique code (or ID) for future processing. */\n code?: string | null;\n /** Translated additional fee's name. */\n name?: string;\n /** Additional fee's price. */\n price?: MultiCurrencyPrice$2;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$2;\n /** Provider's app id. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: MultiCurrencyPrice$2;\n /** Additional fee's price after tax. */\n priceAfterTax?: MultiCurrencyPrice$2;\n /**\n * Optional - Line items associated with this additional fee.\n * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.\n */\n lineItemIds?: string[];\n }\n interface Violation$1 {\n /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */\n severity?: Severity$1;\n /** Target location on a checkout or cart page where the violation will be displayed. */\n target?: Target$1;\n /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`. */\n description?: string | null;\n }\n enum Severity$1 {\n /** The user is allowed to move forward in the flow. */\n WARNING = \"WARNING\",\n /**\n * The user is blocked from moving forward in the flow.\n * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.\n */\n ERROR = \"ERROR\"\n }\n interface Target$1 extends TargetTargetTypeOneOf$1 {\n /** General (other) violation. */\n other?: Other$1;\n /** Specific line item violation. */\n lineItem?: TargetLineItem$1;\n }\n /** @oneof */\n interface TargetTargetTypeOneOf$1 {\n /** General (other) violation. */\n other?: Other$1;\n /** Specific line item violation. */\n lineItem?: TargetLineItem$1;\n }\n /** Available locations on the webpage */\n enum NameInOther$1 {\n /** default location, in case no specific location is specified */\n OTHER_DEFAULT = \"OTHER_DEFAULT\"\n }\n /** Available locations on the line item */\n enum NameInLineItem$1 {\n /** default location, in case no specific location is specified */\n LINE_ITEM_DEFAULT = \"LINE_ITEM_DEFAULT\"\n }\n /** General (other) violation. */\n interface Other$1 {\n /** Location on a checkout or a cart page where a general (other) violation will be displayed. */\n name?: NameInOther$1;\n }\n /** Specific line item violation. */\n interface TargetLineItem$1 {\n /** Location on a checkout or a cart page where the specific line item violation will be displayed. */\n name?: NameInLineItem$1;\n /** ID of the line item containing the violation. */\n _id?: string | null;\n }\n interface RemoveLineItemsFromCurrentCartRequest {\n /** IDs of the line items to remove from the cart. */\n lineItemIds: string[];\n }\n interface RemoveLineItemsResponse {\n /** Updated cart. */\n cart?: Cart;\n }\n interface CreateCheckoutFromCurrentCartRequest {\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$3;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */\n email?: string | null;\n }\n enum ChannelType$3 {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n POS = \"POS\",\n EBAY = \"EBAY\",\n AMAZON = \"AMAZON\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\",\n WIX_INVOICES = \"WIX_INVOICES\",\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n WISH = \"WISH\",\n CLASS_PASS = \"CLASS_PASS\",\n GLOBAL_E = \"GLOBAL_E\",\n FACEBOOK = \"FACEBOOK\",\n ETSY = \"ETSY\",\n TIKTOK = \"TIKTOK\",\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreateCheckoutResponse {\n /** The newly created checkout's ID. */\n checkoutId?: string;\n }\n interface RemoveCouponFromCurrentCartRequest {\n }\n interface RemoveCouponResponse {\n /** Updated cart. */\n cart?: Cart;\n }\n interface UpdateCurrentCartLineItemQuantityRequest {\n /** Line item IDs and their new quantity. */\n lineItems: LineItemQuantityUpdate[];\n }\n interface LineItemQuantityUpdate {\n /** Line item ID. Required. */\n _id?: string;\n /** New quantity. Number must be 1 or higher. Required. */\n quantity?: number;\n }\n interface UpdateLineItemsQuantityResponse {\n /** Updated cart. */\n cart?: Cart;\n }\n interface EstimateCurrentCartTotalsRequest {\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$1;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n interface DeleteCurrentCartRequest {\n }\n interface DeleteCartResponse {\n }\n interface DomainEvent$8 extends DomainEventBodyOneOf$8 {\n createdEvent?: EntityCreatedEvent$8;\n updatedEvent?: EntityUpdatedEvent$8;\n deletedEvent?: EntityDeletedEvent$8;\n actionEvent?: ActionEvent$8;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$8 {\n createdEvent?: EntityCreatedEvent$8;\n updatedEvent?: EntityUpdatedEvent$8;\n deletedEvent?: EntityDeletedEvent$8;\n actionEvent?: ActionEvent$8;\n }\n interface EntityCreatedEvent$8 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n }\n interface RestoreInfo$5 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$8 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$8 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$8 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$8 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$8;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$8 extends IdentificationDataIdOneOf$8 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$8;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$8 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$8 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface CreateCartRequest {\n /** Cart info. */\n cartInfo?: Cart;\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput[];\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n }\n interface CreateCartResponse {\n /** Cart. */\n cart?: Cart;\n }\n interface GetCartRequest {\n /** ID of the cart to retrieve. */\n _id: string;\n }\n interface GetCartResponse {\n /** The requested cart. */\n cart?: Cart;\n }\n interface GetCartByCheckoutIdRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface GetCartByCheckoutIdResponse {\n /** The requested cart. */\n cart?: Cart;\n }\n interface AddToCartRequest {\n /** Cart ID. */\n _id: string;\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n }\n interface RemoveLineItemsRequest {\n /** Cart ID. */\n _id: string;\n /** IDs of the line items to remove from the cart. */\n lineItemIds: string[];\n }\n interface CreateCheckoutRequest {\n /** Cart ID. */\n _id: string;\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$3;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */\n email?: string | null;\n }\n interface RemoveCouponRequest {\n /** Cart ID. */\n _id: string;\n }\n interface UpdateLineItemsQuantityRequest {\n /** Cart ID. */\n _id: string;\n /** Line item IDs and their new quantity. */\n lineItems: LineItemQuantityUpdate[];\n }\n interface EstimateTotalsRequest {\n /** Cart ID. */\n _id: string;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$1;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n interface DeleteCartRequest {\n /** ID of the cart to delete. */\n _id: string;\n }\n interface Empty$4 {\n }\n /**\n * Retrieves the current site visitor's cart.\n *\n *\n * The `getCurrentCart()` function returns a Promise that resolves when the current cart is retrieved.\n * @public\n * @permissionId ECOM.READ_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Current session's active cart.\n */\n function getCurrentCart(): Promise;\n /**\n * Updates the current site visitor's cart.\n *\n *\n * The `updateCurrentCart()` function returns a Promise that resolves when the current cart's properties are updated.\n *\n * > **Note:** When updating catalog items, `options.lineItems.catalogReference` is required.\n * @public\n * @requiredField options.lineItems.catalogReference\n * @param options - Current cart update options.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - The updated current cart.\n */\n function updateCurrentCart(options?: UpdateCurrentCartOptions): Promise;\n interface UpdateCurrentCartOptions {\n /** Cart info. */\n cartInfo?: Cart;\n /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */\n couponCode?: string | null;\n /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */\n merchantDiscounts?: MerchantDiscountInput[];\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n }\n /**\n * Adds catalog line items to the current site visitor's cart.\n *\n *\n * The `addToCurrentCart()` function returns a Promise that resolves to the updated current cart when the specified items have been added.\n *\n * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.\n * @public\n * @requiredField options.lineItems.catalogReference\n * @requiredField options.lineItems.quantity\n * @requiredField options.lineItems.selectedMembership._id\n * @requiredField options.lineItems.selectedMembership.appId\n * @param options - Items to be added to the current cart.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function addToCurrentCart(options?: AddToCurrentCartOptions): Promise;\n interface AddToCurrentCartOptions {\n /** Catalog line items. */\n lineItems?: LineItem$4[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * To access and manage custom line items, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customLineItems?: CustomLineItem$1[];\n }\n /**\n * Removes line items from the current site visitor's cart.\n *\n *\n * The `removeLineItemsFromCurrentCart()` function returns a Promise that resolves to the updated current cart when the line items are removed.\n * @public\n * @requiredField lineItemIds\n * @param lineItemIds - IDs of the line items to remove from the cart.\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function removeLineItemsFromCurrentCart(lineItemIds: string[]): Promise;\n /**\n * Creates a checkout from the current site visitor’s cart.\n *\n *\n * The `createCheckoutFromCurrentCart()` function returns a Promise that resolves to the new checkout's ID when it's created.\n *\n * If a checkout was already created from the current cart, that checkout will be updated with any new information from the cart.\n *\n * > **Note:** `options.channelType` is a required field.\n * @public\n * @param options - Checkout creation options.\n * @permissionId ECOM.CREATE_CHECKOUT_FROM_CART\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function createCheckoutFromCurrentCart(options?: CreateCheckoutFromCurrentCartOptions): Promise;\n interface CreateCheckoutFromCurrentCartOptions {\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$3;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */\n email?: string | null;\n }\n /**\n * Removes the coupon from the current site visitor's cart.\n *\n *\n * The `removeCouponFromCurrentCart()` function returns a Promise that resolves to the updated current cart when the coupon is removed.\n * @public\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - Updated current cart.\n */\n function removeCouponFromCurrentCart(): Promise;\n /**\n * Updates the quantity of one or more line items in the current site visitor's cart.\n *\n *\n * The `updateCurrentCartLineItemQuantity()` function returns a Promise that resolves when the quantities of the current cart's line items are updated. This endpoint is only for updating the quantity of line items. To entirely remove a line item from the current cart, use [`removeLineItemsFromCurrentCart()`](#removelineitemsfromcurrentcart).\n * To add a new line item to the current cart, use [`addToCurrentCart()`](#addtocurrentcart).\n *\n * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.\n * @param lineItems - Line item IDs and their new quantity.\n * @public\n * @requiredField lineItems\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - The updated current cart.\n */\n function updateCurrentCartLineItemQuantity(lineItems: LineItemQuantityUpdate[]): Promise;\n /**\n * Estimates the current cart's price totals (including tax), based on a selected carrier service, shipping address, and billing information.\n *\n *\n * The `estimateCurrentCartTotals()` function returns a Promise that resolves when the estimated totals are generated.\n *\n * > **Note:** Not passing any `options` properties will only estimate the cart items price totals.\n * @public\n * @param options - Total estimation options.\n * @permissionId ECOM.READ_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function estimateCurrentCartTotals(options?: EstimateCurrentCartTotalsOptions): Promise;\n interface EstimateCurrentCartTotalsOptions {\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$3;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$3;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$1;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n */\n calculateTax?: boolean | null;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n */\n calculateShipping?: boolean | null;\n }\n /**\n * Deletes the current site visitor's cart.\n *\n *\n * The `deleteCurrentCart()` function returns a Promise that resolves when the current cart is deleted.\n * @public\n * @permissionId ECOM.MODIFY_CARTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - When the current cart is deleted. Rejected - Error message.\n */\n function deleteCurrentCart(): Promise;\n type ecomV1CartCurrentCart_universal_d_Cart = Cart;\n type ecomV1CartCurrentCart_universal_d_TaxableAddress = TaxableAddress;\n type ecomV1CartCurrentCart_universal_d_TaxableAddressTaxableAddressDataOneOf = TaxableAddressTaxableAddressDataOneOf;\n type ecomV1CartCurrentCart_universal_d_TaxableAddressType = TaxableAddressType;\n const ecomV1CartCurrentCart_universal_d_TaxableAddressType: typeof TaxableAddressType;\n type ecomV1CartCurrentCart_universal_d_CartDiscount = CartDiscount;\n type ecomV1CartCurrentCart_universal_d_CartDiscountDiscountSourceOneOf = CartDiscountDiscountSourceOneOf;\n type ecomV1CartCurrentCart_universal_d_SelectedShippingOption = SelectedShippingOption;\n type ecomV1CartCurrentCart_universal_d_GetCurrentCartRequest = GetCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_GetCurrentCartResponse = GetCurrentCartResponse;\n type ecomV1CartCurrentCart_universal_d_UpdateCartRequest = UpdateCartRequest;\n type ecomV1CartCurrentCart_universal_d_MerchantDiscountInput = MerchantDiscountInput;\n type ecomV1CartCurrentCart_universal_d_UpdateCartResponse = UpdateCartResponse;\n type ecomV1CartCurrentCart_universal_d_AddToCurrentCartRequest = AddToCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_AddToCartResponse = AddToCartResponse;\n type ecomV1CartCurrentCart_universal_d_AddToCurrentCartAndEstimateTotalsRequest = AddToCurrentCartAndEstimateTotalsRequest;\n type ecomV1CartCurrentCart_universal_d_HostSelectedMembership = HostSelectedMembership;\n type ecomV1CartCurrentCart_universal_d_EstimateTotalsResponse = EstimateTotalsResponse;\n type ecomV1CartCurrentCart_universal_d_CalculatedLineItem = CalculatedLineItem;\n type ecomV1CartCurrentCart_universal_d_LineItemPricesData = LineItemPricesData;\n type ecomV1CartCurrentCart_universal_d_V1Coupon = V1Coupon;\n type ecomV1CartCurrentCart_universal_d_V1MerchantDiscount = V1MerchantDiscount;\n type ecomV1CartCurrentCart_universal_d_RemoveLineItemsFromCurrentCartRequest = RemoveLineItemsFromCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_RemoveLineItemsResponse = RemoveLineItemsResponse;\n type ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartRequest = CreateCheckoutFromCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_CreateCheckoutResponse = CreateCheckoutResponse;\n type ecomV1CartCurrentCart_universal_d_RemoveCouponFromCurrentCartRequest = RemoveCouponFromCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_RemoveCouponResponse = RemoveCouponResponse;\n type ecomV1CartCurrentCart_universal_d_UpdateCurrentCartLineItemQuantityRequest = UpdateCurrentCartLineItemQuantityRequest;\n type ecomV1CartCurrentCart_universal_d_LineItemQuantityUpdate = LineItemQuantityUpdate;\n type ecomV1CartCurrentCart_universal_d_UpdateLineItemsQuantityResponse = UpdateLineItemsQuantityResponse;\n type ecomV1CartCurrentCart_universal_d_EstimateCurrentCartTotalsRequest = EstimateCurrentCartTotalsRequest;\n type ecomV1CartCurrentCart_universal_d_DeleteCurrentCartRequest = DeleteCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_DeleteCartResponse = DeleteCartResponse;\n type ecomV1CartCurrentCart_universal_d_CreateCartRequest = CreateCartRequest;\n type ecomV1CartCurrentCart_universal_d_CreateCartResponse = CreateCartResponse;\n type ecomV1CartCurrentCart_universal_d_GetCartRequest = GetCartRequest;\n type ecomV1CartCurrentCart_universal_d_GetCartResponse = GetCartResponse;\n type ecomV1CartCurrentCart_universal_d_GetCartByCheckoutIdRequest = GetCartByCheckoutIdRequest;\n type ecomV1CartCurrentCart_universal_d_GetCartByCheckoutIdResponse = GetCartByCheckoutIdResponse;\n type ecomV1CartCurrentCart_universal_d_AddToCartRequest = AddToCartRequest;\n type ecomV1CartCurrentCart_universal_d_RemoveLineItemsRequest = RemoveLineItemsRequest;\n type ecomV1CartCurrentCart_universal_d_CreateCheckoutRequest = CreateCheckoutRequest;\n type ecomV1CartCurrentCart_universal_d_RemoveCouponRequest = RemoveCouponRequest;\n type ecomV1CartCurrentCart_universal_d_UpdateLineItemsQuantityRequest = UpdateLineItemsQuantityRequest;\n type ecomV1CartCurrentCart_universal_d_EstimateTotalsRequest = EstimateTotalsRequest;\n type ecomV1CartCurrentCart_universal_d_DeleteCartRequest = DeleteCartRequest;\n const ecomV1CartCurrentCart_universal_d_getCurrentCart: typeof getCurrentCart;\n const ecomV1CartCurrentCart_universal_d_updateCurrentCart: typeof updateCurrentCart;\n type ecomV1CartCurrentCart_universal_d_UpdateCurrentCartOptions = UpdateCurrentCartOptions;\n const ecomV1CartCurrentCart_universal_d_addToCurrentCart: typeof addToCurrentCart;\n type ecomV1CartCurrentCart_universal_d_AddToCurrentCartOptions = AddToCurrentCartOptions;\n const ecomV1CartCurrentCart_universal_d_removeLineItemsFromCurrentCart: typeof removeLineItemsFromCurrentCart;\n const ecomV1CartCurrentCart_universal_d_createCheckoutFromCurrentCart: typeof createCheckoutFromCurrentCart;\n type ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartOptions = CreateCheckoutFromCurrentCartOptions;\n const ecomV1CartCurrentCart_universal_d_removeCouponFromCurrentCart: typeof removeCouponFromCurrentCart;\n const ecomV1CartCurrentCart_universal_d_updateCurrentCartLineItemQuantity: typeof updateCurrentCartLineItemQuantity;\n const ecomV1CartCurrentCart_universal_d_estimateCurrentCartTotals: typeof estimateCurrentCartTotals;\n type ecomV1CartCurrentCart_universal_d_EstimateCurrentCartTotalsOptions = EstimateCurrentCartTotalsOptions;\n const ecomV1CartCurrentCart_universal_d_deleteCurrentCart: typeof deleteCurrentCart;\n namespace ecomV1CartCurrentCart_universal_d {\n export { ecomV1CartCurrentCart_universal_d_Cart as Cart, LineItem$4 as LineItem, CatalogReference$4 as CatalogReference, ProductName$2 as ProductName, MultiCurrencyPrice$2 as MultiCurrencyPrice, DescriptionLine$2 as DescriptionLine, DescriptionLineValueOneOf$2 as DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf$2 as DescriptionLineDescriptionLineValueOneOf, DescriptionLineName$2 as DescriptionLineName, PlainTextValue$2 as PlainTextValue, Color$2 as Color, DescriptionLineType$2 as DescriptionLineType, ItemAvailabilityInfo$1 as ItemAvailabilityInfo, ItemAvailabilityStatus$1 as ItemAvailabilityStatus, PhysicalProperties$2 as PhysicalProperties, Scope$2 as Scope, Group$1 as Group, ItemType$2 as ItemType, ItemTypeItemTypeDataOneOf$2 as ItemTypeItemTypeDataOneOf, ItemTypeItemType$2 as ItemTypeItemType, SubscriptionOptionInfo$2 as SubscriptionOptionInfo, SubscriptionSettings$3 as SubscriptionSettings, SubscriptionFrequency$3 as SubscriptionFrequency, Title$1 as Title, Description$1 as Description, SecuredMedia$1 as SecuredMedia, FileType$1 as FileType, PaymentOptionType$2 as PaymentOptionType, ServiceProperties$2 as ServiceProperties, PriceDescription$2 as PriceDescription, SelectedMembership$1 as SelectedMembership, CatalogOverrideFields$1 as CatalogOverrideFields, ecomV1CartCurrentCart_universal_d_TaxableAddress as TaxableAddress, ecomV1CartCurrentCart_universal_d_TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOf, ecomV1CartCurrentCart_universal_d_TaxableAddressType as TaxableAddressType, BuyerInfo$4 as BuyerInfo, BuyerInfoIdOneOf$2 as BuyerInfoIdOneOf, WeightUnit$3 as WeightUnit, ecomV1CartCurrentCart_universal_d_CartDiscount as CartDiscount, ecomV1CartCurrentCart_universal_d_CartDiscountDiscountSourceOneOf as CartDiscountDiscountSourceOneOf, Coupon$2 as Coupon, MerchantDiscount$2 as MerchantDiscount, AddressWithContact$2 as AddressWithContact, Address$3 as Address, StreetAddress$2 as StreetAddress, AddressLocation$2 as AddressLocation, FullAddressContactDetails$2 as FullAddressContactDetails, VatId$3 as VatId, VatType$3 as VatType, ecomV1CartCurrentCart_universal_d_SelectedShippingOption as SelectedShippingOption, ExtendedFields$3 as ExtendedFields, ecomV1CartCurrentCart_universal_d_GetCurrentCartRequest as GetCurrentCartRequest, ecomV1CartCurrentCart_universal_d_GetCurrentCartResponse as GetCurrentCartResponse, ecomV1CartCurrentCart_universal_d_UpdateCartRequest as UpdateCartRequest, ecomV1CartCurrentCart_universal_d_MerchantDiscountInput as MerchantDiscountInput, CustomLineItem$1 as CustomLineItem, ecomV1CartCurrentCart_universal_d_UpdateCartResponse as UpdateCartResponse, ecomV1CartCurrentCart_universal_d_AddToCurrentCartRequest as AddToCurrentCartRequest, ecomV1CartCurrentCart_universal_d_AddToCartResponse as AddToCartResponse, ecomV1CartCurrentCart_universal_d_AddToCurrentCartAndEstimateTotalsRequest as AddToCurrentCartAndEstimateTotalsRequest, SelectedMemberships$1 as SelectedMemberships, ecomV1CartCurrentCart_universal_d_HostSelectedMembership as HostSelectedMembership, ecomV1CartCurrentCart_universal_d_EstimateTotalsResponse as EstimateTotalsResponse, ecomV1CartCurrentCart_universal_d_CalculatedLineItem as CalculatedLineItem, ecomV1CartCurrentCart_universal_d_LineItemPricesData as LineItemPricesData, ItemTaxFullDetails$2 as ItemTaxFullDetails, TaxRateBreakdown$1 as TaxRateBreakdown, TaxBreakdown$1 as TaxBreakdown, JurisdictionType$2 as JurisdictionType, PriceSummary$2 as PriceSummary, GiftCard$2 as GiftCard, TaxSummary$2 as TaxSummary, TaxCalculationDetails$1 as TaxCalculationDetails, TaxCalculationDetailsCalculationDetailsOneOf$1 as TaxCalculationDetailsCalculationDetailsOneOf, RateType$1 as RateType, ManualCalculationReason$1 as ManualCalculationReason, AutoTaxFallbackCalculationDetails$1 as AutoTaxFallbackCalculationDetails, FallbackReason$1 as FallbackReason, ApplicationError$5 as ApplicationError, AggregatedTaxBreakdown$1 as AggregatedTaxBreakdown, ShippingInformation$1 as ShippingInformation, ShippingRegion$2 as ShippingRegion, SelectedCarrierServiceOption$1 as SelectedCarrierServiceOption, DeliveryLogistics$2 as DeliveryLogistics, PickupDetails$3 as PickupDetails, PickupMethod$2 as PickupMethod, DeliveryTimeSlot$2 as DeliveryTimeSlot, SelectedCarrierServiceOptionPrices$1 as SelectedCarrierServiceOptionPrices, SelectedCarrierServiceOptionOtherCharge$1 as SelectedCarrierServiceOptionOtherCharge, ChargeType$1 as ChargeType, CarrierServiceOption$1 as CarrierServiceOption, ShippingOption$1 as ShippingOption, ShippingPrice$2 as ShippingPrice, OtherCharge$1 as OtherCharge, AppliedDiscount$3 as AppliedDiscount, AppliedDiscountDiscountSourceOneOf$2 as AppliedDiscountDiscountSourceOneOf, DiscountType$3 as DiscountType, ecomV1CartCurrentCart_universal_d_V1Coupon as V1Coupon, ecomV1CartCurrentCart_universal_d_V1MerchantDiscount as V1MerchantDiscount, DiscountRule$3 as DiscountRule, DiscountRuleName$3 as DiscountRuleName, LineItemDiscount$2 as LineItemDiscount, CalculationErrors$1 as CalculationErrors, CalculationErrorsShippingCalculationErrorOneOf$1 as CalculationErrorsShippingCalculationErrorOneOf, Details$1 as Details, DetailsKindOneOf$1 as DetailsKindOneOf, ValidationError$1 as ValidationError, RuleType$1 as RuleType, FieldViolation$1 as FieldViolation, SystemError$1 as SystemError, CarrierErrors$1 as CarrierErrors, CarrierError$1 as CarrierError, MembershipOptions$1 as MembershipOptions, Membership$1 as Membership, MembershipName$3 as MembershipName, MembershipPaymentCredits$1 as MembershipPaymentCredits, InvalidMembership$1 as InvalidMembership, AdditionalFee$2 as AdditionalFee, Violation$1 as Violation, Severity$1 as Severity, Target$1 as Target, TargetTargetTypeOneOf$1 as TargetTargetTypeOneOf, NameInOther$1 as NameInOther, NameInLineItem$1 as NameInLineItem, Other$1 as Other, TargetLineItem$1 as TargetLineItem, ecomV1CartCurrentCart_universal_d_RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequest, ecomV1CartCurrentCart_universal_d_RemoveLineItemsResponse as RemoveLineItemsResponse, ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartRequest as CreateCheckoutFromCurrentCartRequest, ChannelType$3 as ChannelType, ecomV1CartCurrentCart_universal_d_CreateCheckoutResponse as CreateCheckoutResponse, ecomV1CartCurrentCart_universal_d_RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequest, ecomV1CartCurrentCart_universal_d_RemoveCouponResponse as RemoveCouponResponse, ecomV1CartCurrentCart_universal_d_UpdateCurrentCartLineItemQuantityRequest as UpdateCurrentCartLineItemQuantityRequest, ecomV1CartCurrentCart_universal_d_LineItemQuantityUpdate as LineItemQuantityUpdate, ecomV1CartCurrentCart_universal_d_UpdateLineItemsQuantityResponse as UpdateLineItemsQuantityResponse, ecomV1CartCurrentCart_universal_d_EstimateCurrentCartTotalsRequest as EstimateCurrentCartTotalsRequest, ecomV1CartCurrentCart_universal_d_DeleteCurrentCartRequest as DeleteCurrentCartRequest, ecomV1CartCurrentCart_universal_d_DeleteCartResponse as DeleteCartResponse, DomainEvent$8 as DomainEvent, DomainEventBodyOneOf$8 as DomainEventBodyOneOf, EntityCreatedEvent$8 as EntityCreatedEvent, RestoreInfo$5 as RestoreInfo, EntityUpdatedEvent$8 as EntityUpdatedEvent, EntityDeletedEvent$8 as EntityDeletedEvent, ActionEvent$8 as ActionEvent, MessageEnvelope$8 as MessageEnvelope, IdentificationData$8 as IdentificationData, IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf, WebhookIdentityType$8 as WebhookIdentityType, ecomV1CartCurrentCart_universal_d_CreateCartRequest as CreateCartRequest, ecomV1CartCurrentCart_universal_d_CreateCartResponse as CreateCartResponse, ecomV1CartCurrentCart_universal_d_GetCartRequest as GetCartRequest, ecomV1CartCurrentCart_universal_d_GetCartResponse as GetCartResponse, ecomV1CartCurrentCart_universal_d_GetCartByCheckoutIdRequest as GetCartByCheckoutIdRequest, ecomV1CartCurrentCart_universal_d_GetCartByCheckoutIdResponse as GetCartByCheckoutIdResponse, ecomV1CartCurrentCart_universal_d_AddToCartRequest as AddToCartRequest, ecomV1CartCurrentCart_universal_d_RemoveLineItemsRequest as RemoveLineItemsRequest, ecomV1CartCurrentCart_universal_d_CreateCheckoutRequest as CreateCheckoutRequest, ecomV1CartCurrentCart_universal_d_RemoveCouponRequest as RemoveCouponRequest, ecomV1CartCurrentCart_universal_d_UpdateLineItemsQuantityRequest as UpdateLineItemsQuantityRequest, ecomV1CartCurrentCart_universal_d_EstimateTotalsRequest as EstimateTotalsRequest, ecomV1CartCurrentCart_universal_d_DeleteCartRequest as DeleteCartRequest, Empty$4 as Empty, ecomV1CartCurrentCart_universal_d_getCurrentCart as getCurrentCart, ecomV1CartCurrentCart_universal_d_updateCurrentCart as updateCurrentCart, ecomV1CartCurrentCart_universal_d_UpdateCurrentCartOptions as UpdateCurrentCartOptions, ecomV1CartCurrentCart_universal_d_addToCurrentCart as addToCurrentCart, ecomV1CartCurrentCart_universal_d_AddToCurrentCartOptions as AddToCurrentCartOptions, ecomV1CartCurrentCart_universal_d_removeLineItemsFromCurrentCart as removeLineItemsFromCurrentCart, ecomV1CartCurrentCart_universal_d_createCheckoutFromCurrentCart as createCheckoutFromCurrentCart, ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartOptions as CreateCheckoutFromCurrentCartOptions, ecomV1CartCurrentCart_universal_d_removeCouponFromCurrentCart as removeCouponFromCurrentCart, ecomV1CartCurrentCart_universal_d_updateCurrentCartLineItemQuantity as updateCurrentCartLineItemQuantity, ecomV1CartCurrentCart_universal_d_estimateCurrentCartTotals as estimateCurrentCartTotals, ecomV1CartCurrentCart_universal_d_EstimateCurrentCartTotalsOptions as EstimateCurrentCartTotalsOptions, ecomV1CartCurrentCart_universal_d_deleteCurrentCart as deleteCurrentCart, };\n }\n /**\n * The back in stock settings object holds information related to the state of collecting back in stock\n * notification requests.\n */\n interface BackInStockSettings {\n /**\n * Information about collecting customer requests to receive\n * back in stock notifications.\n */\n collectionStates?: BackInStockCollectionState[];\n }\n interface BackInStockCollectionState {\n /** ID of the app to receive notification requests for. */\n appId?: string;\n /** Whether to collect requests for items from this app. */\n collectingRequests?: boolean;\n }\n interface StartCollectingRequestsRequest {\n /** ID of the app to start accepting notification requests for. */\n appId: string;\n }\n interface StartCollectingRequestsResponse {\n /** Back in stock settings info. */\n settings?: BackInStockSettings;\n }\n interface StopCollectingRequestsRequest {\n /** ID of the app to stop accepting notification requests for. */\n appId: string;\n }\n interface StopCollectingRequestsResponse {\n /** Back in stock settings info. */\n settings?: BackInStockSettings;\n }\n interface GetSettingsRequest {\n }\n interface GetSettingsResponse {\n /** Retrieved back in stock request settings. */\n settings?: BackInStockSettings;\n }\n /**\n * Sets `settings.collectionStates.collectingRequests` to `true` for given `appId`.\n *\n * When the collection state is set to `true`, collecting requests is enabled and customers may request\n * notifications for out of stock products. While collecting is enabled, customers see a \"Notify When Available\"\n * button on out-of-stock items. Customers can click the button to enter their email address, which creates the\n * notification request.\n * @param appId - ID of the app to start accepting notification requests for.\n * @public\n * @documentationMaturity preview\n * @requiredField appId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function startCollectingRequests(appId: string): Promise;\n /**\n * Sets `settings.collectionStates.collectingRequests` to `false` for given `appId`.\n *\n * When the collection state is set to `false`, collecting notification requests is disabled.\n * @param appId - ID of the app to stop accepting notification requests for.\n * @public\n * @documentationMaturity preview\n * @requiredField appId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function stopCollectingRequests(appId: string): Promise;\n /**\n * Retrieves back in stock request settings.\n * @public\n * @documentationMaturity preview\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function getSettings(): Promise;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_BackInStockSettings = BackInStockSettings;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_BackInStockCollectionState = BackInStockCollectionState;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_StartCollectingRequestsRequest = StartCollectingRequestsRequest;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_StartCollectingRequestsResponse = StartCollectingRequestsResponse;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_StopCollectingRequestsRequest = StopCollectingRequestsRequest;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_StopCollectingRequestsResponse = StopCollectingRequestsResponse;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_GetSettingsRequest = GetSettingsRequest;\n type ecomV1BackInStockSettingsBackInStockSettings_universal_d_GetSettingsResponse = GetSettingsResponse;\n const ecomV1BackInStockSettingsBackInStockSettings_universal_d_startCollectingRequests: typeof startCollectingRequests;\n const ecomV1BackInStockSettingsBackInStockSettings_universal_d_stopCollectingRequests: typeof stopCollectingRequests;\n const ecomV1BackInStockSettingsBackInStockSettings_universal_d_getSettings: typeof getSettings;\n namespace ecomV1BackInStockSettingsBackInStockSettings_universal_d {\n export { ecomV1BackInStockSettingsBackInStockSettings_universal_d_BackInStockSettings as BackInStockSettings, ecomV1BackInStockSettingsBackInStockSettings_universal_d_BackInStockCollectionState as BackInStockCollectionState, ecomV1BackInStockSettingsBackInStockSettings_universal_d_StartCollectingRequestsRequest as StartCollectingRequestsRequest, ecomV1BackInStockSettingsBackInStockSettings_universal_d_StartCollectingRequestsResponse as StartCollectingRequestsResponse, ecomV1BackInStockSettingsBackInStockSettings_universal_d_StopCollectingRequestsRequest as StopCollectingRequestsRequest, ecomV1BackInStockSettingsBackInStockSettings_universal_d_StopCollectingRequestsResponse as StopCollectingRequestsResponse, ecomV1BackInStockSettingsBackInStockSettings_universal_d_GetSettingsRequest as GetSettingsRequest, ecomV1BackInStockSettingsBackInStockSettings_universal_d_GetSettingsResponse as GetSettingsResponse, ecomV1BackInStockSettingsBackInStockSettings_universal_d_startCollectingRequests as startCollectingRequests, ecomV1BackInStockSettingsBackInStockSettings_universal_d_stopCollectingRequests as stopCollectingRequests, ecomV1BackInStockSettingsBackInStockSettings_universal_d_getSettings as getSettings, };\n }\n interface OrderWithFulfillments {\n /** Order ID. */\n orderId?: string;\n /** Fulfillments associated with the order. */\n fulfillments?: Fulfillment$1[];\n }\n /** for now, this is a sub-object of Orders, so can refer to order line items by id. */\n interface Fulfillment$1 extends FulfillmentFulfillmentInfoOneOf {\n /** Tracking info. */\n trackingInfo?: FulfillmentTrackingInfo$1;\n /** Custom fulfillment info. */\n customInfo?: CustomFulfillmentInfo;\n /**\n * Fulfillment ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @readonly\n */\n _createdDate?: Date;\n /** Line items being fulfilled. */\n lineItems?: FulfillmentLineItem$1[];\n /**\n * Fulfillment status.\n *\n * Supported values:\n * + `\"Pending\"`\n * + `\"Accepted\"`\n * + `\"Ready\"`\n * + `\"In_Delivery\"`\n * + `\"Fulfilled\"`\n */\n status?: string | null;\n /** Fulfillment handling complete. */\n completed?: boolean | null;\n }\n /** @oneof */\n interface FulfillmentFulfillmentInfoOneOf {\n /** Tracking info. */\n trackingInfo?: FulfillmentTrackingInfo$1;\n /** Custom fulfillment info. */\n customInfo?: CustomFulfillmentInfo;\n }\n interface FulfillmentLineItem$1 {\n /** Line item ID (mirrors the ID of the order line item). */\n _id?: string;\n /**\n * Line item quantity.\n * * If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment.\n * * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error is returned.\n *\n * Min: `1`\n * Max: `100000`\n */\n quantity?: number | null;\n }\n interface FulfillmentTrackingInfo$1 {\n /** Shipping/delivery tracking number. */\n trackingNumber?: string | null;\n /**\n * Shipping provider. Using one of the following shipping providers will allow for auto-filling the tracking link:\n * * `'fedex'`\n * * `'ups'`\n * * `'usps'`\n * * `'dhl'`\n * * `'canadaPost'`\n */\n shippingProvider?: string | null;\n /** Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation. */\n trackingLink?: string | null;\n }\n interface CustomFulfillmentInfo {\n /** Custom fulfillment info in key:value form. */\n fieldsData?: Record;\n }\n interface FulfillmentCreated {\n /** Order ID (auto generated upon order creation). */\n orderId?: string;\n /** ID of the newly created fulfillment. */\n fulfillmentId?: string;\n /** Fulfillment creation date and time. */\n dateCreated?: Date;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$3;\n /** Order fulfillment status. */\n fulfillmentStatus?: FulfillmentStatus$2;\n /** Fulfillment tracking information. */\n trackingInfo?: V2FulfillmentTrackingInfo;\n }\n /** Buyer Info */\n interface BuyerInfo$3 {\n /** Wix customer ID */\n _id?: string | null;\n /**\n * Deprecated (use identityType instead)\n * @readonly\n * @deprecated\n */\n type?: IdentityType$1;\n /** Customer type */\n identityType?: IdentityType$1;\n /**\n * Customer's first name\n * @readonly\n */\n firstName?: string;\n /**\n * Customer's last name\n * @readonly\n */\n lastName?: string;\n /**\n * Customer's phone number\n * @readonly\n */\n phone?: string | null;\n /**\n * Customer's email address\n * @readonly\n */\n email?: string;\n }\n enum IdentityType$1 {\n UNSPECIFIED_IDENTITY_TYPE = \"UNSPECIFIED_IDENTITY_TYPE\",\n /** Site member */\n MEMBER = \"MEMBER\",\n /** Contact */\n CONTACT = \"CONTACT\"\n }\n enum FulfillmentStatus$2 {\n /** None of the order items are fulfilled */\n NOT_FULFILLED = \"NOT_FULFILLED\",\n /**\n * All of the order items are fulfilled\n * Orders without shipping info are fulfilled automatically\n */\n FULFILLED = \"FULFILLED\",\n /** Order is canceled */\n CANCELED = \"CANCELED\",\n /** Some, but not all of the order items are fulfilled */\n PARTIALLY_FULFILLED = \"PARTIALLY_FULFILLED\"\n }\n interface V2FulfillmentTrackingInfo {\n /** Tracking number. */\n trackingNumber?: string;\n /**\n * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:\n * * `fedex`\n * * `ups`\n * * `usps`\n * * `dhl`\n * * `canadaPost`\n */\n shippingProvider?: string;\n /** Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation. */\n trackingLink?: string | null;\n }\n interface FulfillmentUpdated {\n /** Order ID (auto generated upon order creation). */\n orderId?: string;\n /** ID of the updated fulfillment. */\n fulfillmentId?: string;\n /** Fulfillment tracking information. */\n trackingInfo?: V2FulfillmentTrackingInfo;\n }\n interface FulfillmentDeleted {\n /** Order ID (auto generated upon order creation). */\n orderId?: string;\n /** ID of the deleted fulfillment. */\n fulfillmentId?: string;\n /** Order fulfillment status. */\n fulfillmentStatus?: FulfillmentStatus$2;\n }\n interface ListFulfillmentsForSingleOrderRequest {\n /** Order ID for which to retrieve fulfillments. */\n orderId: string;\n }\n interface ListFulfillmentsForSingleOrderResponse {\n /** List of fulfillments associated with the order. */\n orderWithFulfillments?: OrderWithFulfillments;\n }\n interface ListFulfillmentsForMultipleOrdersRequest {\n /** List of order IDs for which to retrieve fulfillments. */\n orderIds: string[];\n }\n interface ListFulfillmentsForMultipleOrdersResponse {\n /** List of order IDs and their associated fulfillments. */\n ordersWithFulfillments?: OrderWithFulfillments[];\n }\n interface CreateFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** Fulfillment info. */\n fulfillment: Fulfillment$1;\n }\n interface CreateFulfillmentResponse {\n /** Order ID and the orders' fulfillments. */\n orderWithFulfillments?: OrderWithFulfillments;\n /** ID of created fulfillment. */\n fulfillmentId?: string;\n }\n interface UpdateFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** Fulfillment info to update. */\n fulfillment?: Fulfillment$1;\n }\n interface UpdateFulfillmentResponse {\n /** Order ID and the orders' associated fulfillments after update. */\n orderWithFulfillments?: OrderWithFulfillments;\n }\n interface DeleteFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** ID of the fulfillment to delete. */\n fulfillmentId: string;\n }\n interface DeleteFulfillmentResponse {\n /** Order ID and the order's associated fulfillments after deletion. */\n orderWithFulfillments?: OrderWithFulfillments;\n }\n interface BulkCreateFulfillmentRequest {\n /** List of order IDs and their associated fulfillments' info. */\n ordersWithFulfillments: BulkCreateOrderWithFulfillments[];\n }\n interface BulkCreateOrderWithFulfillments {\n /** Order ID. */\n orderId?: string;\n /** Fulfillments associated with the order. */\n fulfillments?: Fulfillment$1[];\n }\n interface BulkCreateFulfillmentResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderFulfillmentsResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface BulkOrderFulfillmentsResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata$3;\n /** List of order IDs and their associated fulfillments. */\n ordersWithFulfillments?: OrderWithFulfillments;\n }\n interface ItemMetadata$3 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$4;\n }\n interface ApplicationError$4 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$3 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface DomainEvent$7 extends DomainEventBodyOneOf$7 {\n createdEvent?: EntityCreatedEvent$7;\n updatedEvent?: EntityUpdatedEvent$7;\n deletedEvent?: EntityDeletedEvent$7;\n actionEvent?: ActionEvent$7;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$7 {\n createdEvent?: EntityCreatedEvent$7;\n updatedEvent?: EntityUpdatedEvent$7;\n deletedEvent?: EntityDeletedEvent$7;\n actionEvent?: ActionEvent$7;\n }\n interface EntityCreatedEvent$7 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$7 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$7 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$7 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$7 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$7;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$7;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$7 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$7 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves fulfillments associated with a specified order.\n *\n *\n * The `listFulfillmentsForSingleOrder()` function returns a Promise that resolves when the fulfillments are retrieved.\n * @param orderId - Order ID for which to retrieve fulfillments.\n * @public\n * @requiredField orderId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n */\n function listFulfillmentsForSingleOrder(orderId: string): Promise;\n /**\n * Retrieves fulfillments associated with multiple specified orders.\n *\n *\n * The `listFulfillmentsForMultipleOrders()` function returns a Promise that resolves when the fulfillments are retrieved.\n * @param orderIds - List of order IDs for which to retrieve fulfillments.\n * @public\n * @requiredField orderIds\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n */\n function listFulfillmentsForMultipleOrders(orderIds: string[]): Promise;\n /**\n * Creates an order fulfillment.\n *\n *\n * The `createFulfillment()` function returns a Promise that resolves when the fulfillment is created.\n * @param orderId - Order ID.\n * @param fulfillment - Fulfillment info.\n * @public\n * @requiredField fulfillment\n * @requiredField fulfillment.lineItems\n * @requiredField fulfillment.lineItems._id\n * @requiredField orderId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function createFulfillment(orderId: string, fulfillment: Fulfillment$1): Promise;\n /**\n * Updates a fulfillment's properties.\n * To update a field's value, include the new value in the `fulfillment` field in the body params.\n * To remove a field's value, pass `null`.\n *\n *\n * The `updateFulfillment()` function returns a Promise that resolves when the fulfillment is updated.\n *\n * > **Note:** Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.fulfillmentId\n * @requiredField identifiers.orderId\n * @param identifiers - Order and fulfillment IDs to be updated.\n * @param options - Available options to use when updating a fulfillment.\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Order ID and the orders' associated fulfillments after update.\n */\n function updateFulfillment(identifiers: UpdateFulfillmentIdentifiers, options?: UpdateFulfillmentOptions): Promise;\n interface UpdateFulfillmentOptions {\n /** Fulfillment info. */\n fulfillment: {\n /** Tracking info. */\n trackingInfo?: FulfillmentTrackingInfo$1;\n /** Custom fulfillment info. */\n customInfo?: CustomFulfillmentInfo;\n /**\n * Fulfillment ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @readonly\n */\n _createdDate?: Date;\n /** Line items being fulfilled. */\n lineItems?: FulfillmentLineItem$1[];\n /**\n * Fulfillment status.\n *\n * Supported values:\n * + `\"Pending\"`\n * + `\"Accepted\"`\n * + `\"Ready\"`\n * + `\"In_Delivery\"`\n * + `\"Fulfilled\"`\n */\n status?: string | null;\n /** Fulfillment handling complete. */\n completed?: boolean | null;\n };\n }\n interface UpdateFulfillmentIdentifiers {\n /**\n * ID of the fulfillment to be updated.\n * @readonly\n */\n fulfillmentId?: string | null;\n /** Order ID. */\n orderId: string;\n }\n /**\n * Deletes an existing order fulfillment.\n *\n *\n * The `deleteFulfillment()` function returns a Promise that resolves when the fulfillment is deleted.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.fulfillmentId\n * @requiredField identifiers.orderId\n * @param identifiers - Order and fulfillment IDs.\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteFulfillment(identifiers: DeleteFulfillmentIdentifiers): Promise;\n interface DeleteFulfillmentIdentifiers {\n /** ID of the fulfillment to delete. */\n fulfillmentId: string;\n /** Order ID. */\n orderId: string;\n }\n /**\n * Creates multiple fulfillments for one or more orders.\n *\n *\n * The `bulkCreateFulfillments()` function returns a Promise that resolves when the fulfillments are created.\n * @param ordersWithFulfillments - List of order IDs and their associated fulfillments' info.\n * @public\n * @requiredField ordersWithFulfillments\n * @requiredField ordersWithFulfillments.fulfillments\n * @requiredField ordersWithFulfillments.fulfillments.lineItems\n * @requiredField ordersWithFulfillments.fulfillments.lineItems._id\n * @requiredField ordersWithFulfillments.orderId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateFulfillments(ordersWithFulfillments: BulkCreateOrderWithFulfillments[]): Promise;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_OrderWithFulfillments = OrderWithFulfillments;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentFulfillmentInfoOneOf = FulfillmentFulfillmentInfoOneOf;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_CustomFulfillmentInfo = CustomFulfillmentInfo;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentCreated = FulfillmentCreated;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_V2FulfillmentTrackingInfo = V2FulfillmentTrackingInfo;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentUpdated = FulfillmentUpdated;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentDeleted = FulfillmentDeleted;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForSingleOrderRequest = ListFulfillmentsForSingleOrderRequest;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForSingleOrderResponse = ListFulfillmentsForSingleOrderResponse;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForMultipleOrdersRequest = ListFulfillmentsForMultipleOrdersRequest;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForMultipleOrdersResponse = ListFulfillmentsForMultipleOrdersResponse;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_CreateFulfillmentRequest = CreateFulfillmentRequest;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_CreateFulfillmentResponse = CreateFulfillmentResponse;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentRequest = UpdateFulfillmentRequest;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentResponse = UpdateFulfillmentResponse;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_DeleteFulfillmentRequest = DeleteFulfillmentRequest;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_DeleteFulfillmentResponse = DeleteFulfillmentResponse;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_BulkCreateFulfillmentRequest = BulkCreateFulfillmentRequest;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_BulkCreateOrderWithFulfillments = BulkCreateOrderWithFulfillments;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_BulkCreateFulfillmentResponse = BulkCreateFulfillmentResponse;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_BulkOrderFulfillmentsResult = BulkOrderFulfillmentsResult;\n const ecomV1FulfillmentsOrderFulfillments_universal_d_listFulfillmentsForSingleOrder: typeof listFulfillmentsForSingleOrder;\n const ecomV1FulfillmentsOrderFulfillments_universal_d_listFulfillmentsForMultipleOrders: typeof listFulfillmentsForMultipleOrders;\n const ecomV1FulfillmentsOrderFulfillments_universal_d_createFulfillment: typeof createFulfillment;\n const ecomV1FulfillmentsOrderFulfillments_universal_d_updateFulfillment: typeof updateFulfillment;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentOptions = UpdateFulfillmentOptions;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentIdentifiers = UpdateFulfillmentIdentifiers;\n const ecomV1FulfillmentsOrderFulfillments_universal_d_deleteFulfillment: typeof deleteFulfillment;\n type ecomV1FulfillmentsOrderFulfillments_universal_d_DeleteFulfillmentIdentifiers = DeleteFulfillmentIdentifiers;\n const ecomV1FulfillmentsOrderFulfillments_universal_d_bulkCreateFulfillments: typeof bulkCreateFulfillments;\n namespace ecomV1FulfillmentsOrderFulfillments_universal_d {\n export { ecomV1FulfillmentsOrderFulfillments_universal_d_OrderWithFulfillments as OrderWithFulfillments, Fulfillment$1 as Fulfillment, ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentFulfillmentInfoOneOf as FulfillmentFulfillmentInfoOneOf, FulfillmentLineItem$1 as FulfillmentLineItem, FulfillmentTrackingInfo$1 as FulfillmentTrackingInfo, ecomV1FulfillmentsOrderFulfillments_universal_d_CustomFulfillmentInfo as CustomFulfillmentInfo, ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentCreated as FulfillmentCreated, BuyerInfo$3 as BuyerInfo, IdentityType$1 as IdentityType, FulfillmentStatus$2 as FulfillmentStatus, ecomV1FulfillmentsOrderFulfillments_universal_d_V2FulfillmentTrackingInfo as V2FulfillmentTrackingInfo, ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentUpdated as FulfillmentUpdated, ecomV1FulfillmentsOrderFulfillments_universal_d_FulfillmentDeleted as FulfillmentDeleted, ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForSingleOrderRequest as ListFulfillmentsForSingleOrderRequest, ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForSingleOrderResponse as ListFulfillmentsForSingleOrderResponse, ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForMultipleOrdersRequest as ListFulfillmentsForMultipleOrdersRequest, ecomV1FulfillmentsOrderFulfillments_universal_d_ListFulfillmentsForMultipleOrdersResponse as ListFulfillmentsForMultipleOrdersResponse, ecomV1FulfillmentsOrderFulfillments_universal_d_CreateFulfillmentRequest as CreateFulfillmentRequest, ecomV1FulfillmentsOrderFulfillments_universal_d_CreateFulfillmentResponse as CreateFulfillmentResponse, ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentRequest as UpdateFulfillmentRequest, ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentResponse as UpdateFulfillmentResponse, ecomV1FulfillmentsOrderFulfillments_universal_d_DeleteFulfillmentRequest as DeleteFulfillmentRequest, ecomV1FulfillmentsOrderFulfillments_universal_d_DeleteFulfillmentResponse as DeleteFulfillmentResponse, ecomV1FulfillmentsOrderFulfillments_universal_d_BulkCreateFulfillmentRequest as BulkCreateFulfillmentRequest, ecomV1FulfillmentsOrderFulfillments_universal_d_BulkCreateOrderWithFulfillments as BulkCreateOrderWithFulfillments, ecomV1FulfillmentsOrderFulfillments_universal_d_BulkCreateFulfillmentResponse as BulkCreateFulfillmentResponse, ecomV1FulfillmentsOrderFulfillments_universal_d_BulkOrderFulfillmentsResult as BulkOrderFulfillmentsResult, ItemMetadata$3 as ItemMetadata, ApplicationError$4 as ApplicationError, BulkActionMetadata$3 as BulkActionMetadata, DomainEvent$7 as DomainEvent, DomainEventBodyOneOf$7 as DomainEventBodyOneOf, EntityCreatedEvent$7 as EntityCreatedEvent, RestoreInfo$4 as RestoreInfo, EntityUpdatedEvent$7 as EntityUpdatedEvent, EntityDeletedEvent$7 as EntityDeletedEvent, ActionEvent$7 as ActionEvent, MessageEnvelope$7 as MessageEnvelope, IdentificationData$7 as IdentificationData, IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf, WebhookIdentityType$7 as WebhookIdentityType, ecomV1FulfillmentsOrderFulfillments_universal_d_listFulfillmentsForSingleOrder as listFulfillmentsForSingleOrder, ecomV1FulfillmentsOrderFulfillments_universal_d_listFulfillmentsForMultipleOrders as listFulfillmentsForMultipleOrders, ecomV1FulfillmentsOrderFulfillments_universal_d_createFulfillment as createFulfillment, ecomV1FulfillmentsOrderFulfillments_universal_d_updateFulfillment as updateFulfillment, ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentOptions as UpdateFulfillmentOptions, ecomV1FulfillmentsOrderFulfillments_universal_d_UpdateFulfillmentIdentifiers as UpdateFulfillmentIdentifiers, ecomV1FulfillmentsOrderFulfillments_universal_d_deleteFulfillment as deleteFulfillment, ecomV1FulfillmentsOrderFulfillments_universal_d_DeleteFulfillmentIdentifiers as DeleteFulfillmentIdentifiers, ecomV1FulfillmentsOrderFulfillments_universal_d_bulkCreateFulfillments as bulkCreateFulfillments, };\n }\n interface Recommendation {\n /** Recommended items. */\n items?: CatalogReference$3[];\n /** The algorithm used to provide the recommendation. */\n algorithm?: Algorithm;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$3 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).\n */\n options?: Record | null;\n }\n interface Algorithm {\n /** Algorithm ID defined by the app providing the algorithm. */\n _id?: string;\n /**\n * App ID of the Wix or 3rd-party app providing the algorithm.\n *\n * Wix app IDs are listed here.\n */\n appId?: string;\n }\n interface ListAvailableAlgorithmsRequest {\n }\n interface ListAvailableAlgorithmsResponse {\n /** Algorithms available for use on your Wix site or project. See the method description for more information. */\n availableAlgorithms?: AlgorithmInfo[];\n }\n interface AlgorithmInfo {\n /** How the algorithm is configured. */\n config?: AlgorithmConfig;\n /**\n * The app ID of the application providing the algorithm.\n *\n * Wix app IDs are listed here.\n */\n appId?: string;\n /**\n * App IDs of catalogs to which the algorithm can be applied.\n *\n * Wix app IDs are listed here.\n */\n catalogAppIds?: string[];\n }\n interface AlgorithmConfig {\n /** Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project. */\n _id?: string;\n /** Algorithm name. This value is not translatable. */\n name?: string;\n /** Algorithm description. This describes how the algorithm works and if it has any limitations regarding site content, number of items in the catalog, site traffic, and so on. This value is not translatable. */\n description?: string;\n /** A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default. */\n additionalInfo?: string | null;\n /**\n * Algorithms may have the following types:\n * * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.\n * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.\n */\n algorithmType?: AlgorithmType;\n }\n enum AlgorithmType {\n UNSPECIFIED = \"UNSPECIFIED\",\n RELATED_ITEMS = \"RELATED_ITEMS\",\n GLOBAL = \"GLOBAL\"\n }\n interface GetRecommendationRequest {\n /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */\n items?: CatalogReference$3[];\n /**\n * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.\n * See the method description for more information.\n *\n * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.\n */\n algorithms: Algorithm[];\n /**\n * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.\n *\n * Max: `100`\n */\n minimumRecommendedItems?: number;\n }\n interface GetRecommendationResponse {\n /** An object containing a list of items recommended by 1 of the specified algorithms. The recommendation is empty if none of the specified algorithms recommended enough items. */\n recommendation?: Recommendation;\n }\n interface ItemAppIdNotSupportedByProvider {\n /** Items with an App ID not supported by the provider. Supported App IDs can be found in the provider config in the Dev Center. */\n items?: CatalogReference$3[];\n /** Algorithms that don't support the requested items. */\n algorithms?: Algorithm[];\n }\n interface RecommendationAlgorithmNotSupported {\n /** Algorithms not supported by the provider. */\n unsupportedAlgorithms?: Algorithm[];\n }\n /**\n * Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [`getRecommendation()`](#getRecommendation) to provide item recommendations to the customer.\n *\n * Algorithms are run by the apps that provide them, and can only be used on catalogs they support. Apps may provide algorithms for use with their own catalogs and/or catalogs from other apps.\n *\n * The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.\n *\n *\n * For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:\n * 1. The algorithm’s `appId` must match the ID of an installed Wix app.\n * 2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.\n *\n * Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).\n * @public\n * @documentationMaturity preview\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function listAvailableAlgorithms(): Promise;\n /**\n * Returns a recommendation object containing a list of items to recommend to the customer.\n *\n * `getRecommendation()` determines which items to recommend based on the given recommendation algorithms.\n *\n * `getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.\n *\n * Apps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.\n * For example, Wix Stores provides algorithms that can only be used on its own catalogs.\n * To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.\n * For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).\n *\n * `getRecommendation()` operates as follows:\n * 1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.\n * 2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.\n * 3. The app runs the algorithms.\n * 4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.\n * 5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.\n * 6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.\n * @param algorithms - A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.\n * See the method description for more information.\n *\n * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.\n * @public\n * @documentationMaturity preview\n * @requiredField algorithms\n * @requiredField algorithms._id\n * @requiredField algorithms.appId\n * @requiredField options.items.appId\n * @requiredField options.items.catalogItemId\n * @param options - Get recommendation options.\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function getRecommendation(algorithms: Algorithm[], options?: GetRecommendationOptions): Promise;\n interface GetRecommendationOptions {\n /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */\n items?: CatalogReference$3[];\n /**\n * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.\n *\n * Max: `100`\n */\n minimumRecommendedItems?: number;\n }\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_Recommendation = Recommendation;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_Algorithm = Algorithm;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_ListAvailableAlgorithmsRequest = ListAvailableAlgorithmsRequest;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_ListAvailableAlgorithmsResponse = ListAvailableAlgorithmsResponse;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmInfo = AlgorithmInfo;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmConfig = AlgorithmConfig;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmType = AlgorithmType;\n const ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmType: typeof AlgorithmType;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_GetRecommendationRequest = GetRecommendationRequest;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_GetRecommendationResponse = GetRecommendationResponse;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_ItemAppIdNotSupportedByProvider = ItemAppIdNotSupportedByProvider;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_RecommendationAlgorithmNotSupported = RecommendationAlgorithmNotSupported;\n const ecomRecommendationsV1RecommendationRecommendations_universal_d_listAvailableAlgorithms: typeof listAvailableAlgorithms;\n const ecomRecommendationsV1RecommendationRecommendations_universal_d_getRecommendation: typeof getRecommendation;\n type ecomRecommendationsV1RecommendationRecommendations_universal_d_GetRecommendationOptions = GetRecommendationOptions;\n namespace ecomRecommendationsV1RecommendationRecommendations_universal_d {\n export { ecomRecommendationsV1RecommendationRecommendations_universal_d_Recommendation as Recommendation, CatalogReference$3 as CatalogReference, ecomRecommendationsV1RecommendationRecommendations_universal_d_Algorithm as Algorithm, ecomRecommendationsV1RecommendationRecommendations_universal_d_ListAvailableAlgorithmsRequest as ListAvailableAlgorithmsRequest, ecomRecommendationsV1RecommendationRecommendations_universal_d_ListAvailableAlgorithmsResponse as ListAvailableAlgorithmsResponse, ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmInfo as AlgorithmInfo, ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmConfig as AlgorithmConfig, ecomRecommendationsV1RecommendationRecommendations_universal_d_AlgorithmType as AlgorithmType, ecomRecommendationsV1RecommendationRecommendations_universal_d_GetRecommendationRequest as GetRecommendationRequest, ecomRecommendationsV1RecommendationRecommendations_universal_d_GetRecommendationResponse as GetRecommendationResponse, ecomRecommendationsV1RecommendationRecommendations_universal_d_ItemAppIdNotSupportedByProvider as ItemAppIdNotSupportedByProvider, ecomRecommendationsV1RecommendationRecommendations_universal_d_RecommendationAlgorithmNotSupported as RecommendationAlgorithmNotSupported, ecomRecommendationsV1RecommendationRecommendations_universal_d_listAvailableAlgorithms as listAvailableAlgorithms, ecomRecommendationsV1RecommendationRecommendations_universal_d_getRecommendation as getRecommendation, ecomRecommendationsV1RecommendationRecommendations_universal_d_GetRecommendationOptions as GetRecommendationOptions, };\n }\n interface CheckoutTemplate {\n /**\n * Checkout template ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Status of the checkout template.\n *\n * When `status` is `INACTIVE` checkouts will not be created with this template `_id`. Instead, the function will redirect to the domain site.\n *\n * Default: `ACTIVE`\n */\n status?: Status$1;\n /** Custom settings to apply to the checkout page created from this template. */\n customization?: CheckoutCustomization;\n /**\n * Catalog line items.\n *\n * Max: 300 items\n */\n lineItems?: V1LineItem[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * Max: 300 items\n */\n customLineItems?: CustomLineItem[];\n /**\n * Coupon code.\n *\n * Note that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\n * For additional information, see the Coupons API.\n */\n couponCode?: string | null;\n /**\n * Reference IDs for the app and component providing custom checkout page content.\n *\n * To access and manage custom checkout page content, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customContentReference?: CustomContentReference;\n }\n enum Status$1 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n interface CheckoutCustomization {\n /** Web client customizations. These customizations only apply to the standard Wix checkout page. */\n webClient?: WebClientCustomization;\n /**\n * Whether to lock the ability to add or remove a gift card.\n *\n * Default: `false`\n */\n lockedGiftCard?: boolean;\n /**\n * Whether to lock the ability to apply or remove a coupon code.\n *\n * Default: `false`\n */\n lockedCoupon?: boolean;\n /**\n * Whether to disable manual payment option for this checkout.\n *\n * Default: `false`\n */\n disabledManualPayment?: boolean;\n }\n interface WebClientCustomization {\n /**\n * Whether to disable the \"Continue shopping\" button.\n *\n * Default: `false`\n */\n disabledContinueShoppingButton?: boolean;\n /**\n * Whether to disable policy agreement checkout in the checkout page\n *\n * Default: `false`\n */\n disabledPolicyAgreementCheckbox?: boolean;\n }\n interface V1LineItem {\n /**\n * Item quantity.\n *\n * Min: `1`
\n * Max: `100000`\n */\n quantity?: number;\n /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$2;\n /** Overriding values for catalog item properties. */\n catalogOverrideFields?: CatalogOverrideFields;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$2 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).\n */\n options?: Record | null;\n }\n interface CatalogOverrideFields {\n /** Item name. */\n productName?: ProductName$1;\n /** Item price **after** discounts. */\n price?: string | null;\n /** Item price **before** discounts. */\n fullPrice?: string | null;\n /** Item description lines. Used when displaying the line item to customers. */\n descriptionLines?: DescriptionLine$1[];\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$1;\n /** Item image. */\n image?: string;\n }\n interface ProductName$1 {\n /**\n * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n *\n * Min: 1 character.\n * Max: 200 characters.\n */\n original?: string;\n /**\n * Item name translated into the buyer's language.\n *\n * Min: 1 character.\n * Max: 400 characters.\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface DescriptionLine$1 extends DescriptionLineValueOneOf$1, DescriptionLineDescriptionLineValueOneOf$1 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$1;\n /** Description line color value. */\n colorInfo?: Color$1;\n /** Description line name. */\n name?: DescriptionLineName$1;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf$1 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$1;\n /** Description line color value. */\n colorInfo?: Color$1;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf$1 {\n }\n interface DescriptionLineName$1 {\n /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface PlainTextValue$1 {\n /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line plain text value translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Color$1 {\n /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line color name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n /** HEX or RGB color code for display. */\n code?: string | null;\n }\n enum DescriptionLineType$1 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n COLOR = \"COLOR\"\n }\n interface PhysicalProperties$1 {\n /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface CustomLineItem {\n /**\n * Custom line item quantity.\n *\n * Min: `1`\n * Max: `100000`\n */\n quantity?: number;\n /**\n * Custom line item price.\n *\n * Must be a number or a decimal without symbols.\n */\n price?: string;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription$1;\n /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine$1[];\n /** Custom line item's media. */\n media?: string;\n /**\n * Custom line item ID. If passed, `id` must be unique.\n *\n * Default: auto-generated ID\n */\n _id?: string | null;\n /** Tax group ID for this custom line item. */\n taxGroupId?: string | null;\n /** Name of the item or product. */\n productName?: ProductName$1;\n /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */\n url?: string;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$1;\n /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: string | null;\n /**\n * Item quantity available for purchase. Only return this if inventory is managed.\n * Not returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart.\n */\n quantityAvailable?: number | null;\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$1;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n *\n * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType$1;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * Used, among other things, when checking for valid memberships.\n */\n serviceProperties?: ServiceProperties$1;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n *\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field is the same as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n */\n rootCatalogItemId?: string | null;\n /**\n * Partial payment for the given item to be paid upfront during the checkout.\n *\n * Eligible for catalog items with type `DEPOSIT_ONLINE`.\n * When omitted, the item's price will not be split and is expected to be paid in a single installment.\n */\n depositAmount?: string | null;\n /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$2;\n }\n interface PriceDescription$1 {\n /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Price description translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface ItemType$1 extends ItemTypeItemTypeDataOneOf$1 {\n /** Preset item type. */\n preset?: ItemTypeItemType$1;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n /** @oneof */\n interface ItemTypeItemTypeDataOneOf$1 {\n /** Preset item type. */\n preset?: ItemTypeItemType$1;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$1 {\n UNRECOGNISED = \"UNRECOGNISED\",\n PHYSICAL = \"PHYSICAL\",\n DIGITAL = \"DIGITAL\",\n GIFT_CARD = \"GIFT_CARD\",\n SERVICE = \"SERVICE\"\n }\n interface SubscriptionOptionInfo$1 {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings$2;\n /** Subscription option title. */\n title?: Title;\n /** Subscription option description. */\n description?: Description;\n }\n interface SubscriptionSettings$2 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$2;\n /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n */\n interval?: number | null;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$2 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface Title {\n /** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Subscription option name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Description {\n /** Subscription option description. */\n original?: string;\n /** Translated subscription option description. */\n translated?: string | null;\n }\n interface SecuredMedia {\n /** Media ID in Wix Media Manager. */\n _id?: string;\n /** Original filename. */\n fileName?: string;\n /** File type. */\n fileType?: FileType;\n }\n enum FileType {\n UNSPECIFIED = \"UNSPECIFIED\",\n SECURE_PICTURE = \"SECURE_PICTURE\",\n SECURE_VIDEO = \"SECURE_VIDEO\",\n SECURE_DOCUMENT = \"SECURE_DOCUMENT\",\n SECURE_MUSIC = \"SECURE_MUSIC\",\n SECURE_ARCHIVE = \"SECURE_ARCHIVE\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType$1 {\n /** The entire payment for this item happens as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\",\n /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface ServiceProperties$1 {\n /**\n * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * For example, the start time of a class.\n */\n scheduledDate?: Date;\n /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface ExtendedFields$2 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface CustomContentReference {\n /**\n * ID of the app providing the content.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n */\n appId?: string;\n /**\n * ID of the component within the app it belongs to.\n *\n * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n */\n componentId?: string;\n }\n interface ExternalReference {\n /**\n * ID of the app associated with the purchase flow.\n * For example, the Wix Pay Links app ID.\n */\n appId?: string;\n /**\n * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\n * For example, a Wix Pay Link ID.\n */\n resourceId?: string | null;\n }\n interface CreateCheckoutTemplateRequest {\n /** Checkout template to create. */\n checkoutTemplate: CheckoutTemplate;\n }\n interface CreateCheckoutTemplateResponse {\n /** Created checkout template. */\n checkoutTemplate?: CheckoutTemplate;\n }\n interface GetCheckoutTemplateRequest {\n /** ID of the checkout template to retrieve. */\n checkoutTemplateId: string;\n }\n interface GetCheckoutTemplateResponse {\n /** Retrieved checkout template. */\n checkoutTemplate?: CheckoutTemplate;\n }\n interface UpdateCheckoutTemplateRequest {\n /** Checkout template info to update. */\n checkoutTemplate: CheckoutTemplate;\n }\n interface UpdateCheckoutTemplateResponse {\n /** Updated checkout template. */\n checkoutTemplate?: CheckoutTemplate;\n }\n interface DeleteCheckoutTemplateRequest {\n /** ID of the checkout template to delete. */\n checkoutTemplateId: string;\n }\n interface DeleteCheckoutTemplateResponse {\n }\n interface QueryCheckoutTemplatesRequest {\n /** Query options. */\n query?: CursorQuery;\n }\n interface CursorQuery extends CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * Example of operators: `$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$2[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results. \n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryCheckoutTemplatesResponse {\n /** Retrieved checkout templates. */\n checkoutTemplates?: CheckoutTemplate[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$1;\n }\n interface CursorPagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$2;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$2 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface CreateCheckoutFromTemplateRequest {\n /** ID of the checkout template to use to create a checkout from. */\n checkoutTemplateId: string;\n /** ID of the site associated with the checkout template. */\n siteId: string;\n }\n interface CreateCheckoutFromTemplateResponse {\n /** ID of the created checkout. */\n checkoutId?: string;\n /** URL of the created checkout page. */\n checkoutUrl?: string;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n /** Triggered when newly checkout created successfully from checkout template */\n interface CheckoutTemplateUsed {\n /** checkout template */\n checkoutTemplate?: CheckoutTemplate;\n /** newly created checkout */\n checkout?: Checkout;\n }\n interface Checkout {\n /**\n * Checkout ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Line items.\n *\n * Max: 300 items\n * @readonly\n */\n lineItems?: LineItem$3[];\n /** Billing information. */\n billingInfo?: AddressWithContact$1;\n /** Shipping information. */\n shippingInfo?: ShippingInfo$1;\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$2;\n /**\n * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * @readonly\n */\n conversionCurrency?: string;\n /**\n * Calculated price summary for the checkout.\n * @readonly\n */\n priceSummary?: PriceSummary$1;\n /**\n * Errors when calculating totals.\n * @readonly\n */\n calculationErrors?: CalculationErrors;\n /**\n * Applied gift card details.\n *\n * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).\n * @readonly\n */\n giftCard?: GiftCard$1;\n /**\n * Applied discounts.\n * @readonly\n */\n appliedDiscounts?: AppliedDiscount$2[];\n /** Custom fields. */\n customFields?: CustomField$2[];\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$2;\n /**\n * Tax summary.\n * @readonly\n */\n taxSummary?: TaxSummary$1;\n /**\n * The currency used when submitting the order.\n * @readonly\n */\n currency?: string;\n /**\n * Sales channel that submitted the order.\n * + `\"UNSPECIFIED\"`: Unspecified sales channel. This value is not supported.\n * + `\"WEB\"`: A web client.\n * + `\"POS\"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)\n * + `\"EBAY\"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)\n * + `\"AMAZON\"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)\n * + `\"WISH\"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)\n * + `\"WIX_INVOICES\"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)\n * + `\"WIX_APP_STORE\"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)\n * + `\"BACKOFFICE_MERCHANT\"`: Wix merchant backoffice\n * + `\"OTHER_PLATFORM\"`: Other sales platform.\n * @readonly\n */\n channelType?: ChannelType$2;\n /**\n * Site language in which original values are shown.\n * @readonly\n */\n siteLanguage?: string;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n * @readonly\n */\n buyerLanguage?: string;\n /**\n * Whether an order was successfully created from this checkout.\n * For an order to be successful, it must be successfully paid for (unless the total is 0).\n * @readonly\n */\n completed?: boolean;\n /**\n * Whether tax is included in line item prices.\n * @readonly\n */\n taxIncludedInPrice?: boolean;\n /**\n * ID of the checkout's initiator.\n * @readonly\n */\n createdBy?: CreatedBy$1;\n /**\n * Date and time the checkout was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the checkout was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Minimal amount to pay in order to place the order.\n * @readonly\n */\n payNow?: PriceSummary$1;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$1;\n /** Memberships to apply when creating the order. */\n membershipOptions?: MembershipOptions;\n /** Additional Fees. */\n additionalFees?: AdditionalFee$1[];\n /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */\n cartId?: string | null;\n /**\n * List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).\n * @readonly\n */\n violations?: Violation[];\n /**\n * Custom field data for the checkout object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$2;\n /**\n * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.\n * @readonly\n */\n purchaseFlowId?: string | null;\n /**\n * Additional settings for customization of the checkout process.\n *\n * > **Notes:**\n * > * Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).\n * > * To access and manage custom checkout page content, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customSettings?: CustomSettings;\n /**\n * Reference IDs for the app and component providing custom checkout page content.\n *\n * To access and manage custom checkout page content, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customContentReference?: CustomContentReference;\n }\n interface LineItem$3 {\n /**\n * Line item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Item quantity.\n *\n * Min: `\"1\"`\n * Max: `\"100000\"`\n */\n quantity?: number;\n /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$2;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n * @readonly\n */\n productName?: ProductName$1;\n /**\n * URL to the item's page on the site.\n * @readonly\n */\n url?: string;\n /**\n * Item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n price?: MultiCurrencyPrice$1;\n /**\n * Total line item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n lineItemPrice?: MultiCurrencyPrice$1;\n /**\n * Item price **before** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n fullPrice?: MultiCurrencyPrice$1;\n /**\n * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: MultiCurrencyPrice$1;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: MultiCurrencyPrice$1;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: MultiCurrencyPrice$1;\n /**\n * Tax details for this line item.\n * @readonly\n */\n taxDetails?: ItemTaxFullDetails$1;\n /**\n * Discount for this line item's entire quantity.\n * @readonly\n */\n discount?: MultiCurrencyPrice$1;\n /**\n * Line item description lines. Used for display purposes for the cart, checkout and order.\n * @readonly\n */\n descriptionLines?: DescriptionLine$1[];\n /**\n * Line item image details.\n * @readonly\n */\n media?: string;\n /**\n * Item availability details.\n * @readonly\n */\n availability?: ItemAvailabilityInfo;\n /**\n * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.\n * @readonly\n */\n physicalProperties?: PhysicalProperties$1;\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$1;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.\n * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.\n * + `MEMBERSHIP_OFFLINE`: Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is `0`.\n * @readonly\n */\n paymentOption?: PaymentOptionType$1;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * @readonly\n */\n serviceProperties?: ServiceProperties$1;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field has the same value as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\".\n * @readonly\n */\n priceDescription?: PriceDescription$1;\n /**\n * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.\n * @readonly\n */\n depositAmount?: MultiCurrencyPrice$1;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @readonly\n */\n customLineItem?: boolean;\n /**\n * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.\n * @readonly\n */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Overriding values for catalog item properties.\n *\n * To override catalog fields, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n catalogOverrideFields?: CatalogOverrideFields;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n }\n interface MultiCurrencyPrice$1 {\n /** Amount. */\n amount?: string;\n /**\n * Converted amount.\n * @readonly\n */\n convertedAmount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n /**\n * Converted amount formatted with currency symbol.\n * @readonly\n */\n formattedConvertedAmount?: string;\n }\n interface ItemTaxFullDetails$1 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$1;\n /** Tax rate %, as a decimal point between 0 and 1. */\n taxRate?: string;\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n totalTax?: MultiCurrencyPrice$1;\n /**\n * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.\n * @readonly\n * @deprecated\n */\n rateBreakdown?: TaxRateBreakdown[];\n }\n interface TaxRateBreakdown {\n /** Name of tax against which the calculation was performed. */\n name?: string;\n /** Rate at which this tax detail was calculated. */\n rate?: string;\n /** Amount of tax for this tax detail. */\n tax?: MultiCurrencyPrice$1;\n }\n /**\n * TaxBreakdown represents tax information for a line item.\n * It holds the tax amount and the tax rate for each tax authority that apply on the line item.\n */\n interface TaxBreakdown {\n /** The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\". */\n jurisdiction?: string | null;\n /** The amount of this line item price that was considered nontaxable. (Decimal value) */\n nonTaxableAmount?: MultiCurrencyPrice$1;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */\n rate?: string | null;\n /** The amount of tax estimated for this line item. (Decimal value) */\n taxAmount?: MultiCurrencyPrice$1;\n /** The taxable amount of this line item. */\n taxableAmount?: MultiCurrencyPrice$1;\n /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc. */\n taxType?: string | null;\n /**\n * The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\n * This name should be explicit enough to allow the merchant to understand what tax was calculated.\n */\n taxName?: string | null;\n /** The type of the jurisdiction in which this tax detail applies. */\n jurisdictionType?: JurisdictionType$1;\n }\n /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n enum JurisdictionType$1 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface ItemAvailabilityInfo {\n /**\n * Item availability status.\n * + `\"NOT_FOUND\"`: Item does not exist\n * + `\"NOT_AVAILABLE\"`: Item not in stock\n * + `\"PARTIALLY_AVAILABLE\"`: Available quantity is less than requested\n */\n status?: ItemAvailabilityStatus;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus {\n AVAILABLE = \"AVAILABLE\",\n NOT_FOUND = \"NOT_FOUND\",\n /** Not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface Scope$1 {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */\n namespace?: string;\n /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */\n group?: Group;\n }\n interface Group {\n /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n name?: string;\n /** Item ID (when the coupon scope is limited to just one item). */\n entityId?: string | null;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$1 {\n /** Address. */\n address?: Address$2;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$1;\n }\n /** Physical address */\n interface Address$2 {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. */\n streetAddress?: StreetAddress$1;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n interface StreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$1 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails$1 {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Company name. */\n company?: string | null;\n /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */\n vatId?: VatId$2;\n }\n interface VatId$2 {\n /** Customer's tax ID. */\n _id?: string;\n /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\n type?: VatType$2;\n }\n /** tax info types */\n enum VatType$2 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface ShippingInfo$1 {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact$1;\n /** Selected option out of the options allowed for the `region`. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption;\n /**\n * Shipping region. Based on the address provided.\n * @readonly\n */\n region?: ShippingRegion$1;\n /**\n * All carrier options for this shipping rule.\n * @readonly\n */\n carrierServiceOptions?: CarrierServiceOption[];\n }\n interface SelectedCarrierServiceOption {\n /** Unique identifier of selected option. For example, \"usps_std_overnight\". */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n * @readonly\n */\n title?: string;\n /**\n * Delivery logistics.\n * @readonly\n */\n logistics?: DeliveryLogistics$1;\n /**\n * Shipping costs.\n * @readonly\n */\n cost?: SelectedCarrierServiceOptionPrices;\n /**\n * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)\n * @readonly\n */\n requestedShippingOption?: boolean;\n /** Other charges */\n otherCharges?: SelectedCarrierServiceOptionOtherCharge[];\n /** This carrier's unique ID */\n carrierId?: string | null;\n }\n interface DeliveryLogistics$1 {\n /** Expected delivery time, in free text. For example, \"3-5 business days\". */\n deliveryTime?: string | null;\n /** Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\". */\n instructions?: string | null;\n /** Pickup details. */\n pickupDetails?: PickupDetails$2;\n }\n interface PickupDetails$2 {\n /** Pickup address. */\n address?: Address$2;\n /**\n * Whether the pickup address is that of a business - this may effect tax calculation.\n * @deprecated\n */\n businessLocation?: boolean;\n /** Pickup method */\n pickupMethod?: PickupMethod$1;\n }\n enum PickupMethod$1 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$1 {\n /** starting time of the delivery time slot */\n from?: Date;\n /** ending time of the delivery time slot */\n to?: Date;\n }\n interface SelectedCarrierServiceOptionPrices {\n /** Total shipping price, after discount and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$1;\n /** Total price of shipping after discounts (when relevant), and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$1;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$1;\n /** Shipping discount before tax. */\n totalDiscount?: MultiCurrencyPrice$1;\n /** Shipping price before discount and before tax. */\n price?: MultiCurrencyPrice$1;\n }\n interface SelectedCarrierServiceOptionOtherCharge {\n /** Type of additional cost. */\n type?: ChargeType;\n /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */\n details?: string | null;\n /** Price of added charge. */\n cost?: SelectedCarrierServiceOptionPrices;\n }\n enum ChargeType {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface ShippingRegion$1 {\n /**\n * Shipping region ID.\n * @readonly\n */\n _id?: string;\n /** Shipping region name. */\n name?: string;\n }\n interface CarrierServiceOption {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption[];\n }\n interface ShippingOption {\n /**\n * Unique code of provided shipping option like \"usps_std_overnight\".\n * For legacy calculators this would be the UUID of the option.\n */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics$1;\n /** Sipping price information. */\n cost?: ShippingPrice$1;\n }\n interface ShippingPrice$1 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$1;\n /** Other costs such as insurance, handling & packaging for fragile items, etc. */\n otherCharges?: OtherCharge[];\n }\n interface OtherCharge {\n /** Type of additional cost. */\n type?: ChargeType;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$1;\n }\n interface BuyerInfo$2 extends BuyerInfoIdOneOf$1 {\n /**\n * Visitor ID (if site visitor is **not** a member).\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID (if site visitor is a site member).\n * @readonly\n */\n memberId?: string;\n /**\n * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).\n * @readonly\n */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf$1 {\n /**\n * Visitor ID (if site visitor is **not** a member).\n * @readonly\n */\n visitorId?: string;\n /**\n * Member ID (if site visitor is a site member).\n * @readonly\n */\n memberId?: string;\n }\n interface PriceSummary$1 {\n /** Subtotal of all line items, before discounts and before tax. */\n subtotal?: MultiCurrencyPrice$1;\n /** Total shipping price, before discounts and before tax. */\n shipping?: MultiCurrencyPrice$1;\n /** Total tax. */\n tax?: MultiCurrencyPrice$1;\n /** Total calculated discount value. */\n discount?: MultiCurrencyPrice$1;\n /** Total price after discounts, gift cards, and tax. */\n total?: MultiCurrencyPrice$1;\n /** Total additional fees price before tax. */\n additionalFees?: MultiCurrencyPrice$1;\n }\n interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors;\n /** Tax calculation error. */\n taxCalculationError?: Details;\n /** Coupon calculation error. */\n couponCalculationError?: Details;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$3[];\n /**\n * Membership payment methods calculation errors\n * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid\n */\n membershipError?: Details;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors;\n }\n interface Details extends DetailsKindOneOf {\n applicationError?: ApplicationError$3;\n validationError?: ValidationError;\n systemError?: SystemError;\n /**\n * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response\n * @deprecated\n */\n tracing?: Record;\n }\n /** @oneof */\n interface DetailsKindOneOf {\n applicationError?: ApplicationError$3;\n validationError?: ValidationError;\n systemError?: SystemError;\n }\n interface ApplicationError$3 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n /**\n * example result:\n * {\n * \"fieldViolations\": [\n * {\n * \"field\": \"fieldA\",\n * \"description\": \"invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]\",\n * \"violatedRule\": \"OTHER\",\n * \"ruleName\": \"INVALID_NOTE\",\n * \"data\": {\n * \"value\": \"FI\"\n * }\n * },\n * {\n * \"field\": \"fieldB\",\n * \"description\": \"field value out of range. supported range: [0-20]\",\n * \"violatedRule\": \"MAX\",\n * \"data\": {\n * \"threshold\": 20\n * }\n * },\n * {\n * \"field\": \"fieldC\",\n * \"description\": \"invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]\",\n * \"violatedRule\": \"FORMAT\",\n * \"data\": {\n * \"type\": \"PHONE\"\n * }\n * }\n * ]\n * }\n */\n interface ValidationError {\n fieldViolations?: FieldViolation[];\n }\n enum RuleType {\n VALIDATION = \"VALIDATION\",\n OTHER = \"OTHER\",\n MAX = \"MAX\",\n MIN = \"MIN\",\n MAX_LENGTH = \"MAX_LENGTH\",\n MIN_LENGTH = \"MIN_LENGTH\",\n MAX_SIZE = \"MAX_SIZE\",\n MIN_SIZE = \"MIN_SIZE\",\n FORMAT = \"FORMAT\",\n DECIMAL_LTE = \"DECIMAL_LTE\",\n DECIMAL_GTE = \"DECIMAL_GTE\",\n DECIMAL_LT = \"DECIMAL_LT\",\n DECIMAL_GT = \"DECIMAL_GT\",\n DECIMAL_MAX_SCALE = \"DECIMAL_MAX_SCALE\",\n INVALID_ENUM_VALUE = \"INVALID_ENUM_VALUE\",\n REQUIRED_FIELD = \"REQUIRED_FIELD\",\n FIELD_NOT_ALLOWED = \"FIELD_NOT_ALLOWED\",\n ONE_OF_ALIGNMENT = \"ONE_OF_ALIGNMENT\"\n }\n interface FieldViolation {\n field?: string;\n description?: string;\n violatedRule?: RuleType;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors {\n /** Carrier errors. */\n errors?: CarrierError[];\n }\n interface CarrierError {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details;\n }\n interface GiftCard$1 {\n /**\n * Gift Card ID.\n * @deprecated\n */\n _id?: string;\n /** Gift card obfuscated code. */\n obfuscatedCode?: string;\n /** Gift card value. */\n amount?: MultiCurrencyPrice$1;\n /** App ID of the gift card provider. */\n appId?: string;\n }\n interface AppliedDiscount$2 extends AppliedDiscountDiscountSourceOneOf$1 {\n /** Coupon details. */\n coupon?: Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$1;\n /** Discount rule */\n discountRule?: DiscountRule$2;\n /** Discount type. */\n discountType?: DiscountType$2;\n /**\n * IDs of line items the discount applies to.\n * @deprecated IDs of line items the discount applies to.\n * @replacedBy line_items_discounts\n * @targetRemovalDate 2024-06-01\n */\n lineItemIds?: string[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$1 {\n /** Coupon details. */\n coupon?: Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$1;\n /** Discount rule */\n discountRule?: DiscountRule$2;\n }\n enum DiscountType$2 {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface Coupon$1 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon value. */\n amount?: MultiCurrencyPrice$1;\n /** Coupon name. */\n name?: string;\n }\n interface MerchantDiscount$1 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$1;\n /** Discount Percentage. Will be calculated from items price before other discounts. */\n percentage?: number | null;\n }\n interface DiscountRule$2 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$2;\n /** Discount value. */\n amount?: MultiCurrencyPrice$1;\n }\n interface DiscountRuleName$2 {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface LineItemDiscount$1 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$1;\n }\n interface CustomField$2 {\n /** Custom field value. */\n value?: any;\n /** Custom field title. */\n title?: string;\n /** Translated custom field title. */\n translatedTitle?: string | null;\n }\n enum WeightUnit$2 {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface TaxSummary$1 {\n /**\n * Amount for which tax is calculated, added from line items.\n * @readonly\n */\n taxableAmount?: MultiCurrencyPrice$1;\n /**\n * Calculated tax, added from line items.\n * @readonly\n */\n totalTax?: MultiCurrencyPrice$1;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails;\n }\n interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;\n /** Rate calculation type. */\n rateType?: RateType;\n }\n /** @oneof */\n interface TaxCalculationDetailsCalculationDetailsOneOf {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;\n }\n enum RateType {\n /** no tax being collected for this request due to location of purchase */\n NO_TAX_COLLECTED = \"NO_TAX_COLLECTED\",\n /** manual rate used for calculation */\n MANUAL_RATE = \"MANUAL_RATE\",\n /** autotax rate used for calculation */\n AUTO_RATE = \"AUTO_RATE\",\n /** fallback rate used for calculation */\n FALLBACK_RATE = \"FALLBACK_RATE\"\n }\n enum ManualCalculationReason {\n /** user set calculator in Business Manager to be Manual */\n GLOBAL_SETTING_TO_MANUAL = \"GLOBAL_SETTING_TO_MANUAL\",\n /** specific region is on manual even though Global setting is Auto-tax */\n REGION_SETTING_TO_MANUAL = \"REGION_SETTING_TO_MANUAL\"\n }\n interface AutoTaxFallbackCalculationDetails {\n /** reason for fallback */\n fallbackReason?: FallbackReason;\n /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */\n error?: ApplicationError$3;\n }\n enum FallbackReason {\n /** auto-tax failed to be calculated */\n AUTO_TAX_FAILED = \"AUTO_TAX_FAILED\",\n /** auto-tax was temporarily deactivated on a system-level */\n AUTO_TAX_DEACTIVATED = \"AUTO_TAX_DEACTIVATED\"\n }\n /**\n * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.\n * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.\n */\n interface AggregatedTaxBreakdown {\n /** The name of the tax against which this tax amount was calculated. */\n taxName?: string;\n /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */\n taxType?: string;\n /** The name of the jurisdiction in which this tax detail applies. */\n jurisdiction?: string;\n /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n jurisdictionTypeEnum?: JurisdictionType$1;\n /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */\n rate?: string;\n /** The sum of all the tax from line items that calculated by the tax identifiers. */\n aggregatedTaxAmount?: MultiCurrencyPrice$1;\n }\n enum ChannelType$2 {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n POS = \"POS\",\n EBAY = \"EBAY\",\n AMAZON = \"AMAZON\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\",\n WIX_INVOICES = \"WIX_INVOICES\",\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n WISH = \"WISH\",\n CLASS_PASS = \"CLASS_PASS\",\n GLOBAL_E = \"GLOBAL_E\",\n FACEBOOK = \"FACEBOOK\",\n ETSY = \"ETSY\",\n TIKTOK = \"TIKTOK\",\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreatedBy$1 extends CreatedByIdOneOf {\n /**\n * User ID - when the order was created by a Wix user on behalf of a buyer.\n * For example, via POS (point of service).\n */\n userId?: string;\n /** Member ID - when the order was created by a **logged in** site visitor. */\n memberId?: string;\n /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */\n visitorId?: string;\n /** App ID - when the order was created by an external application or Wix service. */\n appId?: string;\n }\n /** @oneof */\n interface CreatedByIdOneOf {\n /**\n * User ID - when the order was created by a Wix user on behalf of a buyer.\n * For example, via POS (point of service).\n */\n userId?: string;\n /** Member ID - when the order was created by a **logged in** site visitor. */\n memberId?: string;\n /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */\n visitorId?: string;\n /** App ID - when the order was created by an external application or Wix service. */\n appId?: string;\n }\n /** Reserved for internal use. */\n interface MembershipOptions {\n /**\n * Reserved for internal use.\n * @readonly\n */\n eligibleMemberships?: Membership[];\n /**\n * Reserved for internal use.\n * @readonly\n */\n invalidMemberships?: InvalidMembership[];\n /** Selected membership to apply to this checkout. */\n selectedMemberships?: SelectedMemberships;\n }\n interface Membership {\n /** Membership ID. */\n _id?: string;\n /** ID of the application providing this payment option. */\n appId?: string;\n /** The name of this membership. */\n name?: MembershipName$2;\n /** Line item IDs which are \"paid\" for by this membership. */\n lineItemIds?: string[];\n /** Optional - For a membership that has limited credits, information about credit usage. */\n credits?: MembershipPaymentCredits;\n /** Optional - TMembership expiry date. */\n expirationDate?: Date;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$2 {\n /** The name of this membership */\n original?: string;\n /** Optional - Translated name of this membership. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface MembershipPaymentCredits {\n /** How much credit this membership has in total */\n total?: number;\n /** How much credit remained for this membership */\n remaining?: number;\n }\n interface InvalidMembership {\n /** Membership details. */\n membership?: Membership;\n /** Reason why this membership is invalid and cannot be used. */\n reason?: string;\n }\n interface SelectedMemberships {\n /** Selected memberships. */\n memberships?: SelectedMembership[];\n }\n interface SelectedMembership {\n /** Membership ID. */\n _id?: string;\n /** ID of the app providing this payment option. */\n appId?: string;\n /** IDs of the line items this membership applies to. */\n lineItemIds?: string[];\n }\n interface AdditionalFee$1 {\n /** Additional fee's unique code (or ID) for future processing. */\n code?: string | null;\n /** Translated additional fee's name. */\n name?: string;\n /** Additional fee's price. */\n price?: MultiCurrencyPrice$1;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$1;\n /** Provider's app id. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: MultiCurrencyPrice$1;\n /** Additional fee's price after tax. */\n priceAfterTax?: MultiCurrencyPrice$1;\n /**\n * Optional - Line items associated with this additional fee.\n * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.\n */\n lineItemIds?: string[];\n }\n interface ConversionInfo {\n /**\n * The site currency.\n * @readonly\n */\n siteCurrency?: string;\n /**\n * The rate used when converting from the site currency to the checkout currency.\n * @readonly\n */\n conversionRate?: string;\n }\n interface Violation {\n /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */\n severity?: Severity;\n /** Target location on a checkout or cart page where the violation will be displayed. */\n target?: Target;\n /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`. */\n description?: string | null;\n }\n enum Severity {\n /** The user is allowed to move forward in the flow. */\n WARNING = \"WARNING\",\n /**\n * The user is blocked from moving forward in the flow.\n * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.\n */\n ERROR = \"ERROR\"\n }\n interface Target extends TargetTargetTypeOneOf {\n /** General (other) violation. */\n other?: Other;\n /** Specific line item violation. */\n lineItem?: TargetLineItem;\n }\n /** @oneof */\n interface TargetTargetTypeOneOf {\n /** General (other) violation. */\n other?: Other;\n /** Specific line item violation. */\n lineItem?: TargetLineItem;\n }\n /** Available locations on the webpage */\n enum NameInOther {\n /** default location, in case no specific location is specified */\n OTHER_DEFAULT = \"OTHER_DEFAULT\"\n }\n /** Available locations on the line item */\n enum NameInLineItem {\n /** default location, in case no specific location is specified */\n LINE_ITEM_DEFAULT = \"LINE_ITEM_DEFAULT\"\n }\n /** General (other) violation. */\n interface Other {\n /** Location on a checkout or a cart page where a general (other) violation will be displayed. */\n name?: NameInOther;\n }\n /** Specific line item violation. */\n interface TargetLineItem {\n /** Location on a checkout or a cart page where the specific line item violation will be displayed. */\n name?: NameInLineItem;\n /** ID of the line item containing the violation. */\n _id?: string | null;\n }\n interface CustomSettings {\n /**\n * Whether to restrict the option to add or remove a gift card on the checkout page.\n *\n * Default: `false`\n */\n lockGiftCard?: boolean;\n /**\n * Whether to restrict the option to add or remove a coupon code on the checkout page.\n *\n * Default: `false`\n */\n lockCouponCode?: boolean;\n /**\n * Whether to disable policy agreement checkout in the checkout page\n *\n * Default: `false`\n */\n disabledPolicyAgreementCheckbox?: boolean;\n /**\n * Whether to disable manual payment option for this checkout.\n *\n * Default: `false`\n */\n disabledManualPayment?: boolean;\n }\n interface CreateAndRedirectToCheckoutRequest {\n /** ID of the checkout template to use to create a checkout. */\n checkoutTemplateId: string;\n /** ID of the site associated with the checkout template. */\n siteId: string;\n }\n interface RawHttpResponse {\n body?: Uint8Array;\n statusCode?: number | null;\n headers?: HeadersEntry[];\n }\n interface HeadersEntry {\n key?: string;\n value?: string;\n }\n interface DomainEvent$6 extends DomainEventBodyOneOf$6 {\n createdEvent?: EntityCreatedEvent$6;\n updatedEvent?: EntityUpdatedEvent$6;\n deletedEvent?: EntityDeletedEvent$6;\n actionEvent?: ActionEvent$6;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$6 {\n createdEvent?: EntityCreatedEvent$6;\n updatedEvent?: EntityUpdatedEvent$6;\n deletedEvent?: EntityDeletedEvent$6;\n actionEvent?: ActionEvent$6;\n }\n interface EntityCreatedEvent$6 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n }\n interface RestoreInfo$3 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$6 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$6 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$6 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$6 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$6;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$6 extends IdentificationDataIdOneOf$6 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$6;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$6 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$6 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a checkout template.\n *\n * A checkout template is used to create a new checkout that will include predefined information. For example, a single link with\n * a `checkoutTemplateId` can be shared with customers and each time the link is clicked, a new checkout page will be created\n * for that customer with certain checkout information already populated.\n *\n * The customizable features include the option to allow or to lock coupon codes or gift cards. For example, if a store owner is\n * using the checkout template to offer a flash sale to their social media followers, they may want to lock the option to apply an\n * additional coupon on top of the sale being offered. If so, they can set `customization.lockedCoupon` to `true`.\n *\n * A checkout can be created with a checkout template by calling `createCheckoutFromTemplate()`. The site may add further customizations to the new checkout and then redirect the customer using the new checkout's `checkoutUrl`.\n * @param checkoutTemplate - Checkout template to create.\n * @public\n * @documentationMaturity preview\n * @requiredField checkoutTemplate\n * @requiredField checkoutTemplate.customLineItems.descriptionLines\n * @requiredField checkoutTemplate.customLineItems.descriptionLines.name\n * @requiredField checkoutTemplate.customLineItems.itemType\n * @requiredField checkoutTemplate.customLineItems.productName\n * @requiredField checkoutTemplate.customLineItems.quantity\n * @requiredField checkoutTemplate.lineItems.catalogReference\n * @requiredField checkoutTemplate.lineItems.catalogReference.appId\n * @requiredField checkoutTemplate.lineItems.catalogReference.catalogItemId\n * @requiredField checkoutTemplate.lineItems.quantity\n * @permissionId ECOM.CHECKOUT_TEMPLATE_CREATE\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created checkout template.\n */\n function createCheckoutTemplate(checkoutTemplate: CheckoutTemplate): Promise;\n /**\n * Retrieves a checkout template.\n * @param checkoutTemplateId - ID of the checkout template to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField checkoutTemplateId\n * @permissionId ECOM.CHECKOUT_TEMPLATE_READ\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved checkout template.\n */\n function getCheckoutTemplate(checkoutTemplateId: string): Promise;\n /**\n * Updates a checkout template.\n *\n * If the info in a checkout template is updated, only new checkouts created from this template will include the updated items. Checkouts previously\n * created from this template before the update will not be affected.\n * @param _id - Checkout template ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField checkoutTemplate\n * @param checkoutTemplate - Checkout template info to update.\n * @permissionId ECOM.CHECKOUT_TEMPLATE_UPDATE\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated checkout template.\n */\n function updateCheckoutTemplate(_id: string | null, checkoutTemplate: UpdateCheckoutTemplate, options?: UpdateCheckoutTemplateOptions): Promise;\n interface UpdateCheckoutTemplate {\n /**\n * Checkout template ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Status of the checkout template.\n *\n * When `status` is `INACTIVE` checkouts will not be created with this template `_id`. Instead, the function will redirect to the domain site.\n *\n * Default: `ACTIVE`\n */\n status?: Status$1;\n /** Custom settings to apply to the checkout page created from this template. */\n customization?: CheckoutCustomization;\n /**\n * Catalog line items.\n *\n * Max: 300 items\n */\n lineItems?: V1LineItem[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * Max: 300 items\n */\n customLineItems?: CustomLineItem[];\n /**\n * Coupon code.\n *\n * Note that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\n * For additional information, see the Coupons API.\n */\n couponCode?: string | null;\n /**\n * Reference IDs for the app and component providing custom checkout page content.\n *\n * To access and manage custom checkout page content, your app must have the permission scope named \"Manage eCommerce - Admin Permissions\".\n * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).\n */\n customContentReference?: CustomContentReference;\n }\n interface UpdateCheckoutTemplateOptions {\n }\n /**\n * Deletes a checkout template.\n *\n * If a checkout template is deleted and a customer attempts to create a checkout with that `checkoutTemplateId` then\n * the customer will be redirected to the domain site.\n * @param checkoutTemplateId - ID of the checkout template to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField checkoutTemplateId\n * @permissionId ECOM.CHECKOUT_TEMPLATE_DELETE\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteCheckoutTemplate(checkoutTemplateId: string): Promise;\n /**\n * Creates a query to retrieve a list of checkout templates.\n *\n * The `queryCheckoutTemplates()` function builds a query to retrieve a list of checkout templates and returns a `CheckoutTemplatesQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `CheckoutTemplatesQueryBuilder` functions onto the query. `CheckoutTemplatesQueryBuilder` functions enable you to sort, filter, and control the results that `queryCheckoutTemplates()` returns.\n *\n * `queryCheckoutTemplates()` runs with the following `CheckoutTemplatesQueryBuilder` default that you can override:\n * + `ascending(\"_id\")`\n *\n * The functions that are chained to `queryCheckoutTemplates()` are applied in the order they are called. For example, if you apply `ascending(\"status\")` and then `ascending(\"_id\")`, the results are sorted first by the `\"status\"`, and then, if there are multiple results with the same `\"status\"`, the items are sorted by `\"_id\"`.\n *\n * The following `CheckoutTemplatesQueryBuilder` functions are supported for the `queryCheckoutTemplates()` function. For a full description of the checkout template object, see the object returned for the `items` property in `CheckoutTemplatesQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionId ECOM.CHECKOUT_TEMPLATE_READ\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryCheckoutTemplates(): CheckoutTemplatesQueryBuilder;\n interface QueryCursorResult$2 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CheckoutTemplatesQueryResult extends QueryCursorResult$2 {\n items: CheckoutTemplate[];\n query: CheckoutTemplatesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CheckoutTemplatesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"status\", value: any) => CheckoutTemplatesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"status\", value: any) => CheckoutTemplatesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\", value: string) => CheckoutTemplatesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"status\", value: any[]) => CheckoutTemplatesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"status\", value: any) => CheckoutTemplatesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"status\", value: boolean) => CheckoutTemplatesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"status\">) => CheckoutTemplatesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"status\">) => CheckoutTemplatesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => CheckoutTemplatesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => CheckoutTemplatesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Creates a new checkout based on the checkout template.\n *\n * Before using this function, you must have a checkout template available. Create a checkout template with `createCheckoutTemplate()`.\n *\n * The customer can be directed to the new checkout using the checkout's `checkoutUrl`.\n * @param checkoutTemplateId - ID of the checkout template to use to create a checkout from.\n * @param siteId - ID of the site associated with the checkout template.\n * @public\n * @documentationMaturity preview\n * @requiredField checkoutTemplateId\n * @requiredField siteId\n * @permissionId ECOM.CHECKOUT_TEMPLATE_CREATE_CHECKOUT\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function createCheckoutFromTemplate(checkoutTemplateId: string, siteId: string): Promise;\n /**\n * Creates a new checkout based on the checkout template and redirects to the new checkout page.\n *\n * Before using this function, you must have a checkout template available. Create a checkout template with `createCheckoutTemplate()`.\n *\n * To build a URL that uses this function, follow this format:\n * `https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout?siteId={siteId}`\n *\n * To create a checkout but not automatically redirect to the checkout page, use `createCheckoutFromTemplate()`.\n * @param checkoutTemplateId - ID of the checkout template to use to create a checkout.\n * @param siteId - ID of the site associated with the checkout template.\n * @public\n * @documentationMaturity preview\n * @requiredField checkoutTemplateId\n * @requiredField siteId\n * @adminMethod\n */\n function createAndRedirectToCheckout(checkoutTemplateId: string, siteId: string): Promise;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplate = CheckoutTemplate;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutCustomization = CheckoutCustomization;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_WebClientCustomization = WebClientCustomization;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_V1LineItem = V1LineItem;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CatalogOverrideFields = CatalogOverrideFields;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CustomLineItem = CustomLineItem;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Title = Title;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Description = Description;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SecuredMedia = SecuredMedia;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FileType = FileType;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FileType: typeof FileType;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CustomContentReference = CustomContentReference;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ExternalReference = ExternalReference;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutTemplateRequest = CreateCheckoutTemplateRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutTemplateResponse = CreateCheckoutTemplateResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_GetCheckoutTemplateRequest = GetCheckoutTemplateRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_GetCheckoutTemplateResponse = GetCheckoutTemplateResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplateRequest = UpdateCheckoutTemplateRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplateResponse = UpdateCheckoutTemplateResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_DeleteCheckoutTemplateRequest = DeleteCheckoutTemplateRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_DeleteCheckoutTemplateResponse = DeleteCheckoutTemplateResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_QueryCheckoutTemplatesRequest = QueryCheckoutTemplatesRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CursorQuery = CursorQuery;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_QueryCheckoutTemplatesResponse = QueryCheckoutTemplatesResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutFromTemplateRequest = CreateCheckoutFromTemplateRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutFromTemplateResponse = CreateCheckoutFromTemplateResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplateUsed = CheckoutTemplateUsed;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Checkout = Checkout;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxRateBreakdown = TaxRateBreakdown;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxBreakdown = TaxBreakdown;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ItemAvailabilityInfo = ItemAvailabilityInfo;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ItemAvailabilityStatus = ItemAvailabilityStatus;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ItemAvailabilityStatus: typeof ItemAvailabilityStatus;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Group = Group;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedCarrierServiceOption = SelectedCarrierServiceOption;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedCarrierServiceOptionPrices = SelectedCarrierServiceOptionPrices;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedCarrierServiceOptionOtherCharge = SelectedCarrierServiceOptionOtherCharge;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ChargeType = ChargeType;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ChargeType: typeof ChargeType;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CarrierServiceOption = CarrierServiceOption;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ShippingOption = ShippingOption;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_OtherCharge = OtherCharge;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CalculationErrors = CalculationErrors;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CalculationErrorsShippingCalculationErrorOneOf = CalculationErrorsShippingCalculationErrorOneOf;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Details = Details;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_DetailsKindOneOf = DetailsKindOneOf;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ValidationError = ValidationError;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RuleType = RuleType;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RuleType: typeof RuleType;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FieldViolation = FieldViolation;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SystemError = SystemError;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CarrierErrors = CarrierErrors;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CarrierError = CarrierError;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxCalculationDetails = TaxCalculationDetails;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxCalculationDetailsCalculationDetailsOneOf = TaxCalculationDetailsCalculationDetailsOneOf;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RateType = RateType;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RateType: typeof RateType;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ManualCalculationReason = ManualCalculationReason;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ManualCalculationReason: typeof ManualCalculationReason;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_AutoTaxFallbackCalculationDetails = AutoTaxFallbackCalculationDetails;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FallbackReason = FallbackReason;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FallbackReason: typeof FallbackReason;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_AggregatedTaxBreakdown = AggregatedTaxBreakdown;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreatedByIdOneOf = CreatedByIdOneOf;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_MembershipOptions = MembershipOptions;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Membership = Membership;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_MembershipPaymentCredits = MembershipPaymentCredits;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_InvalidMembership = InvalidMembership;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedMemberships = SelectedMemberships;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedMembership = SelectedMembership;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ConversionInfo = ConversionInfo;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Violation = Violation;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Severity = Severity;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Severity: typeof Severity;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Target = Target;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TargetTargetTypeOneOf = TargetTargetTypeOneOf;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_NameInOther = NameInOther;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_NameInOther: typeof NameInOther;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_NameInLineItem = NameInLineItem;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_NameInLineItem: typeof NameInLineItem;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Other = Other;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TargetLineItem = TargetLineItem;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CustomSettings = CustomSettings;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateAndRedirectToCheckoutRequest = CreateAndRedirectToCheckoutRequest;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RawHttpResponse = RawHttpResponse;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_HeadersEntry = HeadersEntry;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_createCheckoutTemplate: typeof createCheckoutTemplate;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_getCheckoutTemplate: typeof getCheckoutTemplate;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_updateCheckoutTemplate: typeof updateCheckoutTemplate;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplate = UpdateCheckoutTemplate;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplateOptions = UpdateCheckoutTemplateOptions;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_deleteCheckoutTemplate: typeof deleteCheckoutTemplate;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_queryCheckoutTemplates: typeof queryCheckoutTemplates;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplatesQueryResult = CheckoutTemplatesQueryResult;\n type ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplatesQueryBuilder = CheckoutTemplatesQueryBuilder;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_createCheckoutFromTemplate: typeof createCheckoutFromTemplate;\n const ecomV1CheckoutTemplateCheckoutTemplates_universal_d_createAndRedirectToCheckout: typeof createAndRedirectToCheckout;\n namespace ecomV1CheckoutTemplateCheckoutTemplates_universal_d {\n export { ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplate as CheckoutTemplate, Status$1 as Status, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutCustomization as CheckoutCustomization, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_WebClientCustomization as WebClientCustomization, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_V1LineItem as V1LineItem, CatalogReference$2 as CatalogReference, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CatalogOverrideFields as CatalogOverrideFields, ProductName$1 as ProductName, DescriptionLine$1 as DescriptionLine, DescriptionLineValueOneOf$1 as DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf$1 as DescriptionLineDescriptionLineValueOneOf, DescriptionLineName$1 as DescriptionLineName, PlainTextValue$1 as PlainTextValue, Color$1 as Color, DescriptionLineType$1 as DescriptionLineType, PhysicalProperties$1 as PhysicalProperties, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CustomLineItem as CustomLineItem, PriceDescription$1 as PriceDescription, ItemType$1 as ItemType, ItemTypeItemTypeDataOneOf$1 as ItemTypeItemTypeDataOneOf, ItemTypeItemType$1 as ItemTypeItemType, SubscriptionOptionInfo$1 as SubscriptionOptionInfo, SubscriptionSettings$2 as SubscriptionSettings, SubscriptionFrequency$2 as SubscriptionFrequency, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Title as Title, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Description as Description, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SecuredMedia as SecuredMedia, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FileType as FileType, PaymentOptionType$1 as PaymentOptionType, ServiceProperties$1 as ServiceProperties, ExtendedFields$2 as ExtendedFields, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CustomContentReference as CustomContentReference, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ExternalReference as ExternalReference, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutTemplateRequest as CreateCheckoutTemplateRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutTemplateResponse as CreateCheckoutTemplateResponse, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_GetCheckoutTemplateRequest as GetCheckoutTemplateRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_GetCheckoutTemplateResponse as GetCheckoutTemplateResponse, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplateRequest as UpdateCheckoutTemplateRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplateResponse as UpdateCheckoutTemplateResponse, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_DeleteCheckoutTemplateRequest as DeleteCheckoutTemplateRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_DeleteCheckoutTemplateResponse as DeleteCheckoutTemplateResponse, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_QueryCheckoutTemplatesRequest as QueryCheckoutTemplatesRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CursorQuery as CursorQuery, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, Sorting$2 as Sorting, SortOrder$2 as SortOrder, CursorPaging$2 as CursorPaging, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_QueryCheckoutTemplatesResponse as QueryCheckoutTemplatesResponse, CursorPagingMetadata$1 as CursorPagingMetadata, Cursors$2 as Cursors, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutFromTemplateRequest as CreateCheckoutFromTemplateRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateCheckoutFromTemplateResponse as CreateCheckoutFromTemplateResponse, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplateUsed as CheckoutTemplateUsed, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Checkout as Checkout, LineItem$3 as LineItem, MultiCurrencyPrice$1 as MultiCurrencyPrice, ItemTaxFullDetails$1 as ItemTaxFullDetails, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxRateBreakdown as TaxRateBreakdown, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxBreakdown as TaxBreakdown, JurisdictionType$1 as JurisdictionType, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ItemAvailabilityInfo as ItemAvailabilityInfo, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ItemAvailabilityStatus as ItemAvailabilityStatus, Scope$1 as Scope, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Group as Group, AddressWithContact$1 as AddressWithContact, Address$2 as Address, StreetAddress$1 as StreetAddress, AddressLocation$1 as AddressLocation, FullAddressContactDetails$1 as FullAddressContactDetails, VatId$2 as VatId, VatType$2 as VatType, ShippingInfo$1 as ShippingInfo, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedCarrierServiceOption as SelectedCarrierServiceOption, DeliveryLogistics$1 as DeliveryLogistics, PickupDetails$2 as PickupDetails, PickupMethod$1 as PickupMethod, DeliveryTimeSlot$1 as DeliveryTimeSlot, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPrices, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherCharge, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ChargeType as ChargeType, ShippingRegion$1 as ShippingRegion, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CarrierServiceOption as CarrierServiceOption, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ShippingOption as ShippingOption, ShippingPrice$1 as ShippingPrice, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_OtherCharge as OtherCharge, BuyerInfo$2 as BuyerInfo, BuyerInfoIdOneOf$1 as BuyerInfoIdOneOf, PriceSummary$1 as PriceSummary, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CalculationErrors as CalculationErrors, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOf, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Details as Details, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_DetailsKindOneOf as DetailsKindOneOf, ApplicationError$3 as ApplicationError, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ValidationError as ValidationError, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RuleType as RuleType, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FieldViolation as FieldViolation, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SystemError as SystemError, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CarrierErrors as CarrierErrors, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CarrierError as CarrierError, GiftCard$1 as GiftCard, AppliedDiscount$2 as AppliedDiscount, AppliedDiscountDiscountSourceOneOf$1 as AppliedDiscountDiscountSourceOneOf, DiscountType$2 as DiscountType, Coupon$1 as Coupon, MerchantDiscount$1 as MerchantDiscount, DiscountRule$2 as DiscountRule, DiscountRuleName$2 as DiscountRuleName, LineItemDiscount$1 as LineItemDiscount, CustomField$2 as CustomField, WeightUnit$2 as WeightUnit, TaxSummary$1 as TaxSummary, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxCalculationDetails as TaxCalculationDetails, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOf, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RateType as RateType, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ManualCalculationReason as ManualCalculationReason, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetails, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_FallbackReason as FallbackReason, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_AggregatedTaxBreakdown as AggregatedTaxBreakdown, ChannelType$2 as ChannelType, CreatedBy$1 as CreatedBy, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreatedByIdOneOf as CreatedByIdOneOf, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_MembershipOptions as MembershipOptions, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Membership as Membership, MembershipName$2 as MembershipName, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_MembershipPaymentCredits as MembershipPaymentCredits, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_InvalidMembership as InvalidMembership, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedMemberships as SelectedMemberships, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_SelectedMembership as SelectedMembership, AdditionalFee$1 as AdditionalFee, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_ConversionInfo as ConversionInfo, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Violation as Violation, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Severity as Severity, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Target as Target, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TargetTargetTypeOneOf as TargetTargetTypeOneOf, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_NameInOther as NameInOther, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_NameInLineItem as NameInLineItem, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_Other as Other, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_TargetLineItem as TargetLineItem, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CustomSettings as CustomSettings, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CreateAndRedirectToCheckoutRequest as CreateAndRedirectToCheckoutRequest, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_RawHttpResponse as RawHttpResponse, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_HeadersEntry as HeadersEntry, DomainEvent$6 as DomainEvent, DomainEventBodyOneOf$6 as DomainEventBodyOneOf, EntityCreatedEvent$6 as EntityCreatedEvent, RestoreInfo$3 as RestoreInfo, EntityUpdatedEvent$6 as EntityUpdatedEvent, EntityDeletedEvent$6 as EntityDeletedEvent, ActionEvent$6 as ActionEvent, MessageEnvelope$6 as MessageEnvelope, IdentificationData$6 as IdentificationData, IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf, WebhookIdentityType$6 as WebhookIdentityType, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_createCheckoutTemplate as createCheckoutTemplate, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_getCheckoutTemplate as getCheckoutTemplate, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_updateCheckoutTemplate as updateCheckoutTemplate, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplate as UpdateCheckoutTemplate, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_UpdateCheckoutTemplateOptions as UpdateCheckoutTemplateOptions, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_deleteCheckoutTemplate as deleteCheckoutTemplate, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_queryCheckoutTemplates as queryCheckoutTemplates, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplatesQueryResult as CheckoutTemplatesQueryResult, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_CheckoutTemplatesQueryBuilder as CheckoutTemplatesQueryBuilder, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_createCheckoutFromTemplate as createCheckoutFromTemplate, ecomV1CheckoutTemplateCheckoutTemplates_universal_d_createAndRedirectToCheckout as createAndRedirectToCheckout, };\n }\n interface DiscountRule$1 {\n /**\n * Discount rule ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the discount rule is updated.\n * To prevent conflicting changes, the current `revision` must be passed when updating the discount rule.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the discount rule was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the discount rule was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Whether the discount rule is active.\n *\n * Default: `true`\n */\n active?: boolean | null;\n /** Discount rule name. */\n name?: string | null;\n /**\n * Discount rule trigger.\n * A set of conditions that must be met for the `discounts` to be applied.\n * Not passing a trigger will cause the discount to always apply.\n */\n trigger?: DiscountTrigger;\n /** Time frame in which the discount rule is active. */\n activeTimeInfo?: ActiveTimeInfo;\n /**\n * List of discounts that are applied when one or more triggers are met.\n *\n * Currently, a discount rule can apply only 1 discount.\n */\n discounts?: Discounts;\n /**\n * Discount rule status.\n * @readonly\n */\n status?: Status;\n /**\n * Number of times the discount rule was used.\n * @readonly\n */\n usageCount?: number;\n }\n /** DiscountTrigger - description of a set of conditions, that if met, will trigger the associated rule actions */\n interface DiscountTrigger extends DiscountTriggerTriggerOneOf {\n /** Chain multiple triggers with the `and` operator. */\n and?: And;\n /** Chain multiple triggers with the `or` operator. */\n or?: Or;\n /** Custom trigger. */\n customTrigger?: Custom;\n /** Subtotal trigger range. */\n subtotalRange?: SubtotalRange;\n /** Item quantity trigger range. */\n itemQuantityRange?: ItemQuantityRange;\n /**\n * Trigger type.\n *\n * + `\"AND\"`: Operator used for chaining multiple triggers. Currently 1 `\"AND\"` chain operator is supported.\n * + `\"SUBTOTAL_RANGE\"`: Subtotal must be within the specified `subtotalRange` values.\n * + `\"ITEM_QUANTITY_RANGE\"`: Quantity of items in scope must be within specified `itemQuantityRange` values.\n * + `\"CUSTOM\"`: Custom trigger type defined in `customTrigger` object.\n */\n triggerType?: TriggerType;\n }\n /** @oneof */\n interface DiscountTriggerTriggerOneOf {\n /** Chain multiple triggers with the `and` operator. */\n and?: And;\n /** Chain multiple triggers with the `or` operator. */\n or?: Or;\n /** Custom trigger. */\n customTrigger?: Custom;\n /** Subtotal trigger range. */\n subtotalRange?: SubtotalRange;\n /** Item quantity trigger range. */\n itemQuantityRange?: ItemQuantityRange;\n }\n /**\n * This object represents a scope of catalog items. Examples:\n * 1. All catalog items of a specific app - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id`\n * 2. Specific catalog item - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id` + `catalog_item_ids`\n * 3. External catalog filter - type = CUSTOM_FILTER, CustomFilter with 'app_id' + 'params'\n */\n interface Scope extends ScopeScopeItemsOneOf {\n /** Catalog item filter. Must be passed with `type.\"CATALOG_ITEM\"`. */\n catalogItemFilter?: CatalogItemFilter;\n /** Custom filter. Must be passed with `type.\"CATALOG_ITEM\"`. */\n customFilter?: CustomFilter;\n /** Scope ID. */\n _id?: string;\n /** Scope type. */\n type?: ScopeType;\n }\n /** @oneof */\n interface ScopeScopeItemsOneOf {\n /** Catalog item filter. Must be passed with `type.\"CATALOG_ITEM\"`. */\n catalogItemFilter?: CatalogItemFilter;\n /** Custom filter. Must be passed with `type.\"CATALOG_ITEM\"`. */\n customFilter?: CustomFilter;\n }\n enum ScopeType {\n UNDEFINED_SCOPE = \"UNDEFINED_SCOPE\",\n /** Specific catalog items */\n CATALOG_ITEM = \"CATALOG_ITEM\",\n /** Specific items by custom filters */\n CUSTOM_FILTER = \"CUSTOM_FILTER\"\n }\n interface CatalogItemFilter {\n /** Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`. */\n catalogAppId?: string;\n /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores. */\n catalogItemIds?: string[];\n }\n interface CustomFilter {\n /** Custom filter app ID, when relevant. */\n appId?: string;\n /**\n * Custom filter in `{ \"key\": \"value\" }` form.\n * For example, an array of `collectionIDs`:\n * `{ [\"collectionId\": \"12345\"], [\"collectionId\": \"67890\"] }`.\n */\n params?: Record | null;\n }\n interface And {\n /**\n * List of triggers.\n * Max: 5 triggers.\n */\n triggers?: DiscountTrigger[];\n }\n interface Or {\n triggers?: DiscountTrigger[];\n }\n interface Custom {\n /** Trigger ID. */\n _id?: string;\n /** ID of the app that created the trigger. */\n appId?: string;\n }\n interface SubtotalRange {\n /** Relevant scopes for `\"SPECIFIC_ITEMS\"` target type. */\n scopes?: Scope[];\n /** Minimum subtotal price (inclusive). */\n from?: string | null;\n /** Maximum subtotal price (inclusive). */\n to?: string | null;\n }\n interface ItemQuantityRange {\n /** Relevant scopes for `\"SPECIFIC_ITEMS\"` target type. */\n scopes?: Scope[];\n /** Minimum item quantity (inclusive). */\n from?: number | null;\n /** Maximum item quantity (inclusive). */\n to?: number | null;\n }\n enum TriggerType {\n UNDEFINED = \"UNDEFINED\",\n /** Chain multiple triggers with AND operator */\n AND = \"AND\",\n /** Subtotal range trigger */\n SUBTOTAL_RANGE = \"SUBTOTAL_RANGE\",\n /** Item quantity range trigger */\n ITEM_QUANTITY_RANGE = \"ITEM_QUANTITY_RANGE\",\n /** Custom trigger, see Custom Triggers SPI for more details */\n CUSTOM = \"CUSTOM\",\n /** Chain multiple triggers with OR operator */\n OR = \"OR\"\n }\n interface ActiveTimeInfo {\n /** Date and time the discount rule is active **from**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n start?: Date;\n /** Date and time the discount rule is active **till**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n end?: Date;\n }\n interface Discounts {\n /** Discounts. */\n values?: Discount$2[];\n }\n interface Discount$2 extends DiscountDiscountOneOf {\n /** Percentage to discount from original price. */\n percentage?: number;\n /** Amount to discount from original price. */\n fixedAmount?: string;\n /** Fixed price. Line item will be fixed to this price. */\n fixedPrice?: string;\n /**\n * Discount target.\n *\n * + `\"SPECIFIC_ITEMS\"`: Discount applies to a specific set of items.\n */\n targetType?: Type;\n /** Data related to `\"SPECIFIC_ITEMS\"` target type. */\n specificItemsInfo?: SpecificItemsInfo;\n /**\n * Discount type.\n *\n * + `\"PERCENTAGE\"`: Price is reduced by percentage value.\n * + `\"FIXED_AMOUNT\"`: Price is reduced by fixed amount.\n * + `\"FIXED_PRICE\"`: Price will be set to fixed amount.\n */\n discountType?: DiscountType$1;\n }\n /** @oneof */\n interface DiscountDiscountOneOf {\n /** Percentage to discount from original price. */\n percentage?: number;\n /** Amount to discount from original price. */\n fixedAmount?: string;\n /** Fixed price. Line item will be fixed to this price. */\n fixedPrice?: string;\n }\n enum Type {\n /** Target type is not defined */\n UNDEFINED = \"UNDEFINED\",\n /** Target type is a set of specific items */\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n /** Target type is a buy x get y */\n BUY_X_GET_Y = \"BUY_X_GET_Y\"\n }\n interface SpecificItemsInfo {\n /** All associated scopes for `\"SPECIFIC_ITEMS\"` target type. */\n scopes?: Scope[];\n }\n enum DiscountType$1 {\n UNDEFINED = \"UNDEFINED\",\n /** Percentage discount */\n PERCENTAGE = \"PERCENTAGE\",\n /** Fixed amount discount */\n FIXED_AMOUNT = \"FIXED_AMOUNT\",\n /** Fixed price discount */\n FIXED_PRICE = \"FIXED_PRICE\"\n }\n interface BuyXGetYInfo {\n /** Information about which items must be in the cart (buy X) for the discount to apply (get Y). */\n customerBuys?: CustomerBuy;\n /** Information about which items will be discounted (get Y). */\n customerGets?: CustomerGet;\n /**\n * The maximum number of times the 'buy X get Y' discount can be applied.\n * For example, when the value of `limit` is `2`, with a \"2+1\" sale on all items, the following logic applies:\n * + Buy 2 get 1, buy 3 get 1.\n * + Buy 4 get 2, buy 6 get 2, buy 9 get 2, and so on.\n */\n limit?: number | null;\n }\n interface CustomerBuy extends CustomerBuyConditionOneOf {\n /** Minimum number of items the customer must add to the cart to be eligible for a discount. */\n minimumQuantity?: number;\n /** Minimum price the customer must add to the cart to be eligible for a discount. */\n minimumSpend?: string | null;\n /** Scopes of the items that must be added to the cart to enable the discount. */\n scopes?: Scope[];\n }\n /** @oneof */\n interface CustomerBuyConditionOneOf {\n /** Minimum number of items the customer must add to the cart to be eligible for a discount. */\n minimumQuantity?: number;\n /** Minimum price the customer must add to the cart to be eligible for a discount. */\n minimumSpend?: string | null;\n }\n interface CustomerGet {\n /**\n * Exact number of items in the cart that will be discounted.\n * If the cart contains fewer items than the value of quantity, the discount will not apply.\n */\n quantity?: number;\n /** Scopes of the items that will be discounted. */\n scopes?: Scope[];\n }\n enum Status {\n /** Rule status is not defined. */\n UNDEFINED = \"UNDEFINED\",\n /** Rule status is live. */\n LIVE = \"LIVE\",\n /** Rule status is expired, it might have been live in the past. */\n EXPIRED = \"EXPIRED\",\n /** Rule status is pending, it might be live in the future. */\n PENDING = \"PENDING\"\n }\n /** The discount settings */\n interface DiscountSettings {\n /** Discount applies to either `ALL_ITEMS`, or to the `LOWEST_PRICED_ITEM`. */\n appliesTo?: AppliedSubjectType;\n /**\n * Whether the discount will apply to subscriptions.\n *\n * Default: `false`\n */\n includeSubscription?: boolean | null;\n /** Maximum total number of uses allowed for the discount rule. */\n usageLimit?: number | null;\n /**\n * The usage limit per user per discount.\n * When not provided, this setting will not apply.\n */\n usageLimitPerUser?: number | null;\n }\n /** TODO: check if can be removed */\n enum AppliedSubjectType {\n UNDEFINED = \"UNDEFINED\",\n /** Discount applies to all items at checkout. */\n ALL_ITEMS = \"ALL_ITEMS\",\n /** Discount applies to the lowest priced item at checkout. */\n LOWEST_PRICED_ITEM = \"LOWEST_PRICED_ITEM\"\n }\n interface ExtendedFields$1 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface CreateDiscountRuleRequest {\n /** Discount rule info. */\n discountRule: DiscountRule$1;\n }\n interface CreateDiscountRuleResponse {\n /** Discount rule. */\n discountRule?: DiscountRule$1;\n }\n interface GetDiscountRuleRequest {\n /** ID of the discount rule to retrieve. */\n discountRuleId: string;\n }\n interface GetDiscountRuleResponse {\n /** The requested discount rule. */\n discountRule?: DiscountRule$1;\n }\n interface UpdateDiscountRuleRequest {\n /** Discount rule info. */\n discountRule: DiscountRule$1;\n }\n interface UpdateDiscountRuleResponse {\n /** Updated discount rule. */\n discountRule?: DiscountRule$1;\n }\n interface DeleteDiscountRuleRequest {\n /** ID of the discount rule to delete. */\n discountRuleId: string;\n }\n interface DeleteDiscountRuleResponse {\n }\n interface QueryDiscountRulesRequest {\n /** Query options. */\n query?: PlatformQuery$1;\n }\n interface PlatformQuery$1 extends PlatformQueryPagingMethodOneOf$1 {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging$1;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting$1[];\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf$1 {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging$1;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformPaging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$1 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryDiscountRulesResponse {\n /** List of discount rules. */\n discountRules?: DiscountRule$1[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PlatformPagingMetadata$1;\n }\n interface PlatformPagingMetadata$1 {\n /** The number of items returned in this response. */\n count?: number | null;\n /** The offset which was requested. Returned if offset paging was used. */\n offset?: number | null;\n /** The total number of items that match the query. Returned if offset paging was used. */\n total?: number | null;\n /** Cursors to navigate through result pages. Returned if cursor paging was used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface GetAppliedDiscountsRequest {\n /** Line items for which to check for discount rules. */\n lineItems?: LineItem$2[];\n purchaseFlowId?: string | null;\n }\n interface LineItem$2 {\n /** Line item ID. */\n _id?: string;\n /** Line item quantity. */\n quantity?: number | null;\n /** Catalog and item reference info. Learn more about [integrating Wix Stores products with Wix eCommerce](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration). */\n catalogReference?: CatalogReference$1;\n /** Line item price. */\n price?: string;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$1 {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).\n */\n options?: Record | null;\n }\n interface GetAppliedDiscountsResponse {\n /** All eligible discounts. */\n appliedDiscounts?: AppliedDiscount$1[];\n }\n interface AppliedDiscount$1 {\n /** Discount type. */\n discountType?: Type;\n /** IDs of line items the discount applies to, in GUID format. */\n lineItemIds?: string[];\n /** Applied discount rule. */\n appliedDiscountRule?: AppliedDiscountRule;\n }\n interface AppliedDiscountRule {\n /** Applied discount rule ID. */\n _id?: string;\n /** Discount rule name. */\n name?: DiscountRuleName$1;\n /** Total amount reduced from all discounted line items. */\n amount?: MultiCurrencyPrice;\n /** Discount rule type. */\n discountRuleType?: DiscountType$1;\n }\n interface DiscountRuleName$1 {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /**\n * Translated discount rule name according to buyer language.\n *\n * Default: `original`\n */\n translated?: string | null;\n }\n interface MultiCurrencyPrice {\n /** Amount. */\n amount?: string;\n /**\n * Converted amount.\n * @readonly\n */\n convertedAmount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n /**\n * Converted amount formatted with currency symbol.\n * @readonly\n */\n formattedConvertedAmount?: string;\n }\n interface DomainEvent$5 extends DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n }\n interface EntityCreatedEvent$5 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$5 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$5 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\n }\n interface Empty$3 {\n }\n interface DiscountRuleUsageLimitReached {\n /** Discount Rule */\n rule?: DiscountRule$1;\n }\n interface MessageEnvelope$5 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$5;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$5;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$5 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new discount rule.\n *\n *\n * The `createDiscountRule()` function returns a Promise that resolves to the new discount rule when it's created.\n * @param discountRule - Discount rule info.\n * @public\n * @requiredField discountRule\n * @requiredField discountRule.discounts\n * @requiredField discountRule.name\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Discount rule.\n */\n function createDiscountRule(discountRule: DiscountRule$1): Promise;\n /**\n * Retrieves a discount rule.\n *\n *\n * The `getDiscountRule()` function returns a Promise that resolves when the specified discount rule is retrieved.\n * @param discountRuleId - ID of the discount rule to retrieve.\n * @public\n * @requiredField discountRuleId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n * @returns The requested discount rule.\n */\n function getDiscountRule(discountRuleId: string): Promise;\n /**\n * Updates a discount rule's properties.\n *\n *\n * The `updateDiscountRule()` function returns a Promise that resolves when the specified discount rule's properties are updated.\n *\n * Each time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.\n * @param _id - Discount rule ID.\n * @public\n * @requiredField _id\n * @requiredField discountRule\n * @requiredField discountRule.revision\n * @param discountRule - Discount rule info.\n * @param options - Discount rule info.\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated discount rule.\n */\n function updateDiscountRule(_id: string | null, discountRule: UpdateDiscountRule, options?: UpdateDiscountRuleOptions): Promise;\n interface UpdateDiscountRule {\n /**\n * Discount rule ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the discount rule is updated.\n * To prevent conflicting changes, the current `revision` must be passed when updating the discount rule.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the discount rule was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the discount rule was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Whether the discount rule is active.\n *\n * Default: `true`\n */\n active?: boolean | null;\n /** Discount rule name. */\n name?: string | null;\n /**\n * Discount rule trigger.\n * A set of conditions that must be met for the `discounts` to be applied.\n * Not passing a trigger will cause the discount to always apply.\n */\n trigger?: DiscountTrigger;\n /** Time frame in which the discount rule is active. */\n activeTimeInfo?: ActiveTimeInfo;\n /**\n * List of discounts that are applied when one or more triggers are met.\n *\n * Currently, a discount rule can apply only 1 discount.\n */\n discounts?: Discounts;\n /**\n * Discount rule status.\n * @readonly\n */\n status?: Status;\n /**\n * Number of times the discount rule was used.\n * @readonly\n */\n usageCount?: number;\n }\n interface UpdateDiscountRuleOptions {\n }\n /**\n * Deletes a discount rule.\n *\n *\n * The `deleteDiscountRule()` function returns a Promise that resolves when the specified discount rule is deleted.\n * @param discountRuleId - ID of the discount rule to delete.\n * @public\n * @requiredField discountRuleId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteDiscountRule(discountRuleId: string): Promise;\n /**\n * Creates a query to retrieve a list of discount rules.\n *\n *\n * The `queryDiscountRules()` function builds a query to retrieve a list of up to 100 discount rules, and returns a [`DiscountRulesQueryBuilder`](#discountrulesquerybuilder) object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](/discount-rules/discount-rules-query-builder/find) function.\n *\n * You can refine the query by chaining `DiscountRulesQueryBuilder` functions onto the query. `DiscountRulesQueryBuilder` functions enable you to sort, filter, and control the results queryDiscountRules() returns.\n *\n * By default, `queryDiscountRules()` sorts results by [`ascending(\"_id\")`](/discount-rules/discount-rules-query-builder/ascending) by default. This can be overridden.\n *\n * To learn how to query posts, refer to the table below.\n *\n * The following `DiscountRulesQueryBuilder` functions are supported for the `queryDiscountRules()` function. For a full description of the discount rule object, see the object returned for the [`items`](/discount-rules/discount-rules-query-result/items) property in the `DiscountRulesQueryResult`.\n * @public\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryDiscountRules(): DiscountRulesQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DiscountRulesQueryResult extends QueryCursorResult$1 {\n items: DiscountRule$1[];\n query: DiscountRulesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface DiscountRulesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"_id\" | \"name\", value: string) => DiscountRulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any[]) => DiscountRulesQueryBuilder;\n in: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: any) => DiscountRulesQueryBuilder;\n exists: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\", value: boolean) => DiscountRulesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\">) => DiscountRulesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"active\" | \"name\" | \"activeTimeInfo.start\" | \"activeTimeInfo.end\">) => DiscountRulesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => DiscountRulesQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => DiscountRulesQueryBuilder;\n find: () => Promise;\n }\n interface GetAppliedDiscountsOptions {\n /** Line items for which to check for discount rules. */\n lineItems?: LineItem$2[];\n purchaseFlowId?: string | null;\n }\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountTrigger = DiscountTrigger;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountTriggerTriggerOneOf = DiscountTriggerTriggerOneOf;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Scope = Scope;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ScopeScopeItemsOneOf = ScopeScopeItemsOneOf;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ScopeType = ScopeType;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ScopeType: typeof ScopeType;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CatalogItemFilter = CatalogItemFilter;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomFilter = CustomFilter;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_And = And;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Or = Or;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Custom = Custom;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_SubtotalRange = SubtotalRange;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ItemQuantityRange = ItemQuantityRange;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_TriggerType = TriggerType;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_TriggerType: typeof TriggerType;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ActiveTimeInfo = ActiveTimeInfo;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Discounts = Discounts;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountDiscountOneOf = DiscountDiscountOneOf;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Type = Type;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Type: typeof Type;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_SpecificItemsInfo = SpecificItemsInfo;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_BuyXGetYInfo = BuyXGetYInfo;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomerBuy = CustomerBuy;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomerBuyConditionOneOf = CustomerBuyConditionOneOf;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomerGet = CustomerGet;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Status = Status;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Status: typeof Status;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountSettings = DiscountSettings;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_AppliedSubjectType = AppliedSubjectType;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_AppliedSubjectType: typeof AppliedSubjectType;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CreateDiscountRuleRequest = CreateDiscountRuleRequest;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CreateDiscountRuleResponse = CreateDiscountRuleResponse;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetDiscountRuleRequest = GetDiscountRuleRequest;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetDiscountRuleResponse = GetDiscountRuleResponse;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRuleRequest = UpdateDiscountRuleRequest;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRuleResponse = UpdateDiscountRuleResponse;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DeleteDiscountRuleRequest = DeleteDiscountRuleRequest;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DeleteDiscountRuleResponse = DeleteDiscountRuleResponse;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_QueryDiscountRulesRequest = QueryDiscountRulesRequest;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_QueryDiscountRulesResponse = QueryDiscountRulesResponse;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetAppliedDiscountsRequest = GetAppliedDiscountsRequest;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetAppliedDiscountsResponse = GetAppliedDiscountsResponse;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_AppliedDiscountRule = AppliedDiscountRule;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_MultiCurrencyPrice = MultiCurrencyPrice;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountRuleUsageLimitReached = DiscountRuleUsageLimitReached;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_createDiscountRule: typeof createDiscountRule;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_getDiscountRule: typeof getDiscountRule;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_updateDiscountRule: typeof updateDiscountRule;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRule = UpdateDiscountRule;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRuleOptions = UpdateDiscountRuleOptions;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_deleteDiscountRule: typeof deleteDiscountRule;\n const ecomDiscountsV1DiscountRuleDiscountRules_universal_d_queryDiscountRules: typeof queryDiscountRules;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountRulesQueryResult = DiscountRulesQueryResult;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountRulesQueryBuilder = DiscountRulesQueryBuilder;\n type ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetAppliedDiscountsOptions = GetAppliedDiscountsOptions;\n namespace ecomDiscountsV1DiscountRuleDiscountRules_universal_d {\n export { DiscountRule$1 as DiscountRule, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountTrigger as DiscountTrigger, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountTriggerTriggerOneOf as DiscountTriggerTriggerOneOf, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Scope as Scope, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ScopeScopeItemsOneOf as ScopeScopeItemsOneOf, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ScopeType as ScopeType, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CatalogItemFilter as CatalogItemFilter, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomFilter as CustomFilter, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_And as And, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Or as Or, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Custom as Custom, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_SubtotalRange as SubtotalRange, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ItemQuantityRange as ItemQuantityRange, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_TriggerType as TriggerType, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_ActiveTimeInfo as ActiveTimeInfo, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Discounts as Discounts, Discount$2 as Discount, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountDiscountOneOf as DiscountDiscountOneOf, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Type as Type, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_SpecificItemsInfo as SpecificItemsInfo, DiscountType$1 as DiscountType, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_BuyXGetYInfo as BuyXGetYInfo, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomerBuy as CustomerBuy, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomerBuyConditionOneOf as CustomerBuyConditionOneOf, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CustomerGet as CustomerGet, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_Status as Status, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountSettings as DiscountSettings, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_AppliedSubjectType as AppliedSubjectType, ExtendedFields$1 as ExtendedFields, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CreateDiscountRuleRequest as CreateDiscountRuleRequest, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_CreateDiscountRuleResponse as CreateDiscountRuleResponse, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetDiscountRuleRequest as GetDiscountRuleRequest, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetDiscountRuleResponse as GetDiscountRuleResponse, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRuleRequest as UpdateDiscountRuleRequest, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRuleResponse as UpdateDiscountRuleResponse, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DeleteDiscountRuleRequest as DeleteDiscountRuleRequest, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DeleteDiscountRuleResponse as DeleteDiscountRuleResponse, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_QueryDiscountRulesRequest as QueryDiscountRulesRequest, PlatformQuery$1 as PlatformQuery, PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf, Sorting$1 as Sorting, SortOrder$1 as SortOrder, PlatformPaging$1 as PlatformPaging, CursorPaging$1 as CursorPaging, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_QueryDiscountRulesResponse as QueryDiscountRulesResponse, PlatformPagingMetadata$1 as PlatformPagingMetadata, Cursors$1 as Cursors, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetAppliedDiscountsRequest as GetAppliedDiscountsRequest, LineItem$2 as LineItem, CatalogReference$1 as CatalogReference, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetAppliedDiscountsResponse as GetAppliedDiscountsResponse, AppliedDiscount$1 as AppliedDiscount, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_AppliedDiscountRule as AppliedDiscountRule, DiscountRuleName$1 as DiscountRuleName, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_MultiCurrencyPrice as MultiCurrencyPrice, DomainEvent$5 as DomainEvent, DomainEventBodyOneOf$5 as DomainEventBodyOneOf, EntityCreatedEvent$5 as EntityCreatedEvent, EntityUpdatedEvent$5 as EntityUpdatedEvent, EntityDeletedEvent$5 as EntityDeletedEvent, ActionEvent$5 as ActionEvent, Empty$3 as Empty, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountRuleUsageLimitReached as DiscountRuleUsageLimitReached, MessageEnvelope$5 as MessageEnvelope, IdentificationData$5 as IdentificationData, IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, WebhookIdentityType$5 as WebhookIdentityType, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_createDiscountRule as createDiscountRule, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_getDiscountRule as getDiscountRule, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_updateDiscountRule as updateDiscountRule, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRule as UpdateDiscountRule, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_UpdateDiscountRuleOptions as UpdateDiscountRuleOptions, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_deleteDiscountRule as deleteDiscountRule, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_queryDiscountRules as queryDiscountRules, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountRulesQueryResult as DiscountRulesQueryResult, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_DiscountRulesQueryBuilder as DiscountRulesQueryBuilder, ecomDiscountsV1DiscountRuleDiscountRules_universal_d_GetAppliedDiscountsOptions as GetAppliedDiscountsOptions, };\n }\n interface Invoice {\n /** Invoice ID. */\n _id?: string;\n /** ID of the app that set the invoice. */\n appId?: string;\n }\n interface ListInvoicesForSingleOrderRequest$1 {\n /** Order ID. */\n orderId: string;\n }\n interface ListInvoicesForSingleOrderResponse$1 {\n /** List of invoices. */\n invoices?: Invoice[];\n }\n interface ListInvoicesForMultipleOrdersRequest$1 {\n /** Order IDs for which to retrieve invoices. */\n orderIds: string[];\n }\n interface ListInvoicesForMultipleOrdersResponse$1 {\n /** List of order IDs and their associated invoices. */\n invoicesForOrder?: InvoicesForOrder$1[];\n }\n interface InvoicesForOrder$1 {\n /** Order ID. */\n orderId?: string;\n /** Invoices info. */\n invoicesInfo?: Invoice[];\n }\n interface GenerateInvoiceRequest$1 {\n /** Order ID. */\n orderId: string;\n }\n interface GenerateInvoiceResponse$1 {\n /** Invoice ID. */\n invoiceId?: string;\n }\n interface BulkGenerateInvoicesRequest$1 {\n /** Order IDs. */\n orderIds: string[];\n }\n interface BulkGenerateInvoicesResponse$1 {\n results?: BulkInvoiceResult$1[];\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkInvoiceResult$1 {\n itemMetadata?: ItemMetadata$2;\n item?: InvoiceForOrder$1;\n }\n interface ItemMetadata$2 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$2;\n }\n interface ApplicationError$2 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface InvoiceForOrder$1 {\n /** Order ID. */\n orderId?: string;\n /** Invoice ID. */\n invoiceId?: string;\n }\n interface BulkActionMetadata$2 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface AddInvoiceToOrderRequest$1 {\n /** Order ID. */\n orderId: string;\n /** Invoice info. */\n invoiceInfo: Invoice;\n }\n interface AddInvoiceToOrderResponse$1 {\n /** List of order invoices. */\n orderInvoices?: Invoice[];\n }\n interface DomainEvent$4 extends DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n }\n interface EntityCreatedEvent$4 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$4 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$4 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface Empty$2 {\n }\n interface MessageEnvelope$4 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$4;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$4;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$4 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves the IDs of invoices associated with all specified orders.\n *\n *\n * The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.\n * @param orderIds - Order IDs for which to retrieve invoices.\n * @public\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n */\n function listInvoicesForMultipleOrders(orderIds: string[]): Promise;\n type ecomOrdersV1InvoiceOrderInvoices_universal_d_Invoice = Invoice;\n const ecomOrdersV1InvoiceOrderInvoices_universal_d_listInvoicesForMultipleOrders: typeof listInvoicesForMultipleOrders;\n namespace ecomOrdersV1InvoiceOrderInvoices_universal_d {\n export { ecomOrdersV1InvoiceOrderInvoices_universal_d_Invoice as Invoice, ListInvoicesForSingleOrderRequest$1 as ListInvoicesForSingleOrderRequest, ListInvoicesForSingleOrderResponse$1 as ListInvoicesForSingleOrderResponse, ListInvoicesForMultipleOrdersRequest$1 as ListInvoicesForMultipleOrdersRequest, ListInvoicesForMultipleOrdersResponse$1 as ListInvoicesForMultipleOrdersResponse, InvoicesForOrder$1 as InvoicesForOrder, GenerateInvoiceRequest$1 as GenerateInvoiceRequest, GenerateInvoiceResponse$1 as GenerateInvoiceResponse, BulkGenerateInvoicesRequest$1 as BulkGenerateInvoicesRequest, BulkGenerateInvoicesResponse$1 as BulkGenerateInvoicesResponse, BulkInvoiceResult$1 as BulkInvoiceResult, ItemMetadata$2 as ItemMetadata, ApplicationError$2 as ApplicationError, InvoiceForOrder$1 as InvoiceForOrder, BulkActionMetadata$2 as BulkActionMetadata, AddInvoiceToOrderRequest$1 as AddInvoiceToOrderRequest, AddInvoiceToOrderResponse$1 as AddInvoiceToOrderResponse, DomainEvent$4 as DomainEvent, DomainEventBodyOneOf$4 as DomainEventBodyOneOf, EntityCreatedEvent$4 as EntityCreatedEvent, EntityUpdatedEvent$4 as EntityUpdatedEvent, EntityDeletedEvent$4 as EntityDeletedEvent, ActionEvent$4 as ActionEvent, Empty$2 as Empty, MessageEnvelope$4 as MessageEnvelope, IdentificationData$4 as IdentificationData, IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, WebhookIdentityType$4 as WebhookIdentityType, ecomOrdersV1InvoiceOrderInvoices_universal_d_listInvoicesForMultipleOrders as listInvoicesForMultipleOrders, };\n }\n interface Order$1 {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Order number displayed in the site owner's dashboard (auto-generated).\n * @readonly\n */\n number?: string;\n /**\n * Date and time the order was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Order line items.\n * @readonly\n */\n lineItems?: OrderLineItem[];\n /** Buyer information. */\n buyerInfo?: BuyerInfo$1;\n /**\n * Order payment status.\n * + `NOT_PAID` - This can be an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.\n * + This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.\n * + `PAID` - All payments associated with this order are paid. For online payments: [`payment.regularPaymentDetails.status: APPROVED`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object). For gift cards: [`payment.giftCardPaymentDetails.voided: false`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object).\n * + `PARTIALLY_REFUNDED` - Order was refunded, but refund amount is less than order total price.\n * + `FULLY_REFUNDED` - Order fully refunded. Refund amount equals total price.\n * + `PENDING` - Payments received but not yet confirmed by the payment provider.\n * + `PARTIALLY_PAID` - At least one payment was received and approved, covering less than total price amount.\n */\n paymentStatus?: PaymentStatus$1;\n /**\n * Order fulfillment status.\n * @readonly\n */\n fulfillmentStatus?: FulfillmentStatus$1;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n */\n buyerLanguage?: string | null;\n /** Weight measurement unit - defaults to site's weight unit. */\n weightUnit?: WeightUnit$1;\n /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */\n currency?: string | null;\n /** Whether tax is included in line item prices. */\n taxIncludedInPrices?: boolean;\n /**\n * Site language in which original values are shown.\n * @readonly\n */\n siteLanguage?: string | null;\n /**\n * Order price summary.\n * @readonly\n */\n priceSummary?: PriceSummary;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: V1ShippingInformation;\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /**\n * Order status.\n * + `INITIALIZED`: Order created, but not yet approved or canceled.\n * + `APPROVED`: Order approved. This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order). Offline orders (cash payment) are automatically approved.\n * + `CANCELED`: Order canceled by the user.\n */\n status?: OrderStatus;\n /** Whether order is archived. */\n archived?: boolean | null;\n /**\n * Tax summary.\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * @deprecated Tax summary.\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxSummary?: TaxSummary;\n /** Tax information. */\n taxInfo?: OrderTaxInfo;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount[];\n /**\n * Order activities.\n * @readonly\n */\n activities?: Activity$1[];\n /** Order attribution source. */\n attributionSource?: AttributionSource;\n /**\n * ID of the order's initiator.\n * @readonly\n */\n createdBy?: CreatedBy;\n /** Information about the sales channel that submitted this order. */\n channelInfo?: ChannelInfo$1;\n /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */\n seenByAHuman?: boolean | null;\n /** Checkout ID. */\n checkoutId?: string | null;\n /** Custom fields. */\n customFields?: CustomField$1[];\n /**\n * Balance summary.\n * @readonly\n */\n balanceSummary?: BalanceSummary;\n /** Additional fees applied to the order. */\n additionalFees?: AdditionalFee[];\n /**\n * Custom field data for the order object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /**\n * Order recipient address and contact details.\n *\n * This field may differ from the address in `shippingInfo.logistics` when:\n * + The chosen shipping option is pickup point or store pickup.\n * + No shipping option is selected.\n */\n recipientInfo?: AddressWithContact;\n }\n interface OrderLineItem {\n /** Line item ID. */\n _id?: string;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n */\n productName?: ProductName;\n /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */\n catalogReference?: CatalogReference;\n /** Line item quantity. */\n quantity?: number;\n /**\n * Total discount for this line item's entire quantity.\n * @readonly\n */\n totalDiscount?: Price$1;\n /** Line item description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine[];\n /** Line item image. */\n image?: string;\n /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */\n physicalProperties?: PhysicalProperties;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType;\n /**\n * Fulfiller ID. Field is empty when the line item is self-fulfilled.\n *\n * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).\n */\n fulfillerId?: string | null;\n /**\n * Number of items that were refunded.\n * @readonly\n */\n refundQuantity?: number | null;\n /**\n * Number of items restocked.\n * @readonly\n */\n restockQuantity?: number | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$1;\n /**\n * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: Price$1;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$1;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$1;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.\n */\n paymentOption?: PaymentOptionType;\n /**\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax details for this line item.\n * @deprecated Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax details for this line item.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxDetails?: ItemTaxFullDetails;\n /** Represents all the relevant tax details for a specific line item. */\n taxInfo?: LineItemTaxInfo;\n /** Digital file identifier, relevant only for items with type DIGITAL. */\n digitalFile?: DigitalFile$1;\n /** Subscription info. */\n subscriptionInfo?: SubscriptionInfo$1;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription;\n /**\n * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `\"DEPOSIT_ONLINE\"`.\n * @readonly\n */\n depositAmount?: Price$1;\n }\n interface ProductName {\n /**\n * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n *\n * Min: 1 character.\n * Max: 200 characters.\n */\n original?: string;\n /**\n * Item name translated into the buyer's language.\n *\n * Min: 1 character.\n * Max: 400 characters.\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference {\n /** ID of the item within the catalog it belongs to. */\n catalogItemId?: string;\n /**\n * ID of the app providing the catalog.\n *\n * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n *\n * For items from Wix catalogs, the following values always apply:\n * + Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`\n */\n appId?: string;\n /**\n * Additional item details in key:value pairs.\n *\n * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n *\n * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).\n */\n options?: Record | null;\n }\n interface Price$1 {\n /** Amount. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n }\n interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n /** Description line name. */\n name?: DescriptionLineName;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf {\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf {\n }\n interface DescriptionLineName {\n /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface PlainTextValue {\n /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line plain text value translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface Color {\n /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Description line color name translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n /** HEX or RGB color code for display. */\n code?: string | null;\n }\n enum DescriptionLineType {\n UNRECOGNISED = \"UNRECOGNISED\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n COLOR = \"COLOR\"\n }\n interface PhysicalProperties {\n /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface ItemType extends ItemTypeItemTypeDataOneOf {\n /** Preset item type. */\n preset?: ItemTypeItemType;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n /** @oneof */\n interface ItemTypeItemTypeDataOneOf {\n /** Preset item type. */\n preset?: ItemTypeItemType;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType {\n UNRECOGNISED = \"UNRECOGNISED\",\n PHYSICAL = \"PHYSICAL\",\n DIGITAL = \"DIGITAL\",\n GIFT_CARD = \"GIFT_CARD\",\n SERVICE = \"SERVICE\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType {\n /** The entire payment for this item happens as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\",\n /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface ItemTaxFullDetails {\n /** Taxable amount of this line item. */\n taxableAmount?: Price$1;\n /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `\"0.13\"`. */\n taxRate?: string;\n /** The calculated tax, based on the `taxableAmount` and `taxRate`. */\n totalTax?: Price$1;\n }\n interface LineItemTaxInfo {\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n taxAmount?: Price$1;\n /** Amount for which tax is calculated. */\n taxableAmount?: Price$1;\n /** Tax rate %, as a decimal point. */\n taxRate?: string | null;\n /**\n * Tax group ID.\n * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).\n */\n taxGroupId?: string | null;\n /** Indicates whether the price already includes tax. */\n taxIncludedInPrice?: boolean;\n /** Tax information for a line item. */\n taxBreakdown?: LineItemTaxBreakdown[];\n }\n /**\n * TaxBreakdown represents tax information for a line item.\n * It holds the tax amount and the tax rate for each tax authority that apply on the line item.\n */\n interface LineItemTaxBreakdown {\n /** Jurisdiction that taxes were calculated for. For example, \"New York\", or \"Quebec\". */\n jurisdiction?: string | null;\n /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */\n rate?: string | null;\n /** Amount of tax calculated for this line item. */\n taxAmount?: Price$1;\n /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc. */\n taxType?: string | null;\n /**\n * The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\n * This name should be explicit enough to allow the merchant to understand what tax was calculated.\n */\n taxName?: string | null;\n /** Type of jurisdiction that taxes were calculated for. */\n jurisdictionType?: JurisdictionType;\n /** Non-taxable amount of the line item price. */\n nonTaxableAmount?: Price$1;\n /** Taxable amount of the line item price. */\n taxableAmount?: Price$1;\n }\n /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n enum JurisdictionType {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface DigitalFile$1 {\n /** ID of the secure file in media. */\n fileId?: string;\n /** Link will exist after the digital links have been generated on the order. */\n link?: string | null;\n /**\n * Link expiration time and date.\n * @readonly\n */\n expirationDate?: Date;\n }\n interface SubscriptionInfo$1 {\n /** Subscription ID. */\n _id?: string | null;\n /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */\n cycleNumber?: number;\n /** Subscription option title. For example, `\"Monthly coffee Subscription\"`. */\n subscriptionOptionTitle?: string;\n /** Subscription option description. For example, `\"1kg of selected coffee, once a month\"`. */\n subscriptionOptionDescription?: string | null;\n /** Subscription detailed information. */\n subscriptionSettings?: SubscriptionSettings$1;\n }\n interface SubscriptionSettings$1 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$1;\n /** Interval of recurring payment. */\n interval?: number | null;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$1 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface PriceDescription {\n /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */\n original?: string;\n /**\n * Price description translated into the buyer's language.\n *\n * Default: Same as `original`.\n */\n translated?: string | null;\n }\n interface LocationAndQuantity {\n /** Location id in the associated owner app. */\n _id?: string;\n /** Location owner app, if not provided then the site business info locations will be used. */\n appId?: string | null;\n /** Quantity for specific location. */\n quantity?: number;\n }\n /** Buyer Info */\n interface BuyerInfo$1 extends BuyerInfoIdOneOf {\n /** Visitor ID (if site visitor is not a member). */\n visitorId?: string;\n /** Member ID (if site visitor is a site member). */\n memberId?: string;\n /** Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction). */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf {\n /** Visitor ID (if site visitor is not a member). */\n visitorId?: string;\n /** Member ID (if site visitor is a site member). */\n memberId?: string;\n }\n enum PaymentStatus$1 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** Order is not paid */\n NOT_PAID = \"NOT_PAID\",\n /** Order is paid */\n PAID = \"PAID\",\n /** Order was refunded, refund amount less than order total price */\n PARTIALLY_REFUNDED = \"PARTIALLY_REFUNDED\",\n /** Full order total price was refunded */\n FULLY_REFUNDED = \"FULLY_REFUNDED\",\n /** Payments received but not yet confirmed by the payment provider */\n PENDING = \"PENDING\",\n /** At least one payment was received and approved, covering less than total price amount */\n PARTIALLY_PAID = \"PARTIALLY_PAID\"\n }\n enum FulfillmentStatus$1 {\n /** none of the order items are fulfilled or order was manually marked as unfulfilled */\n NOT_FULFILLED = \"NOT_FULFILLED\",\n /**\n * All of the order items are fulfilled or order was manually marked as fulfilled\n * Orders without shipping info are fulfilled automatically\n */\n FULFILLED = \"FULFILLED\",\n /** Some, but not all of the order items are fulfilled */\n PARTIALLY_FULFILLED = \"PARTIALLY_FULFILLED\"\n }\n enum WeightUnit$1 {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface PriceSummary {\n /** Subtotal of all the line items, before discounts and before tax. */\n subtotal?: Price$1;\n /** Total shipping price, before discounts and before tax. */\n shipping?: Price$1;\n /** Total tax on this order. */\n tax?: Price$1;\n /** Total calculated discount value. */\n discount?: Price$1;\n /** Order’s total price after discounts and tax. */\n total?: Price$1;\n /** Total price of additional fees before tax. */\n totalAdditionalFees?: Price$1;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact {\n /** Address. */\n address?: Address$1;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails;\n }\n /** Physical address */\n interface Address$1 {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. */\n streetAddress?: StreetAddress;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Company name. */\n company?: string | null;\n /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */\n vatId?: VatId$1;\n }\n interface VatId$1 {\n /** Customer's tax ID. */\n _id?: string;\n /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\n type?: VatType$1;\n }\n /** tax info types */\n enum VatType$1 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface V1ShippingInformation {\n /** App Def Id of external provider which was a source of shipping info */\n carrierId?: string | null;\n /** Unique code (or ID) of selected shipping option. For example, `\"usps_std_overnight\"``. */\n code?: string | null;\n /**\n * Shipping option title.\n * For example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"` or `\"First-Class Package International\"`.\n */\n title?: string;\n /** Shipping logistics. */\n logistics?: DeliveryLogistics;\n /** Shipping costs. */\n cost?: ShippingPrice;\n /** Shipping region. */\n region?: ShippingRegion;\n }\n interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact;\n /** Pickup details. */\n pickupDetails?: PickupDetails$1;\n /** Expected delivery time in free text. For example, `\"3-5 business days\"`. */\n deliveryTime?: string | null;\n /** Instructions for carrier. For example, `\"Please knock on the door. If unanswered, please call contact number. Thanks.\"`. */\n instructions?: string | null;\n /**\n * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @deprecated\n */\n deliverByDate?: Date;\n /** Expected delivery time. */\n deliveryTimeSlot?: DeliveryTimeSlot;\n }\n /** @oneof */\n interface DeliveryLogisticsAddressOneOf {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact;\n /** Pickup details. */\n pickupDetails?: PickupDetails$1;\n }\n interface PickupDetails$1 {\n /** Pickup address. */\n address?: PickupAddress$1;\n /** Pickup method */\n pickupMethod?: PickupMethod;\n }\n /** Physical address */\n interface PickupAddress$1 {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address object, with number, name, and apartment number in separate fields. */\n streetAddress?: StreetAddress;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n enum PickupMethod {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot {\n /** Delivery slot starting time. */\n from?: Date;\n /** Delivery slot ending time. */\n to?: Date;\n }\n interface ShippingPrice {\n /** Shipping price for display purposes. */\n price?: Price$1;\n /**\n * Total price of shipping after discounts (when relevant), and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$1;\n /**\n * Shipping price after all discounts (if any exist), and after tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$1;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails;\n /**\n * Shipping discount before tax.\n * @readonly\n */\n discount?: Price$1;\n }\n interface ShippingRegion {\n /** Name of shipping region. For example, `\"Metropolitan London\"`, or `\"Outer Melbourne suburbs\"`. */\n name?: string | null;\n }\n enum OrderStatus {\n INITIALIZED = \"INITIALIZED\",\n APPROVED = \"APPROVED\",\n CANCELED = \"CANCELED\"\n }\n interface TaxSummary {\n /**\n * Total tax.\n * @readonly\n */\n totalTax?: Price$1;\n }\n interface OrderTaxInfo {\n /** Calculated tax, added from line items. */\n totalTax?: Price$1;\n /** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */\n taxBreakdown?: OrderTaxBreakdown[];\n }\n /**\n * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.\n * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.\n */\n interface OrderTaxBreakdown {\n /** The name of the tax against which this tax amount was calculated. */\n taxName?: string;\n /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */\n taxType?: string;\n /** The name of the jurisdiction in which this tax detail applies. */\n jurisdiction?: string;\n /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n jurisdictionType?: JurisdictionType;\n /** The rate at which this tax detail was calculated. */\n rate?: string;\n /** The sum of all the tax from line items that calculated by the tax identifiers. */\n aggregatedTaxAmount?: Price$1;\n }\n interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {\n /** Applied coupon info. */\n coupon?: Coupon;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount;\n /** Automatic Discount */\n discountRule?: DiscountRule;\n /**\n * Discount type.\n * * `\"GLOBAL\"` - discount applies to entire order.\n * * `\"SPECIFIC-ITEMS\"` - discount applies to specific items.\n * * `\"SHIPPING\"` - discount applies to shipping. For example, free shipping.\n */\n discountType?: DiscountType;\n /**\n * IDs of line items discount applies to.\n * Deprecated. Use `line_item_discounts` instead.\n * @deprecated IDs of line items discount applies to.\n * Deprecated. Use `line_item_discounts` instead.\n * @replacedBy line_item_discounts\n * @targetRemovalDate 2024-10-30\n */\n lineItemIds?: string[];\n /** Discount id. */\n _id?: string | null;\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf {\n /** Applied coupon info. */\n coupon?: Coupon;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount;\n /** Automatic Discount */\n discountRule?: DiscountRule;\n }\n enum DiscountType {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface Coupon {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon name. */\n name?: string;\n /** Coupon value. */\n amount?: Price$1;\n }\n interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {\n /**\n * Pre-defined discount reason (optional).\n * * `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange.\n */\n discountReason?: DiscountReason;\n /** Discount description as free text (optional). */\n description?: string | null;\n /** Discount amount. */\n amount?: Price$1;\n }\n /** @oneof */\n interface MerchantDiscountMerchantDiscountReasonOneOf {\n /**\n * Pre-defined discount reason (optional).\n * * `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange.\n */\n discountReason?: DiscountReason;\n /** Discount description as free text (optional). */\n description?: string | null;\n }\n enum DiscountReason {\n UNSPECIFIED = \"UNSPECIFIED\",\n EXCHANGED_ITEMS = \"EXCHANGED_ITEMS\"\n }\n interface DiscountRule {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName;\n /** Discount value. */\n amount?: Price$1;\n }\n interface DiscountRuleName {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface LineItemDiscount {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Total discount for this line item. */\n totalDiscount?: Price$1;\n }\n interface Activity$1 extends ActivityContentOneOf {\n /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */\n customActivity?: CustomActivity;\n /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */\n merchantComment?: MerchantComment;\n /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */\n orderRefunded?: OrderRefunded$1;\n /**\n * Activity ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Activity author's email.\n * @readonly\n */\n authorEmail?: string | null;\n /**\n * Activity creation date and time.\n * @readonly\n */\n _createdDate?: Date;\n /** Activity type. */\n type?: ActivityType$1;\n }\n /** @oneof */\n interface ActivityContentOneOf {\n /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */\n customActivity?: CustomActivity;\n /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */\n merchantComment?: MerchantComment;\n /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */\n orderRefunded?: OrderRefunded$1;\n }\n interface CustomActivity {\n /** ID of the app that created the custom activity. */\n appId?: string;\n /** Custom activity type. For example, `\"Ticket number set\"`. */\n type?: string;\n /** Additional data in key-value form. For example, `{ \"Ticket number\": \"123456\" }`. */\n additionalData?: Record;\n }\n /** Store owner added a comment */\n interface MerchantComment {\n /** Merchant comment message. */\n message?: string;\n }\n interface OrderRefunded$1 {\n /** Whether order was refunded manually. For example, via payment provider or using cash. */\n manual?: boolean;\n /** Refund amount. */\n amount?: Price$1;\n /** Reason for refund. */\n reason?: string;\n }\n interface OrderCreatedFromExchange {\n /** ID of the original order for which the exchange happened. */\n originalOrderId?: string;\n }\n interface NewExchangeOrderCreated {\n /** ID of the new order created as a result of an exchange of items. */\n exchangeOrderId?: string;\n /** IDs of the items that were exchanged. */\n lineItems?: LineItemExchangeData[];\n }\n interface LineItemExchangeData {\n /** ID of the exchanged line item. */\n lineItemId?: string;\n /** Line item quantity being exchanged. */\n quantity?: number;\n }\n interface DraftOrderChangesApplied {\n /** Draft order id. */\n draftOrderId?: string;\n /** Reason for edit, given by user (optional). */\n reason?: string | null;\n /** Changes applied to order. */\n changes?: OrderChange[];\n }\n interface OrderChange extends OrderChangeValueOneOf {\n lineItemChanged?: LineItemChanges;\n lineItemAdded?: ManagedLineItem;\n lineItemRemoved?: ManagedLineItem;\n discountAdded?: ManagedDiscount;\n discountRemoved?: ManagedDiscount;\n additionalFeeAdded?: ManagedAdditionalFee;\n additionalFeeRemoved?: ManagedAdditionalFee;\n totalPriceChanged?: TotalPriceChange;\n shippingInformationChanged?: ShippingInformationChange;\n }\n /** @oneof */\n interface OrderChangeValueOneOf {\n lineItemChanged?: LineItemChanges;\n lineItemAdded?: ManagedLineItem;\n lineItemRemoved?: ManagedLineItem;\n discountAdded?: ManagedDiscount;\n discountRemoved?: ManagedDiscount;\n additionalFeeAdded?: ManagedAdditionalFee;\n additionalFeeRemoved?: ManagedAdditionalFee;\n totalPriceChanged?: TotalPriceChange;\n shippingInformationChanged?: ShippingInformationChange;\n }\n interface LineItemChanges {\n /** Line item ID. */\n _id?: string;\n /** Item name. */\n name?: ProductName;\n /** Item quantity change. */\n quantity?: LineItemQuantityChange;\n /** Item price change. */\n price?: LineItemPriceChange;\n }\n interface LineItemQuantityChange {\n /** Item quantity before update. */\n originalQuantity?: number;\n /** Item quantity after update. */\n newQuantity?: number;\n /** Difference between original and new quantity. Absolute value. */\n diff?: number;\n /** Type of quantity change: increase or decrease. */\n deltaType?: LineItemQuantityChangeType;\n }\n enum LineItemQuantityChangeType {\n QUANTITY_INCREASED = \"QUANTITY_INCREASED\",\n QUANTITY_DECREASED = \"QUANTITY_DECREASED\"\n }\n interface LineItemPriceChange {\n /** Item price before update. */\n originalPrice?: Price$1;\n /** Item price after update. */\n newPrice?: Price$1;\n }\n interface ManagedLineItem {\n /** Line item ID. */\n _id?: string;\n /** Item name. */\n name?: ProductName;\n /** Added or removed item quantity. */\n quantity?: number;\n }\n interface ManagedDiscount {\n /** Discount id. */\n _id?: string;\n /** Discount name: coupon name / discount rule name / merchant discount description. */\n name?: TranslatedValue;\n /** Line items discount applies to. */\n affectedLineItems?: LineItemAmount[];\n /** Discount amount. */\n totalAmount?: Price$1;\n }\n interface TranslatedValue {\n /** Value in site default language. */\n original?: string;\n /** Translated value. */\n translated?: string | null;\n }\n interface LineItemAmount {\n /** Order line item id */\n _id?: string;\n /** Item name. */\n name?: ProductName;\n /** Amount associated with this item. (Discount amount for item / additional fee amount for item) */\n amount?: Price$1;\n }\n interface ManagedAdditionalFee {\n /** Additional fee id. */\n _id?: string;\n /** Additional fee name. */\n name?: TranslatedValue;\n /** Line items additional fee applies to. */\n affectedLineItems?: LineItemAmount[];\n /** Additional fee amount. */\n totalAmount?: Price$1;\n }\n interface TotalPriceChange {\n /** Order’s total price after discounts and tax. Before update */\n originalTotal?: Price$1;\n /** Order’s total price after discounts and tax. After update */\n newTotal?: Price$1;\n }\n interface ShippingInformationChange {\n /** Order’s Shipping Information. Before update */\n originalShippingInfo?: ShippingInformation;\n /** Order’s Shipping Information. After update */\n newShippingInfo?: ShippingInformation;\n }\n interface ShippingInformation {\n /** Order’s shipping price. */\n total?: Price$1;\n /** Order’s shipping title. */\n shippingTitle?: string;\n }\n /** Payment method is saved for order */\n interface SavedPaymentMethod {\n /** Payment method name */\n name?: string;\n /** Payment method description */\n description?: string | null;\n }\n interface AuthorizedPaymentCreated {\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n /** Payment amount */\n amount?: Price$1;\n /** The last 4 digits of the card number. */\n lastFourDigits?: string | null;\n /** Card issuer's brand. */\n brand?: string | null;\n }\n interface AuthorizedPaymentCaptured {\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n /** Payment amount */\n amount?: Price$1;\n /** The last 4 digits of the card number. */\n lastFourDigits?: string | null;\n /** Card issuer's brand. */\n brand?: string | null;\n }\n interface AuthorizedPaymentVoided {\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n /** Payment amount */\n amount?: Price$1;\n /** The last 4 digits of the card number. */\n lastFourDigits?: string | null;\n /** Card issuer's brand. */\n brand?: string | null;\n }\n enum ActivityType$1 {\n ORDER_REFUNDED = \"ORDER_REFUNDED\",\n ORDER_PLACED = \"ORDER_PLACED\",\n ORDER_PAID = \"ORDER_PAID\",\n ORDER_FULFILLED = \"ORDER_FULFILLED\",\n ORDER_NOT_FULFILLED = \"ORDER_NOT_FULFILLED\",\n ORDER_CANCELED = \"ORDER_CANCELED\",\n DOWNLOAD_LINK_SENT = \"DOWNLOAD_LINK_SENT\",\n TRACKING_NUMBER_ADDED = \"TRACKING_NUMBER_ADDED\",\n TRACKING_NUMBER_EDITED = \"TRACKING_NUMBER_EDITED\",\n TRACKING_LINK_ADDED = \"TRACKING_LINK_ADDED\",\n SHIPPING_CONFIRMATION_EMAIL_SENT = \"SHIPPING_CONFIRMATION_EMAIL_SENT\",\n INVOICE_ADDED = \"INVOICE_ADDED\",\n INVOICE_REMOVED = \"INVOICE_REMOVED\",\n INVOICE_SENT = \"INVOICE_SENT\",\n FULFILLER_EMAIL_SENT = \"FULFILLER_EMAIL_SENT\",\n SHIPPING_ADDRESS_EDITED = \"SHIPPING_ADDRESS_EDITED\",\n EMAIL_EDITED = \"EMAIL_EDITED\",\n PICKUP_READY_EMAIL_SENT = \"PICKUP_READY_EMAIL_SENT\",\n CUSTOM_ACTIVITY = \"CUSTOM_ACTIVITY\",\n MERCHANT_COMMENT = \"MERCHANT_COMMENT\",\n ORDER_CREATED_FROM_EXCHANGE = \"ORDER_CREATED_FROM_EXCHANGE\",\n NEW_EXCHANGE_ORDER_CREATED = \"NEW_EXCHANGE_ORDER_CREATED\",\n ORDER_PARTIALLY_PAID = \"ORDER_PARTIALLY_PAID\",\n DRAFT_ORDER_CHANGES_APPLIED = \"DRAFT_ORDER_CHANGES_APPLIED\",\n SAVED_PAYMENT_METHOD = \"SAVED_PAYMENT_METHOD\",\n AUTHORIZED_PAYMENT_CREATED = \"AUTHORIZED_PAYMENT_CREATED\",\n AUTHORIZED_PAYMENT_CAPTURED = \"AUTHORIZED_PAYMENT_CAPTURED\",\n AUTHORIZED_PAYMENT_VOIDED = \"AUTHORIZED_PAYMENT_VOIDED\"\n }\n enum AttributionSource {\n UNSPECIFIED = \"UNSPECIFIED\",\n FACEBOOK_ADS = \"FACEBOOK_ADS\"\n }\n interface CreatedBy extends CreatedByStringOneOf {\n /**\n * User ID - when the order was created by a Wix user on behalf of a buyer.\n * For example, via POS (point of service).\n */\n userId?: string;\n /** Member ID - when the order was created by a **logged in** site visitor. */\n memberId?: string;\n /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */\n visitorId?: string;\n /** App ID - when the order was created by an external application. */\n appId?: string;\n }\n /** @oneof */\n interface CreatedByStringOneOf {\n /**\n * User ID - when the order was created by a Wix user on behalf of a buyer.\n * For example, via POS (point of service).\n */\n userId?: string;\n /** Member ID - when the order was created by a **logged in** site visitor. */\n memberId?: string;\n /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */\n visitorId?: string;\n /** App ID - when the order was created by an external application. */\n appId?: string;\n }\n interface ChannelInfo$1 {\n /** Sales channel that submitted the order. */\n type?: ChannelType$1;\n /** Reference to an order ID from an external system. */\n externalOrderId?: string | null;\n /** URL to the order in the external system. */\n externalOrderUrl?: string | null;\n }\n enum ChannelType$1 {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n POS = \"POS\",\n EBAY = \"EBAY\",\n AMAZON = \"AMAZON\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\",\n WIX_INVOICES = \"WIX_INVOICES\",\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n WISH = \"WISH\",\n CLASS_PASS = \"CLASS_PASS\",\n GLOBAL_E = \"GLOBAL_E\",\n FACEBOOK = \"FACEBOOK\",\n ETSY = \"ETSY\",\n TIKTOK = \"TIKTOK\",\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CustomField$1 {\n /** Custom field value. */\n value?: any;\n /** Custom field title. */\n title?: string;\n /** Translated custom field title. */\n translatedTitle?: string | null;\n }\n interface BalanceSummary {\n /**\n * Current amount left to pay.\n * @readonly\n */\n balance?: Balance;\n /**\n * Sum of all approved and successful payments.\n *\n * The value includes payments that have subsequently been fully or partially refunded.\n * @readonly\n */\n paid?: Price$1;\n /**\n * Sum of all successfully refunded payments.\n * @readonly\n */\n refunded?: Price$1;\n }\n /**\n * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.\n * `amount` field depends on order payment status:\n * + UNSPECIFIED, NOT_PAID: price_summary.total_price\n * + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price\n * + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0\n */\n interface Balance {\n /**\n * Balance amount.\n *\n * A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made.\n * @readonly\n */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n }\n interface AdditionalFee {\n /** Additional fee's unique code for future processing. */\n code?: string | null;\n /** Name of additional fee. */\n name?: string;\n /** Additional fee's price. */\n price?: Price$1;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails;\n /** SPI implementer's `appId`. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: Price$1;\n /** Additional fee's id. */\n _id?: string;\n /**\n * Optional - Line items associated with this additional fee.\n * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.\n */\n lineItemIds?: string[];\n }\n interface FulfillmentStatusesAggregate {\n /** Unique string values based on Fulfillment entities statuses */\n statuses?: string[] | null;\n }\n interface ExtendedFields {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n /**\n * Common object for tags.\n * Should be use as in this example:\n * message Foo {\n * string id = 1;\n * ...\n * Tags tags = 5\n * }\n *\n * example of taggable entity\n * {\n * id: \"123\"\n * tags: {\n * tags: {\n * tag_ids:[\"11\",\"22\"]\n * },\n * private_tags: {\n * tag_ids: [\"33\", \"44\"]\n * }\n * }\n * }\n */\n interface Tags {\n /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */\n privateTags?: TagList;\n /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */\n tags?: TagList;\n }\n interface TagList {\n /** List of tag IDs */\n tagIds?: string[];\n }\n interface TriggerReindexOrderRequest {\n metasiteId?: string;\n orderId?: string;\n }\n interface SnapshotMessage$1 {\n _id?: string;\n opType?: number;\n }\n /** Triggered when a payment is updated. */\n interface PaymentsUpdated$1 {\n /** Updated order transactions. */\n orderTransactions?: OrderTransactions$1;\n /** List of IDs of the updated payments. */\n paymentIds?: string[];\n /** List of IDs of the updated refunds. */\n refundIds?: string[];\n }\n interface OrderTransactions$1 {\n /** Order ID. */\n orderId?: string;\n /** Record of payments made to the merchant. */\n payments?: Payment$1[];\n /** Record of refunds made to the buyer. */\n refunds?: Refund$1[];\n }\n interface Payment$1 extends PaymentPaymentDetailsOneOf$1 {\n /** Regular payment details. */\n regularPaymentDetails?: RegularPaymentDetails$1;\n /** Gift card payment details. */\n giftcardPaymentDetails?: GiftCardPaymentDetails$1;\n /**\n * Payment ID.\n * @readonly\n */\n _id?: string | null;\n /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */\n _createdDate?: Date;\n /**\n * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date;\n /** Payment amount. */\n amount?: Price$1;\n /**\n * Whether refunds for this payment are disabled.\n * + `true`: This payment is not refundable.\n * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.\n */\n refundDisabled?: boolean;\n }\n /** @oneof */\n interface PaymentPaymentDetailsOneOf$1 {\n /** Regular payment details. */\n regularPaymentDetails?: RegularPaymentDetails$1;\n /** Gift card payment details. */\n giftcardPaymentDetails?: GiftCardPaymentDetails$1;\n }\n interface RegularPaymentDetails$1 extends RegularPaymentDetailsPaymentMethodDetailsOneOf {\n /** Wix Payments order ID. */\n paymentOrderId?: string | null;\n /**\n * Payment gateway's transaction ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\n * This field is only returned when the value of `offline_payment` is `false`.\n */\n gatewayTransactionId?: string | null;\n /**\n * Payment method. Non-exhaustive list of supported values:\n * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`\n */\n paymentMethod?: string | null;\n /** Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments. */\n providerTransactionId?: string | null;\n /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */\n offlinePayment?: boolean;\n /** Payment status. */\n status?: TransactionStatus$1;\n /** Whether there is a payment agreement that allows for future charges. */\n savedPaymentMethod?: boolean;\n }\n /** @oneof */\n interface RegularPaymentDetailsPaymentMethodDetailsOneOf {\n }\n enum TransactionStatus$1 {\n UNDEFINED = \"UNDEFINED\",\n APPROVED = \"APPROVED\",\n PENDING = \"PENDING\",\n PENDING_MERCHANT = \"PENDING_MERCHANT\",\n CANCELED = \"CANCELED\",\n DECLINED = \"DECLINED\",\n REFUNDED = \"REFUNDED\",\n PARTIALLY_REFUNDED = \"PARTIALLY_REFUNDED\",\n AUTHORIZED = \"AUTHORIZED\",\n VOIDED = \"VOIDED\"\n }\n interface CreditCardPaymentMethodDetails {\n }\n interface AuthorizationDetails {\n }\n interface AuthorizationCapture {\n /**\n * Capture ID.\n * @readonly\n */\n _id?: string | null;\n }\n enum AuthorizationCaptureStatus {\n /** Whether capture operation still in progress */\n PENDING = \"PENDING\",\n /** The capture operation was succeeded */\n SUCCEEDED = \"SUCCEEDED\",\n /** The capture operation was failed */\n FAILED = \"FAILED\"\n }\n interface AuthorizationActionFailureDetails {\n }\n interface AuthorizationVoid {\n }\n enum AuthorizationVoidStatus {\n /** Whether void operation still in progress */\n PENDING = \"PENDING\",\n /** The void operation was succeeded */\n SUCCEEDED = \"SUCCEEDED\",\n /** The void operation was failed */\n FAILED = \"FAILED\"\n }\n /**\n * Reason the authorization was voided.\n *\n * + `MANUAL`: Authorization was voided by user.\n * + `SCHEDULED`: Authorization passed execution date.\n */\n enum Reason {\n UNKNOWN_REASON = \"UNKNOWN_REASON\",\n MANUAL = \"MANUAL\",\n SCHEDULED = \"SCHEDULED\"\n }\n interface ScheduledAction {\n /** type of the action */\n actionType?: ActionType;\n /** the date and time of the action */\n executionDate?: Date;\n }\n enum ActionType {\n UNKNOWN_ACTION_TYPE = \"UNKNOWN_ACTION_TYPE\",\n VOID = \"VOID\",\n CAPTURE = \"CAPTURE\"\n }\n interface GiftCardPaymentDetails$1 {\n /** Gift card payment ID. */\n giftCardPaymentId?: string;\n /** ID of the app that created the gift card. */\n appId?: string;\n /**\n * Whether the gift card is voided.\n * @readonly\n */\n voided?: boolean;\n }\n interface MembershipPaymentDetails$1 {\n /** Membership ID. */\n membershipId?: string;\n /** ID of the line item this membership applies to. */\n lineItemId?: string;\n /** Payment status. */\n status?: MembershipPaymentStatus$1;\n /** Membership name. */\n name?: MembershipName$1;\n /** The transaction ID in the membership system. Can be used to void the transaction. */\n externalTransactionId?: string | null;\n /**\n * Whether the membership is voided.\n * @readonly\n */\n voided?: boolean;\n /** ID of the application providing this payment option. */\n providerAppId?: string;\n }\n enum MembershipPaymentStatus$1 {\n /** CHARGED - Payment was charged */\n CHARGED = \"CHARGED\",\n /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */\n CHARGE_FAILED = \"CHARGE_FAILED\"\n }\n interface MembershipName$1 {\n /** The name of this membership */\n original?: string;\n /** Optional - Translated name of this membership. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface Refund$1 {\n /**\n * Refund ID.\n * @readonly\n */\n _id?: string;\n /** List of transactions. */\n transactions?: RefundTransaction$1[];\n /** Refund business details. */\n details?: RefundDetails$1;\n /** Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */\n _createdDate?: Date;\n }\n interface RefundTransaction$1 {\n /** ID of the payment associated with this refund. */\n paymentId?: string;\n /** Refund amount. */\n amount?: Price$1;\n /** Refund status. */\n refundStatus?: RefundStatus$1;\n /**\n * Payment gateway's refund ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\n * This field is only returned when the value of `external_refund` is `false`.\n */\n gatewayRefundId?: string | null;\n /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */\n providerRefundId?: string | null;\n /** Whether refund was made externally and manually on the payment provider's side. */\n externalRefund?: boolean;\n }\n enum RefundStatus$1 {\n PENDING = \"PENDING\",\n SUCCEEDED = \"SUCCEEDED\",\n FAILED = \"FAILED\"\n }\n /** Business model of a refund request */\n interface RefundDetails$1 {\n /** Order line item IDs and quantities that were refunded. */\n items?: RefundItem$1[];\n /** Whether the shipping fee was also refunded. */\n shippingIncluded?: boolean;\n /** Reason for the refund, provided by customer (optional). */\n reason?: string | null;\n }\n interface RefundItem$1 {\n /** Line item ID the refunded line item. */\n lineItemId?: string;\n /** Line item quantity refunded. */\n quantity?: number;\n }\n interface LineItemRefund {\n }\n interface AdditionalFeeRefund {\n }\n interface ShippingRefund {\n }\n interface AggregatedRefundSummary {\n }\n interface GetMetasiteDataRequest {\n /** meta site Id for data to retrieve */\n metasiteId: string;\n }\n interface GetMetasiteDataResponse {\n /** meta site data */\n metasite?: MetaSite;\n /** is metasite added to new SDL population via population manager */\n isInNewPopulation?: boolean;\n /** metasite url */\n metasiteUrl?: string;\n /** owner data */\n userDataResponse?: UserDataResponse;\n }\n /**\n * Represents Meta Site.\n *\n * Meta Site is a legacy concept, it aggregates data from several domains. Generally, it contains and manages\n * relations between different entities related to the site (or, as a new concept, to the container).\n *\n * We prefer to pronounce it as 2 separate words, therefore we use terms \"meta site\" or \"metaSite\" or \"meta_site\" in code.\n */\n interface MetaSite {\n /**\n * Identifier of meta site.\n * @readonly\n */\n metaSiteId?: string;\n /**\n * Internal version of meta site. Monotonically increasing number.\n *\n * If passed within update request, it will be used for optimistic locking. In this case,\n * StaleStateException will be thrown if current version doesn't match.\n *\n * In old MetaSiteDTO -- revision.\n * @readonly\n */\n version?: string;\n /**\n * Identifier of account that owns this meta site.\n * @readonly\n */\n ownerId?: string;\n /**\n * Date and time when meta site was created.\n * @readonly\n */\n dateCreated?: Date;\n /**\n * Date and time when meta site was updated for the last time.\n * @readonly\n */\n dateUpdated?: Date;\n /**\n * All \"applications\" of this meta site.\n *\n * In old MetaSiteDTO -- embeddedServices.\n */\n apps?: App[];\n /** Namespace of meta site. */\n namespace?: Namespace;\n /**\n * Indicates whether https should be used for viewing a site.\n *\n * In old MetaSiteDTO -- flags.UseHttps.\n */\n useHttps?: boolean;\n defaultSeoData?: SeoData;\n /**\n * Information about HTML application.\n *\n * In old MetaSiteDTO -- appplications.find(_.applicationType == HtmlWeb).\n */\n htmlApp?: HtmlApplication;\n /** @deprecated */\n externalUriMappings?: ExternalUriMapping[];\n /** Indicates whether meta site was published. If true - site should be accessible for viewing. */\n published?: boolean;\n /**\n * The name of meta site.\n *\n * Matches this regular expression: [a-z0-9_\\-]{4,20} (but for some legacy sites might be shorted/longer).\n */\n name?: string;\n /**\n * Indicates whether this site is managed by ADI editor\n *\n * Values:\n * None - not managed.\n * Some(false) - site was created via ADI editor, but later on user switched to regular editor.\n * Some(true) - site was created and still is managed by ADI editor.\n *\n * In old MetaSiteDTO: embeddedService[embeddedServiceType=Onboarding].attributes.isInUse.\n */\n adi?: boolean | null;\n /**\n * Indicates whether this meta site is template.\n *\n * In old MetaSiteDTO: documentType == Template.\n * @readonly\n */\n template?: boolean | null;\n /**\n * Identifier of a template (meta site) from which this site was created.\n *\n * If it's empty it either means that site wasn't created from a template OR it's very old, so we didn't store\n * it back then.\n *\n * For example, if \"site\" was created from \"template\", then \"template\"'s id will be in origin_template_id.\n * When \"site\" is cloned, clone will also have \"template\"'s id in origin_instance_id.\n * @readonly\n */\n originTemplateId?: string | null;\n /**\n * Indicates meta site blocked from publishing and added additional filtering in listing API (MSS). READ_ONLY.\n * @readonly\n */\n blocked?: boolean;\n /**\n * If true - default meta site routing (connected domains, free url, ML) is not used for this meta site.\n *\n * Meaning, that if `example.org` is connected to this meta site, `router-server` will return 404 for `example.org`\n * anyway.\n *\n * This flag is set for some sites that have custom mapping in Routes API / wix-pages-bo.\n */\n dontUseDefaultRouting?: boolean;\n /**\n * Indicates the site is used as critical asset and as such is protected. You would be only able to provision applications to this meta site. READ_ONLY.\n * @readonly\n */\n criticalAsset?: boolean;\n }\n interface App {\n /**\n * Identifier of application type (application definition id).\n *\n * Can be both UUID and non-UUID, for example: SiteMembers, Onboarding, CloudSiteExtension etc.\n */\n appDefId?: string;\n /**\n * Identifier of the instance (concrete application, installed on a site).\n *\n * Mostly UUID, but for some specific legacy cases might be something else.\n */\n instanceId?: string;\n /**\n * State of this app (see docs for state).\n * @readonly\n */\n state?: State;\n /**\n * Identifier of the originating application. For example, if this app was part of a template,\n * then an app will get instance_id of that app as origin instance id.\n *\n * If application was provisioned not from some template, it should be empty.\n *\n * Note, it could be == to instance_id (for old sites).\n */\n originInstanceId?: string;\n }\n /**\n * Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,\n * which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)\n */\n enum State {\n UNKNOWN = \"UNKNOWN\",\n /** App is installed on a site. */\n ENABLED = \"ENABLED\",\n /** App is removed from a site (but we preserve it just in case). */\n DISABLED = \"DISABLED\",\n /** App is in \"demo\" mode, meaning that it's in read-only mode (it's in a template OR not installed yet). */\n TEMPLATE = \"TEMPLATE\",\n /** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */\n PENDING = \"PENDING\"\n }\n enum Namespace {\n UNKNOWN_NAMESPACE = \"UNKNOWN_NAMESPACE\",\n /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */\n WIX = \"WIX\",\n /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n SHOUT_OUT = \"SHOUT_OUT\",\n /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ALBUMS = \"ALBUMS\",\n /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n WIX_STORES_TEST_DRIVE = \"WIX_STORES_TEST_DRIVE\",\n /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n HOTELS = \"HOTELS\",\n /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n CLUBS = \"CLUBS\",\n /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ONBOARDING_DRAFT = \"ONBOARDING_DRAFT\",\n /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_SITE = \"DEV_SITE\",\n /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n LOGOS = \"LOGOS\",\n /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n VIDEO_MAKER = \"VIDEO_MAKER\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n PARTNER_DASHBOARD = \"PARTNER_DASHBOARD\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_CENTER_COMPANY = \"DEV_CENTER_COMPANY\",\n /**\n * A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n *\n * Meta site with this namespace will *not* be shown in a user's site list by default.\n */\n HTML_DRAFT = \"HTML_DRAFT\",\n /**\n * the user-journey for Fitness users who want to start from managing their business instead of designing their website.\n * Will be accessible from Site List and will not have a website app.\n * Once the user attaches a site, the site will become a regular wixsite.\n */\n SITELESS_BUSINESS = \"SITELESS_BUSINESS\",\n /** Belongs to \"strategic products\" company. Supports new product in the creator's economy space. */\n CREATOR_ECONOMY = \"CREATOR_ECONOMY\",\n /** It is to be used in the Business First efforts. */\n DASHBOARD_FIRST = \"DASHBOARD_FIRST\",\n /** Bookings business flow with no site. */\n ANYWHERE = \"ANYWHERE\",\n /** Namespace for Headless Backoffice with no editor */\n HEADLESS = \"HEADLESS\",\n /**\n * Namespace for master site that will exist in parent account that will be referenced by subaccounts\n * The site will be used for account level CSM feature for enterprise\n */\n ACCOUNT_MASTER_CMS = \"ACCOUNT_MASTER_CMS\",\n /** Rise.ai Siteless account management for Gift Cards and Store Credit. */\n RISE = \"RISE\",\n /**\n * As part of the branded app new funnel, users now can create a meta site that will be branded app first.\n * There's a blank site behind the scene but it's blank).\n * The Mobile company will be the owner of this namespace.\n */\n BRANDED_FIRST = \"BRANDED_FIRST\",\n /** Nownia.com Siteless account management for Ai Scheduling Assistant. */\n NOWNIA = \"NOWNIA\"\n }\n interface SeoData {\n /** A title. */\n title?: string | null;\n /** Indicates whether the site should be indexable by bots. */\n indexable?: boolean;\n /** TDB. */\n suppressTrackingCookies?: boolean;\n /** TDB. */\n ogImage?: string | null;\n /** A list of meta tags. */\n metaTags?: MetaTag[];\n /** A canonical URL for a site. */\n canonicalUrl?: string | null;\n }\n interface MetaTag {\n /** A name. */\n name?: string;\n /** A value. */\n value?: string;\n /** Indicates whether should be rendered as property. */\n property?: boolean;\n }\n /** Represents an HTML application (HTML site). */\n interface HtmlApplication {\n /** Legacy, don't use it if you can. */\n intId?: number;\n /** Identifier of the instance. */\n instanceId?: string;\n seoData?: SeoData;\n /** Language of this site. */\n languageCode?: string;\n /** File name for thumbnail. */\n thumbnail?: string | null;\n /** Indicates whether this site is managed by EditorX. */\n editorX?: boolean;\n /** Indicates whether this site is managed by Wix Studio. */\n studio?: boolean;\n }\n interface ExternalUriMapping {\n /** Deprecated. */\n fromExternalUri?: string;\n /** Deprecated. */\n toWixUri?: string;\n /** Deprecated. */\n oldToWixUri?: string | null;\n /** Deprecated. */\n requireDomain?: boolean | null;\n }\n interface UserDataResponse {\n userEmail?: string;\n /** owner name */\n userName?: string;\n /** owner status */\n userStatus?: string;\n /** owner language */\n userLanguage?: string;\n }\n interface QueryOrdersForMetasiteRequest {\n /** meta site Id for EP orders to retrieve */\n metasiteId: string;\n /** paginated internal orders query request */\n internalQueryOrdersRequest?: InternalQueryOrdersRequest;\n }\n interface InternalQueryOrdersRequest {\n /** Query options. */\n query?: PlatformQuery;\n }\n interface PlatformQuery extends PlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting[];\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformPaging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryOrdersForMetasiteResponse {\n /** found exisitng orders according to pagination and query provided. */\n orders?: Order$1[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PlatformPagingMetadata;\n }\n interface PlatformPagingMetadata {\n /** The number of items returned in this response. */\n count?: number | null;\n /** The offset which was requested. Returned if offset paging was used. */\n offset?: number | null;\n /** The total number of items that match the query. Returned if offset paging was used. */\n total?: number | null;\n /** Cursors to navigate through result pages. Returned if cursor paging was used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface GetOrderForMetasiteRequest {\n /** meta site Id for EP order to retrieve */\n metasiteId: string;\n /** Order Id for EP order to retrieve */\n orderId: string;\n }\n interface GetOrderForMetasiteResponse {\n /** Existing EP order */\n order?: Order$1;\n }\n interface ListOrderTransactionsForMetasiteRequest {\n /** meta site Id for EP order transactions to retrieve */\n metasiteId: string;\n /** Order Id for EP order transactions to retrieve */\n orderId: string;\n }\n interface ListOrderTransactionsForMetasiteResponse {\n /** Order ID and its associated transactions. */\n orderTransactions?: OrderTransactions$1;\n }\n interface TestUrlAdditionalBindingsRequest {\n }\n interface TestUrlAdditionalBindingsResponse {\n responseString?: string;\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n }\n interface RestoreInfo$2 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$3;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: InternalDocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update internal documents matching filter */\n updateByFilter?: InternalDocumentUpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: InternalUpdateExistingOperation;\n /** insert/update documents with versioning */\n versionedUpdate?: VersionedDocumentUpdateOperation;\n /** delete by document ids with versioning */\n versionedDeleteByIds?: VersionedDeleteByIdsOperation;\n /** type of the documents */\n documentType?: string;\n /** language of the documents (mandatory) */\n language?: string | null;\n /**\n * one or more search documents\n * @deprecated\n */\n addDocuments?: InternalDocument[];\n /**\n * one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)\n * @deprecated\n */\n removeDocumentIds?: string[];\n /** id to pass to processing notification */\n correlationId?: string | null;\n }\n /** @oneof */\n interface UpdateInternalDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: InternalDocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update internal documents matching filter */\n updateByFilter?: InternalDocumentUpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: InternalUpdateExistingOperation;\n /** insert/update documents with versioning */\n versionedUpdate?: VersionedDocumentUpdateOperation;\n /** delete by document ids with versioning */\n versionedDeleteByIds?: VersionedDeleteByIdsOperation;\n }\n interface InternalDocument {\n /** document with mandatory fields (id) and with fields specific to the type of the document */\n document?: Record | null;\n }\n interface InternalDocumentUpdateOperation {\n /** documents to index or update */\n documents?: InternalDocument[];\n }\n interface DeleteByIdsOperation {\n /** ids of the documents to delete */\n documentIds?: string[];\n }\n interface DeleteByFilterOperation {\n /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */\n filter?: Record | null;\n }\n interface InternalDocumentUpdateByFilterOperation {\n /** documents matching this filter will be updated */\n filter?: Record | null;\n /** partial document to apply */\n document?: InternalDocument;\n }\n interface InternalUpdateExistingOperation {\n /** documents to update */\n documents?: InternalDocument[];\n }\n interface VersionedDocumentUpdateOperation {\n /** documents to create or overwrite */\n documents?: InternalDocument[];\n /** versioning mode to use instead of default */\n versioningMode?: VersioningMode;\n }\n enum VersioningMode {\n /** use default versioning mode agreed with search team */\n DEFAULT = \"DEFAULT\",\n /** execute only if version is greater than existing */\n GREATER_THAN = \"GREATER_THAN\",\n /** execute only if version is greater or equal to existing */\n GREATER_OR_EQUAL = \"GREATER_OR_EQUAL\"\n }\n interface VersionedDeleteByIdsOperation {\n /** ids with version of the documents to delete */\n documentIds?: VersionedDocumentId[];\n }\n interface VersionedDocumentId {\n /** document id */\n documentId?: string;\n /** document version */\n version?: string;\n /** versioning mode to use instead of default */\n versioningMode?: VersioningMode;\n }\n interface TriggerReindexRequest {\n metasiteId: string;\n orderIds?: string[];\n }\n interface TriggerReindexResponse {\n }\n interface Empty$1 {\n }\n interface BatchOfTriggerReindexOrderRequest {\n requests?: TriggerReindexOrderRequest[];\n }\n interface SendBuyerConfirmationEmailRequest {\n orderId: string;\n }\n interface SendBuyerConfirmationEmailResponse {\n }\n interface SendBuyerPaymentsReceivedEmailRequest {\n orderId: string;\n }\n interface SendBuyerPaymentsReceivedEmailResponse {\n }\n interface SendBuyerPickupConfirmationEmailRequest {\n orderId: string;\n }\n interface SendBuyerPickupConfirmationEmailResponse {\n }\n interface BulkSendBuyerPickupConfirmationEmailsRequest {\n /** IDs of orders to send pickup emails for. */\n orderIds?: string[];\n }\n interface BulkSendBuyerPickupConfirmationEmailsResponse {\n }\n interface SendBuyerShippingConfirmationEmailRequest {\n orderId: string;\n }\n interface SendBuyerShippingConfirmationEmailResponse {\n }\n interface BulkSendBuyerShippingConfirmationEmailsRequest {\n /** IDs of orders to send pickup emails for. */\n orderIds?: string[];\n }\n interface BulkSendBuyerShippingConfirmationEmailsResponse {\n }\n interface SendMerchantOrderReceivedNotificationRequest {\n orderId: string;\n }\n interface SendMerchantOrderReceivedNotificationResponse {\n }\n interface SendCancelRefundEmailRequest {\n /** The ID of order that is canceled/refunded */\n orderId: string;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund amount */\n refundAmount: Price$1;\n }\n interface SendCancelRefundEmailResponse {\n }\n interface SendMerchantOrderReceivedPushRequest {\n orderId: string;\n }\n interface SendMerchantOrderReceivedPushResponse {\n }\n interface PreviewEmailByTypeRequest {\n emailType: PreviewEmailType;\n }\n enum PreviewEmailType {\n ORDER_PLACED = \"ORDER_PLACED\",\n DOWNLOAD_LINKS = \"DOWNLOAD_LINKS\",\n ORDER_SHIPPED = \"ORDER_SHIPPED\",\n ORDER_READY_FOR_PICKUP = \"ORDER_READY_FOR_PICKUP\"\n }\n interface PreviewEmailByTypeResponse {\n emailPreview?: string;\n }\n interface PreviewRefundEmailRequest {\n orderId: string;\n /** Refund amount */\n refundAmount: Price$1;\n /** Refund business details */\n details?: RefundDetails$1;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n }\n interface PreviewRefundEmailResponse {\n emailPreview?: string;\n }\n interface PreviewCancelEmailRequest {\n orderId: string;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n }\n interface PreviewCancelEmailResponse {\n emailPreview?: string;\n }\n interface PreviewCancelRefundEmailRequest {\n orderId: string;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund amount */\n refundAmount?: Price$1;\n }\n interface PreviewCancelRefundEmailResponse {\n emailPreview?: string;\n }\n interface PreviewBuyerPaymentsReceivedEmailRequest {\n }\n interface PreviewBuyerPaymentsReceivedEmailResponse {\n emailPreview?: string;\n }\n interface PreviewBuyerConfirmationEmailRequest {\n }\n interface PreviewBuyerConfirmationEmailResponse {\n emailPreview?: string;\n }\n interface PreviewBuyerPickupConfirmationEmailRequest {\n }\n interface PreviewBuyerPickupConfirmationEmailResponse {\n emailPreview?: string;\n }\n interface PreviewShippingConfirmationEmailRequest {\n }\n interface PreviewShippingConfirmationEmailResponse {\n emailPreview?: string;\n }\n interface PreviewResendDownloadLinksEmailRequest {\n }\n interface PreviewResendDownloadLinksEmailResponse {\n emailPreview?: string;\n }\n interface PreparePaymentCollectionRequest {\n /** Ecom order ID. */\n ecomOrderId: string;\n /** Amount to collect */\n amount: Price$1;\n /**\n * Optional parameter. When present, payment collection will be performed using given payment gateway order.\n * Existing payment gateway order will be updated with a new amount.\n * When parameter is absent, new payment gateway order will be created and used for payment collection.\n */\n paymentGatewayOrderId?: string | null;\n }\n interface RedirectUrls {\n /** URL to redirect buyer in case of approved (successful) transaction */\n successUrl?: string | null;\n /** URL to redirect buyer in case of buyer canceled the transaction */\n cancelUrl?: string | null;\n /** URL to redirect buyer in case of failed/rejected transaction */\n errorUrl?: string | null;\n /** URL to redirect buyer in case of pending transaction (that might take some time to process) */\n pendingUrl?: string | null;\n }\n interface PreparePaymentCollectionResponse {\n /** Payment gateway order id which is associated with given payment */\n paymentGatewayOrderId?: string;\n }\n interface GetPaymentCollectabilityStatusRequest {\n /** Ecom order ID. */\n ecomOrderId: string;\n }\n interface GetPaymentCollectabilityStatusResponse {\n /** Payment collectability status */\n status?: PaymentCollectabilityStatus;\n /** Collectable order amount */\n amount?: Price$1;\n }\n enum PaymentCollectabilityStatus {\n UNKNOWN = \"UNKNOWN\",\n COLLECTABLE = \"COLLECTABLE\",\n NONCOLLECTABLE_ORDER_IS_CANCELLED = \"NONCOLLECTABLE_ORDER_IS_CANCELLED\",\n NONCOLLECTABLE_ORDER_IS_PAID = \"NONCOLLECTABLE_ORDER_IS_PAID\",\n NONCOLLECTABLE_MISSING_PAYMENT_METHOD = \"NONCOLLECTABLE_MISSING_PAYMENT_METHOD\"\n }\n interface RecordManuallyCollectedPaymentRequest {\n /** Order ID. */\n orderId: string;\n /** Amount to be recorded as approved manual payment for given order */\n amount: Price$1;\n }\n interface RecordManuallyCollectedPaymentResponse {\n }\n interface MarkOrderAsPaidRequest {\n /** Ecom order ID. */\n ecomOrderId: string;\n }\n interface MarkOrderAsPaidResponse {\n /** Updated order. */\n order?: Order$1;\n }\n /** Triggered when the payment status of an order is updated */\n interface PaymentStatusUpdated {\n /** The order that was updated */\n order?: Order$1;\n /** The previous status (before the update) */\n previousPaymentStatus?: PaymentStatus$1;\n }\n interface BulkMarkOrdersAsPaidRequest {\n /** IDs of orders to mark as paid. */\n ecomOrderIds: string[];\n }\n interface BulkMarkOrdersAsPaidResponse {\n /**\n * Items updated by the bulk action.\n * The Order entity within the results optimistically changes its payment status to paid, however this process is async.\n */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkOrderResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata$1;\n /**\n * Updated order.\n *\n * Returned when `returnFullEntity = true`.\n */\n item?: Order$1;\n }\n interface ItemMetadata$1 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$1;\n }\n interface ApplicationError$1 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$1 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetRefundabilityStatusRequest$1 {\n /** Order ID. */\n ecomOrderId: string;\n }\n interface GetRefundabilityStatusResponse$1 {\n /** Refundability details. */\n refundabilities?: Refundability$1[];\n /**\n * Whether the order supports refunding per item.\n * @deprecated\n */\n refundablePerItem?: boolean;\n }\n interface Refundability$1 extends RefundabilityAdditionalRefundabilityInfoOneOf$1 {\n /** Reason why payment is not refundable. */\n nonRefundableReason?: NonRefundableReason$1;\n /** Reason why payment is only refundable manually. */\n manuallyRefundableReason?: ManuallyRefundableReason$1;\n /** Payment ID. */\n paymentId?: string;\n /** Payment refundability status. */\n refundabilityStatus?: RefundableStatus$1;\n /** Link to payment provider dashboard. */\n providerLink?: string | null;\n }\n /** @oneof */\n interface RefundabilityAdditionalRefundabilityInfoOneOf$1 {\n /** Reason why payment is not refundable. */\n nonRefundableReason?: NonRefundableReason$1;\n /** Reason why payment is only refundable manually. */\n manuallyRefundableReason?: ManuallyRefundableReason$1;\n }\n enum RefundableStatus$1 {\n NOT_REFUNDABLE = \"NOT_REFUNDABLE\",\n MANUAL = \"MANUAL\",\n REFUNDABLE = \"REFUNDABLE\"\n }\n enum NonRefundableReason$1 {\n NONE = \"NONE\",\n ALREADY_REFUNDED = \"ALREADY_REFUNDED\",\n PROVIDER_IS_DOWN = \"PROVIDER_IS_DOWN\",\n INTERNAL_ERROR = \"INTERNAL_ERROR\",\n NOT_PAID = \"NOT_PAID\",\n ACCESS_DENIED = \"ACCESS_DENIED\",\n ZERO_PRICE = \"ZERO_PRICE\",\n DISABLED_BY_PROVIDER = \"DISABLED_BY_PROVIDER\",\n PENDING_REFUND = \"PENDING_REFUND\",\n FORBIDDEN = \"FORBIDDEN\",\n TRANSACTION_NOT_FOUND = \"TRANSACTION_NOT_FOUND\"\n }\n enum ManuallyRefundableReason$1 {\n EXPIRED = \"EXPIRED\",\n NOT_SUPPORTED = \"NOT_SUPPORTED\",\n OFFLINE = \"OFFLINE\"\n }\n interface CreatePaymentGatewayOrderRequest {\n /** Ecom order ID. */\n ecomOrderId: string;\n /** Information about the user who initiated the payment. */\n chargedBy?: ChargedBy;\n }\n interface ChargedBy {\n /** ID - id of the user who initiated the payment */\n _id?: string;\n /** Full name - name of the user who initiated the payment */\n fullName?: string | null;\n }\n interface CreatePaymentGatewayOrderResponse {\n /** ID of the order created in the payment gateway */\n paymentGatewayOrderId?: string;\n }\n interface ChargeMembershipsRequest {\n /** Order ID. */\n ecomOrderId: string;\n /**\n * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member\n * but a user which is using the membership on behalf of the a member\n */\n memberId: string;\n /** List of items to be paid by memberships */\n membershipCharges?: MembershipChargeItem[];\n }\n interface MembershipChargeItem {\n /** The id of used membership */\n membershipId?: string;\n /** ID of the application providing this payment option */\n appId?: string;\n /** The name of used membership */\n membershipName?: MembershipName$1;\n /** Additional data about this membership */\n membershipAdditionalData?: Record | null;\n /** Catalog and item reference info. */\n catalogReference?: CatalogReference;\n /** Properties of the service. When relevant, contains information such as date and number of participants. */\n serviceProperties?: ServiceProperties;\n /**\n * Usually would be the same as catalogReference.catalogItemId\n * For cases when these are not the same, this field would return the actual id of the item in the catalog\n * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id\n */\n rootCatalogItemId?: string | null;\n /** line item id of Checkout/Order line item */\n lineItemId?: string;\n }\n interface ServiceProperties {\n /**\n * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * For example, the start time of a class.\n */\n scheduledDate?: Date;\n /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface ChargeMembershipsResponse {\n }\n interface TriggerRefundRequest$1 {\n /** The order this refund related to */\n ecomOrderId: string;\n /** Refund operations information */\n payments: PaymentRefund$1[];\n /** Business model of a refund */\n details?: RefundDetails$1;\n /** Side effect details related to refund */\n sideEffects?: RefundSideEffects$1;\n }\n interface PaymentRefund$1 {\n /** Specific payment within the order to refund */\n paymentId?: string;\n /** Refund amount. Not relevant for membership and gift card refunds. */\n amount?: Price$1;\n /**\n * Whether refund is made externally and manually (on the payment provider's side)\n * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.\n * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.\n */\n externalRefund?: boolean;\n }\n interface RefundSideEffects$1 {\n /** Inventory restock details as part of this refund. */\n restockInfo?: RestockInfo$1;\n /** Whether to send a refund confirmation email to the customer. */\n sendOrderRefundedEmail?: boolean;\n /** Custom message added to the refund confirmation email. */\n customMessage?: string | null;\n }\n interface RestockInfo$1 {\n /** Restock type. */\n type?: RestockType$1;\n /** Restocked line items and quantities. Only relevant for `{\"type\": \"SOME_ITEMS\"}`. */\n items?: RestockItem$1[];\n }\n enum RestockType$1 {\n NO_ITEMS = \"NO_ITEMS\",\n ALL_ITEMS = \"ALL_ITEMS\",\n SOME_ITEMS = \"SOME_ITEMS\"\n }\n interface RestockItem$1 {\n /** ID of the line item being restocked. */\n lineItemId?: string;\n /** Line item quantity being restocked. */\n quantity?: number;\n }\n interface TriggerRefundResponse$1 {\n /** All order's transactions after the refunds were added */\n orderTransactions?: OrderTransactions$1;\n /** Created refund ID */\n refundId?: string | null;\n /** Payment ID's that the refund execution had failed for */\n failedPaymentIds?: ItemMetadata$1[];\n }\n /** Triggered when a refund is created. */\n interface RefundCreated$1 {\n /** Updated order transactions. */\n orderTransactions?: OrderTransactions$1;\n /** ID of the created refund. */\n refundId?: string;\n /** Inventory restock details as part of this refund.. */\n restockInfo?: RestockInfo$1;\n /** Whether to send a refund confirmation email to the customer. */\n sendOrderRefundedEmail?: boolean;\n /** Custom message added to the refund confirmation email. */\n customMessage?: string | null;\n /** Refunded line items and quantities that are part of the created refund. */\n refundItems?: RefundItem$1[];\n }\n interface CalculateRefundRequest$1 {\n /** Order ID */\n ecomOrderId: string;\n /** Refunded line items and quantity */\n refundItems?: CalculateRefundItemRequest$1[];\n /** Should include shipping in refund calculation */\n refundShipping?: boolean;\n }\n interface CalculateRefundItemRequest$1 {\n /** ID of the line item being refunded */\n _id?: string;\n /** How much of that line item is being refunded */\n quantity?: number;\n }\n interface CalculateRefundResponse$1 {\n /** Total refundable amount */\n total?: Price$1;\n /** Tax cost of the order */\n tax?: Price$1;\n /** Discount given for this order */\n discount?: Price$1;\n /** Total cost of the order (without tax) */\n subtotal?: Price$1;\n /** Total shipping cost for order */\n shipping?: Price$1;\n /** Previous refund given on that order */\n previouslyRefundedAmount?: Price$1;\n /** The refundable items of that order */\n items?: CalculateRefundItemResponse$1[];\n }\n interface CalculateRefundItemResponse$1 {\n /** Line item ID */\n _id?: string;\n /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */\n price?: Price$1;\n }\n interface VoidAuthorizedPaymentsRequest {\n /** Wix eCommerce order ID */\n ecomOrderId: string;\n /** Payment IDs */\n paymentIds: string[];\n }\n interface VoidAuthorizedPaymentsResponse {\n /** All order's transactions after the void was triggered */\n orderTransactions?: OrderTransactions$1;\n }\n interface CaptureAuthorizedPaymentsRequest {\n /** Wix eCommerce order ID */\n ecomOrderId: string;\n /** Capture payments information */\n payments: PaymentCapture[];\n }\n interface PaymentCapture {\n /** Payment ID */\n paymentId?: string | null;\n /**\n * Capture amount.\n * If not provided - full authorized amount will be captured.\n */\n amount?: Price$1;\n }\n interface CaptureAuthorizedPaymentsResponse {\n /** All order's transactions after the capture was triggered */\n orderTransactions?: OrderTransactions$1;\n }\n interface ChargeSavedPaymentMethodRequest {\n /** Ecom Order ID. */\n ecomOrderId: string;\n /** Amount to be charged */\n amount: Price$1;\n }\n interface ChargeSavedPaymentMethodResponse {\n /** Payment gateway's order ID (e.g Wix Payments) */\n paymentGatewayOrderId?: string;\n }\n interface DiffmatokyPayload$1 {\n left?: string;\n right?: string;\n compareChannel?: string;\n entityId?: string;\n errorInformation?: ErrorInformation$1;\n tags?: string[];\n }\n interface ErrorInformation$1 {\n stackTrace?: string;\n }\n interface ContinueSideEffectsFlowInLegacyData {\n storeId?: string;\n orderId?: string;\n ordersExperiments?: OrdersExperiments;\n }\n interface OrdersExperiments {\n epCommitTax?: boolean;\n moveMerchantEmailToEp?: boolean;\n moveBuyerOrderConfirmationEmailToEp?: boolean;\n producedByEpBridge?: boolean;\n enableRewrittenSideEffects?: boolean;\n }\n interface IndexingMessage$1 {\n _id?: string;\n opType?: number;\n requiredVersions?: string[];\n }\n interface GetOrderRequest {\n /** ID of the order to retrieve. */\n _id: string;\n }\n interface GetOrderResponse {\n /** The requested order. */\n order?: Order$1;\n }\n interface InternalQueryOrdersResponse {\n /** List of orders. */\n orders?: Order$1[];\n /** Details on the paged set of results returned. */\n metadata?: PlatformPagingMetadata;\n }\n interface QueryOrderRequest {\n /** Query options. */\n query?: PlatformQuery;\n }\n interface QueryOrderResponse {\n /** List of orders. */\n orders?: Order$1[];\n /** Details on the paged set of results returned. */\n metadata?: PlatformPagingMetadata;\n }\n interface SearchOrdersRequest {\n /** Search options. */\n search?: CursorSearch;\n }\n interface CursorSearch extends CursorSearchPagingMethodOneOf {\n /**\n * Cursor paging options.\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging;\n /**\n * Filter object.\n *\n * For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:\n *\n * `\"filter\": {\"paymentStatus\": {\"$in\": [\"PAID\", \"PARTIALLY_PAID\"]}}`\n *\n * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Array of sort objects that specify the order in which results should be sorted.\n *\n * For example, the following `sort` array will sort by `createdDate` in descending order:\n *\n * `\"sort\": [{\"fieldName\": \"createdDate\", \"order\":\"DESC\"}]`.\n *\n * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting[];\n }\n /** @oneof */\n interface CursorSearchPagingMethodOneOf {\n /**\n * Cursor paging options.\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging;\n }\n interface SearchOrdersResponse {\n /** List of orders. */\n orders?: Order$1[];\n /** Details on the paged set of results returned. */\n metadata?: CursorPagingMetadata;\n }\n interface CursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface CreateOrderRequest {\n /** Order info. */\n order: Order$1;\n }\n interface OrderCreationSettings {\n }\n enum OrderApprovalStrategy {\n DEFAULT = \"DEFAULT\",\n PAYMENT_RECEIVED = \"PAYMENT_RECEIVED\",\n PAYMENT_METHOD_SAVED = \"PAYMENT_METHOD_SAVED\"\n }\n interface OrderCreateNotifications {\n }\n interface CreateOrderResponse {\n /** Newly created order. */\n order?: Order$1;\n }\n interface UpdateOrderRequest {\n /** Order to be updated. */\n order: Order$1;\n }\n interface UpdateOrderResponse {\n /** Newly created order. */\n order?: Order$1;\n }\n interface BulkUpdateOrdersRequest {\n /** Orders to update. */\n orders: MaskedOrder[];\n /**\n * Whether to return the full order entities.\n *\n * Default: `false`\n */\n returnEntity?: boolean;\n }\n interface MaskedOrder {\n /** Order to be updated. */\n order?: Order$1;\n }\n interface BulkUpdateOrdersResponse {\n /** Bulk action results. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface CommitDeltasRequest {\n /** Order id to be updated */\n _id: string;\n /**\n * Draft order Id representing this change.\n * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get\n */\n draftOrderId?: string;\n /** Draft order changes to be applied */\n changes: DraftOrderDiffs;\n /** Side-effects to happen after order is updated */\n commitSettings?: DraftOrderCommitSettings;\n /** Reason for edit, given by user (optional). */\n reason?: string | null;\n }\n interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {\n /** Shipping info and selected shipping option details. */\n changedShippingInfo?: V1ShippingInformation;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n /** Added/updated/removed order line items. */\n lineItems?: V1LineItemDelta[];\n /**\n * Added/updated/removed discounts.\n * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts\n */\n appliedDiscounts?: AppliedDiscountDelta[];\n /** Added/updated/removed additional fee. */\n additionalFees?: AdditionalFeeDelta[];\n /**\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Updated Tax summary. overwrites existing tax summary.\n * @deprecated Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Updated Tax summary. overwrites existing tax summary.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxSummary?: TaxSummary;\n /**\n * Updated order price summary. overwrites existing price summary.\n * balance will be updated automatically.\n */\n priceSummary?: PriceSummary;\n }\n /** @oneof */\n interface DraftOrderDiffsShippingUpdateInfoOneOf {\n /** Shipping info and selected shipping option details. */\n changedShippingInfo?: V1ShippingInformation;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n }\n /** @oneof */\n interface DraftOrderDiffsBuyerUpdateInfoOneOf {\n }\n /** @oneof */\n interface DraftOrderDiffsBillingUpdateInfoOneOf {\n }\n /** @oneof */\n interface DraftOrderDiffsRecipientUpdateInfoOneOf {\n }\n interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {\n /** The line item was added. */\n lineItemAdded?: boolean;\n /** The line item was modified. */\n changedDetails?: ItemChangedDetails;\n /** The line item was added. */\n lineItemRemoved?: boolean;\n /** Line item ID. */\n lineItemId?: string;\n lineItem?: OrderLineItemChangedDetails;\n }\n /** @oneof */\n interface V1LineItemDeltaDeltaOneOf {\n /** The line item was added. */\n lineItemAdded?: boolean;\n /** The line item was modified. */\n changedDetails?: ItemChangedDetails;\n /** The line item was added. */\n lineItemRemoved?: boolean;\n }\n interface OrderLineItemChangedDetails {\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n */\n productName?: ProductName;\n /**\n * References to the line item's origin catalog.\n * This field is empty in the case of a custom line item.\n */\n catalogReference?: CatalogReference;\n /** Line item quantity. */\n quantity?: number;\n /** Total discount for this line item's entire quantity. */\n totalDiscount?: Price$1;\n /** Line item description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine[];\n /** Line item image. */\n image?: string;\n /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */\n physicalProperties?: PhysicalProperties;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType;\n /**\n * Fulfiller ID. Field is empty when the line item is self-fulfilled.\n *\n * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).\n */\n fulfillerId?: string | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$1;\n /** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: Price$1;\n /** Total price after all discounts and tax. */\n totalPriceAfterTax?: Price$1;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n */\n paymentOption?: DeltaPaymentOptionType;\n /**\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax details for this line item.\n * @deprecated Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax details for this line item.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxDetails?: ItemTaxFullDetails;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription;\n /** Total price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: Price$1;\n /** Total price after all discounts excluding tax. */\n totalPriceBeforeTax?: Price$1;\n }\n /** Type of selected payment option for catalog item */\n enum DeltaPaymentOptionType {\n /** irrelevant */\n UNKNOWN_PAYMENT_OPTION = \"UNKNOWN_PAYMENT_OPTION\",\n /** The entire payment for given item will happen after the checkout. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /**\n * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.\n * Note: when this option is used, price will be 0.\n */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface ItemChangedDetails {\n /** The quantity before the change. */\n quantityBeforeChange?: number | null;\n /** The price before the change. */\n priceBeforeChange?: Price$1;\n /** The price description before the change */\n priceDescriptionBeforeChange?: PriceDescription;\n }\n interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {\n editedDiscount?: AppliedDiscount;\n discountRemoved?: boolean;\n /** Discount id. */\n discountId?: string;\n }\n /** @oneof */\n interface AppliedDiscountDeltaDeltaOneOf {\n editedDiscount?: AppliedDiscount;\n discountRemoved?: boolean;\n }\n interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {\n editedAdditionalFee?: AdditionalFee;\n additionalFeeRemoved?: boolean;\n /** Additional fee id. */\n additionalFeeId?: string;\n }\n /** @oneof */\n interface AdditionalFeeDeltaDeltaOneOf {\n editedAdditionalFee?: AdditionalFee;\n additionalFeeRemoved?: boolean;\n }\n interface DraftOrderCommitSettings {\n /** If false, do not send notifications to buyer. Default is true. */\n sendNotificationsToBuyer?: boolean | null;\n /** If false, do not send notifications to business. Default is true. */\n sendNotificationsToBusiness?: boolean | null;\n /** If false,do not add activities to the order. Default is true. */\n addActivitiesToOrder?: boolean | null;\n /** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */\n sendNotificationsToCustomFulfillers?: boolean | null;\n /** Inventory changes to be applied. Either to restock, or decrease. */\n inventoryUpdates?: InventoryUpdateDetails[];\n }\n interface InventoryUpdateDetails {\n /** Action to be applied - decrease or restock */\n actionType?: InventoryAction;\n /** Order line item id */\n lineItemId?: string;\n /** The amount to be increased or restocked */\n quantityChange?: number;\n }\n enum InventoryAction {\n /** Restock inventory */\n RESTOCK = \"RESTOCK\",\n /** Decrease inventory. Without failing on negative inventory. */\n DECREASE = \"DECREASE\"\n }\n interface CommitDeltasResponse {\n /** Order after deltas are applied */\n order?: Order$1;\n }\n /** Triggered when order is edited by draftOrders */\n interface OrderDeltasCommitted {\n /** The order after committed changes. */\n order?: Order$1;\n /** Draft order Id representing this change. */\n draftOrderId?: string;\n /** Applied changes. */\n changes?: CommittedDiffs;\n /** Side-effects requested to happen as a result of this edit. */\n commitSettings?: DraftOrderCommitSettings;\n /**\n * Date and time when order deltas were committed.\n * @readonly\n */\n commitDate?: Date;\n }\n interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {\n /** Shipping info and selected shipping option details. */\n changedShippingInfo?: V1ShippingInformation;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n /** Added/updated/removed order line items. */\n lineItems?: LineItemDelta[];\n /**\n * Added/updated/removed discounts.\n * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts\n */\n appliedDiscounts?: AppliedDiscountDelta[];\n /** Added/updated/removed additional fee. */\n additionalFees?: AdditionalFeeDelta[];\n }\n /** @oneof */\n interface CommittedDiffsShippingUpdateInfoOneOf {\n /** Shipping info and selected shipping option details. */\n changedShippingInfo?: V1ShippingInformation;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n }\n interface LineItemDelta extends LineItemDeltaDeltaOneOf {\n lineItemAdded?: boolean;\n changedDetails?: ItemChangedDetails;\n lineItemRemoved?: OrderLineItemChangedDetails;\n /** Line item ID. */\n lineItemId?: string;\n }\n /** @oneof */\n interface LineItemDeltaDeltaOneOf {\n lineItemAdded?: boolean;\n changedDetails?: ItemChangedDetails;\n lineItemRemoved?: OrderLineItemChangedDetails;\n }\n interface ArchiveOrderRequest {\n /** Order ID. */\n _id: string;\n }\n interface ArchiveOrderResponse {\n /** Archived order. */\n order?: Order$1;\n }\n interface BulkArchiveOrdersRequest {\n /** IDs of orders to archive. */\n ids: string[];\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkArchiveOrdersResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkArchiveOrdersByFilterRequest {\n /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */\n filter: Record | null;\n }\n interface BulkArchiveOrdersByFilterResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface UnArchiveOrderRequest {\n /** Order ID. */\n _id: string;\n }\n interface UnArchiveOrderResponse {\n /** Unarchived order. */\n order?: Order$1;\n }\n interface BulkUnArchiveOrdersRequest {\n /** IDs or orders to unarchive. */\n ids: string[];\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkUnArchiveOrdersResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkUnArchiveOrdersByFilterRequest {\n /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */\n filter: Record | null;\n }\n interface BulkUnArchiveOrdersByFilterResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface UpdateBuyerInfoRequest {\n /**\n * Order ID.\n * @readonly\n */\n _id: string;\n /** Buyer info. */\n buyerInfo?: BuyerInfoUpdate;\n }\n interface BuyerInfoUpdate {\n /** Contact ID. */\n contactId?: string | null;\n /** Email associated with the buyer. */\n email?: string | null;\n }\n interface UpdateBuyerInfoResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface UpdateBuyerEmailRequest {\n /** @readonly */\n _id: string;\n email?: string | null;\n }\n interface UpdateBuyerEmailResponse {\n order?: Order$1;\n }\n interface UpdateOrderShippingAddressRequest {\n /** Order ID. */\n _id: string;\n /** Shipping address and contact details to be updated. */\n shippingAddress: AddressWithContact;\n }\n interface UpdateOrderShippingAddressResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface UpdateBillingContactDetailsRequest {\n /**\n * Order ID.\n * @readonly\n */\n _id: string;\n /** Contact details. */\n addressContactDetails?: FullAddressContactDetails;\n }\n interface UpdateBillingContactDetailsResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface UpdateOrderLineItemRequest {\n /** Order ID */\n _id: string;\n /** Order line item to update */\n lineItem: OrderLineItem;\n }\n interface UpdateOrderLineItemResponse {\n /** Updated order data */\n order?: Order$1;\n }\n interface UpdateOrderLineItemsRequest {\n /** Order ID */\n orderId: string;\n /** Order line items to update */\n lineItems: MaskedOrderLineItem[];\n }\n interface MaskedOrderLineItem {\n /** Order line item to update */\n lineItem?: OrderLineItem;\n }\n interface UpdateOrderLineItemsResponse {\n /** Updated order data */\n order?: Order$1;\n }\n interface AddInternalActivityRequest {\n /** Order ID. */\n _id: string;\n /** Activity info. */\n activity: InternalActivity;\n }\n interface InternalActivity extends InternalActivityContentOneOf {\n /** Order refunded. */\n orderRefunded?: OrderRefunded$1;\n /** Order placed. */\n orderPlaced?: OrderPlaced;\n /** Order paid. Either by the store owner (for offline orders), or when an online transaction was confirmed. */\n orderPaid?: OrderPaid;\n /** Order shipping status set as fulfilled. */\n orderFulfilled?: OrderFulfilled;\n /** Order shipping status set as not fulfilled. */\n orderNotFulfilled?: OrderNotFulfilled;\n /** Order canceled. */\n orderCanceled?: OrderCanceled;\n /** Download link was sent (relevant for orders with digital line items). */\n downloadLinkSent?: DownloadLinkSent;\n /** Shipping tracking number added to order. */\n trackingNumberAdded?: TrackingNumberAdded;\n /** Shipping tracking number was edited. */\n trackingNumberEdited?: TrackingNumberEdited;\n /** Shipping tracking link added to order. */\n trackingLinkAdded?: TrackingLinkAdded;\n /** An email confirmation of order shipment was sent. */\n shippingConfirmationEmailSent?: ShippingConfirmationEmailSent;\n /** Invoice was added to order. */\n invoiceAdded?: InvoiceAdded;\n /** Invoice sent to customer via email. */\n invoiceSent?: InvoiceSent;\n /** Email sent to fulfiller. */\n fulfillerEmailSent?: FulfillerEmailSent;\n /** Shipping address was updated. */\n shippingAddressEdited?: ShippingAddressEdited;\n /** Order email was updated. */\n emailEdited?: EmailEdited;\n /** Email notification for pickup sent. */\n pickupReadyEmailSent?: PickupReadyEmailSent;\n /** Order created as a result of items exchange. */\n orderCreatedFromExchange?: OrderCreatedFromExchange;\n /** New exchange order created. */\n newExchangeOrderCreated?: NewExchangeOrderCreated;\n /** Order partially paid. During the checkout for orders with deposit items. */\n orderPartiallyPaid?: OrderPartiallyPaid;\n /** Draft order changes applied */\n draftOrderChangesApplied?: DraftOrderChangesApplied;\n /** Payment method is saved for order */\n savedPaymentMethod?: SavedPaymentMethod;\n /**\n * Internal activity ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Internal activity author's email.\n * @readonly\n */\n authorEmail?: string | null;\n /**\n * Internal activity creation date and time.\n * @readonly\n */\n _createdDate?: Date;\n }\n /** @oneof */\n interface InternalActivityContentOneOf {\n /** Order refunded. */\n orderRefunded?: OrderRefunded$1;\n /** Order placed. */\n orderPlaced?: OrderPlaced;\n /** Order paid. Either by the store owner (for offline orders), or when an online transaction was confirmed. */\n orderPaid?: OrderPaid;\n /** Order shipping status set as fulfilled. */\n orderFulfilled?: OrderFulfilled;\n /** Order shipping status set as not fulfilled. */\n orderNotFulfilled?: OrderNotFulfilled;\n /** Order canceled. */\n orderCanceled?: OrderCanceled;\n /** Download link was sent (relevant for orders with digital line items). */\n downloadLinkSent?: DownloadLinkSent;\n /** Shipping tracking number added to order. */\n trackingNumberAdded?: TrackingNumberAdded;\n /** Shipping tracking number was edited. */\n trackingNumberEdited?: TrackingNumberEdited;\n /** Shipping tracking link added to order. */\n trackingLinkAdded?: TrackingLinkAdded;\n /** An email confirmation of order shipment was sent. */\n shippingConfirmationEmailSent?: ShippingConfirmationEmailSent;\n /** Invoice was added to order. */\n invoiceAdded?: InvoiceAdded;\n /** Invoice sent to customer via email. */\n invoiceSent?: InvoiceSent;\n /** Email sent to fulfiller. */\n fulfillerEmailSent?: FulfillerEmailSent;\n /** Shipping address was updated. */\n shippingAddressEdited?: ShippingAddressEdited;\n /** Order email was updated. */\n emailEdited?: EmailEdited;\n /** Email notification for pickup sent. */\n pickupReadyEmailSent?: PickupReadyEmailSent;\n /** Order created as a result of items exchange. */\n orderCreatedFromExchange?: OrderCreatedFromExchange;\n /** New exchange order created. */\n newExchangeOrderCreated?: NewExchangeOrderCreated;\n /** Order partially paid. During the checkout for orders with deposit items. */\n orderPartiallyPaid?: OrderPartiallyPaid;\n /** Draft order changes applied */\n draftOrderChangesApplied?: DraftOrderChangesApplied;\n /** Payment method is saved for order */\n savedPaymentMethod?: SavedPaymentMethod;\n }\n /** Order placed */\n interface OrderPlaced {\n }\n /** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */\n interface OrderPaid {\n }\n /** Order shipping status set as fulfilled */\n interface OrderFulfilled {\n }\n /** Order shipping status set as not fulfilled */\n interface OrderNotFulfilled {\n }\n /** Order canceled */\n interface OrderCanceled {\n }\n /** A download link was sent (relevant for orders with digital line items) */\n interface DownloadLinkSent {\n }\n /** Shipping tracking number was set */\n interface TrackingNumberAdded {\n }\n /** Shipping tracking number was edited */\n interface TrackingNumberEdited {\n }\n /** Shipping tracking link was set */\n interface TrackingLinkAdded {\n }\n /** An email confirmation of order shipment was sent */\n interface ShippingConfirmationEmailSent {\n }\n /** Invoice was set in the order */\n interface InvoiceAdded {\n }\n /** Invoice sent to customer via email */\n interface InvoiceSent {\n }\n /** Email was sent to fulfiller */\n interface FulfillerEmailSent {\n }\n /** Shipping address was updated */\n interface ShippingAddressEdited {\n }\n /** Order email was updated */\n interface EmailEdited {\n }\n /** An email notification for pickup was sent */\n interface PickupReadyEmailSent {\n }\n /** Order marked as partially paid when an online transaction was confirmed with partial minimal required amount of total sum */\n interface OrderPartiallyPaid {\n }\n interface AddInternalActivityResponse {\n /** Updated order. */\n order?: Order$1;\n /**\n * ID of the added internal activity.\n * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.\n */\n activityId?: string;\n }\n interface AddActivityRequest {\n /** Order ID. */\n _id: string;\n /** Activity info. */\n activity: PublicActivity;\n }\n interface PublicActivity extends PublicActivityContentOneOf {\n /** Custom activity details. */\n customActivity?: CustomActivity;\n /** Merchant commment. */\n merchantComment?: MerchantComment;\n }\n /** @oneof */\n interface PublicActivityContentOneOf {\n /** Custom activity details. */\n customActivity?: CustomActivity;\n /** Merchant commment. */\n merchantComment?: MerchantComment;\n }\n interface AddActivityResponse {\n /** Updated order. */\n order?: Order$1;\n /**\n * ID of the added activity.\n * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.\n */\n activityId?: string;\n }\n interface AddActivitiesRequest {\n /** Order ID. */\n orderId: string;\n /** Activities to add. */\n activities: PublicActivity[];\n }\n interface AddActivitiesResponse {\n /** Updated order. */\n order?: Order$1;\n /**\n * IDs of the added activities.\n * Use this IDs to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activities) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activities) the activities.\n */\n activityIds?: string[];\n }\n interface UpdateActivityRequest {\n /** Order ID. */\n _id: string;\n /** ID of the activity to update. */\n activityId: string;\n /** Activity info. */\n activity: PublicActivity;\n }\n interface UpdateActivityResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface DeleteActivityRequest {\n /** Order ID. */\n _id: string;\n /** ID of the activity to delete. */\n activityId: string;\n }\n interface DeleteActivityResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface UpdateLineItemsDescriptionLinesRequest {\n /** Order ID. */\n _id: string;\n /** Line items. */\n lineItems: LineItemUpdate[];\n }\n interface LineItemUpdate {\n /** Line item ID. */\n lineItemId?: string;\n /**\n * Description lines' info.\n * If description line already exists for this name, it will be replaced.\n */\n descriptionLines?: DescriptionLine[];\n }\n interface UpdateLineItemsDescriptionLinesResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface MarkOrderAsSeenByHumanRequest {\n /** Order ID. */\n _id: string;\n }\n interface MarkOrderAsSeenByHumanResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface CancelOrderRequest {\n /** Order ID. */\n _id: string;\n /** Whether to send an order canceled email to the buyer. */\n sendOrderCanceledEmail?: boolean;\n /** Custom note to be added to the email (optional). */\n customMessage?: string | null;\n /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */\n restockAllItems?: boolean;\n }\n interface CancelOrderResponse {\n /** Canceled order. */\n order?: Order$1;\n }\n interface OrderCanceledEventOrderCanceled {\n /** The order that was cancelled */\n order?: Order$1;\n /** Should restock all items on that order */\n restockAllItems?: boolean;\n /** Should send a confirmation mail to the customer */\n sendOrderCanceledEmail?: boolean;\n /** Personal note added to the email */\n customMessage?: string | null;\n }\n interface MarkAsFulfilledRequest {\n /** Order ID. */\n _id: string;\n }\n interface MarkAsFulfilledResponse {\n /** Updated order. */\n order?: Order$1;\n }\n /** Triggered when the fulfillment status of an order is updated */\n interface FulfillmentStatusUpdated {\n /** The order that was updated */\n order?: Order$1;\n /** The previous status (before the update) */\n previousFulfillmentStatus?: FulfillmentStatus$1;\n /** the new status (after the update) */\n newFulfillmentStatus?: FulfillmentStatus$1;\n /** the action that caused this update */\n action?: string;\n }\n interface BulkMarkAsFulfilledRequest {\n /** IDs of orders to be marked as fulfilled. */\n ids: string[];\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkMarkAsFulfilledResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkMarkAsFulfilledByFilterRequest {\n /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */\n filter: Record | null;\n }\n interface BulkMarkAsFulfilledByFilterResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface MarkAsUnfulfilledRequest {\n /** Order ID. */\n _id: string;\n }\n interface MarkAsUnfulfilledResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface BulkMarkAsUnfulfilledRequest {\n /** IDs of orders to be marked as not fulfilled. */\n ids: string[];\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkMarkAsUnfulfilledResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkMarkAsUnfulfilledByFilterRequest {\n /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */\n filter: Record | null;\n }\n interface BulkMarkAsUnfulfilledByFilterResponse {\n /** Items updated by bulk action. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface V1MarkOrderAsPaidRequest {\n /** Order ID. */\n _id: string;\n }\n interface V1MarkOrderAsPaidResponse {\n /** Updated order. */\n order?: Order$1;\n }\n interface V1BulkMarkOrdersAsPaidRequest {\n /** IDs of orders to mark as paid. */\n ids: string[];\n }\n interface V1BulkMarkOrdersAsPaidResponse {\n /**\n * Items updated by the bulk action.\n * The Order entity within the results optimistically changes its payment status to paid, however this process is async.\n */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface V1CreatePaymentGatewayOrderRequest {\n /** eCom Order ID */\n ecomOrderId: string;\n }\n interface V1CreatePaymentGatewayOrderResponse {\n /** ID of the order created in the payment gateway */\n paymentGatewayOrderId?: string;\n }\n interface GetShipmentsRequest {\n _id: string;\n }\n interface GetShipmentsResponse {\n shipmentIds?: string[];\n }\n interface AggregateOrdersRequest {\n /** Filter applied to original data */\n filter?: Record | null;\n /** This is an object defining aggregation itself */\n aggregation: Record | null;\n /**\n * Optional custom separator string that can be used to override default separator value '|'\n * for hierarchical responses of multifaceted aggregation requests like:\n * '{\"aggregation\": {\"example_request_key\": {\"$count\" : [\"deliveryMethod\", \"shippingRegion\"]}}}'\n * with example response for default '|' separator like:\n * '{\"aggregates\" :{\"example_request_key\": {\"(Mail|Region 1)\": 5, \"(Pickup|Region 2)\": 10}}}'\n */\n hierarchySeparatorOverride?: string | null;\n }\n interface AggregateOrdersResponse {\n aggregates?: Record | null;\n }\n interface DecrementItemsQuantityRequest {\n /** Order ID */\n _id: string;\n /** Which items to decrement, and how much to decrement from each one */\n decrementData: DecrementData[];\n }\n interface DecrementData {\n /** ID of the line item being decremented. */\n lineItemId?: string;\n /** Line item quantity being decremented. */\n decrementBy?: number;\n /** Whether to restock the line item (triggers inventory update). */\n restock?: boolean;\n }\n interface DecrementItemsQuantityResponse {\n /** Updated order data */\n order?: Order$1;\n }\n /** Triggered when order items are marked as restocked */\n interface OrderItemsRestocked {\n /** The order which items were restocked */\n order?: Order$1;\n /** Restocked items and quantities */\n restockItems?: V1RestockItem[];\n }\n interface V1RestockItem {\n /** ID of the line item being restocked. */\n lineItemId?: string;\n /** Line item quantity being restocked. */\n quantity?: number;\n }\n interface BulkUpdateOrderTagsRequest {\n /** IDs of orders to update tags for. */\n orderIds: string[];\n /** Tags to be added to orders */\n assignTags?: Tags;\n /** Tags to be removed from orders */\n unassignTags?: Tags;\n }\n interface BulkUpdateOrderTagsResponse {\n results?: BulkUpdateOrderTagsResult[];\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkUpdateOrderTagsResult {\n itemMetadata?: ItemMetadata$1;\n }\n /** Triggered when the the order status changes to approved */\n interface OrderApproved {\n /** The order that was updated */\n order?: Order$1;\n }\n interface Task {\n key?: TaskKey;\n executeAt?: Date;\n payload?: string | null;\n }\n interface TaskKey {\n appId?: string;\n instanceId?: string;\n subjectId?: string | null;\n }\n interface TaskAction extends TaskActionActionOneOf {\n complete?: Complete;\n cancel?: Cancel;\n reschedule?: Reschedule;\n }\n /** @oneof */\n interface TaskActionActionOneOf {\n complete?: Complete;\n cancel?: Cancel;\n reschedule?: Reschedule;\n }\n interface Complete {\n }\n interface Cancel {\n }\n interface Reschedule {\n executeAt?: Date;\n payload?: string | null;\n }\n interface InvoiceSentEvent {\n _id?: IdAndVersion;\n /** @readonly */\n data?: InvoiceFields;\n /** @readonly */\n status?: InvoiceStatus;\n }\n interface IdAndVersion {\n _id?: string | null;\n version?: number | null;\n }\n interface InvoiceFields {\n /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */\n number?: string | null;\n /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */\n currencyCode?: string | null;\n /** The invoice customer. The customer must be a contact of the site, with an email. */\n customer?: Customer;\n /**\n * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.\n * Last seen date is the optional date when the invoice was last seen be UoU.\n */\n dates?: InvoiceDates;\n /**\n * Line items containing the details of the products or services relevant to the invoice, with their name, prices,\n * and quantity. There must be at least one line item on the invoice.\n */\n lineItems?: LineItems;\n /**\n * Locale of the invoice, containing the language.\n * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates\n * on the invoice.\n */\n locale?: Locale;\n /**\n * The totals on the invoice.\n * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.\n * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.\n * The totals contain fees and a discount, that apply to the invoice.\n */\n totals?: TotalPrice;\n /** An optional discount on the invoice. */\n discount?: Discount$1;\n /** The taxes of the invoice. */\n taxes?: CalculatedTaxes;\n /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */\n payments?: Payments;\n /** Invoice metadata */\n metaData?: MetaData;\n /**\n * Not used\n * @deprecated\n */\n creationAdditional_BIInformation?: string | null;\n /**\n * The balance and amount paid on the invoice.\n * This read-only field is calculated based on the invoice totals and payments.\n * @readonly\n */\n dynamicTotals?: InvoiceDynamicPriceTotals;\n /** The invoice title */\n title?: string | null;\n /** Invoice custom fields */\n customFields?: CustomFieldValue[];\n /**\n * Not used\n * @deprecated\n */\n designTemplateId?: string | null;\n /**\n * Not used\n * @deprecated\n */\n createOrder?: boolean | null;\n /** The optional deposit of the invoice */\n deposit?: Deposit;\n /** Associated checkout for this invoice */\n ecomCheckoutId?: string | null;\n }\n interface Customer {\n contactId?: string | null;\n name?: string | null;\n email?: Email;\n address?: QuotesAddress;\n phone?: Phone;\n company?: Company;\n firstName?: string | null;\n lastName?: string | null;\n billingAddress?: CommonAddress;\n shippingAddress?: CommonAddress;\n }\n interface Email {\n address?: string;\n }\n interface QuotesAddress {\n street?: string | null;\n city?: string | null;\n zip?: string | null;\n state?: string | null;\n country?: string | null;\n /** @readonly */\n description?: AddressDescription;\n }\n interface AddressDescription {\n content?: string;\n placement?: Placement;\n }\n enum Placement {\n Unknown = \"Unknown\",\n Replace = \"Replace\",\n Before = \"Before\",\n After = \"After\"\n }\n interface Phone {\n number?: string;\n }\n interface Company {\n name?: string;\n _id?: string | null;\n }\n /** Physical address */\n interface CommonAddress extends CommonAddressStreetOneOf {\n /** Street name and number. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface CommonAddressStreetOneOf {\n /** Street name and number. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface Subdivision {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n enum SubdivisionType {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n /** Subdivision Concordance values */\n interface StandardDetails {\n /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */\n iso31662?: string | null;\n }\n interface InvoiceDates {\n /** use UTC midnight date to set the issue date according to the site time zone */\n issueDate?: Date;\n /** use UTC midnight date to set the due date according to the site time zone */\n dueDate?: Date;\n /** Valid time zones */\n timeZoneCode?: string | null;\n /**\n * ignored in request use in response to get the site time zone\n * @readonly\n */\n lastSeenDate?: Date;\n }\n interface LineItems {\n lineItems?: LineItem$1[];\n }\n interface LineItem$1 {\n _id?: string;\n name?: string;\n description?: string | null;\n price?: BigDecimalWrapper;\n taxedTotal?: BigDecimalWrapper;\n quantity?: BigDecimalWrapper;\n taxes?: LineItemTax[];\n /** The source of the line item */\n source?: Source;\n /** The line-item level metadata. */\n metadata?: LineItemMetaData;\n }\n interface BigDecimalWrapper {\n serializedValue?: number;\n }\n interface LineItemTax {\n name?: string;\n rate?: BigDecimalWrapper;\n code?: string | null;\n }\n interface Source {\n /**\n * Source app or service ID.\n * @readonly\n */\n sourceId?: string;\n /**\n * App or service type.\n * @readonly\n */\n sourceType?: SourceType;\n }\n enum SourceType {\n UNKNOWN_SOURCE_TYPE = \"UNKNOWN_SOURCE_TYPE\",\n WIX_APP = \"WIX_APP\",\n EXTERNAL = \"EXTERNAL\",\n ADMIN = \"ADMIN\",\n OTHER = \"OTHER\"\n }\n interface LineItemMetaData {\n metadata?: Record;\n }\n interface Locale {\n /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */\n language?: string;\n /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */\n country?: string | null;\n invariant?: string | null;\n }\n interface TotalPrice {\n /** the subtotal of the line items without the tax reduction */\n subtotal?: BigDecimalWrapper;\n /** the total price taking into account the itemized fees and the taxes */\n total?: BigDecimalWrapper;\n fees?: ItemizedFee[];\n discountAmount?: BigDecimalWrapper;\n taxedAmount?: BigDecimalWrapper;\n }\n interface ItemizedFee {\n name?: string;\n price?: BigDecimalWrapper;\n }\n interface Discount$1 extends DiscountOneDiscountTypeOneOf {\n /** Discount as percentage value. */\n percentage?: BigDecimalWrapper;\n }\n /** @oneof */\n interface DiscountOneDiscountTypeOneOf {\n /** Discount as percentage value. */\n percentage?: BigDecimalWrapper;\n }\n interface CalculatedTaxes {\n /** consider calculated or not - cannot enforce set */\n taxes?: CalculatedTax[];\n }\n interface CalculatedTax {\n name?: string;\n rate?: BigDecimalWrapper;\n /** the costs on which the taxes are applied */\n taxable?: BigDecimalWrapper;\n /** the taxes as a result of the */\n taxed?: BigDecimalWrapper;\n code?: string | null;\n }\n interface Payments {\n payments?: InvoicesPayment[];\n }\n interface InvoicesPayment {\n /** document */\n _id?: string;\n type?: string;\n amount?: BigDecimalWrapper;\n date?: Date;\n /**\n * The orderId of the order in cashier associated with the payment.\n * This field is populated for external payments that are charged by invoices via AddPayment endpoint.\n */\n orderId?: string | null;\n /**\n * The transactionId corresponding to the orderId of the payment which are returned by cashier.\n * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.\n */\n transactionId?: string | null;\n }\n interface MetaData {\n notes?: string | null;\n legalTerms?: string | null;\n sourceUrl?: string | null;\n sourceProperties?: Record;\n source?: string | null;\n sourceRefId?: string | null;\n /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */\n allowEditByOthers?: boolean | null;\n }\n interface InvoiceDynamicPriceTotals {\n paidAmount?: BigDecimalWrapper;\n balance?: BigDecimalWrapper;\n }\n /**\n * A custom field value is used to add additional data to a financial document or to a financial document template.\n * The custom field value may be based on a custom field definition.\n */\n interface CustomFieldValue {\n /**\n * The unique id of the custom field value\n * @readonly\n */\n _id?: string | null;\n /** The display name of the custom field value */\n displayName?: string;\n /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */\n namespace?: string | null;\n /** The group of the custom field indicates its intended placement in the financial document */\n group?: CustomFieldGroup;\n /** The value of the custom field */\n value?: Value;\n /** The optional key of the custom field definition on which the custom field value is based */\n originCustomFieldKey?: string | null;\n }\n enum CustomFieldGroup {\n UNKNOWN_CUSTOM_FIELD_GROUP = \"UNKNOWN_CUSTOM_FIELD_GROUP\",\n BUSINESS_DETAILS = \"BUSINESS_DETAILS\",\n CUSTOMER_DETAILS = \"CUSTOMER_DETAILS\",\n DOCUMENT = \"DOCUMENT\",\n FOOTER = \"FOOTER\",\n OTHER = \"OTHER\"\n }\n interface Value {\n value?: string;\n valueType?: ValueType;\n }\n enum ValueType {\n UNKNOWN_VALUE_TYPE = \"UNKNOWN_VALUE_TYPE\",\n STRING = \"STRING\",\n DATE = \"DATE\",\n BOOLEAN = \"BOOLEAN\",\n NUMBER = \"NUMBER\"\n }\n interface Deposit {\n /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */\n flatAmount?: string;\n /**\n * The read-only percentage value of the deposit.\n * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.\n * @readonly\n */\n percentage?: string;\n /** The type of the deposit. The default is FLAT. */\n type?: DepositType;\n }\n enum DepositType {\n UNKNOWN = \"UNKNOWN\",\n FLAT = \"FLAT\",\n PERCENTAGE = \"PERCENTAGE\"\n }\n /**\n * InvoiceStatus allowed transitions based on current status:\n * Draft -> Deleted, Paid, Partially Paid, Sent\n * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)\n * Processing -> PartiallyPaid, Paid, Sent\n * Paid -> Void\n * PartiallyPaid -> Void, (PartialAndOverdue)\n * Void -> Deleted\n * Deleted\n */\n enum InvoiceStatus {\n Draft = \"Draft\",\n Sent = \"Sent\",\n Processing = \"Processing\",\n Paid = \"Paid\",\n Overdue = \"Overdue\",\n Void = \"Void\",\n Deleted = \"Deleted\",\n PartiallyPaid = \"PartiallyPaid\",\n PartialAndOverdue = \"PartialAndOverdue\"\n }\n interface TriggerSideEffectsFromLegacyData {\n storeId?: string;\n orderId?: string;\n ordersExperiments?: OrdersExperiments;\n }\n interface QueryOrdersForMetasiteOptions {\n /** paginated internal orders query request */\n internalQueryOrdersRequest?: InternalQueryOrdersRequest;\n }\n interface GetOrderForMetasiteIdentifiers {\n /** meta site Id for EP order to retrieve */\n metasiteId: string;\n /** Order Id for EP order to retrieve */\n orderId: string;\n }\n interface ListOrderTransactionsForMetasiteIdentifiers {\n /** meta site Id for EP order transactions to retrieve */\n metasiteId: string;\n /** Order Id for EP order transactions to retrieve */\n orderId: string;\n }\n interface TriggerReindexOptions {\n orderIds?: string[];\n }\n interface BulkSendBuyerPickupConfirmationEmailsOptions {\n /** IDs of orders to send pickup emails for. */\n orderIds?: string[];\n }\n interface BulkSendBuyerShippingConfirmationEmailsOptions {\n /** IDs of orders to send pickup emails for. */\n orderIds?: string[];\n }\n interface SendCancelRefundEmailOptions {\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund amount */\n refundAmount: Price$1;\n }\n interface PreviewRefundEmailOptions {\n /** Refund amount */\n refundAmount: Price$1;\n /** Refund business details */\n details?: RefundDetails$1;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n }\n interface PreviewCancelEmailOptions {\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n }\n interface PreviewCancelRefundEmailOptions {\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund amount */\n refundAmount?: Price$1;\n }\n interface PreparePaymentCollectionOptions {\n /**\n * Optional parameter. When present, payment collection will be performed using given payment gateway order.\n * Existing payment gateway order will be updated with a new amount.\n * When parameter is absent, new payment gateway order will be created and used for payment collection.\n */\n paymentGatewayOrderId?: string | null;\n }\n /**\n * Provides payment collectability status for given order. If payment collection is possible\n * response will contain collectable amount for given ecom order. If not - response will contain\n * reason why payment collection is not possible.\n * @param ecomOrderId - Ecom order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function getPaymentCollectabilityStatus(ecomOrderId: string): Promise;\n interface PaymentCollectionCreatePaymentGatewayOrderOptions {\n /** Information about the user who initiated the payment. */\n chargedBy?: ChargedBy;\n }\n interface ChargeMembershipsOptions {\n /** List of items to be paid by memberships */\n membershipCharges?: MembershipChargeItem[];\n }\n interface TriggerRefundOptions$1 {\n /** Business model of a refund */\n details?: RefundDetails$1;\n /** Side effect details related to refund */\n sideEffects?: RefundSideEffects$1;\n }\n interface CalculateRefundOptions$1 {\n /** Refunded line items and quantity */\n refundItems?: CalculateRefundItemRequest$1[];\n /** Should include shipping in refund calculation */\n refundShipping?: boolean;\n }\n /**\n * Retrieves an order.\n *\n *\n * The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.\n *\n * To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).\n * @param _id - ID of the order to retrieve.\n * @public\n * @requiredField _id\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The requested order.\n */\n function getOrder(_id: string): Promise;\n interface InternalQueryOrdersOptions {\n /** Query options. */\n query?: PlatformQuery;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OrdersQueryResult extends QueryCursorResult {\n items: Order$1[];\n query: OrdersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface OrdersQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"number\" | \"_createdDate\" | \"_updatedDate\" | \"lineItems.subscriptionInfo.id\" | \"buyerInfo.memberId\" | \"buyerInfo.contactId\" | \"buyerInfo.email\" | \"paymentStatus\" | \"fulfillmentStatus\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"shippingInfo.title\" | \"shippingInfo.logistics.deliveryTime\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\" | \"shippingInfo.region.name\" | \"status\" | \"archived\" | \"createdBy.userId\" | \"channelInfo.type\" | \"channelInfo.externalOrderId\" | \"seenByAHuman\" | \"checkoutId\", value: any) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"number\" | \"_createdDate\" | \"_updatedDate\" | \"lineItems.subscriptionInfo.id\" | \"buyerInfo.memberId\" | \"buyerInfo.contactId\" | \"buyerInfo.email\" | \"paymentStatus\" | \"fulfillmentStatus\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"shippingInfo.title\" | \"shippingInfo.logistics.deliveryTime\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\" | \"shippingInfo.region.name\" | \"status\" | \"archived\" | \"createdBy.userId\" | \"channelInfo.type\" | \"channelInfo.externalOrderId\" | \"seenByAHuman\" | \"checkoutId\", value: any) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"number\" | \"_createdDate\" | \"_updatedDate\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\", value: any) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"number\" | \"_createdDate\" | \"_updatedDate\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\", value: any) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"number\" | \"_createdDate\" | \"_updatedDate\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\", value: any) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"number\" | \"_createdDate\" | \"_updatedDate\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\", value: any) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"buyerInfo.email\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"shippingInfo.logistics.deliveryTime\", value: string) => OrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"number\" | \"_createdDate\" | \"_updatedDate\" | \"buyerInfo.email\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"shippingInfo.logistics.deliveryTime\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\" | \"archived\" | \"seenByAHuman\", value: any[]) => OrdersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"number\" | \"_createdDate\" | \"_updatedDate\" | \"lineItems.subscriptionInfo.id\" | \"buyerInfo.memberId\" | \"buyerInfo.contactId\" | \"buyerInfo.email\" | \"paymentStatus\" | \"fulfillmentStatus\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"shippingInfo.title\" | \"shippingInfo.logistics.deliveryTime\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\" | \"shippingInfo.region.name\" | \"status\" | \"archived\" | \"createdBy.userId\" | \"channelInfo.type\" | \"channelInfo.externalOrderId\" | \"seenByAHuman\" | \"checkoutId\", value: any) => OrdersQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"number\" | \"_createdDate\" | \"_updatedDate\" | \"buyerInfo.email\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"shippingInfo.logistics.deliveryTime\" | \"shippingInfo.logistics.deliveryTimeSlot.from\" | \"shippingInfo.logistics.deliveryTimeSlot.to\" | \"archived\" | \"seenByAHuman\", value: boolean) => OrdersQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"number\" | \"_createdDate\" | \"_updatedDate\" | \"buyerInfo.email\" | \"paymentStatus\" | \"fulfillmentStatus\" | \"priceSummary.totalPrice\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"status\">) => OrdersQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"number\" | \"_createdDate\" | \"_updatedDate\" | \"buyerInfo.email\" | \"paymentStatus\" | \"fulfillmentStatus\" | \"priceSummary.totalPrice\" | \"priceSummary.total\" | \"billingInfo.contactDetails.firstName\" | \"billingInfo.contactDetails.lastName\" | \"status\">) => OrdersQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => OrdersQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => OrdersQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves a list of orders, given the provided paging, filtering, and sorting.\n *\n *\n * Search Orders runs with these defaults, which you can override:\n *\n * - `createdDate` is sorted in `DESC` order\n * - `cursorPaging.limit` is `100`\n * - `filter: {\"status\": {\"$ne\": \"INITIALIZED\"}}` - other order statuses can be queried, but orders with `status: \"INITIALIZED\"` are never returned\n *\n * For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).\n *\n * To learn about working with _Search_ endpoints, see\n * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and\n * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function searchOrders(options?: SearchOrdersOptions): Promise;\n interface SearchOrdersOptions {\n /** Search options. */\n search?: CursorSearch;\n }\n /**\n * Creates an order.\n *\n *\n * The `createOrder()` function returns a Promise that resolves when the order is created.\n *\n * > **Notes:**\n * > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.\n * > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.\n * @param order - Order info.\n * @public\n * @requiredField order\n * @requiredField order.billingInfo.contactDetails\n * @requiredField order.billingInfo.contactDetails.firstName\n * @requiredField order.channelInfo\n * @requiredField order.lineItems\n * @requiredField order.lineItems.catalogReference.appId\n * @requiredField order.lineItems.catalogReference.catalogItemId\n * @requiredField order.lineItems.itemType\n * @requiredField order.lineItems.price\n * @requiredField order.lineItems.productName\n * @requiredField order.lineItems.productName.original\n * @requiredField order.lineItems.quantity\n * @requiredField order.lineItems.subscriptionInfo.subscriptionSettings.interval\n * @requiredField order.priceSummary\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Newly created order.\n */\n function createOrder(order: Order$1, options?: CreateOrderOptions): Promise;\n interface CreateOrderOptions {\n }\n /**\n * Updates an order.\n *\n *\n * The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.\n *\n * Currently, the following fields can be updated:\n * + `order.buyerInfo.email`\n * + `order.buyerLanguage`\n * + `order.weightUnit`\n * + `order.billingInfo.address`\n * + `order.billingInfo.contactDetails`\n * + `order.archived`\n * + `order.attributionSource`\n * + `order.seenByAHuman`\n * + `order.recipientInfo.address`\n * + `order.recipientInfo.contactDetails`\n * + `order.shippingInfo.logistics.shippingDestination.address`\n * + `order.shippingInfo.logistics.shippingDestination.contactDetails`\n *\n * To update a field's value, include the new value in the `order` object in the method parameters.\n * To remove a field's value, pass `null`.\n *\n * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.\n *\n * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @requiredField order\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Newly created order.\n */\n function updateOrder(_id: string | null, order: UpdateOrder, options?: UpdateOrderOptions): Promise;\n interface UpdateOrder {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Order number displayed in the site owner's dashboard (auto-generated).\n * @readonly\n */\n number?: string;\n /**\n * Date and time the order was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Order line items.\n * @readonly\n */\n lineItems?: OrderLineItem[];\n /** Buyer information. */\n buyerInfo?: BuyerInfo$1;\n /**\n * Order payment status.\n * + `NOT_PAID` - This can be an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.\n * + This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.\n * + `PAID` - All payments associated with this order are paid. For online payments: [`payment.regularPaymentDetails.status: APPROVED`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object). For gift cards: [`payment.giftCardPaymentDetails.voided: false`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object).\n * + `PARTIALLY_REFUNDED` - Order was refunded, but refund amount is less than order total price.\n * + `FULLY_REFUNDED` - Order fully refunded. Refund amount equals total price.\n * + `PENDING` - Payments received but not yet confirmed by the payment provider.\n * + `PARTIALLY_PAID` - At least one payment was received and approved, covering less than total price amount.\n */\n paymentStatus?: PaymentStatus$1;\n /**\n * Order fulfillment status.\n * @readonly\n */\n fulfillmentStatus?: FulfillmentStatus$1;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n */\n buyerLanguage?: string | null;\n /** Weight measurement unit - defaults to site's weight unit. */\n weightUnit?: WeightUnit$1;\n /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */\n currency?: string | null;\n /** Whether tax is included in line item prices. */\n taxIncludedInPrices?: boolean;\n /**\n * Site language in which original values are shown.\n * @readonly\n */\n siteLanguage?: string | null;\n /**\n * Order price summary.\n * @readonly\n */\n priceSummary?: PriceSummary;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: V1ShippingInformation;\n /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */\n buyerNote?: string | null;\n /**\n * Order status.\n * + `INITIALIZED`: Order created, but not yet approved or canceled.\n * + `APPROVED`: Order approved. This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order). Offline orders (cash payment) are automatically approved.\n * + `CANCELED`: Order canceled by the user.\n */\n status?: OrderStatus;\n /** Whether order is archived. */\n archived?: boolean | null;\n /**\n * Tax summary.\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * @deprecated Tax summary.\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxSummary?: TaxSummary;\n /** Tax information. */\n taxInfo?: OrderTaxInfo;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount[];\n /**\n * Order activities.\n * @readonly\n */\n activities?: Activity$1[];\n /** Order attribution source. */\n attributionSource?: AttributionSource;\n /**\n * ID of the order's initiator.\n * @readonly\n */\n createdBy?: CreatedBy;\n /** Information about the sales channel that submitted this order. */\n channelInfo?: ChannelInfo$1;\n /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */\n seenByAHuman?: boolean | null;\n /** Checkout ID. */\n checkoutId?: string | null;\n /** Custom fields. */\n customFields?: CustomField$1[];\n /**\n * Balance summary.\n * @readonly\n */\n balanceSummary?: BalanceSummary;\n /** Additional fees applied to the order. */\n additionalFees?: AdditionalFee[];\n /**\n * Custom field data for the order object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /**\n * Order recipient address and contact details.\n *\n * This field may differ from the address in `shippingInfo.logistics` when:\n * + The chosen shipping option is pickup point or store pickup.\n * + No shipping option is selected.\n */\n recipientInfo?: AddressWithContact;\n }\n interface UpdateOrderOptions {\n }\n /**\n * Updates up to 100 orders.\n *\n *\n * The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.\n *\n * Currently, the following fields can be updated:\n * + `order.buyerInfo.email`\n * + `order.buyerLanguage`\n * + `order.weightUnit`\n * + `order.billingInfo.address`\n * + `order.billingInfo.contactDetails`\n * + `order.archived`\n * + `order.attributionSource`\n * + `order.seenByAHuman`\n * + `order.recipientInfo.address`\n * + `order.recipientInfo.contactDetails`\n * + `order.shippingInfo.logistics.shippingDestination.address`\n * + `order.shippingInfo.logistics.shippingDestination.contactDetails`\n *\n * To update a field's value, include the new value in the `orders.order` object in the method parameters.\n * To remove a field's value, pass `null`.\n *\n * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.\n *\n * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).\n * @param orders - Orders to update.\n * @public\n * @requiredField orders\n * @requiredField orders.order\n * @requiredField orders.order._id\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateOrders(orders: MaskedOrder[], options?: BulkUpdateOrdersOptions): Promise;\n interface BulkUpdateOrdersOptions {\n /**\n * Whether to return the full order entities.\n *\n * Default: `false`\n */\n returnEntity?: boolean;\n }\n interface CommitDeltasOptions {\n /**\n * Draft order Id representing this change.\n * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get\n */\n draftOrderId?: string;\n /** Draft order changes to be applied */\n changes: DraftOrderDiffs;\n /** Side-effects to happen after order is updated */\n commitSettings?: DraftOrderCommitSettings;\n /** Reason for edit, given by user (optional). */\n reason?: string | null;\n }\n interface BulkArchiveOrdersOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkUnArchiveOrdersOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface UpdateBuyerInfoOptions {\n /** Buyer info. */\n buyerInfo?: BuyerInfoUpdate;\n }\n interface UpdateBuyerEmailOptions {\n email?: string | null;\n }\n interface UpdateOrderShippingAddressOptions {\n /** Shipping address and contact details to be updated. */\n shippingAddress: AddressWithContact;\n }\n interface UpdateBillingContactDetailsOptions {\n /** Contact details. */\n addressContactDetails?: FullAddressContactDetails;\n }\n interface UpdateOrderLineItemIdentifiers {\n /** Order ID */\n _id: string;\n /** Line item ID. */\n lineItemId?: string;\n }\n interface UpdateOrderLineItem {\n /** Line item ID. */\n _id?: string;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n */\n productName?: ProductName;\n /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. */\n catalogReference?: CatalogReference;\n /** Line item quantity. */\n quantity?: number;\n /**\n * Total discount for this line item's entire quantity.\n * @readonly\n */\n totalDiscount?: Price$1;\n /** Line item description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine[];\n /** Line item image. */\n image?: string;\n /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */\n physicalProperties?: PhysicalProperties;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType;\n /**\n * Fulfiller ID. Field is empty when the line item is self-fulfilled.\n *\n * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).\n */\n fulfillerId?: string | null;\n /**\n * Number of items that were refunded.\n * @readonly\n */\n refundQuantity?: number | null;\n /**\n * Number of items restocked.\n * @readonly\n */\n restockQuantity?: number | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$1;\n /**\n * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: Price$1;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$1;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$1;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.\n */\n paymentOption?: PaymentOptionType;\n /**\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax details for this line item.\n * @deprecated Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax details for this line item.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxDetails?: ItemTaxFullDetails;\n /** Represents all the relevant tax details for a specific line item. */\n taxInfo?: LineItemTaxInfo;\n /** Digital file identifier, relevant only for items with type DIGITAL. */\n digitalFile?: DigitalFile$1;\n /** Subscription info. */\n subscriptionInfo?: SubscriptionInfo$1;\n /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription;\n /**\n * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `\"DEPOSIT_ONLINE\"`.\n * @readonly\n */\n depositAmount?: Price$1;\n }\n interface UpdateOrderLineItemOptions {\n }\n interface UpdateActivityIdentifiers {\n /** Order ID. */\n _id: string;\n /** ID of the activity to update. */\n activityId: string;\n }\n interface DeleteActivityIdentifiers {\n /** Order ID. */\n _id: string;\n /** ID of the activity to delete. */\n activityId: string;\n }\n /**\n * Cancels an order.\n *\n *\n * The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function cancelOrder(_id: string, options?: CancelOrderOptions): Promise;\n interface CancelOrderOptions {\n /** Whether to send an order canceled email to the buyer. */\n sendOrderCanceledEmail?: boolean;\n /** Custom note to be added to the email (optional). */\n customMessage?: string | null;\n /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */\n restockAllItems?: boolean;\n }\n interface BulkMarkAsFulfilledOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkMarkAsUnfulfilledOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n interface AggregateOrdersOptions {\n /** Filter applied to original data */\n filter?: Record | null;\n /** This is an object defining aggregation itself */\n aggregation: Record | null;\n /**\n * Optional custom separator string that can be used to override default separator value '|'\n * for hierarchical responses of multifaceted aggregation requests like:\n * '{\"aggregation\": {\"example_request_key\": {\"$count\" : [\"deliveryMethod\", \"shippingRegion\"]}}}'\n * with example response for default '|' separator like:\n * '{\"aggregates\" :{\"example_request_key\": {\"(Mail|Region 1)\": 5, \"(Pickup|Region 2)\": 10}}}'\n */\n hierarchySeparatorOverride?: string | null;\n }\n interface BulkUpdateOrderTagsOptions {\n /** Tags to be added to orders */\n assignTags?: Tags;\n /** Tags to be removed from orders */\n unassignTags?: Tags;\n }\n type ecomV1OrderOrders_universal_d_OrderLineItem = OrderLineItem;\n type ecomV1OrderOrders_universal_d_ProductName = ProductName;\n type ecomV1OrderOrders_universal_d_CatalogReference = CatalogReference;\n type ecomV1OrderOrders_universal_d_DescriptionLine = DescriptionLine;\n type ecomV1OrderOrders_universal_d_DescriptionLineValueOneOf = DescriptionLineValueOneOf;\n type ecomV1OrderOrders_universal_d_DescriptionLineDescriptionLineValueOneOf = DescriptionLineDescriptionLineValueOneOf;\n type ecomV1OrderOrders_universal_d_DescriptionLineName = DescriptionLineName;\n type ecomV1OrderOrders_universal_d_PlainTextValue = PlainTextValue;\n type ecomV1OrderOrders_universal_d_Color = Color;\n type ecomV1OrderOrders_universal_d_DescriptionLineType = DescriptionLineType;\n const ecomV1OrderOrders_universal_d_DescriptionLineType: typeof DescriptionLineType;\n type ecomV1OrderOrders_universal_d_PhysicalProperties = PhysicalProperties;\n type ecomV1OrderOrders_universal_d_ItemType = ItemType;\n type ecomV1OrderOrders_universal_d_ItemTypeItemTypeDataOneOf = ItemTypeItemTypeDataOneOf;\n type ecomV1OrderOrders_universal_d_ItemTypeItemType = ItemTypeItemType;\n const ecomV1OrderOrders_universal_d_ItemTypeItemType: typeof ItemTypeItemType;\n type ecomV1OrderOrders_universal_d_PaymentOptionType = PaymentOptionType;\n const ecomV1OrderOrders_universal_d_PaymentOptionType: typeof PaymentOptionType;\n type ecomV1OrderOrders_universal_d_ItemTaxFullDetails = ItemTaxFullDetails;\n type ecomV1OrderOrders_universal_d_LineItemTaxInfo = LineItemTaxInfo;\n type ecomV1OrderOrders_universal_d_LineItemTaxBreakdown = LineItemTaxBreakdown;\n type ecomV1OrderOrders_universal_d_JurisdictionType = JurisdictionType;\n const ecomV1OrderOrders_universal_d_JurisdictionType: typeof JurisdictionType;\n type ecomV1OrderOrders_universal_d_PriceDescription = PriceDescription;\n type ecomV1OrderOrders_universal_d_LocationAndQuantity = LocationAndQuantity;\n type ecomV1OrderOrders_universal_d_BuyerInfoIdOneOf = BuyerInfoIdOneOf;\n type ecomV1OrderOrders_universal_d_PriceSummary = PriceSummary;\n type ecomV1OrderOrders_universal_d_AddressWithContact = AddressWithContact;\n type ecomV1OrderOrders_universal_d_StreetAddress = StreetAddress;\n type ecomV1OrderOrders_universal_d_AddressLocation = AddressLocation;\n type ecomV1OrderOrders_universal_d_FullAddressContactDetails = FullAddressContactDetails;\n type ecomV1OrderOrders_universal_d_V1ShippingInformation = V1ShippingInformation;\n type ecomV1OrderOrders_universal_d_DeliveryLogistics = DeliveryLogistics;\n type ecomV1OrderOrders_universal_d_DeliveryLogisticsAddressOneOf = DeliveryLogisticsAddressOneOf;\n type ecomV1OrderOrders_universal_d_PickupMethod = PickupMethod;\n const ecomV1OrderOrders_universal_d_PickupMethod: typeof PickupMethod;\n type ecomV1OrderOrders_universal_d_DeliveryTimeSlot = DeliveryTimeSlot;\n type ecomV1OrderOrders_universal_d_ShippingPrice = ShippingPrice;\n type ecomV1OrderOrders_universal_d_ShippingRegion = ShippingRegion;\n type ecomV1OrderOrders_universal_d_OrderStatus = OrderStatus;\n const ecomV1OrderOrders_universal_d_OrderStatus: typeof OrderStatus;\n type ecomV1OrderOrders_universal_d_TaxSummary = TaxSummary;\n type ecomV1OrderOrders_universal_d_OrderTaxInfo = OrderTaxInfo;\n type ecomV1OrderOrders_universal_d_OrderTaxBreakdown = OrderTaxBreakdown;\n type ecomV1OrderOrders_universal_d_AppliedDiscount = AppliedDiscount;\n type ecomV1OrderOrders_universal_d_AppliedDiscountDiscountSourceOneOf = AppliedDiscountDiscountSourceOneOf;\n type ecomV1OrderOrders_universal_d_DiscountType = DiscountType;\n const ecomV1OrderOrders_universal_d_DiscountType: typeof DiscountType;\n type ecomV1OrderOrders_universal_d_Coupon = Coupon;\n type ecomV1OrderOrders_universal_d_MerchantDiscount = MerchantDiscount;\n type ecomV1OrderOrders_universal_d_MerchantDiscountMerchantDiscountReasonOneOf = MerchantDiscountMerchantDiscountReasonOneOf;\n type ecomV1OrderOrders_universal_d_DiscountReason = DiscountReason;\n const ecomV1OrderOrders_universal_d_DiscountReason: typeof DiscountReason;\n type ecomV1OrderOrders_universal_d_DiscountRule = DiscountRule;\n type ecomV1OrderOrders_universal_d_DiscountRuleName = DiscountRuleName;\n type ecomV1OrderOrders_universal_d_LineItemDiscount = LineItemDiscount;\n type ecomV1OrderOrders_universal_d_ActivityContentOneOf = ActivityContentOneOf;\n type ecomV1OrderOrders_universal_d_CustomActivity = CustomActivity;\n type ecomV1OrderOrders_universal_d_MerchantComment = MerchantComment;\n type ecomV1OrderOrders_universal_d_OrderCreatedFromExchange = OrderCreatedFromExchange;\n type ecomV1OrderOrders_universal_d_NewExchangeOrderCreated = NewExchangeOrderCreated;\n type ecomV1OrderOrders_universal_d_LineItemExchangeData = LineItemExchangeData;\n type ecomV1OrderOrders_universal_d_DraftOrderChangesApplied = DraftOrderChangesApplied;\n type ecomV1OrderOrders_universal_d_OrderChange = OrderChange;\n type ecomV1OrderOrders_universal_d_OrderChangeValueOneOf = OrderChangeValueOneOf;\n type ecomV1OrderOrders_universal_d_LineItemChanges = LineItemChanges;\n type ecomV1OrderOrders_universal_d_LineItemQuantityChange = LineItemQuantityChange;\n type ecomV1OrderOrders_universal_d_LineItemQuantityChangeType = LineItemQuantityChangeType;\n const ecomV1OrderOrders_universal_d_LineItemQuantityChangeType: typeof LineItemQuantityChangeType;\n type ecomV1OrderOrders_universal_d_LineItemPriceChange = LineItemPriceChange;\n type ecomV1OrderOrders_universal_d_ManagedLineItem = ManagedLineItem;\n type ecomV1OrderOrders_universal_d_ManagedDiscount = ManagedDiscount;\n type ecomV1OrderOrders_universal_d_TranslatedValue = TranslatedValue;\n type ecomV1OrderOrders_universal_d_LineItemAmount = LineItemAmount;\n type ecomV1OrderOrders_universal_d_ManagedAdditionalFee = ManagedAdditionalFee;\n type ecomV1OrderOrders_universal_d_TotalPriceChange = TotalPriceChange;\n type ecomV1OrderOrders_universal_d_ShippingInformationChange = ShippingInformationChange;\n type ecomV1OrderOrders_universal_d_ShippingInformation = ShippingInformation;\n type ecomV1OrderOrders_universal_d_SavedPaymentMethod = SavedPaymentMethod;\n type ecomV1OrderOrders_universal_d_AuthorizedPaymentCreated = AuthorizedPaymentCreated;\n type ecomV1OrderOrders_universal_d_AuthorizedPaymentCaptured = AuthorizedPaymentCaptured;\n type ecomV1OrderOrders_universal_d_AuthorizedPaymentVoided = AuthorizedPaymentVoided;\n type ecomV1OrderOrders_universal_d_AttributionSource = AttributionSource;\n const ecomV1OrderOrders_universal_d_AttributionSource: typeof AttributionSource;\n type ecomV1OrderOrders_universal_d_CreatedBy = CreatedBy;\n type ecomV1OrderOrders_universal_d_CreatedByStringOneOf = CreatedByStringOneOf;\n type ecomV1OrderOrders_universal_d_BalanceSummary = BalanceSummary;\n type ecomV1OrderOrders_universal_d_Balance = Balance;\n type ecomV1OrderOrders_universal_d_AdditionalFee = AdditionalFee;\n type ecomV1OrderOrders_universal_d_FulfillmentStatusesAggregate = FulfillmentStatusesAggregate;\n type ecomV1OrderOrders_universal_d_ExtendedFields = ExtendedFields;\n type ecomV1OrderOrders_universal_d_Tags = Tags;\n type ecomV1OrderOrders_universal_d_TagList = TagList;\n type ecomV1OrderOrders_universal_d_TriggerReindexOrderRequest = TriggerReindexOrderRequest;\n type ecomV1OrderOrders_universal_d_RegularPaymentDetailsPaymentMethodDetailsOneOf = RegularPaymentDetailsPaymentMethodDetailsOneOf;\n type ecomV1OrderOrders_universal_d_CreditCardPaymentMethodDetails = CreditCardPaymentMethodDetails;\n type ecomV1OrderOrders_universal_d_AuthorizationDetails = AuthorizationDetails;\n type ecomV1OrderOrders_universal_d_AuthorizationCapture = AuthorizationCapture;\n type ecomV1OrderOrders_universal_d_AuthorizationCaptureStatus = AuthorizationCaptureStatus;\n const ecomV1OrderOrders_universal_d_AuthorizationCaptureStatus: typeof AuthorizationCaptureStatus;\n type ecomV1OrderOrders_universal_d_AuthorizationActionFailureDetails = AuthorizationActionFailureDetails;\n type ecomV1OrderOrders_universal_d_AuthorizationVoid = AuthorizationVoid;\n type ecomV1OrderOrders_universal_d_AuthorizationVoidStatus = AuthorizationVoidStatus;\n const ecomV1OrderOrders_universal_d_AuthorizationVoidStatus: typeof AuthorizationVoidStatus;\n type ecomV1OrderOrders_universal_d_Reason = Reason;\n const ecomV1OrderOrders_universal_d_Reason: typeof Reason;\n type ecomV1OrderOrders_universal_d_ScheduledAction = ScheduledAction;\n type ecomV1OrderOrders_universal_d_ActionType = ActionType;\n const ecomV1OrderOrders_universal_d_ActionType: typeof ActionType;\n type ecomV1OrderOrders_universal_d_LineItemRefund = LineItemRefund;\n type ecomV1OrderOrders_universal_d_AdditionalFeeRefund = AdditionalFeeRefund;\n type ecomV1OrderOrders_universal_d_ShippingRefund = ShippingRefund;\n type ecomV1OrderOrders_universal_d_AggregatedRefundSummary = AggregatedRefundSummary;\n type ecomV1OrderOrders_universal_d_GetMetasiteDataRequest = GetMetasiteDataRequest;\n type ecomV1OrderOrders_universal_d_GetMetasiteDataResponse = GetMetasiteDataResponse;\n type ecomV1OrderOrders_universal_d_MetaSite = MetaSite;\n type ecomV1OrderOrders_universal_d_App = App;\n type ecomV1OrderOrders_universal_d_State = State;\n const ecomV1OrderOrders_universal_d_State: typeof State;\n type ecomV1OrderOrders_universal_d_Namespace = Namespace;\n const ecomV1OrderOrders_universal_d_Namespace: typeof Namespace;\n type ecomV1OrderOrders_universal_d_SeoData = SeoData;\n type ecomV1OrderOrders_universal_d_MetaTag = MetaTag;\n type ecomV1OrderOrders_universal_d_HtmlApplication = HtmlApplication;\n type ecomV1OrderOrders_universal_d_ExternalUriMapping = ExternalUriMapping;\n type ecomV1OrderOrders_universal_d_UserDataResponse = UserDataResponse;\n type ecomV1OrderOrders_universal_d_QueryOrdersForMetasiteRequest = QueryOrdersForMetasiteRequest;\n type ecomV1OrderOrders_universal_d_InternalQueryOrdersRequest = InternalQueryOrdersRequest;\n type ecomV1OrderOrders_universal_d_PlatformQuery = PlatformQuery;\n type ecomV1OrderOrders_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type ecomV1OrderOrders_universal_d_Sorting = Sorting;\n type ecomV1OrderOrders_universal_d_SortOrder = SortOrder;\n const ecomV1OrderOrders_universal_d_SortOrder: typeof SortOrder;\n type ecomV1OrderOrders_universal_d_PlatformPaging = PlatformPaging;\n type ecomV1OrderOrders_universal_d_CursorPaging = CursorPaging;\n type ecomV1OrderOrders_universal_d_QueryOrdersForMetasiteResponse = QueryOrdersForMetasiteResponse;\n type ecomV1OrderOrders_universal_d_PlatformPagingMetadata = PlatformPagingMetadata;\n type ecomV1OrderOrders_universal_d_Cursors = Cursors;\n type ecomV1OrderOrders_universal_d_GetOrderForMetasiteRequest = GetOrderForMetasiteRequest;\n type ecomV1OrderOrders_universal_d_GetOrderForMetasiteResponse = GetOrderForMetasiteResponse;\n type ecomV1OrderOrders_universal_d_ListOrderTransactionsForMetasiteRequest = ListOrderTransactionsForMetasiteRequest;\n type ecomV1OrderOrders_universal_d_ListOrderTransactionsForMetasiteResponse = ListOrderTransactionsForMetasiteResponse;\n type ecomV1OrderOrders_universal_d_TestUrlAdditionalBindingsRequest = TestUrlAdditionalBindingsRequest;\n type ecomV1OrderOrders_universal_d_TestUrlAdditionalBindingsResponse = TestUrlAdditionalBindingsResponse;\n type ecomV1OrderOrders_universal_d_UpdateInternalDocumentsEvent = UpdateInternalDocumentsEvent;\n type ecomV1OrderOrders_universal_d_UpdateInternalDocumentsEventOperationOneOf = UpdateInternalDocumentsEventOperationOneOf;\n type ecomV1OrderOrders_universal_d_InternalDocument = InternalDocument;\n type ecomV1OrderOrders_universal_d_InternalDocumentUpdateOperation = InternalDocumentUpdateOperation;\n type ecomV1OrderOrders_universal_d_DeleteByIdsOperation = DeleteByIdsOperation;\n type ecomV1OrderOrders_universal_d_DeleteByFilterOperation = DeleteByFilterOperation;\n type ecomV1OrderOrders_universal_d_InternalDocumentUpdateByFilterOperation = InternalDocumentUpdateByFilterOperation;\n type ecomV1OrderOrders_universal_d_InternalUpdateExistingOperation = InternalUpdateExistingOperation;\n type ecomV1OrderOrders_universal_d_VersionedDocumentUpdateOperation = VersionedDocumentUpdateOperation;\n type ecomV1OrderOrders_universal_d_VersioningMode = VersioningMode;\n const ecomV1OrderOrders_universal_d_VersioningMode: typeof VersioningMode;\n type ecomV1OrderOrders_universal_d_VersionedDeleteByIdsOperation = VersionedDeleteByIdsOperation;\n type ecomV1OrderOrders_universal_d_VersionedDocumentId = VersionedDocumentId;\n type ecomV1OrderOrders_universal_d_TriggerReindexRequest = TriggerReindexRequest;\n type ecomV1OrderOrders_universal_d_TriggerReindexResponse = TriggerReindexResponse;\n type ecomV1OrderOrders_universal_d_BatchOfTriggerReindexOrderRequest = BatchOfTriggerReindexOrderRequest;\n type ecomV1OrderOrders_universal_d_SendBuyerConfirmationEmailRequest = SendBuyerConfirmationEmailRequest;\n type ecomV1OrderOrders_universal_d_SendBuyerConfirmationEmailResponse = SendBuyerConfirmationEmailResponse;\n type ecomV1OrderOrders_universal_d_SendBuyerPaymentsReceivedEmailRequest = SendBuyerPaymentsReceivedEmailRequest;\n type ecomV1OrderOrders_universal_d_SendBuyerPaymentsReceivedEmailResponse = SendBuyerPaymentsReceivedEmailResponse;\n type ecomV1OrderOrders_universal_d_SendBuyerPickupConfirmationEmailRequest = SendBuyerPickupConfirmationEmailRequest;\n type ecomV1OrderOrders_universal_d_SendBuyerPickupConfirmationEmailResponse = SendBuyerPickupConfirmationEmailResponse;\n type ecomV1OrderOrders_universal_d_BulkSendBuyerPickupConfirmationEmailsRequest = BulkSendBuyerPickupConfirmationEmailsRequest;\n type ecomV1OrderOrders_universal_d_BulkSendBuyerPickupConfirmationEmailsResponse = BulkSendBuyerPickupConfirmationEmailsResponse;\n type ecomV1OrderOrders_universal_d_SendBuyerShippingConfirmationEmailRequest = SendBuyerShippingConfirmationEmailRequest;\n type ecomV1OrderOrders_universal_d_SendBuyerShippingConfirmationEmailResponse = SendBuyerShippingConfirmationEmailResponse;\n type ecomV1OrderOrders_universal_d_BulkSendBuyerShippingConfirmationEmailsRequest = BulkSendBuyerShippingConfirmationEmailsRequest;\n type ecomV1OrderOrders_universal_d_BulkSendBuyerShippingConfirmationEmailsResponse = BulkSendBuyerShippingConfirmationEmailsResponse;\n type ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedNotificationRequest = SendMerchantOrderReceivedNotificationRequest;\n type ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedNotificationResponse = SendMerchantOrderReceivedNotificationResponse;\n type ecomV1OrderOrders_universal_d_SendCancelRefundEmailRequest = SendCancelRefundEmailRequest;\n type ecomV1OrderOrders_universal_d_SendCancelRefundEmailResponse = SendCancelRefundEmailResponse;\n type ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedPushRequest = SendMerchantOrderReceivedPushRequest;\n type ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedPushResponse = SendMerchantOrderReceivedPushResponse;\n type ecomV1OrderOrders_universal_d_PreviewEmailByTypeRequest = PreviewEmailByTypeRequest;\n type ecomV1OrderOrders_universal_d_PreviewEmailType = PreviewEmailType;\n const ecomV1OrderOrders_universal_d_PreviewEmailType: typeof PreviewEmailType;\n type ecomV1OrderOrders_universal_d_PreviewEmailByTypeResponse = PreviewEmailByTypeResponse;\n type ecomV1OrderOrders_universal_d_PreviewRefundEmailRequest = PreviewRefundEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewRefundEmailResponse = PreviewRefundEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewCancelEmailRequest = PreviewCancelEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewCancelEmailResponse = PreviewCancelEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewCancelRefundEmailRequest = PreviewCancelRefundEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewCancelRefundEmailResponse = PreviewCancelRefundEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewBuyerPaymentsReceivedEmailRequest = PreviewBuyerPaymentsReceivedEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewBuyerPaymentsReceivedEmailResponse = PreviewBuyerPaymentsReceivedEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewBuyerConfirmationEmailRequest = PreviewBuyerConfirmationEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewBuyerConfirmationEmailResponse = PreviewBuyerConfirmationEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewBuyerPickupConfirmationEmailRequest = PreviewBuyerPickupConfirmationEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewBuyerPickupConfirmationEmailResponse = PreviewBuyerPickupConfirmationEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewShippingConfirmationEmailRequest = PreviewShippingConfirmationEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewShippingConfirmationEmailResponse = PreviewShippingConfirmationEmailResponse;\n type ecomV1OrderOrders_universal_d_PreviewResendDownloadLinksEmailRequest = PreviewResendDownloadLinksEmailRequest;\n type ecomV1OrderOrders_universal_d_PreviewResendDownloadLinksEmailResponse = PreviewResendDownloadLinksEmailResponse;\n type ecomV1OrderOrders_universal_d_PreparePaymentCollectionRequest = PreparePaymentCollectionRequest;\n type ecomV1OrderOrders_universal_d_RedirectUrls = RedirectUrls;\n type ecomV1OrderOrders_universal_d_PreparePaymentCollectionResponse = PreparePaymentCollectionResponse;\n type ecomV1OrderOrders_universal_d_GetPaymentCollectabilityStatusRequest = GetPaymentCollectabilityStatusRequest;\n type ecomV1OrderOrders_universal_d_GetPaymentCollectabilityStatusResponse = GetPaymentCollectabilityStatusResponse;\n type ecomV1OrderOrders_universal_d_PaymentCollectabilityStatus = PaymentCollectabilityStatus;\n const ecomV1OrderOrders_universal_d_PaymentCollectabilityStatus: typeof PaymentCollectabilityStatus;\n type ecomV1OrderOrders_universal_d_RecordManuallyCollectedPaymentRequest = RecordManuallyCollectedPaymentRequest;\n type ecomV1OrderOrders_universal_d_RecordManuallyCollectedPaymentResponse = RecordManuallyCollectedPaymentResponse;\n type ecomV1OrderOrders_universal_d_MarkOrderAsPaidRequest = MarkOrderAsPaidRequest;\n type ecomV1OrderOrders_universal_d_MarkOrderAsPaidResponse = MarkOrderAsPaidResponse;\n type ecomV1OrderOrders_universal_d_PaymentStatusUpdated = PaymentStatusUpdated;\n type ecomV1OrderOrders_universal_d_BulkMarkOrdersAsPaidRequest = BulkMarkOrdersAsPaidRequest;\n type ecomV1OrderOrders_universal_d_BulkMarkOrdersAsPaidResponse = BulkMarkOrdersAsPaidResponse;\n type ecomV1OrderOrders_universal_d_BulkOrderResult = BulkOrderResult;\n type ecomV1OrderOrders_universal_d_CreatePaymentGatewayOrderRequest = CreatePaymentGatewayOrderRequest;\n type ecomV1OrderOrders_universal_d_ChargedBy = ChargedBy;\n type ecomV1OrderOrders_universal_d_CreatePaymentGatewayOrderResponse = CreatePaymentGatewayOrderResponse;\n type ecomV1OrderOrders_universal_d_ChargeMembershipsRequest = ChargeMembershipsRequest;\n type ecomV1OrderOrders_universal_d_MembershipChargeItem = MembershipChargeItem;\n type ecomV1OrderOrders_universal_d_ServiceProperties = ServiceProperties;\n type ecomV1OrderOrders_universal_d_ChargeMembershipsResponse = ChargeMembershipsResponse;\n type ecomV1OrderOrders_universal_d_VoidAuthorizedPaymentsRequest = VoidAuthorizedPaymentsRequest;\n type ecomV1OrderOrders_universal_d_VoidAuthorizedPaymentsResponse = VoidAuthorizedPaymentsResponse;\n type ecomV1OrderOrders_universal_d_CaptureAuthorizedPaymentsRequest = CaptureAuthorizedPaymentsRequest;\n type ecomV1OrderOrders_universal_d_PaymentCapture = PaymentCapture;\n type ecomV1OrderOrders_universal_d_CaptureAuthorizedPaymentsResponse = CaptureAuthorizedPaymentsResponse;\n type ecomV1OrderOrders_universal_d_ChargeSavedPaymentMethodRequest = ChargeSavedPaymentMethodRequest;\n type ecomV1OrderOrders_universal_d_ChargeSavedPaymentMethodResponse = ChargeSavedPaymentMethodResponse;\n type ecomV1OrderOrders_universal_d_ContinueSideEffectsFlowInLegacyData = ContinueSideEffectsFlowInLegacyData;\n type ecomV1OrderOrders_universal_d_OrdersExperiments = OrdersExperiments;\n type ecomV1OrderOrders_universal_d_GetOrderRequest = GetOrderRequest;\n type ecomV1OrderOrders_universal_d_GetOrderResponse = GetOrderResponse;\n type ecomV1OrderOrders_universal_d_InternalQueryOrdersResponse = InternalQueryOrdersResponse;\n type ecomV1OrderOrders_universal_d_QueryOrderRequest = QueryOrderRequest;\n type ecomV1OrderOrders_universal_d_QueryOrderResponse = QueryOrderResponse;\n type ecomV1OrderOrders_universal_d_SearchOrdersRequest = SearchOrdersRequest;\n type ecomV1OrderOrders_universal_d_CursorSearch = CursorSearch;\n type ecomV1OrderOrders_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type ecomV1OrderOrders_universal_d_SearchOrdersResponse = SearchOrdersResponse;\n type ecomV1OrderOrders_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type ecomV1OrderOrders_universal_d_CreateOrderRequest = CreateOrderRequest;\n type ecomV1OrderOrders_universal_d_OrderCreationSettings = OrderCreationSettings;\n type ecomV1OrderOrders_universal_d_OrderApprovalStrategy = OrderApprovalStrategy;\n const ecomV1OrderOrders_universal_d_OrderApprovalStrategy: typeof OrderApprovalStrategy;\n type ecomV1OrderOrders_universal_d_OrderCreateNotifications = OrderCreateNotifications;\n type ecomV1OrderOrders_universal_d_CreateOrderResponse = CreateOrderResponse;\n type ecomV1OrderOrders_universal_d_UpdateOrderRequest = UpdateOrderRequest;\n type ecomV1OrderOrders_universal_d_UpdateOrderResponse = UpdateOrderResponse;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrdersRequest = BulkUpdateOrdersRequest;\n type ecomV1OrderOrders_universal_d_MaskedOrder = MaskedOrder;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrdersResponse = BulkUpdateOrdersResponse;\n type ecomV1OrderOrders_universal_d_CommitDeltasRequest = CommitDeltasRequest;\n type ecomV1OrderOrders_universal_d_DraftOrderDiffs = DraftOrderDiffs;\n type ecomV1OrderOrders_universal_d_DraftOrderDiffsShippingUpdateInfoOneOf = DraftOrderDiffsShippingUpdateInfoOneOf;\n type ecomV1OrderOrders_universal_d_DraftOrderDiffsBuyerUpdateInfoOneOf = DraftOrderDiffsBuyerUpdateInfoOneOf;\n type ecomV1OrderOrders_universal_d_DraftOrderDiffsBillingUpdateInfoOneOf = DraftOrderDiffsBillingUpdateInfoOneOf;\n type ecomV1OrderOrders_universal_d_DraftOrderDiffsRecipientUpdateInfoOneOf = DraftOrderDiffsRecipientUpdateInfoOneOf;\n type ecomV1OrderOrders_universal_d_V1LineItemDelta = V1LineItemDelta;\n type ecomV1OrderOrders_universal_d_V1LineItemDeltaDeltaOneOf = V1LineItemDeltaDeltaOneOf;\n type ecomV1OrderOrders_universal_d_OrderLineItemChangedDetails = OrderLineItemChangedDetails;\n type ecomV1OrderOrders_universal_d_DeltaPaymentOptionType = DeltaPaymentOptionType;\n const ecomV1OrderOrders_universal_d_DeltaPaymentOptionType: typeof DeltaPaymentOptionType;\n type ecomV1OrderOrders_universal_d_ItemChangedDetails = ItemChangedDetails;\n type ecomV1OrderOrders_universal_d_AppliedDiscountDelta = AppliedDiscountDelta;\n type ecomV1OrderOrders_universal_d_AppliedDiscountDeltaDeltaOneOf = AppliedDiscountDeltaDeltaOneOf;\n type ecomV1OrderOrders_universal_d_AdditionalFeeDelta = AdditionalFeeDelta;\n type ecomV1OrderOrders_universal_d_AdditionalFeeDeltaDeltaOneOf = AdditionalFeeDeltaDeltaOneOf;\n type ecomV1OrderOrders_universal_d_DraftOrderCommitSettings = DraftOrderCommitSettings;\n type ecomV1OrderOrders_universal_d_InventoryUpdateDetails = InventoryUpdateDetails;\n type ecomV1OrderOrders_universal_d_InventoryAction = InventoryAction;\n const ecomV1OrderOrders_universal_d_InventoryAction: typeof InventoryAction;\n type ecomV1OrderOrders_universal_d_CommitDeltasResponse = CommitDeltasResponse;\n type ecomV1OrderOrders_universal_d_OrderDeltasCommitted = OrderDeltasCommitted;\n type ecomV1OrderOrders_universal_d_CommittedDiffs = CommittedDiffs;\n type ecomV1OrderOrders_universal_d_CommittedDiffsShippingUpdateInfoOneOf = CommittedDiffsShippingUpdateInfoOneOf;\n type ecomV1OrderOrders_universal_d_LineItemDelta = LineItemDelta;\n type ecomV1OrderOrders_universal_d_LineItemDeltaDeltaOneOf = LineItemDeltaDeltaOneOf;\n type ecomV1OrderOrders_universal_d_ArchiveOrderRequest = ArchiveOrderRequest;\n type ecomV1OrderOrders_universal_d_ArchiveOrderResponse = ArchiveOrderResponse;\n type ecomV1OrderOrders_universal_d_BulkArchiveOrdersRequest = BulkArchiveOrdersRequest;\n type ecomV1OrderOrders_universal_d_BulkArchiveOrdersResponse = BulkArchiveOrdersResponse;\n type ecomV1OrderOrders_universal_d_BulkArchiveOrdersByFilterRequest = BulkArchiveOrdersByFilterRequest;\n type ecomV1OrderOrders_universal_d_BulkArchiveOrdersByFilterResponse = BulkArchiveOrdersByFilterResponse;\n type ecomV1OrderOrders_universal_d_UnArchiveOrderRequest = UnArchiveOrderRequest;\n type ecomV1OrderOrders_universal_d_UnArchiveOrderResponse = UnArchiveOrderResponse;\n type ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersRequest = BulkUnArchiveOrdersRequest;\n type ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersResponse = BulkUnArchiveOrdersResponse;\n type ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersByFilterRequest = BulkUnArchiveOrdersByFilterRequest;\n type ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersByFilterResponse = BulkUnArchiveOrdersByFilterResponse;\n type ecomV1OrderOrders_universal_d_UpdateBuyerInfoRequest = UpdateBuyerInfoRequest;\n type ecomV1OrderOrders_universal_d_BuyerInfoUpdate = BuyerInfoUpdate;\n type ecomV1OrderOrders_universal_d_UpdateBuyerInfoResponse = UpdateBuyerInfoResponse;\n type ecomV1OrderOrders_universal_d_UpdateBuyerEmailRequest = UpdateBuyerEmailRequest;\n type ecomV1OrderOrders_universal_d_UpdateBuyerEmailResponse = UpdateBuyerEmailResponse;\n type ecomV1OrderOrders_universal_d_UpdateOrderShippingAddressRequest = UpdateOrderShippingAddressRequest;\n type ecomV1OrderOrders_universal_d_UpdateOrderShippingAddressResponse = UpdateOrderShippingAddressResponse;\n type ecomV1OrderOrders_universal_d_UpdateBillingContactDetailsRequest = UpdateBillingContactDetailsRequest;\n type ecomV1OrderOrders_universal_d_UpdateBillingContactDetailsResponse = UpdateBillingContactDetailsResponse;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItemRequest = UpdateOrderLineItemRequest;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItemResponse = UpdateOrderLineItemResponse;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItemsRequest = UpdateOrderLineItemsRequest;\n type ecomV1OrderOrders_universal_d_MaskedOrderLineItem = MaskedOrderLineItem;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItemsResponse = UpdateOrderLineItemsResponse;\n type ecomV1OrderOrders_universal_d_AddInternalActivityRequest = AddInternalActivityRequest;\n type ecomV1OrderOrders_universal_d_InternalActivity = InternalActivity;\n type ecomV1OrderOrders_universal_d_InternalActivityContentOneOf = InternalActivityContentOneOf;\n type ecomV1OrderOrders_universal_d_OrderPlaced = OrderPlaced;\n type ecomV1OrderOrders_universal_d_OrderPaid = OrderPaid;\n type ecomV1OrderOrders_universal_d_OrderFulfilled = OrderFulfilled;\n type ecomV1OrderOrders_universal_d_OrderNotFulfilled = OrderNotFulfilled;\n type ecomV1OrderOrders_universal_d_OrderCanceled = OrderCanceled;\n type ecomV1OrderOrders_universal_d_DownloadLinkSent = DownloadLinkSent;\n type ecomV1OrderOrders_universal_d_TrackingNumberAdded = TrackingNumberAdded;\n type ecomV1OrderOrders_universal_d_TrackingNumberEdited = TrackingNumberEdited;\n type ecomV1OrderOrders_universal_d_TrackingLinkAdded = TrackingLinkAdded;\n type ecomV1OrderOrders_universal_d_ShippingConfirmationEmailSent = ShippingConfirmationEmailSent;\n type ecomV1OrderOrders_universal_d_InvoiceAdded = InvoiceAdded;\n type ecomV1OrderOrders_universal_d_InvoiceSent = InvoiceSent;\n type ecomV1OrderOrders_universal_d_FulfillerEmailSent = FulfillerEmailSent;\n type ecomV1OrderOrders_universal_d_ShippingAddressEdited = ShippingAddressEdited;\n type ecomV1OrderOrders_universal_d_EmailEdited = EmailEdited;\n type ecomV1OrderOrders_universal_d_PickupReadyEmailSent = PickupReadyEmailSent;\n type ecomV1OrderOrders_universal_d_OrderPartiallyPaid = OrderPartiallyPaid;\n type ecomV1OrderOrders_universal_d_AddInternalActivityResponse = AddInternalActivityResponse;\n type ecomV1OrderOrders_universal_d_AddActivityRequest = AddActivityRequest;\n type ecomV1OrderOrders_universal_d_PublicActivity = PublicActivity;\n type ecomV1OrderOrders_universal_d_PublicActivityContentOneOf = PublicActivityContentOneOf;\n type ecomV1OrderOrders_universal_d_AddActivityResponse = AddActivityResponse;\n type ecomV1OrderOrders_universal_d_AddActivitiesRequest = AddActivitiesRequest;\n type ecomV1OrderOrders_universal_d_AddActivitiesResponse = AddActivitiesResponse;\n type ecomV1OrderOrders_universal_d_UpdateActivityRequest = UpdateActivityRequest;\n type ecomV1OrderOrders_universal_d_UpdateActivityResponse = UpdateActivityResponse;\n type ecomV1OrderOrders_universal_d_DeleteActivityRequest = DeleteActivityRequest;\n type ecomV1OrderOrders_universal_d_DeleteActivityResponse = DeleteActivityResponse;\n type ecomV1OrderOrders_universal_d_UpdateLineItemsDescriptionLinesRequest = UpdateLineItemsDescriptionLinesRequest;\n type ecomV1OrderOrders_universal_d_LineItemUpdate = LineItemUpdate;\n type ecomV1OrderOrders_universal_d_UpdateLineItemsDescriptionLinesResponse = UpdateLineItemsDescriptionLinesResponse;\n type ecomV1OrderOrders_universal_d_MarkOrderAsSeenByHumanRequest = MarkOrderAsSeenByHumanRequest;\n type ecomV1OrderOrders_universal_d_MarkOrderAsSeenByHumanResponse = MarkOrderAsSeenByHumanResponse;\n type ecomV1OrderOrders_universal_d_CancelOrderRequest = CancelOrderRequest;\n type ecomV1OrderOrders_universal_d_CancelOrderResponse = CancelOrderResponse;\n type ecomV1OrderOrders_universal_d_OrderCanceledEventOrderCanceled = OrderCanceledEventOrderCanceled;\n type ecomV1OrderOrders_universal_d_MarkAsFulfilledRequest = MarkAsFulfilledRequest;\n type ecomV1OrderOrders_universal_d_MarkAsFulfilledResponse = MarkAsFulfilledResponse;\n type ecomV1OrderOrders_universal_d_FulfillmentStatusUpdated = FulfillmentStatusUpdated;\n type ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledRequest = BulkMarkAsFulfilledRequest;\n type ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledResponse = BulkMarkAsFulfilledResponse;\n type ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledByFilterRequest = BulkMarkAsFulfilledByFilterRequest;\n type ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledByFilterResponse = BulkMarkAsFulfilledByFilterResponse;\n type ecomV1OrderOrders_universal_d_MarkAsUnfulfilledRequest = MarkAsUnfulfilledRequest;\n type ecomV1OrderOrders_universal_d_MarkAsUnfulfilledResponse = MarkAsUnfulfilledResponse;\n type ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledRequest = BulkMarkAsUnfulfilledRequest;\n type ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledResponse = BulkMarkAsUnfulfilledResponse;\n type ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledByFilterRequest = BulkMarkAsUnfulfilledByFilterRequest;\n type ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledByFilterResponse = BulkMarkAsUnfulfilledByFilterResponse;\n type ecomV1OrderOrders_universal_d_V1MarkOrderAsPaidRequest = V1MarkOrderAsPaidRequest;\n type ecomV1OrderOrders_universal_d_V1MarkOrderAsPaidResponse = V1MarkOrderAsPaidResponse;\n type ecomV1OrderOrders_universal_d_V1BulkMarkOrdersAsPaidRequest = V1BulkMarkOrdersAsPaidRequest;\n type ecomV1OrderOrders_universal_d_V1BulkMarkOrdersAsPaidResponse = V1BulkMarkOrdersAsPaidResponse;\n type ecomV1OrderOrders_universal_d_V1CreatePaymentGatewayOrderRequest = V1CreatePaymentGatewayOrderRequest;\n type ecomV1OrderOrders_universal_d_V1CreatePaymentGatewayOrderResponse = V1CreatePaymentGatewayOrderResponse;\n type ecomV1OrderOrders_universal_d_GetShipmentsRequest = GetShipmentsRequest;\n type ecomV1OrderOrders_universal_d_GetShipmentsResponse = GetShipmentsResponse;\n type ecomV1OrderOrders_universal_d_AggregateOrdersRequest = AggregateOrdersRequest;\n type ecomV1OrderOrders_universal_d_AggregateOrdersResponse = AggregateOrdersResponse;\n type ecomV1OrderOrders_universal_d_DecrementItemsQuantityRequest = DecrementItemsQuantityRequest;\n type ecomV1OrderOrders_universal_d_DecrementData = DecrementData;\n type ecomV1OrderOrders_universal_d_DecrementItemsQuantityResponse = DecrementItemsQuantityResponse;\n type ecomV1OrderOrders_universal_d_OrderItemsRestocked = OrderItemsRestocked;\n type ecomV1OrderOrders_universal_d_V1RestockItem = V1RestockItem;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsRequest = BulkUpdateOrderTagsRequest;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsResponse = BulkUpdateOrderTagsResponse;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsResult = BulkUpdateOrderTagsResult;\n type ecomV1OrderOrders_universal_d_OrderApproved = OrderApproved;\n type ecomV1OrderOrders_universal_d_Task = Task;\n type ecomV1OrderOrders_universal_d_TaskKey = TaskKey;\n type ecomV1OrderOrders_universal_d_TaskAction = TaskAction;\n type ecomV1OrderOrders_universal_d_TaskActionActionOneOf = TaskActionActionOneOf;\n type ecomV1OrderOrders_universal_d_Complete = Complete;\n type ecomV1OrderOrders_universal_d_Cancel = Cancel;\n type ecomV1OrderOrders_universal_d_Reschedule = Reschedule;\n type ecomV1OrderOrders_universal_d_InvoiceSentEvent = InvoiceSentEvent;\n type ecomV1OrderOrders_universal_d_IdAndVersion = IdAndVersion;\n type ecomV1OrderOrders_universal_d_InvoiceFields = InvoiceFields;\n type ecomV1OrderOrders_universal_d_Customer = Customer;\n type ecomV1OrderOrders_universal_d_Email = Email;\n type ecomV1OrderOrders_universal_d_QuotesAddress = QuotesAddress;\n type ecomV1OrderOrders_universal_d_AddressDescription = AddressDescription;\n type ecomV1OrderOrders_universal_d_Placement = Placement;\n const ecomV1OrderOrders_universal_d_Placement: typeof Placement;\n type ecomV1OrderOrders_universal_d_Phone = Phone;\n type ecomV1OrderOrders_universal_d_Company = Company;\n type ecomV1OrderOrders_universal_d_CommonAddress = CommonAddress;\n type ecomV1OrderOrders_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type ecomV1OrderOrders_universal_d_Subdivision = Subdivision;\n type ecomV1OrderOrders_universal_d_SubdivisionType = SubdivisionType;\n const ecomV1OrderOrders_universal_d_SubdivisionType: typeof SubdivisionType;\n type ecomV1OrderOrders_universal_d_StandardDetails = StandardDetails;\n type ecomV1OrderOrders_universal_d_InvoiceDates = InvoiceDates;\n type ecomV1OrderOrders_universal_d_LineItems = LineItems;\n type ecomV1OrderOrders_universal_d_BigDecimalWrapper = BigDecimalWrapper;\n type ecomV1OrderOrders_universal_d_LineItemTax = LineItemTax;\n type ecomV1OrderOrders_universal_d_Source = Source;\n type ecomV1OrderOrders_universal_d_SourceType = SourceType;\n const ecomV1OrderOrders_universal_d_SourceType: typeof SourceType;\n type ecomV1OrderOrders_universal_d_LineItemMetaData = LineItemMetaData;\n type ecomV1OrderOrders_universal_d_Locale = Locale;\n type ecomV1OrderOrders_universal_d_TotalPrice = TotalPrice;\n type ecomV1OrderOrders_universal_d_ItemizedFee = ItemizedFee;\n type ecomV1OrderOrders_universal_d_DiscountOneDiscountTypeOneOf = DiscountOneDiscountTypeOneOf;\n type ecomV1OrderOrders_universal_d_CalculatedTaxes = CalculatedTaxes;\n type ecomV1OrderOrders_universal_d_CalculatedTax = CalculatedTax;\n type ecomV1OrderOrders_universal_d_Payments = Payments;\n type ecomV1OrderOrders_universal_d_InvoicesPayment = InvoicesPayment;\n type ecomV1OrderOrders_universal_d_MetaData = MetaData;\n type ecomV1OrderOrders_universal_d_InvoiceDynamicPriceTotals = InvoiceDynamicPriceTotals;\n type ecomV1OrderOrders_universal_d_CustomFieldValue = CustomFieldValue;\n type ecomV1OrderOrders_universal_d_CustomFieldGroup = CustomFieldGroup;\n const ecomV1OrderOrders_universal_d_CustomFieldGroup: typeof CustomFieldGroup;\n type ecomV1OrderOrders_universal_d_Value = Value;\n type ecomV1OrderOrders_universal_d_ValueType = ValueType;\n const ecomV1OrderOrders_universal_d_ValueType: typeof ValueType;\n type ecomV1OrderOrders_universal_d_Deposit = Deposit;\n type ecomV1OrderOrders_universal_d_DepositType = DepositType;\n const ecomV1OrderOrders_universal_d_DepositType: typeof DepositType;\n type ecomV1OrderOrders_universal_d_InvoiceStatus = InvoiceStatus;\n const ecomV1OrderOrders_universal_d_InvoiceStatus: typeof InvoiceStatus;\n type ecomV1OrderOrders_universal_d_TriggerSideEffectsFromLegacyData = TriggerSideEffectsFromLegacyData;\n type ecomV1OrderOrders_universal_d_QueryOrdersForMetasiteOptions = QueryOrdersForMetasiteOptions;\n type ecomV1OrderOrders_universal_d_GetOrderForMetasiteIdentifiers = GetOrderForMetasiteIdentifiers;\n type ecomV1OrderOrders_universal_d_ListOrderTransactionsForMetasiteIdentifiers = ListOrderTransactionsForMetasiteIdentifiers;\n type ecomV1OrderOrders_universal_d_TriggerReindexOptions = TriggerReindexOptions;\n type ecomV1OrderOrders_universal_d_BulkSendBuyerPickupConfirmationEmailsOptions = BulkSendBuyerPickupConfirmationEmailsOptions;\n type ecomV1OrderOrders_universal_d_BulkSendBuyerShippingConfirmationEmailsOptions = BulkSendBuyerShippingConfirmationEmailsOptions;\n type ecomV1OrderOrders_universal_d_SendCancelRefundEmailOptions = SendCancelRefundEmailOptions;\n type ecomV1OrderOrders_universal_d_PreviewRefundEmailOptions = PreviewRefundEmailOptions;\n type ecomV1OrderOrders_universal_d_PreviewCancelEmailOptions = PreviewCancelEmailOptions;\n type ecomV1OrderOrders_universal_d_PreviewCancelRefundEmailOptions = PreviewCancelRefundEmailOptions;\n type ecomV1OrderOrders_universal_d_PreparePaymentCollectionOptions = PreparePaymentCollectionOptions;\n const ecomV1OrderOrders_universal_d_getPaymentCollectabilityStatus: typeof getPaymentCollectabilityStatus;\n type ecomV1OrderOrders_universal_d_PaymentCollectionCreatePaymentGatewayOrderOptions = PaymentCollectionCreatePaymentGatewayOrderOptions;\n type ecomV1OrderOrders_universal_d_ChargeMembershipsOptions = ChargeMembershipsOptions;\n const ecomV1OrderOrders_universal_d_getOrder: typeof getOrder;\n type ecomV1OrderOrders_universal_d_InternalQueryOrdersOptions = InternalQueryOrdersOptions;\n type ecomV1OrderOrders_universal_d_OrdersQueryResult = OrdersQueryResult;\n type ecomV1OrderOrders_universal_d_OrdersQueryBuilder = OrdersQueryBuilder;\n const ecomV1OrderOrders_universal_d_searchOrders: typeof searchOrders;\n type ecomV1OrderOrders_universal_d_SearchOrdersOptions = SearchOrdersOptions;\n const ecomV1OrderOrders_universal_d_createOrder: typeof createOrder;\n type ecomV1OrderOrders_universal_d_CreateOrderOptions = CreateOrderOptions;\n const ecomV1OrderOrders_universal_d_updateOrder: typeof updateOrder;\n type ecomV1OrderOrders_universal_d_UpdateOrder = UpdateOrder;\n type ecomV1OrderOrders_universal_d_UpdateOrderOptions = UpdateOrderOptions;\n const ecomV1OrderOrders_universal_d_bulkUpdateOrders: typeof bulkUpdateOrders;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrdersOptions = BulkUpdateOrdersOptions;\n type ecomV1OrderOrders_universal_d_CommitDeltasOptions = CommitDeltasOptions;\n type ecomV1OrderOrders_universal_d_BulkArchiveOrdersOptions = BulkArchiveOrdersOptions;\n type ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersOptions = BulkUnArchiveOrdersOptions;\n type ecomV1OrderOrders_universal_d_UpdateBuyerInfoOptions = UpdateBuyerInfoOptions;\n type ecomV1OrderOrders_universal_d_UpdateBuyerEmailOptions = UpdateBuyerEmailOptions;\n type ecomV1OrderOrders_universal_d_UpdateOrderShippingAddressOptions = UpdateOrderShippingAddressOptions;\n type ecomV1OrderOrders_universal_d_UpdateBillingContactDetailsOptions = UpdateBillingContactDetailsOptions;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItemIdentifiers = UpdateOrderLineItemIdentifiers;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItem = UpdateOrderLineItem;\n type ecomV1OrderOrders_universal_d_UpdateOrderLineItemOptions = UpdateOrderLineItemOptions;\n type ecomV1OrderOrders_universal_d_UpdateActivityIdentifiers = UpdateActivityIdentifiers;\n type ecomV1OrderOrders_universal_d_DeleteActivityIdentifiers = DeleteActivityIdentifiers;\n const ecomV1OrderOrders_universal_d_cancelOrder: typeof cancelOrder;\n type ecomV1OrderOrders_universal_d_CancelOrderOptions = CancelOrderOptions;\n type ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledOptions = BulkMarkAsFulfilledOptions;\n type ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledOptions = BulkMarkAsUnfulfilledOptions;\n type ecomV1OrderOrders_universal_d_AggregateOrdersOptions = AggregateOrdersOptions;\n type ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsOptions = BulkUpdateOrderTagsOptions;\n namespace ecomV1OrderOrders_universal_d {\n export { Order$1 as Order, ecomV1OrderOrders_universal_d_OrderLineItem as OrderLineItem, ecomV1OrderOrders_universal_d_ProductName as ProductName, ecomV1OrderOrders_universal_d_CatalogReference as CatalogReference, Price$1 as Price, ecomV1OrderOrders_universal_d_DescriptionLine as DescriptionLine, ecomV1OrderOrders_universal_d_DescriptionLineValueOneOf as DescriptionLineValueOneOf, ecomV1OrderOrders_universal_d_DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOf, ecomV1OrderOrders_universal_d_DescriptionLineName as DescriptionLineName, ecomV1OrderOrders_universal_d_PlainTextValue as PlainTextValue, ecomV1OrderOrders_universal_d_Color as Color, ecomV1OrderOrders_universal_d_DescriptionLineType as DescriptionLineType, ecomV1OrderOrders_universal_d_PhysicalProperties as PhysicalProperties, ecomV1OrderOrders_universal_d_ItemType as ItemType, ecomV1OrderOrders_universal_d_ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOf, ecomV1OrderOrders_universal_d_ItemTypeItemType as ItemTypeItemType, ecomV1OrderOrders_universal_d_PaymentOptionType as PaymentOptionType, ecomV1OrderOrders_universal_d_ItemTaxFullDetails as ItemTaxFullDetails, ecomV1OrderOrders_universal_d_LineItemTaxInfo as LineItemTaxInfo, ecomV1OrderOrders_universal_d_LineItemTaxBreakdown as LineItemTaxBreakdown, ecomV1OrderOrders_universal_d_JurisdictionType as JurisdictionType, DigitalFile$1 as DigitalFile, SubscriptionInfo$1 as SubscriptionInfo, SubscriptionSettings$1 as SubscriptionSettings, SubscriptionFrequency$1 as SubscriptionFrequency, ecomV1OrderOrders_universal_d_PriceDescription as PriceDescription, ecomV1OrderOrders_universal_d_LocationAndQuantity as LocationAndQuantity, BuyerInfo$1 as BuyerInfo, ecomV1OrderOrders_universal_d_BuyerInfoIdOneOf as BuyerInfoIdOneOf, PaymentStatus$1 as PaymentStatus, FulfillmentStatus$1 as FulfillmentStatus, WeightUnit$1 as WeightUnit, ecomV1OrderOrders_universal_d_PriceSummary as PriceSummary, ecomV1OrderOrders_universal_d_AddressWithContact as AddressWithContact, Address$1 as Address, ecomV1OrderOrders_universal_d_StreetAddress as StreetAddress, ecomV1OrderOrders_universal_d_AddressLocation as AddressLocation, ecomV1OrderOrders_universal_d_FullAddressContactDetails as FullAddressContactDetails, VatId$1 as VatId, VatType$1 as VatType, ecomV1OrderOrders_universal_d_V1ShippingInformation as V1ShippingInformation, ecomV1OrderOrders_universal_d_DeliveryLogistics as DeliveryLogistics, ecomV1OrderOrders_universal_d_DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOf, PickupDetails$1 as PickupDetails, PickupAddress$1 as PickupAddress, ecomV1OrderOrders_universal_d_PickupMethod as PickupMethod, ecomV1OrderOrders_universal_d_DeliveryTimeSlot as DeliveryTimeSlot, ecomV1OrderOrders_universal_d_ShippingPrice as ShippingPrice, ecomV1OrderOrders_universal_d_ShippingRegion as ShippingRegion, ecomV1OrderOrders_universal_d_OrderStatus as OrderStatus, ecomV1OrderOrders_universal_d_TaxSummary as TaxSummary, ecomV1OrderOrders_universal_d_OrderTaxInfo as OrderTaxInfo, ecomV1OrderOrders_universal_d_OrderTaxBreakdown as OrderTaxBreakdown, ecomV1OrderOrders_universal_d_AppliedDiscount as AppliedDiscount, ecomV1OrderOrders_universal_d_AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOf, ecomV1OrderOrders_universal_d_DiscountType as DiscountType, ecomV1OrderOrders_universal_d_Coupon as Coupon, ecomV1OrderOrders_universal_d_MerchantDiscount as MerchantDiscount, ecomV1OrderOrders_universal_d_MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOf, ecomV1OrderOrders_universal_d_DiscountReason as DiscountReason, ecomV1OrderOrders_universal_d_DiscountRule as DiscountRule, ecomV1OrderOrders_universal_d_DiscountRuleName as DiscountRuleName, ecomV1OrderOrders_universal_d_LineItemDiscount as LineItemDiscount, Activity$1 as Activity, ecomV1OrderOrders_universal_d_ActivityContentOneOf as ActivityContentOneOf, ecomV1OrderOrders_universal_d_CustomActivity as CustomActivity, ecomV1OrderOrders_universal_d_MerchantComment as MerchantComment, OrderRefunded$1 as OrderRefunded, ecomV1OrderOrders_universal_d_OrderCreatedFromExchange as OrderCreatedFromExchange, ecomV1OrderOrders_universal_d_NewExchangeOrderCreated as NewExchangeOrderCreated, ecomV1OrderOrders_universal_d_LineItemExchangeData as LineItemExchangeData, ecomV1OrderOrders_universal_d_DraftOrderChangesApplied as DraftOrderChangesApplied, ecomV1OrderOrders_universal_d_OrderChange as OrderChange, ecomV1OrderOrders_universal_d_OrderChangeValueOneOf as OrderChangeValueOneOf, ecomV1OrderOrders_universal_d_LineItemChanges as LineItemChanges, ecomV1OrderOrders_universal_d_LineItemQuantityChange as LineItemQuantityChange, ecomV1OrderOrders_universal_d_LineItemQuantityChangeType as LineItemQuantityChangeType, ecomV1OrderOrders_universal_d_LineItemPriceChange as LineItemPriceChange, ecomV1OrderOrders_universal_d_ManagedLineItem as ManagedLineItem, ecomV1OrderOrders_universal_d_ManagedDiscount as ManagedDiscount, ecomV1OrderOrders_universal_d_TranslatedValue as TranslatedValue, ecomV1OrderOrders_universal_d_LineItemAmount as LineItemAmount, ecomV1OrderOrders_universal_d_ManagedAdditionalFee as ManagedAdditionalFee, ecomV1OrderOrders_universal_d_TotalPriceChange as TotalPriceChange, ecomV1OrderOrders_universal_d_ShippingInformationChange as ShippingInformationChange, ecomV1OrderOrders_universal_d_ShippingInformation as ShippingInformation, ecomV1OrderOrders_universal_d_SavedPaymentMethod as SavedPaymentMethod, ecomV1OrderOrders_universal_d_AuthorizedPaymentCreated as AuthorizedPaymentCreated, ecomV1OrderOrders_universal_d_AuthorizedPaymentCaptured as AuthorizedPaymentCaptured, ecomV1OrderOrders_universal_d_AuthorizedPaymentVoided as AuthorizedPaymentVoided, ActivityType$1 as ActivityType, ecomV1OrderOrders_universal_d_AttributionSource as AttributionSource, ecomV1OrderOrders_universal_d_CreatedBy as CreatedBy, ecomV1OrderOrders_universal_d_CreatedByStringOneOf as CreatedByStringOneOf, ChannelInfo$1 as ChannelInfo, ChannelType$1 as ChannelType, CustomField$1 as CustomField, ecomV1OrderOrders_universal_d_BalanceSummary as BalanceSummary, ecomV1OrderOrders_universal_d_Balance as Balance, ecomV1OrderOrders_universal_d_AdditionalFee as AdditionalFee, ecomV1OrderOrders_universal_d_FulfillmentStatusesAggregate as FulfillmentStatusesAggregate, ecomV1OrderOrders_universal_d_ExtendedFields as ExtendedFields, ecomV1OrderOrders_universal_d_Tags as Tags, ecomV1OrderOrders_universal_d_TagList as TagList, ecomV1OrderOrders_universal_d_TriggerReindexOrderRequest as TriggerReindexOrderRequest, SnapshotMessage$1 as SnapshotMessage, PaymentsUpdated$1 as PaymentsUpdated, OrderTransactions$1 as OrderTransactions, Payment$1 as Payment, PaymentPaymentDetailsOneOf$1 as PaymentPaymentDetailsOneOf, RegularPaymentDetails$1 as RegularPaymentDetails, ecomV1OrderOrders_universal_d_RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOf, TransactionStatus$1 as TransactionStatus, ecomV1OrderOrders_universal_d_CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetails, ecomV1OrderOrders_universal_d_AuthorizationDetails as AuthorizationDetails, ecomV1OrderOrders_universal_d_AuthorizationCapture as AuthorizationCapture, ecomV1OrderOrders_universal_d_AuthorizationCaptureStatus as AuthorizationCaptureStatus, ecomV1OrderOrders_universal_d_AuthorizationActionFailureDetails as AuthorizationActionFailureDetails, ecomV1OrderOrders_universal_d_AuthorizationVoid as AuthorizationVoid, ecomV1OrderOrders_universal_d_AuthorizationVoidStatus as AuthorizationVoidStatus, ecomV1OrderOrders_universal_d_Reason as Reason, ecomV1OrderOrders_universal_d_ScheduledAction as ScheduledAction, ecomV1OrderOrders_universal_d_ActionType as ActionType, GiftCardPaymentDetails$1 as GiftCardPaymentDetails, MembershipPaymentDetails$1 as MembershipPaymentDetails, MembershipPaymentStatus$1 as MembershipPaymentStatus, MembershipName$1 as MembershipName, Refund$1 as Refund, RefundTransaction$1 as RefundTransaction, RefundStatus$1 as RefundStatus, RefundDetails$1 as RefundDetails, RefundItem$1 as RefundItem, ecomV1OrderOrders_universal_d_LineItemRefund as LineItemRefund, ecomV1OrderOrders_universal_d_AdditionalFeeRefund as AdditionalFeeRefund, ecomV1OrderOrders_universal_d_ShippingRefund as ShippingRefund, ecomV1OrderOrders_universal_d_AggregatedRefundSummary as AggregatedRefundSummary, ecomV1OrderOrders_universal_d_GetMetasiteDataRequest as GetMetasiteDataRequest, ecomV1OrderOrders_universal_d_GetMetasiteDataResponse as GetMetasiteDataResponse, ecomV1OrderOrders_universal_d_MetaSite as MetaSite, ecomV1OrderOrders_universal_d_App as App, ecomV1OrderOrders_universal_d_State as State, ecomV1OrderOrders_universal_d_Namespace as Namespace, ecomV1OrderOrders_universal_d_SeoData as SeoData, ecomV1OrderOrders_universal_d_MetaTag as MetaTag, ecomV1OrderOrders_universal_d_HtmlApplication as HtmlApplication, ecomV1OrderOrders_universal_d_ExternalUriMapping as ExternalUriMapping, ecomV1OrderOrders_universal_d_UserDataResponse as UserDataResponse, ecomV1OrderOrders_universal_d_QueryOrdersForMetasiteRequest as QueryOrdersForMetasiteRequest, ecomV1OrderOrders_universal_d_InternalQueryOrdersRequest as InternalQueryOrdersRequest, ecomV1OrderOrders_universal_d_PlatformQuery as PlatformQuery, ecomV1OrderOrders_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf, ecomV1OrderOrders_universal_d_Sorting as Sorting, ecomV1OrderOrders_universal_d_SortOrder as SortOrder, ecomV1OrderOrders_universal_d_PlatformPaging as PlatformPaging, ecomV1OrderOrders_universal_d_CursorPaging as CursorPaging, ecomV1OrderOrders_universal_d_QueryOrdersForMetasiteResponse as QueryOrdersForMetasiteResponse, ecomV1OrderOrders_universal_d_PlatformPagingMetadata as PlatformPagingMetadata, ecomV1OrderOrders_universal_d_Cursors as Cursors, ecomV1OrderOrders_universal_d_GetOrderForMetasiteRequest as GetOrderForMetasiteRequest, ecomV1OrderOrders_universal_d_GetOrderForMetasiteResponse as GetOrderForMetasiteResponse, ecomV1OrderOrders_universal_d_ListOrderTransactionsForMetasiteRequest as ListOrderTransactionsForMetasiteRequest, ecomV1OrderOrders_universal_d_ListOrderTransactionsForMetasiteResponse as ListOrderTransactionsForMetasiteResponse, ecomV1OrderOrders_universal_d_TestUrlAdditionalBindingsRequest as TestUrlAdditionalBindingsRequest, ecomV1OrderOrders_universal_d_TestUrlAdditionalBindingsResponse as TestUrlAdditionalBindingsResponse, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$2 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, MessageEnvelope$3 as MessageEnvelope, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, ecomV1OrderOrders_universal_d_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent, ecomV1OrderOrders_universal_d_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf, ecomV1OrderOrders_universal_d_InternalDocument as InternalDocument, ecomV1OrderOrders_universal_d_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation, ecomV1OrderOrders_universal_d_DeleteByIdsOperation as DeleteByIdsOperation, ecomV1OrderOrders_universal_d_DeleteByFilterOperation as DeleteByFilterOperation, ecomV1OrderOrders_universal_d_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation, ecomV1OrderOrders_universal_d_InternalUpdateExistingOperation as InternalUpdateExistingOperation, ecomV1OrderOrders_universal_d_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation, ecomV1OrderOrders_universal_d_VersioningMode as VersioningMode, ecomV1OrderOrders_universal_d_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation, ecomV1OrderOrders_universal_d_VersionedDocumentId as VersionedDocumentId, ecomV1OrderOrders_universal_d_TriggerReindexRequest as TriggerReindexRequest, ecomV1OrderOrders_universal_d_TriggerReindexResponse as TriggerReindexResponse, Empty$1 as Empty, ecomV1OrderOrders_universal_d_BatchOfTriggerReindexOrderRequest as BatchOfTriggerReindexOrderRequest, ecomV1OrderOrders_universal_d_SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequest, ecomV1OrderOrders_universal_d_SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponse, ecomV1OrderOrders_universal_d_SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequest, ecomV1OrderOrders_universal_d_SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponse, ecomV1OrderOrders_universal_d_SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequest, ecomV1OrderOrders_universal_d_SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponse, ecomV1OrderOrders_universal_d_BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequest, ecomV1OrderOrders_universal_d_BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponse, ecomV1OrderOrders_universal_d_SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequest, ecomV1OrderOrders_universal_d_SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponse, ecomV1OrderOrders_universal_d_BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequest, ecomV1OrderOrders_universal_d_BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponse, ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequest, ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponse, ecomV1OrderOrders_universal_d_SendCancelRefundEmailRequest as SendCancelRefundEmailRequest, ecomV1OrderOrders_universal_d_SendCancelRefundEmailResponse as SendCancelRefundEmailResponse, ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequest, ecomV1OrderOrders_universal_d_SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponse, ecomV1OrderOrders_universal_d_PreviewEmailByTypeRequest as PreviewEmailByTypeRequest, ecomV1OrderOrders_universal_d_PreviewEmailType as PreviewEmailType, ecomV1OrderOrders_universal_d_PreviewEmailByTypeResponse as PreviewEmailByTypeResponse, ecomV1OrderOrders_universal_d_PreviewRefundEmailRequest as PreviewRefundEmailRequest, ecomV1OrderOrders_universal_d_PreviewRefundEmailResponse as PreviewRefundEmailResponse, ecomV1OrderOrders_universal_d_PreviewCancelEmailRequest as PreviewCancelEmailRequest, ecomV1OrderOrders_universal_d_PreviewCancelEmailResponse as PreviewCancelEmailResponse, ecomV1OrderOrders_universal_d_PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequest, ecomV1OrderOrders_universal_d_PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponse, ecomV1OrderOrders_universal_d_PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequest, ecomV1OrderOrders_universal_d_PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponse, ecomV1OrderOrders_universal_d_PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequest, ecomV1OrderOrders_universal_d_PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponse, ecomV1OrderOrders_universal_d_PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequest, ecomV1OrderOrders_universal_d_PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponse, ecomV1OrderOrders_universal_d_PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequest, ecomV1OrderOrders_universal_d_PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponse, ecomV1OrderOrders_universal_d_PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequest, ecomV1OrderOrders_universal_d_PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponse, ecomV1OrderOrders_universal_d_PreparePaymentCollectionRequest as PreparePaymentCollectionRequest, ecomV1OrderOrders_universal_d_RedirectUrls as RedirectUrls, ecomV1OrderOrders_universal_d_PreparePaymentCollectionResponse as PreparePaymentCollectionResponse, ecomV1OrderOrders_universal_d_GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequest, ecomV1OrderOrders_universal_d_GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponse, ecomV1OrderOrders_universal_d_PaymentCollectabilityStatus as PaymentCollectabilityStatus, ecomV1OrderOrders_universal_d_RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequest, ecomV1OrderOrders_universal_d_RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponse, ecomV1OrderOrders_universal_d_MarkOrderAsPaidRequest as MarkOrderAsPaidRequest, ecomV1OrderOrders_universal_d_MarkOrderAsPaidResponse as MarkOrderAsPaidResponse, ecomV1OrderOrders_universal_d_PaymentStatusUpdated as PaymentStatusUpdated, ecomV1OrderOrders_universal_d_BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequest, ecomV1OrderOrders_universal_d_BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponse, ecomV1OrderOrders_universal_d_BulkOrderResult as BulkOrderResult, ItemMetadata$1 as ItemMetadata, ApplicationError$1 as ApplicationError, BulkActionMetadata$1 as BulkActionMetadata, GetRefundabilityStatusRequest$1 as GetRefundabilityStatusRequest, GetRefundabilityStatusResponse$1 as GetRefundabilityStatusResponse, Refundability$1 as Refundability, RefundabilityAdditionalRefundabilityInfoOneOf$1 as RefundabilityAdditionalRefundabilityInfoOneOf, RefundableStatus$1 as RefundableStatus, NonRefundableReason$1 as NonRefundableReason, ManuallyRefundableReason$1 as ManuallyRefundableReason, ecomV1OrderOrders_universal_d_CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequest, ecomV1OrderOrders_universal_d_ChargedBy as ChargedBy, ecomV1OrderOrders_universal_d_CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponse, ecomV1OrderOrders_universal_d_ChargeMembershipsRequest as ChargeMembershipsRequest, ecomV1OrderOrders_universal_d_MembershipChargeItem as MembershipChargeItem, ecomV1OrderOrders_universal_d_ServiceProperties as ServiceProperties, ecomV1OrderOrders_universal_d_ChargeMembershipsResponse as ChargeMembershipsResponse, TriggerRefundRequest$1 as TriggerRefundRequest, PaymentRefund$1 as PaymentRefund, RefundSideEffects$1 as RefundSideEffects, RestockInfo$1 as RestockInfo, RestockType$1 as RestockType, RestockItem$1 as RestockItem, TriggerRefundResponse$1 as TriggerRefundResponse, RefundCreated$1 as RefundCreated, CalculateRefundRequest$1 as CalculateRefundRequest, CalculateRefundItemRequest$1 as CalculateRefundItemRequest, CalculateRefundResponse$1 as CalculateRefundResponse, CalculateRefundItemResponse$1 as CalculateRefundItemResponse, ecomV1OrderOrders_universal_d_VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequest, ecomV1OrderOrders_universal_d_VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponse, ecomV1OrderOrders_universal_d_CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequest, ecomV1OrderOrders_universal_d_PaymentCapture as PaymentCapture, ecomV1OrderOrders_universal_d_CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponse, ecomV1OrderOrders_universal_d_ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequest, ecomV1OrderOrders_universal_d_ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponse, DiffmatokyPayload$1 as DiffmatokyPayload, ErrorInformation$1 as ErrorInformation, ecomV1OrderOrders_universal_d_ContinueSideEffectsFlowInLegacyData as ContinueSideEffectsFlowInLegacyData, ecomV1OrderOrders_universal_d_OrdersExperiments as OrdersExperiments, IndexingMessage$1 as IndexingMessage, ecomV1OrderOrders_universal_d_GetOrderRequest as GetOrderRequest, ecomV1OrderOrders_universal_d_GetOrderResponse as GetOrderResponse, ecomV1OrderOrders_universal_d_InternalQueryOrdersResponse as InternalQueryOrdersResponse, ecomV1OrderOrders_universal_d_QueryOrderRequest as QueryOrderRequest, ecomV1OrderOrders_universal_d_QueryOrderResponse as QueryOrderResponse, ecomV1OrderOrders_universal_d_SearchOrdersRequest as SearchOrdersRequest, ecomV1OrderOrders_universal_d_CursorSearch as CursorSearch, ecomV1OrderOrders_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, ecomV1OrderOrders_universal_d_SearchOrdersResponse as SearchOrdersResponse, ecomV1OrderOrders_universal_d_CursorPagingMetadata as CursorPagingMetadata, ecomV1OrderOrders_universal_d_CreateOrderRequest as CreateOrderRequest, ecomV1OrderOrders_universal_d_OrderCreationSettings as OrderCreationSettings, ecomV1OrderOrders_universal_d_OrderApprovalStrategy as OrderApprovalStrategy, ecomV1OrderOrders_universal_d_OrderCreateNotifications as OrderCreateNotifications, ecomV1OrderOrders_universal_d_CreateOrderResponse as CreateOrderResponse, ecomV1OrderOrders_universal_d_UpdateOrderRequest as UpdateOrderRequest, ecomV1OrderOrders_universal_d_UpdateOrderResponse as UpdateOrderResponse, ecomV1OrderOrders_universal_d_BulkUpdateOrdersRequest as BulkUpdateOrdersRequest, ecomV1OrderOrders_universal_d_MaskedOrder as MaskedOrder, ecomV1OrderOrders_universal_d_BulkUpdateOrdersResponse as BulkUpdateOrdersResponse, ecomV1OrderOrders_universal_d_CommitDeltasRequest as CommitDeltasRequest, ecomV1OrderOrders_universal_d_DraftOrderDiffs as DraftOrderDiffs, ecomV1OrderOrders_universal_d_DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOf, ecomV1OrderOrders_universal_d_DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOf, ecomV1OrderOrders_universal_d_DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOf, ecomV1OrderOrders_universal_d_DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOf, ecomV1OrderOrders_universal_d_V1LineItemDelta as V1LineItemDelta, ecomV1OrderOrders_universal_d_V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOf, ecomV1OrderOrders_universal_d_OrderLineItemChangedDetails as OrderLineItemChangedDetails, ecomV1OrderOrders_universal_d_DeltaPaymentOptionType as DeltaPaymentOptionType, ecomV1OrderOrders_universal_d_ItemChangedDetails as ItemChangedDetails, ecomV1OrderOrders_universal_d_AppliedDiscountDelta as AppliedDiscountDelta, ecomV1OrderOrders_universal_d_AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOf, ecomV1OrderOrders_universal_d_AdditionalFeeDelta as AdditionalFeeDelta, ecomV1OrderOrders_universal_d_AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOf, ecomV1OrderOrders_universal_d_DraftOrderCommitSettings as DraftOrderCommitSettings, ecomV1OrderOrders_universal_d_InventoryUpdateDetails as InventoryUpdateDetails, ecomV1OrderOrders_universal_d_InventoryAction as InventoryAction, ecomV1OrderOrders_universal_d_CommitDeltasResponse as CommitDeltasResponse, ecomV1OrderOrders_universal_d_OrderDeltasCommitted as OrderDeltasCommitted, ecomV1OrderOrders_universal_d_CommittedDiffs as CommittedDiffs, ecomV1OrderOrders_universal_d_CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOf, ecomV1OrderOrders_universal_d_LineItemDelta as LineItemDelta, ecomV1OrderOrders_universal_d_LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOf, ecomV1OrderOrders_universal_d_ArchiveOrderRequest as ArchiveOrderRequest, ecomV1OrderOrders_universal_d_ArchiveOrderResponse as ArchiveOrderResponse, ecomV1OrderOrders_universal_d_BulkArchiveOrdersRequest as BulkArchiveOrdersRequest, ecomV1OrderOrders_universal_d_BulkArchiveOrdersResponse as BulkArchiveOrdersResponse, ecomV1OrderOrders_universal_d_BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequest, ecomV1OrderOrders_universal_d_BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponse, ecomV1OrderOrders_universal_d_UnArchiveOrderRequest as UnArchiveOrderRequest, ecomV1OrderOrders_universal_d_UnArchiveOrderResponse as UnArchiveOrderResponse, ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequest, ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponse, ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequest, ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponse, ecomV1OrderOrders_universal_d_UpdateBuyerInfoRequest as UpdateBuyerInfoRequest, ecomV1OrderOrders_universal_d_BuyerInfoUpdate as BuyerInfoUpdate, ecomV1OrderOrders_universal_d_UpdateBuyerInfoResponse as UpdateBuyerInfoResponse, ecomV1OrderOrders_universal_d_UpdateBuyerEmailRequest as UpdateBuyerEmailRequest, ecomV1OrderOrders_universal_d_UpdateBuyerEmailResponse as UpdateBuyerEmailResponse, ecomV1OrderOrders_universal_d_UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequest, ecomV1OrderOrders_universal_d_UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponse, ecomV1OrderOrders_universal_d_UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequest, ecomV1OrderOrders_universal_d_UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponse, ecomV1OrderOrders_universal_d_UpdateOrderLineItemRequest as UpdateOrderLineItemRequest, ecomV1OrderOrders_universal_d_UpdateOrderLineItemResponse as UpdateOrderLineItemResponse, ecomV1OrderOrders_universal_d_UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequest, ecomV1OrderOrders_universal_d_MaskedOrderLineItem as MaskedOrderLineItem, ecomV1OrderOrders_universal_d_UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponse, ecomV1OrderOrders_universal_d_AddInternalActivityRequest as AddInternalActivityRequest, ecomV1OrderOrders_universal_d_InternalActivity as InternalActivity, ecomV1OrderOrders_universal_d_InternalActivityContentOneOf as InternalActivityContentOneOf, ecomV1OrderOrders_universal_d_OrderPlaced as OrderPlaced, ecomV1OrderOrders_universal_d_OrderPaid as OrderPaid, ecomV1OrderOrders_universal_d_OrderFulfilled as OrderFulfilled, ecomV1OrderOrders_universal_d_OrderNotFulfilled as OrderNotFulfilled, ecomV1OrderOrders_universal_d_OrderCanceled as OrderCanceled, ecomV1OrderOrders_universal_d_DownloadLinkSent as DownloadLinkSent, ecomV1OrderOrders_universal_d_TrackingNumberAdded as TrackingNumberAdded, ecomV1OrderOrders_universal_d_TrackingNumberEdited as TrackingNumberEdited, ecomV1OrderOrders_universal_d_TrackingLinkAdded as TrackingLinkAdded, ecomV1OrderOrders_universal_d_ShippingConfirmationEmailSent as ShippingConfirmationEmailSent, ecomV1OrderOrders_universal_d_InvoiceAdded as InvoiceAdded, ecomV1OrderOrders_universal_d_InvoiceSent as InvoiceSent, ecomV1OrderOrders_universal_d_FulfillerEmailSent as FulfillerEmailSent, ecomV1OrderOrders_universal_d_ShippingAddressEdited as ShippingAddressEdited, ecomV1OrderOrders_universal_d_EmailEdited as EmailEdited, ecomV1OrderOrders_universal_d_PickupReadyEmailSent as PickupReadyEmailSent, ecomV1OrderOrders_universal_d_OrderPartiallyPaid as OrderPartiallyPaid, ecomV1OrderOrders_universal_d_AddInternalActivityResponse as AddInternalActivityResponse, ecomV1OrderOrders_universal_d_AddActivityRequest as AddActivityRequest, ecomV1OrderOrders_universal_d_PublicActivity as PublicActivity, ecomV1OrderOrders_universal_d_PublicActivityContentOneOf as PublicActivityContentOneOf, ecomV1OrderOrders_universal_d_AddActivityResponse as AddActivityResponse, ecomV1OrderOrders_universal_d_AddActivitiesRequest as AddActivitiesRequest, ecomV1OrderOrders_universal_d_AddActivitiesResponse as AddActivitiesResponse, ecomV1OrderOrders_universal_d_UpdateActivityRequest as UpdateActivityRequest, ecomV1OrderOrders_universal_d_UpdateActivityResponse as UpdateActivityResponse, ecomV1OrderOrders_universal_d_DeleteActivityRequest as DeleteActivityRequest, ecomV1OrderOrders_universal_d_DeleteActivityResponse as DeleteActivityResponse, ecomV1OrderOrders_universal_d_UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequest, ecomV1OrderOrders_universal_d_LineItemUpdate as LineItemUpdate, ecomV1OrderOrders_universal_d_UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponse, ecomV1OrderOrders_universal_d_MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequest, ecomV1OrderOrders_universal_d_MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponse, ecomV1OrderOrders_universal_d_CancelOrderRequest as CancelOrderRequest, ecomV1OrderOrders_universal_d_CancelOrderResponse as CancelOrderResponse, ecomV1OrderOrders_universal_d_OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceled, ecomV1OrderOrders_universal_d_MarkAsFulfilledRequest as MarkAsFulfilledRequest, ecomV1OrderOrders_universal_d_MarkAsFulfilledResponse as MarkAsFulfilledResponse, ecomV1OrderOrders_universal_d_FulfillmentStatusUpdated as FulfillmentStatusUpdated, ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequest, ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponse, ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequest, ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponse, ecomV1OrderOrders_universal_d_MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequest, ecomV1OrderOrders_universal_d_MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponse, ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequest, ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponse, ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequest, ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponse, ecomV1OrderOrders_universal_d_V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequest, ecomV1OrderOrders_universal_d_V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponse, ecomV1OrderOrders_universal_d_V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequest, ecomV1OrderOrders_universal_d_V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponse, ecomV1OrderOrders_universal_d_V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequest, ecomV1OrderOrders_universal_d_V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponse, ecomV1OrderOrders_universal_d_GetShipmentsRequest as GetShipmentsRequest, ecomV1OrderOrders_universal_d_GetShipmentsResponse as GetShipmentsResponse, ecomV1OrderOrders_universal_d_AggregateOrdersRequest as AggregateOrdersRequest, ecomV1OrderOrders_universal_d_AggregateOrdersResponse as AggregateOrdersResponse, ecomV1OrderOrders_universal_d_DecrementItemsQuantityRequest as DecrementItemsQuantityRequest, ecomV1OrderOrders_universal_d_DecrementData as DecrementData, ecomV1OrderOrders_universal_d_DecrementItemsQuantityResponse as DecrementItemsQuantityResponse, ecomV1OrderOrders_universal_d_OrderItemsRestocked as OrderItemsRestocked, ecomV1OrderOrders_universal_d_V1RestockItem as V1RestockItem, ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequest, ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponse, ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResult, ecomV1OrderOrders_universal_d_OrderApproved as OrderApproved, ecomV1OrderOrders_universal_d_Task as Task, ecomV1OrderOrders_universal_d_TaskKey as TaskKey, ecomV1OrderOrders_universal_d_TaskAction as TaskAction, ecomV1OrderOrders_universal_d_TaskActionActionOneOf as TaskActionActionOneOf, ecomV1OrderOrders_universal_d_Complete as Complete, ecomV1OrderOrders_universal_d_Cancel as Cancel, ecomV1OrderOrders_universal_d_Reschedule as Reschedule, ecomV1OrderOrders_universal_d_InvoiceSentEvent as InvoiceSentEvent, ecomV1OrderOrders_universal_d_IdAndVersion as IdAndVersion, ecomV1OrderOrders_universal_d_InvoiceFields as InvoiceFields, ecomV1OrderOrders_universal_d_Customer as Customer, ecomV1OrderOrders_universal_d_Email as Email, ecomV1OrderOrders_universal_d_QuotesAddress as QuotesAddress, ecomV1OrderOrders_universal_d_AddressDescription as AddressDescription, ecomV1OrderOrders_universal_d_Placement as Placement, ecomV1OrderOrders_universal_d_Phone as Phone, ecomV1OrderOrders_universal_d_Company as Company, ecomV1OrderOrders_universal_d_CommonAddress as CommonAddress, ecomV1OrderOrders_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf, ecomV1OrderOrders_universal_d_Subdivision as Subdivision, ecomV1OrderOrders_universal_d_SubdivisionType as SubdivisionType, ecomV1OrderOrders_universal_d_StandardDetails as StandardDetails, ecomV1OrderOrders_universal_d_InvoiceDates as InvoiceDates, ecomV1OrderOrders_universal_d_LineItems as LineItems, LineItem$1 as LineItem, ecomV1OrderOrders_universal_d_BigDecimalWrapper as BigDecimalWrapper, ecomV1OrderOrders_universal_d_LineItemTax as LineItemTax, ecomV1OrderOrders_universal_d_Source as Source, ecomV1OrderOrders_universal_d_SourceType as SourceType, ecomV1OrderOrders_universal_d_LineItemMetaData as LineItemMetaData, ecomV1OrderOrders_universal_d_Locale as Locale, ecomV1OrderOrders_universal_d_TotalPrice as TotalPrice, ecomV1OrderOrders_universal_d_ItemizedFee as ItemizedFee, Discount$1 as Discount, ecomV1OrderOrders_universal_d_DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOf, ecomV1OrderOrders_universal_d_CalculatedTaxes as CalculatedTaxes, ecomV1OrderOrders_universal_d_CalculatedTax as CalculatedTax, ecomV1OrderOrders_universal_d_Payments as Payments, ecomV1OrderOrders_universal_d_InvoicesPayment as InvoicesPayment, ecomV1OrderOrders_universal_d_MetaData as MetaData, ecomV1OrderOrders_universal_d_InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotals, ecomV1OrderOrders_universal_d_CustomFieldValue as CustomFieldValue, ecomV1OrderOrders_universal_d_CustomFieldGroup as CustomFieldGroup, ecomV1OrderOrders_universal_d_Value as Value, ecomV1OrderOrders_universal_d_ValueType as ValueType, ecomV1OrderOrders_universal_d_Deposit as Deposit, ecomV1OrderOrders_universal_d_DepositType as DepositType, ecomV1OrderOrders_universal_d_InvoiceStatus as InvoiceStatus, ecomV1OrderOrders_universal_d_TriggerSideEffectsFromLegacyData as TriggerSideEffectsFromLegacyData, ecomV1OrderOrders_universal_d_QueryOrdersForMetasiteOptions as QueryOrdersForMetasiteOptions, ecomV1OrderOrders_universal_d_GetOrderForMetasiteIdentifiers as GetOrderForMetasiteIdentifiers, ecomV1OrderOrders_universal_d_ListOrderTransactionsForMetasiteIdentifiers as ListOrderTransactionsForMetasiteIdentifiers, ecomV1OrderOrders_universal_d_TriggerReindexOptions as TriggerReindexOptions, ecomV1OrderOrders_universal_d_BulkSendBuyerPickupConfirmationEmailsOptions as BulkSendBuyerPickupConfirmationEmailsOptions, ecomV1OrderOrders_universal_d_BulkSendBuyerShippingConfirmationEmailsOptions as BulkSendBuyerShippingConfirmationEmailsOptions, ecomV1OrderOrders_universal_d_SendCancelRefundEmailOptions as SendCancelRefundEmailOptions, ecomV1OrderOrders_universal_d_PreviewRefundEmailOptions as PreviewRefundEmailOptions, ecomV1OrderOrders_universal_d_PreviewCancelEmailOptions as PreviewCancelEmailOptions, ecomV1OrderOrders_universal_d_PreviewCancelRefundEmailOptions as PreviewCancelRefundEmailOptions, ecomV1OrderOrders_universal_d_PreparePaymentCollectionOptions as PreparePaymentCollectionOptions, ecomV1OrderOrders_universal_d_getPaymentCollectabilityStatus as getPaymentCollectabilityStatus, ecomV1OrderOrders_universal_d_PaymentCollectionCreatePaymentGatewayOrderOptions as PaymentCollectionCreatePaymentGatewayOrderOptions, ecomV1OrderOrders_universal_d_ChargeMembershipsOptions as ChargeMembershipsOptions, TriggerRefundOptions$1 as TriggerRefundOptions, CalculateRefundOptions$1 as CalculateRefundOptions, ecomV1OrderOrders_universal_d_getOrder as getOrder, ecomV1OrderOrders_universal_d_InternalQueryOrdersOptions as InternalQueryOrdersOptions, ecomV1OrderOrders_universal_d_OrdersQueryResult as OrdersQueryResult, ecomV1OrderOrders_universal_d_OrdersQueryBuilder as OrdersQueryBuilder, ecomV1OrderOrders_universal_d_searchOrders as searchOrders, ecomV1OrderOrders_universal_d_SearchOrdersOptions as SearchOrdersOptions, ecomV1OrderOrders_universal_d_createOrder as createOrder, ecomV1OrderOrders_universal_d_CreateOrderOptions as CreateOrderOptions, ecomV1OrderOrders_universal_d_updateOrder as updateOrder, ecomV1OrderOrders_universal_d_UpdateOrder as UpdateOrder, ecomV1OrderOrders_universal_d_UpdateOrderOptions as UpdateOrderOptions, ecomV1OrderOrders_universal_d_bulkUpdateOrders as bulkUpdateOrders, ecomV1OrderOrders_universal_d_BulkUpdateOrdersOptions as BulkUpdateOrdersOptions, ecomV1OrderOrders_universal_d_CommitDeltasOptions as CommitDeltasOptions, ecomV1OrderOrders_universal_d_BulkArchiveOrdersOptions as BulkArchiveOrdersOptions, ecomV1OrderOrders_universal_d_BulkUnArchiveOrdersOptions as BulkUnArchiveOrdersOptions, ecomV1OrderOrders_universal_d_UpdateBuyerInfoOptions as UpdateBuyerInfoOptions, ecomV1OrderOrders_universal_d_UpdateBuyerEmailOptions as UpdateBuyerEmailOptions, ecomV1OrderOrders_universal_d_UpdateOrderShippingAddressOptions as UpdateOrderShippingAddressOptions, ecomV1OrderOrders_universal_d_UpdateBillingContactDetailsOptions as UpdateBillingContactDetailsOptions, ecomV1OrderOrders_universal_d_UpdateOrderLineItemIdentifiers as UpdateOrderLineItemIdentifiers, ecomV1OrderOrders_universal_d_UpdateOrderLineItem as UpdateOrderLineItem, ecomV1OrderOrders_universal_d_UpdateOrderLineItemOptions as UpdateOrderLineItemOptions, ecomV1OrderOrders_universal_d_UpdateActivityIdentifiers as UpdateActivityIdentifiers, ecomV1OrderOrders_universal_d_DeleteActivityIdentifiers as DeleteActivityIdentifiers, ecomV1OrderOrders_universal_d_cancelOrder as cancelOrder, ecomV1OrderOrders_universal_d_CancelOrderOptions as CancelOrderOptions, ecomV1OrderOrders_universal_d_BulkMarkAsFulfilledOptions as BulkMarkAsFulfilledOptions, ecomV1OrderOrders_universal_d_BulkMarkAsUnfulfilledOptions as BulkMarkAsUnfulfilledOptions, ecomV1OrderOrders_universal_d_AggregateOrdersOptions as AggregateOrdersOptions, ecomV1OrderOrders_universal_d_BulkUpdateOrderTagsOptions as BulkUpdateOrderTagsOptions, };\n }\n interface CheckoutSettings {\n /** Checkout policies. */\n checkoutPolicies?: CheckoutPolicies;\n /** Settings that apply to checkout fields and the checkout process. */\n checkoutFields?: CheckoutFields;\n /**\n * Date and time the checkout settings were created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the checkout settings were updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface CheckoutPolicies {\n /** Terms and conditions. */\n termsAndConditions?: TermsAndConditionsPolicy;\n /** Privacy policy. */\n privacyPolicy?: PrivacyPolicy;\n /** Return policy. */\n returnPolicy?: ReturnPolicy;\n /** Digital item policy. */\n digitalItemPolicy?: DigitalItemPolicy;\n /** \"Contact us\" information. */\n contactUs?: ContactUsPolicy;\n /** Custom policy. */\n customPolicy?: CustomCheckoutPolicy;\n }\n interface TermsAndConditionsPolicy {\n /**\n * Whether the terms & conditions policy is visible to the customer in the checkout page.

\n *\n * Default: `false`\n */\n visible?: boolean | null;\n /** Terms and conditions policy content. */\n content?: string | null;\n }\n interface PrivacyPolicy {\n /**\n * Whether the privacy policy is visible to the customer in the checkout page.

\n *\n * Default: `false`\n */\n visible?: boolean | null;\n /** Privacy policy content. */\n content?: string | null;\n }\n interface ReturnPolicy {\n /**\n * Whether the return policy is visible to the customer in the checkout page.

\n *\n * Default: `false`\n */\n visible?: boolean | null;\n /** Return policy content. */\n content?: string | null;\n }\n interface DigitalItemPolicy {\n /**\n * Whether the digital item policy is visible to the customer in the checkout page.

\n *\n * Default: `false`\n */\n visible?: boolean | null;\n /** Digital item policy content. */\n content?: string | null;\n }\n interface ContactUsPolicy {\n /**\n * Whether the contact us policy is visible to the customer in the checkout page.

\n *\n * Default: `false`\n */\n visible?: boolean | null;\n /** Contact us policy content. */\n content?: string | null;\n }\n interface CustomCheckoutPolicy {\n /**\n * Whether the policy is visible to the customer on the checkout page.\n * Default: `false`.\n */\n visible?: boolean | null;\n /** Policy content. */\n content?: string | null;\n /** Policy title. */\n title?: string | null;\n }\n interface CheckoutFields {\n /**\n * Subscription checkbox.\n * Default:\n * - `visible`: `false`,\n * - `checkedByDefault`: `false`\n */\n subscriptionCheckbox?: CheckboxField;\n /**\n * Policy agreement checkbox.\n * Default:\n * - `visible`: `true`,\n * - `checkedByDefault`: `true`\n */\n policyAgreementCheckbox?: CheckboxField;\n /**\n * Whether the ability to redeem a gift card is enabled.\n * Default: `false`.\n */\n giftCardRedeemEnabled?: boolean | null;\n /**\n * Whether to allow for MIT transactions.\n * Default: `false`.\n */\n mitEnabled?: boolean | null;\n }\n interface CheckboxField {\n /** Whether the checkbox is visible to the customer. */\n visible?: boolean | null;\n /** Whether the checkbox is checked by default. */\n checkedByDefault?: boolean | null;\n }\n interface CheckoutBrand {\n /** Checkout header. */\n header?: CheckoutHeader;\n }\n interface CheckoutHeader {\n /**\n * Textual content to be included in the header (e.g. Business Name)\n * TODO: update maxLength validation once limitation is known\n */\n text?: string | null;\n /** Specifications for when a logo is included in the header. */\n logo?: Logo;\n /**\n * Alignment within the header.\n *\n * >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left.\n */\n alignment?: Alignment;\n /**\n * Whether to display the 'Checkout' label within the header.\n * Depending on the locale, the label may be translated.\n */\n displayCheckoutLabel?: boolean | null;\n }\n interface Logo {\n /** Size of the logo. */\n size?: LogoSize;\n }\n enum LogoSize {\n UNKNOWN_LOGO_SIZE = \"UNKNOWN_LOGO_SIZE\",\n SMALL = \"SMALL\",\n MEDIUM = \"MEDIUM\",\n LARGE = \"LARGE\"\n }\n enum Alignment {\n UNKNOWN_ALIGNMENT = \"UNKNOWN_ALIGNMENT\",\n SIDE = \"SIDE\",\n CENTER = \"CENTER\"\n }\n interface GetCheckoutSettingsRequest {\n }\n interface GetCheckoutSettingsResponse {\n /** Checkout settings. */\n checkoutSettings?: CheckoutSettings;\n }\n interface UpdateCheckoutSettingsRequest {\n /** Checkout settings to update. */\n checkoutSettings: CheckoutSettings;\n }\n interface UpdateCheckoutSettingsResponse {\n /** The updated checkout settings. */\n checkoutSettings?: CheckoutSettings;\n }\n interface ListCheckoutSettingsRequest {\n }\n interface ListCheckoutSettingsResponse {\n /** List of retrieved checkout settings. */\n checkoutSettings?: CheckoutSettings[];\n }\n interface GiftCardProviderWasProvisioned {\n /** The gift card provider which was installed */\n providerAppDefId?: string;\n providerInstanceId?: string;\n }\n interface Empty {\n }\n interface DeleteCheckoutSettingsRequest {\n }\n interface DeleteCheckoutSettingsResponse {\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$2 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$2 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$2 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$2;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$2;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves the sites' checkout settings.\n *\n *\n * The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns The requested checkout settings.\n */\n function getCheckoutSettings(): Promise;\n /**\n * Updates the sites' checkout settings.\n *\n *\n * The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.\n * @param checkoutSettings - Checkout settings to update.\n * @public\n * @documentationMaturity preview\n * @requiredField checkoutSettings\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated checkout settings.\n */\n function updateCheckoutSettings(checkoutSettings: CheckoutSettings, options?: UpdateCheckoutSettingsOptions): Promise;\n interface UpdateCheckoutSettingsOptions {\n }\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutSettings = CheckoutSettings;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutPolicies = CheckoutPolicies;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_TermsAndConditionsPolicy = TermsAndConditionsPolicy;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_PrivacyPolicy = PrivacyPolicy;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_ReturnPolicy = ReturnPolicy;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_DigitalItemPolicy = DigitalItemPolicy;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_ContactUsPolicy = ContactUsPolicy;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CustomCheckoutPolicy = CustomCheckoutPolicy;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutFields = CheckoutFields;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckboxField = CheckboxField;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutBrand = CheckoutBrand;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutHeader = CheckoutHeader;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_Logo = Logo;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_LogoSize = LogoSize;\n const ecomV1CheckoutSettingsCheckoutSettings_universal_d_LogoSize: typeof LogoSize;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_Alignment = Alignment;\n const ecomV1CheckoutSettingsCheckoutSettings_universal_d_Alignment: typeof Alignment;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_GetCheckoutSettingsRequest = GetCheckoutSettingsRequest;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_GetCheckoutSettingsResponse = GetCheckoutSettingsResponse;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_UpdateCheckoutSettingsRequest = UpdateCheckoutSettingsRequest;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_UpdateCheckoutSettingsResponse = UpdateCheckoutSettingsResponse;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_ListCheckoutSettingsRequest = ListCheckoutSettingsRequest;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_ListCheckoutSettingsResponse = ListCheckoutSettingsResponse;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_GiftCardProviderWasProvisioned = GiftCardProviderWasProvisioned;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_Empty = Empty;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_DeleteCheckoutSettingsRequest = DeleteCheckoutSettingsRequest;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_DeleteCheckoutSettingsResponse = DeleteCheckoutSettingsResponse;\n const ecomV1CheckoutSettingsCheckoutSettings_universal_d_getCheckoutSettings: typeof getCheckoutSettings;\n const ecomV1CheckoutSettingsCheckoutSettings_universal_d_updateCheckoutSettings: typeof updateCheckoutSettings;\n type ecomV1CheckoutSettingsCheckoutSettings_universal_d_UpdateCheckoutSettingsOptions = UpdateCheckoutSettingsOptions;\n namespace ecomV1CheckoutSettingsCheckoutSettings_universal_d {\n export { ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutSettings as CheckoutSettings, ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutPolicies as CheckoutPolicies, ecomV1CheckoutSettingsCheckoutSettings_universal_d_TermsAndConditionsPolicy as TermsAndConditionsPolicy, ecomV1CheckoutSettingsCheckoutSettings_universal_d_PrivacyPolicy as PrivacyPolicy, ecomV1CheckoutSettingsCheckoutSettings_universal_d_ReturnPolicy as ReturnPolicy, ecomV1CheckoutSettingsCheckoutSettings_universal_d_DigitalItemPolicy as DigitalItemPolicy, ecomV1CheckoutSettingsCheckoutSettings_universal_d_ContactUsPolicy as ContactUsPolicy, ecomV1CheckoutSettingsCheckoutSettings_universal_d_CustomCheckoutPolicy as CustomCheckoutPolicy, ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutFields as CheckoutFields, ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckboxField as CheckboxField, ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutBrand as CheckoutBrand, ecomV1CheckoutSettingsCheckoutSettings_universal_d_CheckoutHeader as CheckoutHeader, ecomV1CheckoutSettingsCheckoutSettings_universal_d_Logo as Logo, ecomV1CheckoutSettingsCheckoutSettings_universal_d_LogoSize as LogoSize, ecomV1CheckoutSettingsCheckoutSettings_universal_d_Alignment as Alignment, ecomV1CheckoutSettingsCheckoutSettings_universal_d_GetCheckoutSettingsRequest as GetCheckoutSettingsRequest, ecomV1CheckoutSettingsCheckoutSettings_universal_d_GetCheckoutSettingsResponse as GetCheckoutSettingsResponse, ecomV1CheckoutSettingsCheckoutSettings_universal_d_UpdateCheckoutSettingsRequest as UpdateCheckoutSettingsRequest, ecomV1CheckoutSettingsCheckoutSettings_universal_d_UpdateCheckoutSettingsResponse as UpdateCheckoutSettingsResponse, ecomV1CheckoutSettingsCheckoutSettings_universal_d_ListCheckoutSettingsRequest as ListCheckoutSettingsRequest, ecomV1CheckoutSettingsCheckoutSettings_universal_d_ListCheckoutSettingsResponse as ListCheckoutSettingsResponse, ecomV1CheckoutSettingsCheckoutSettings_universal_d_GiftCardProviderWasProvisioned as GiftCardProviderWasProvisioned, ecomV1CheckoutSettingsCheckoutSettings_universal_d_Empty as Empty, ecomV1CheckoutSettingsCheckoutSettings_universal_d_DeleteCheckoutSettingsRequest as DeleteCheckoutSettingsRequest, ecomV1CheckoutSettingsCheckoutSettings_universal_d_DeleteCheckoutSettingsResponse as DeleteCheckoutSettingsResponse, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, MessageEnvelope$2 as MessageEnvelope, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, ecomV1CheckoutSettingsCheckoutSettings_universal_d_getCheckoutSettings as getCheckoutSettings, ecomV1CheckoutSettingsCheckoutSettings_universal_d_updateCheckoutSettings as updateCheckoutSettings, ecomV1CheckoutSettingsCheckoutSettings_universal_d_UpdateCheckoutSettingsOptions as UpdateCheckoutSettingsOptions, };\n }\n interface OrdersSettings {\n /**\n * Defines when to update the store inventory.\n *\n * - `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.\n * - `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.\n *\n * Default: `ON_ORDER_PLACED`\n */\n inventoryUpdateTrigger?: InventoryUpdateTrigger;\n /**\n * Whether to automatically create invoices for every new order paid online.\n * Default: `false`\n */\n createInvoice?: boolean | null;\n /**\n * Date and time the orders settings were created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the orders settings were updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n enum InventoryUpdateTrigger {\n UNKNOWN_INVENTORY_UPDATE_TRIGGER = \"UNKNOWN_INVENTORY_UPDATE_TRIGGER\",\n ON_ORDER_PAID = \"ON_ORDER_PAID\",\n ON_ORDER_PLACED = \"ON_ORDER_PLACED\"\n }\n interface GetOrdersSettingsRequest {\n }\n interface GetOrdersSettingsResponse {\n /** Orders settings. */\n ordersSettings?: OrdersSettings;\n }\n interface UpdateOrdersSettingsRequest {\n /** Orders settings to update. */\n ordersSettings: OrdersSettings;\n }\n interface UpdateOrdersSettingsResponse {\n /** The updated orders settings. */\n ordersSettings?: OrdersSettings;\n }\n interface DeleteOrdersSettingsRequest {\n }\n interface DeleteOrdersSettingsResponse {\n }\n interface ListOrdersSettingsRequest {\n }\n interface ListOrdersSettingsResponse {\n /** List of retrieved orders settings. */\n ordersSettings?: OrdersSettings[];\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves the sites' order settings.\n *\n *\n * The `getOrdersSettings()` function returns a Promise that resolves to orders settings.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns The requested orders settings.\n */\n function getOrdersSettings(): Promise;\n /**\n * Updates the sites' orders settings.\n *\n *\n * The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.\n * @public\n * @documentationMaturity preview\n * @requiredField ordersSettings\n * @param ordersSettings - Orders settings to update.\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated orders settings.\n */\n function updateOrdersSettings(ordersSettings: OrdersSettings, options?: UpdateOrdersSettingsOptions): Promise;\n interface UpdateOrdersSettingsOptions {\n }\n type ecomV1OrdersSettingsOrdersSettings_universal_d_OrdersSettings = OrdersSettings;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_InventoryUpdateTrigger = InventoryUpdateTrigger;\n const ecomV1OrdersSettingsOrdersSettings_universal_d_InventoryUpdateTrigger: typeof InventoryUpdateTrigger;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_GetOrdersSettingsRequest = GetOrdersSettingsRequest;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_GetOrdersSettingsResponse = GetOrdersSettingsResponse;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_UpdateOrdersSettingsRequest = UpdateOrdersSettingsRequest;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_UpdateOrdersSettingsResponse = UpdateOrdersSettingsResponse;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_DeleteOrdersSettingsRequest = DeleteOrdersSettingsRequest;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_DeleteOrdersSettingsResponse = DeleteOrdersSettingsResponse;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_ListOrdersSettingsRequest = ListOrdersSettingsRequest;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_ListOrdersSettingsResponse = ListOrdersSettingsResponse;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_RestoreInfo = RestoreInfo;\n const ecomV1OrdersSettingsOrdersSettings_universal_d_getOrdersSettings: typeof getOrdersSettings;\n const ecomV1OrdersSettingsOrdersSettings_universal_d_updateOrdersSettings: typeof updateOrdersSettings;\n type ecomV1OrdersSettingsOrdersSettings_universal_d_UpdateOrdersSettingsOptions = UpdateOrdersSettingsOptions;\n namespace ecomV1OrdersSettingsOrdersSettings_universal_d {\n export { ecomV1OrdersSettingsOrdersSettings_universal_d_OrdersSettings as OrdersSettings, ecomV1OrdersSettingsOrdersSettings_universal_d_InventoryUpdateTrigger as InventoryUpdateTrigger, ecomV1OrdersSettingsOrdersSettings_universal_d_GetOrdersSettingsRequest as GetOrdersSettingsRequest, ecomV1OrdersSettingsOrdersSettings_universal_d_GetOrdersSettingsResponse as GetOrdersSettingsResponse, ecomV1OrdersSettingsOrdersSettings_universal_d_UpdateOrdersSettingsRequest as UpdateOrdersSettingsRequest, ecomV1OrdersSettingsOrdersSettings_universal_d_UpdateOrdersSettingsResponse as UpdateOrdersSettingsResponse, ecomV1OrdersSettingsOrdersSettings_universal_d_DeleteOrdersSettingsRequest as DeleteOrdersSettingsRequest, ecomV1OrdersSettingsOrdersSettings_universal_d_DeleteOrdersSettingsResponse as DeleteOrdersSettingsResponse, ecomV1OrdersSettingsOrdersSettings_universal_d_ListOrdersSettingsRequest as ListOrdersSettingsRequest, ecomV1OrdersSettingsOrdersSettings_universal_d_ListOrdersSettingsResponse as ListOrdersSettingsResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, ecomV1OrdersSettingsOrdersSettings_universal_d_RestoreInfo as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, ecomV1OrdersSettingsOrdersSettings_universal_d_getOrdersSettings as getOrdersSettings, ecomV1OrdersSettingsOrdersSettings_universal_d_updateOrdersSettings as updateOrdersSettings, ecomV1OrdersSettingsOrdersSettings_universal_d_UpdateOrdersSettingsOptions as UpdateOrdersSettingsOptions, };\n }\n interface OrderTransactions {\n /** Order ID. */\n orderId?: string;\n /** Record of payments made to the merchant. */\n payments?: Payment[];\n /** Record of refunds made to the buyer. */\n refunds?: Refund[];\n }\n interface Payment extends PaymentPaymentDetailsOneOf {\n /** Regular payment details. */\n regularPaymentDetails?: RegularPaymentDetails;\n /** Gift card payment details. */\n giftcardPaymentDetails?: GiftCardPaymentDetails;\n /**\n * Payment ID.\n * @readonly\n */\n _id?: string | null;\n /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */\n _createdDate?: Date;\n /**\n * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date;\n /** Payment amount. */\n amount?: Price;\n /**\n * Whether refunds for this payment are disabled.\n * + `true`: This payment is not refundable.\n * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.\n */\n refundDisabled?: boolean;\n }\n /** @oneof */\n interface PaymentPaymentDetailsOneOf {\n /** Regular payment details. */\n regularPaymentDetails?: RegularPaymentDetails;\n /** Gift card payment details. */\n giftcardPaymentDetails?: GiftCardPaymentDetails;\n }\n interface RegularPaymentDetails {\n /** Wix Payments order ID. */\n paymentOrderId?: string | null;\n /**\n * Payment gateway's transaction ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\n * This field is only returned when the value of `offline_payment` is `false`.\n */\n gatewayTransactionId?: string | null;\n /**\n * Payment method. Non-exhaustive list of supported values:\n * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`\n */\n paymentMethod?: string | null;\n /** Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments. */\n providerTransactionId?: string | null;\n /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */\n offlinePayment?: boolean;\n /** Payment status. */\n status?: TransactionStatus;\n /** Whether there is a payment agreement that allows for future charges. */\n savedPaymentMethod?: boolean;\n }\n enum TransactionStatus {\n UNDEFINED = \"UNDEFINED\",\n APPROVED = \"APPROVED\",\n PENDING = \"PENDING\",\n PENDING_MERCHANT = \"PENDING_MERCHANT\",\n CANCELED = \"CANCELED\",\n DECLINED = \"DECLINED\",\n REFUNDED = \"REFUNDED\",\n PARTIALLY_REFUNDED = \"PARTIALLY_REFUNDED\",\n AUTHORIZED = \"AUTHORIZED\",\n VOIDED = \"VOIDED\"\n }\n interface GiftCardPaymentDetails {\n /** Gift card payment ID. */\n giftCardPaymentId?: string;\n /** ID of the app that created the gift card. */\n appId?: string;\n /**\n * Whether the gift card is voided.\n * @readonly\n */\n voided?: boolean;\n }\n interface MembershipPaymentDetails {\n /** Membership ID. */\n membershipId?: string;\n /** ID of the line item this membership applies to. */\n lineItemId?: string;\n /** Payment status. */\n status?: MembershipPaymentStatus;\n /** Membership name. */\n name?: MembershipName;\n /** The transaction ID in the membership system. Can be used to void the transaction. */\n externalTransactionId?: string | null;\n /**\n * Whether the membership is voided.\n * @readonly\n */\n voided?: boolean;\n /** ID of the application providing this payment option. */\n providerAppId?: string;\n }\n enum MembershipPaymentStatus {\n /** CHARGED - Payment was charged */\n CHARGED = \"CHARGED\",\n /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */\n CHARGE_FAILED = \"CHARGE_FAILED\"\n }\n interface MembershipName {\n /** The name of this membership */\n original?: string;\n /** Optional - Translated name of this membership. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface Price {\n /** Amount. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n }\n interface Refund {\n /**\n * Refund ID.\n * @readonly\n */\n _id?: string;\n /** List of transactions. */\n transactions?: RefundTransaction[];\n /** Refund business details. */\n details?: RefundDetails;\n /** Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */\n _createdDate?: Date;\n }\n interface RefundTransaction {\n /** ID of the payment associated with this refund. */\n paymentId?: string;\n /** Refund amount. */\n amount?: Price;\n /** Refund status. */\n refundStatus?: RefundStatus;\n /**\n * Payment gateway's refund ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\n * This field is only returned when the value of `external_refund` is `false`.\n */\n gatewayRefundId?: string | null;\n /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */\n providerRefundId?: string | null;\n /** Whether refund was made externally and manually on the payment provider's side. */\n externalRefund?: boolean;\n }\n enum RefundStatus {\n PENDING = \"PENDING\",\n SUCCEEDED = \"SUCCEEDED\",\n FAILED = \"FAILED\"\n }\n /** Business model of a refund request */\n interface RefundDetails {\n /** Order line item IDs and quantities that were refunded. */\n items?: RefundItem[];\n /** Whether the shipping fee was also refunded. */\n shippingIncluded?: boolean;\n /** Reason for the refund, provided by customer (optional). */\n reason?: string | null;\n }\n interface RefundItem {\n /** Line item ID the refunded line item. */\n lineItemId?: string;\n /** Line item quantity refunded. */\n quantity?: number;\n }\n interface SnapshotMessage {\n _id?: string;\n opType?: number;\n }\n interface IndexingMessage {\n _id?: string;\n opType?: number;\n requiredVersions?: string[];\n }\n interface DiffmatokyPayload {\n left?: string;\n right?: string;\n compareChannel?: string;\n entityId?: string;\n errorInformation?: ErrorInformation;\n tags?: string[];\n }\n interface ErrorInformation {\n stackTrace?: string;\n }\n interface OrderRefunded {\n /**\n * Refund ID.\n * @readonly\n */\n refundId?: string;\n /**\n * Refunded order data.\n * @readonly\n */\n order?: Order;\n }\n interface Order {\n /**\n * Order ID (auto-generated upon order creation).\n * @readonly\n */\n _id?: string | null;\n /**\n * Order number displayed in the owner's store (auto-generated).\n * @readonly\n */\n number?: number;\n /**\n * Order creation date and time.\n * @readonly\n */\n dateCreated?: Date;\n /** Buyer information. */\n buyerInfo?: BuyerInfo;\n /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */\n currency?: string | null;\n /** Weight unit used in this store. */\n weightUnit?: WeightUnit;\n /** Totals for order's line items. */\n totals?: Totals;\n /** Billing information. */\n billingInfo?: BillingInfo;\n /** Shipping information. */\n shippingInfo?: ShippingInfo;\n /** A note added by the buyer. */\n buyerNote?: string | null;\n /**\n * Deprecated.\n * @readonly\n */\n read?: boolean;\n /**\n * Whether or not the order was archived.\n * @readonly\n */\n archived?: boolean;\n /** Current status of the payment. */\n paymentStatus?: PaymentStatus;\n /**\n * Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).\n * @readonly\n */\n fulfillmentStatus?: FulfillmentStatus;\n /** Line items ordered. */\n lineItems?: LineItem[];\n /**\n * Log of updates related to the order.\n * @readonly\n */\n activities?: Activity[];\n /** Invoice information. */\n invoiceInfo?: V2InvoiceInfo;\n /**\n * Order fulfillment information.\n * @readonly\n */\n fulfillments?: Fulfillment[];\n /** Discount information. */\n discount?: Discount;\n /** Custom field information. */\n customField?: CustomField;\n /** Shopping cart ID. */\n cartId?: string | null;\n /**\n * Language for communication with the buyer. Defaults to the site language.\n * For a site that supports multiple languages, this is the language the buyer selected.\n */\n buyerLanguage?: string | null;\n /** Information about the sales channel that submitted this order. */\n channelInfo?: ChannelInfo;\n /**\n * Identity of the order's initiator.\n * @readonly\n */\n enteredBy?: EnteredBy;\n /**\n * Date and time of latest update.\n * @readonly\n */\n lastUpdated?: Date;\n /** Subscription information. */\n subscriptionInfo?: SubscriptionInfo;\n /**\n * Order’s unique numeric ID.\n * Primarily used for sorting and filtering when crawling all orders.\n * @readonly\n */\n numericId?: string;\n /**\n * Refund information.\n * @readonly\n */\n refunds?: V2Refund[];\n }\n /** Buyer Info */\n interface BuyerInfo {\n /** Wix customer ID */\n _id?: string | null;\n /**\n * Deprecated (use identityType instead)\n * @readonly\n */\n type?: IdentityType;\n /** Customer type */\n identityType?: IdentityType;\n /**\n * Customer's first name\n * @readonly\n */\n firstName?: string;\n /**\n * Customer's last name\n * @readonly\n */\n lastName?: string;\n /**\n * Customer's phone number\n * @readonly\n */\n phone?: string | null;\n /**\n * Customer's email address\n * @readonly\n */\n email?: string;\n }\n enum IdentityType {\n UNSPECIFIED_IDENTITY_TYPE = \"UNSPECIFIED_IDENTITY_TYPE\",\n /** Site member */\n MEMBER = \"MEMBER\",\n /** Contact */\n CONTACT = \"CONTACT\"\n }\n enum WeightUnit {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface Totals {\n /** Subtotal of all the line items, before tax. */\n subtotal?: string;\n /** Total shipping price, before tax. */\n shipping?: string | null;\n /** Total tax. */\n tax?: string | null;\n /** Total calculated discount value. */\n discount?: string | null;\n /** Total price charged. */\n total?: string;\n /**\n * Total items weight.\n * @readonly\n */\n weight?: string;\n /**\n * Total number of line items.\n * @readonly\n */\n quantity?: number;\n /**\n * Total refund.\n * @readonly\n */\n refund?: string | null;\n /** Total calculated gift card value. */\n giftCard?: string | null;\n }\n interface BillingInfo {\n /** Payment method used for this order */\n paymentMethod?: string | null;\n /**\n * Deprecated (use paymentProviderTransactionId instead)\n * @readonly\n */\n externalTransactionId?: string | null;\n /** Transaction ID from payment provider (e.g., PayPal, Square, Stripe) transaction ID */\n paymentProviderTransactionId?: string | null;\n /** Transaction ID from payment gateway (e.g., Wix Payments) */\n paymentGatewayTransactionId?: string | null;\n /** Full billing address */\n address?: Address;\n /**\n * Payment date\n * @readonly\n */\n paidDate?: Date;\n /** Whether order can be refunded by payment provider (manually or automatic) */\n refundableByPaymentProvider?: boolean | null;\n }\n interface Address extends AddressAddressLine1OptionsOneOf {\n /** Address line 1 (free text) */\n addressLine1?: string;\n /** Address line 1 (street) */\n street?: Street;\n /** Addressee name */\n fullName?: FullName;\n /** Country code (2 letters) */\n country?: string | null;\n /** State or district */\n subdivision?: string | null;\n /** City name */\n city?: string | null;\n /** ZIP/postal code */\n zipCode?: string | null;\n /** Phone number */\n phone?: string | null;\n /** Company name */\n company?: string | null;\n /** Email address */\n email?: string | null;\n /** address line */\n addressLine2?: string | null;\n /** Tax information (for Brazil only) */\n vatId?: VatId;\n }\n /** @oneof */\n interface AddressAddressLine1OptionsOneOf {\n /** Address line 1 (free text) */\n addressLine1?: string;\n /** Address line 1 (street) */\n street?: Street;\n }\n interface FullName {\n /** Customer's first name */\n firstName?: string;\n /** Customer's last name */\n lastName?: string;\n }\n interface Street {\n /** Street number */\n number?: string;\n /** Street name */\n name?: string;\n }\n interface VatId {\n /** Customer's tax ID. */\n number?: string;\n /**\n * Tax type.\n * + `CPF`: For individual tax payers.\n * + `CNPJ`: For corporations.\n */\n type?: VatType;\n }\n /** Brazilian tax info types */\n enum VatType {\n /** When the tax info type can't be classified, due to an error */\n UNSPECIFIED_TAX_TYPE = \"UNSPECIFIED_TAX_TYPE\",\n /** CPF - for individual tax payers */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface ShippingInfo extends ShippingInfoDetailsOneOf {\n /** Shipment details (when this object describes shipment). */\n shipmentDetails?: ShipmentDetails;\n /** Pickup details (when this object describes pickup). */\n pickupDetails?: PickupDetails;\n /** Shipping option name. */\n deliveryOption?: string;\n /** Shipping option delivery time. */\n estimatedDeliveryTime?: string | null;\n /** Deprecated - Latest expected delivery date. */\n deliverByDate?: Date;\n /** Shipping region. */\n shippingRegion?: string | null;\n /**\n * Unique code of provided shipping option. For example, `\"usps_std_overnight\"`.\n * @readonly\n */\n code?: string | null;\n }\n /** @oneof */\n interface ShippingInfoDetailsOneOf {\n /** Shipment details (when this object describes shipment). */\n shipmentDetails?: ShipmentDetails;\n /** Pickup details (when this object describes pickup). */\n pickupDetails?: PickupDetails;\n }\n interface ShipmentDetails {\n /** Shipping destination address. */\n address?: Address;\n /**\n * Deprecated (use fulfillments instead).\n * @readonly\n */\n trackingInfo?: TrackingInfo;\n /** Discount applied for shipping. */\n discount?: string | null;\n /** Tax applied for shipping. */\n tax?: string | null;\n /** Price data. */\n priceData?: ShippingPriceData;\n }\n interface TrackingInfo {\n /**\n * Tracking number\n * @readonly\n */\n trackingNumber?: string | null;\n /**\n * Shipping provider\n * @readonly\n */\n shippingProvider?: string | null;\n /**\n * Tracking link\n * @readonly\n */\n trackingLink?: string | null;\n }\n interface ShippingPriceData {\n /** Whether tax is included in the price. */\n taxIncludedInPrice?: boolean;\n /** Shipping price. */\n price?: string | null;\n }\n interface PickupDetails {\n /** Pickup address. */\n pickupAddress?: PickupAddress;\n /**\n * Deprecated (use billingInfo instead).\n * @readonly\n */\n buyerDetails?: BuyerDetails;\n /** Store owner's pickup instructions. */\n pickupInstructions?: string | null;\n }\n interface PickupAddress {\n /** Country code (3 letters) */\n country?: string;\n /** State/District */\n subdivision?: string | null;\n /** Address */\n addressLine1?: string;\n /** City */\n city?: string;\n /** ZIP/postal code */\n zipCode?: string;\n }\n interface BuyerDetails {\n /** Addressee name */\n fullName?: FullName;\n /** Email address */\n email?: string;\n /** Phone number */\n phone?: string;\n }\n /** This might be extended in the future with pending orders statuses */\n enum PaymentStatus {\n /** Payment status can't be classified, due to an error */\n UNSPECIFIED_PAYMENT_STATUS = \"UNSPECIFIED_PAYMENT_STATUS\",\n /** Order is pending response from the payment provider */\n PENDING = \"PENDING\",\n /** Order is marked as not paid, and can be marked as paid later on. This is relevant for POS and offline orders */\n NOT_PAID = \"NOT_PAID\",\n /** The order is marked as paid */\n PAID = \"PAID\",\n /** Order was refunded, refund amount less than order total price */\n PARTIALLY_REFUNDED = \"PARTIALLY_REFUNDED\",\n /** Full order total price was refunded */\n FULLY_REFUNDED = \"FULLY_REFUNDED\",\n /** At least one payment was received and approved, covering less than total price amount */\n PARTIALLY_PAID = \"PARTIALLY_PAID\"\n }\n enum FulfillmentStatus {\n /** None of the order items are fulfilled */\n NOT_FULFILLED = \"NOT_FULFILLED\",\n /**\n * All of the order items are fulfilled\n * Orders without shipping info are fulfilled automatically\n */\n FULFILLED = \"FULFILLED\",\n /** Order is canceled */\n CANCELED = \"CANCELED\",\n /** Some, but not all of the order items are fulfilled */\n PARTIALLY_FULFILLED = \"PARTIALLY_FULFILLED\"\n }\n interface LineItem {\n /**\n * Line item ID (auto-generated, stable within this order only)\n * @readonly\n */\n index?: number | null;\n /** Line item quantity */\n quantity?: number;\n /**\n * Deprecated (use priceData instead)\n * @readonly\n */\n price?: string | null;\n /** Line item name */\n name?: string | null;\n /** Product name, translated into the customer's language */\n translatedName?: string | null;\n /** Line item product ID (optional for POS orders) */\n productId?: string | null;\n /**\n * Deprecated (use priceData instead)\n * @readonly\n */\n totalPrice?: string | null;\n /** Line item type (may be extended) */\n lineItemType?: LineItemType;\n /** Line item options ordered */\n options?: OptionSelection[];\n /** Line item custom text field entry */\n customTextFields?: CustomTextFieldSelection[];\n /** Line item weight */\n weight?: string | null;\n /** Primary media for preview of the line item */\n mediaItem?: MediaItem;\n /** Line item SKU */\n sku?: string | null;\n /** Line item notes */\n notes?: string | null;\n /** Line item variantId (from Stores Catalog) */\n variantId?: string | null;\n /** Line item fulfillerId from stores fulfillers. No value equals self fulfilled */\n fulfillerId?: string | null;\n /** Discount applied for this line item */\n discount?: string | null;\n /** Tax applied for this line item */\n tax?: string | null;\n /**\n * Deprecated (use priceData instead)\n * @readonly\n */\n taxIncludedInPrice?: boolean;\n /** Tax group ID */\n taxGroupId?: string | null;\n /** Price data */\n priceData?: LineItemPriceData;\n }\n enum LineItemType {\n /** Line item type can't be classified, due to an error */\n UNSPECIFIED_LINE_ITEM_TYPE = \"UNSPECIFIED_LINE_ITEM_TYPE\",\n /** Physical item type */\n PHYSICAL = \"PHYSICAL\",\n /** Digital item type */\n DIGITAL = \"DIGITAL\",\n /** Custom item price */\n CUSTOM_AMOUNT_ITEM = \"CUSTOM_AMOUNT_ITEM\"\n }\n interface OptionSelection {\n /** Option name */\n option?: string;\n /** Selected choice for this option */\n selection?: string;\n }\n interface CustomTextFieldSelection {\n /** Custom text field name */\n title?: string;\n /** Custom text field value */\n value?: string;\n }\n interface MediaItem {\n /**\n * Media type\n * @readonly\n */\n mediaType?: MediaItemType;\n /**\n * Media URL\n * @readonly\n */\n url?: string;\n /**\n * Media item width\n * @readonly\n */\n width?: number;\n /**\n * Media item height\n * @readonly\n */\n height?: number;\n /** Deprecated */\n mediaId?: string | null;\n /** Media ID (for media items previously saved in Wix Media) */\n _id?: string | null;\n /** Media external URL */\n externalImageUrl?: string | null;\n /** Alternative text for presentation when media cannot be displayed */\n altText?: string | null;\n }\n enum MediaItemType {\n /** Media item type can't be classified, due to an error */\n UNSPECIFIED_MEDIA_TYPE_ITEM = \"UNSPECIFIED_MEDIA_TYPE_ITEM\",\n /** Image item type */\n IMAGE = \"IMAGE\"\n }\n interface LineItemPriceData {\n /** Whether tax is included in the price set for this line item */\n taxIncludedInPrice?: boolean;\n /** Line item price */\n price?: string;\n /**\n * Total price charged to the customer (per line item) after computation of quantity and discount\n * @readonly\n */\n totalPrice?: string | null;\n }\n interface DigitalFile {\n /** id of the secure file in media */\n fileId?: string;\n }\n interface Activity {\n /**\n * Activity item type\n * @readonly\n */\n type?: ActivityType;\n /**\n * Activity item author\n * @readonly\n */\n author?: string | null;\n /**\n * Comment added to activity item\n * @readonly\n */\n message?: string | null;\n /**\n * Activity item timestamp\n * @readonly\n */\n timestamp?: Date;\n }\n enum ActivityType {\n /** Activity item type can't be classified, due to an error */\n UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE = \"UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE\",\n /** Store owner added a comment */\n MERCHANT_COMMENT = \"MERCHANT_COMMENT\",\n /** Order placed */\n ORDER_PLACED = \"ORDER_PLACED\",\n /** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */\n ORDER_PAID = \"ORDER_PAID\",\n /** Order shipping status set as fulfilled */\n ORDER_FULFILLED = \"ORDER_FULFILLED\",\n /** Order shipping status set as not fulfilled */\n ORDER_NOT_FULFILLED = \"ORDER_NOT_FULFILLED\",\n /** A download link was sent (relevant for orders with digital line items) */\n DOWNLOAD_LINK_SENT = \"DOWNLOAD_LINK_SENT\",\n /** An email notification for pickup was sent */\n PICKUP_READY_EMAIL_SENT = \"PICKUP_READY_EMAIL_SENT\",\n /** Shipping tracking number was set */\n TRACKING_NUMBER_ADDED = \"TRACKING_NUMBER_ADDED\",\n /** Shipping tracking number was edited */\n TRACKING_NUMBER_EDITED = \"TRACKING_NUMBER_EDITED\",\n /** Shipping tracking link was set */\n TRACKING_LINK_WAS_SET = \"TRACKING_LINK_WAS_SET\",\n /** An email confirmation of order shipment was sent */\n SHIPPING_CONFIRMATION_EMAIL_SENT = \"SHIPPING_CONFIRMATION_EMAIL_SENT\",\n /** Invoice was set in the order */\n INVOICE_WAS_SET = \"INVOICE_WAS_SET\",\n /** Invoice was removed from the order */\n INVOICE_WAS_REMOVED = \"INVOICE_WAS_REMOVED\",\n /** Invoice was sent to customer via email */\n INVOICE_WAS_SENT = \"INVOICE_WAS_SENT\",\n /** Email was sent to fulfiller */\n FULFILLER_EMAIL_SENT = \"FULFILLER_EMAIL_SENT\",\n /** Shipping address was updated */\n SHIPPING_ADDRESS_EDITED = \"SHIPPING_ADDRESS_EDITED\",\n /** Order email was updated */\n EMAIL_EDITED = \"EMAIL_EDITED\",\n /** Order partially paid. During the checkout for orders with deposit items. */\n ORDER_PARTIALLY_PAID = \"ORDER_PARTIALLY_PAID\"\n }\n interface V2InvoiceInfo {\n /** Invoice ID */\n _id?: string;\n /** Invoice source */\n source?: InvoiceSource;\n }\n enum InvoiceSource {\n /** Invoice source can't be classified, due to an error */\n UNSPECIFIED_INVOICE_SOURCE = \"UNSPECIFIED_INVOICE_SOURCE\",\n /** Invoice created using the Invoices API */\n WIX = \"WIX\"\n }\n interface Fulfillment {\n /**\n * Fulfillment ID (auto generated upon fulfillment creation).\n * @readonly\n */\n _id?: string | null;\n /**\n * Fulfillment creation date and time.\n * @readonly\n */\n dateCreated?: Date;\n /** Information about the line items in the fulfilled order. */\n lineItems?: FulfillmentLineItem[];\n /** Tracking information. */\n trackingInfo?: FulfillmentTrackingInfo;\n }\n interface FulfillmentLineItem {\n /** Line item ID (mirrors the line item index of the order). */\n index?: number;\n /**\n * Line item quantity.\n * On creation, if this parameter isn't passed, the new fulfillment will automatically include all items of this line item that have not already been linked to a fulfillment.\n * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error will be returned.\n * This property will always have a value when returned.\n */\n quantity?: number | null;\n }\n interface FulfillmentTrackingInfo {\n /** Tracking number. */\n trackingNumber?: string;\n /**\n * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:\n * * `fedex`\n * * `ups`\n * * `usps`\n * * `dhl`\n * * `canadaPost`\n */\n shippingProvider?: string;\n /** Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation. */\n trackingLink?: string | null;\n }\n interface Discount {\n /**\n * Deprecated (use Totals.discount instead)\n * @readonly\n */\n value?: string;\n /** Applied coupon */\n appliedCoupon?: AppliedCoupon;\n }\n interface AppliedCoupon {\n /** Coupon ID */\n couponId?: string;\n /** Coupon name */\n name?: string;\n /** Coupon code */\n code?: string;\n }\n /** Custom field */\n interface CustomField {\n /** Free text that the customer entered in the custom field during the checkout process */\n value?: string;\n /** Title for the custom field */\n title?: string;\n /** The title translated according to the buyer language */\n translatedTitle?: string;\n }\n interface ChannelInfo {\n /** Sales channel that submitted the order */\n type?: ChannelType;\n /** Reference to an order ID from an external system, as defined in channelInfo (e.g., eBay or Amazon) */\n externalOrderId?: string | null;\n /** URL to the order in the external system, as defined in channelInfo (e.g., eBay or Amazon) */\n externalOrderUrl?: string | null;\n }\n enum ChannelType {\n UNSPECIFIED = \"UNSPECIFIED\",\n WEB = \"WEB\",\n POS = \"POS\",\n EBAY = \"EBAY\",\n AMAZON = \"AMAZON\",\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n WIX_APP_STORE = \"WIX_APP_STORE\",\n WIX_INVOICES = \"WIX_INVOICES\",\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n WISH = \"WISH\",\n CLASS_PASS = \"CLASS_PASS\",\n GLOBAL_E = \"GLOBAL_E\",\n FACEBOOK = \"FACEBOOK\",\n ETSY = \"ETSY\",\n TIKTOK = \"TIKTOK\",\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface EnteredBy {\n _id?: string;\n identityType?: EnteredByIdentityType;\n }\n enum EnteredByIdentityType {\n USER = \"USER\",\n MEMBER = \"MEMBER\",\n CONTACT = \"CONTACT\",\n APP = \"APP\"\n }\n interface SubscriptionInfo {\n /** Subscription ID. */\n _id?: string | null;\n /** Current cycle number. For example, if the subscription is in the 3rd month of a 4-month subscription, the value will be `3`. */\n cycleNumber?: number;\n /** Subscription settings. */\n subscriptionSettings?: SubscriptionSettings;\n /** Subscription options info. */\n subscriptionOptionInfo?: SubscriptionOptionInfo;\n }\n interface SubscriptionSettings {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface SubscriptionOptionInfo {\n /** Subscription option title. */\n title?: string;\n /** Subscription option description. */\n description?: string | null;\n }\n interface V2Refund {\n /** Refund created timestamp. */\n dateCreated?: Date;\n /** Refund amount. */\n amount?: string;\n /** Reason for refund, given by user (optional). */\n reason?: string | null;\n /** Payment provider transaction ID. Used to find refund transaction info on the payment provider's side. */\n paymentProviderTransactionId?: string | null;\n /** Refund ID. */\n _id?: string;\n /** Whether refund was made externally (on the payment provider's side). */\n externalRefund?: boolean;\n }\n interface GiftCard {\n transactionId?: string;\n /** giftcard internal ID */\n _id?: string;\n /** giftcard provider appid */\n providerId?: string;\n /** giftcard amount */\n amount?: string;\n }\n interface ListTransactionsForSingleOrderRequest {\n /** Order ID. */\n orderId: string;\n }\n interface ListTransactionsForSingleOrderResponse {\n /** Order ID and its associated transactions. */\n orderTransactions?: OrderTransactions;\n }\n interface ListTransactionsForMultipleOrdersRequest {\n /** Order IDs for which to retrieve transactions. */\n orderIds: string[];\n }\n interface ListTransactionsForMultipleOrdersResponse {\n /** List of order IDs and their associated transactions. */\n orderTransactions?: OrderTransactions[];\n }\n interface AddPaymentsRequest {\n /** Order ID. */\n orderId: string;\n /** Payments to be added to order. */\n payments: Payment[];\n }\n interface AddPaymentsResponse {\n /** Order ID and its associated transactions. */\n orderTransactions?: OrderTransactions;\n /** IDs of added order payments. */\n paymentsIds?: string[];\n }\n /** Triggered when a payment is updated. */\n interface PaymentsUpdated {\n /** Updated order transactions. */\n orderTransactions?: OrderTransactions;\n /** List of IDs of the updated payments. */\n paymentIds?: string[];\n /** List of IDs of the updated refunds. */\n refundIds?: string[];\n }\n interface AddRefundRequest {\n /** Order ID this refunds related to */\n orderId: string;\n /** Refund with refund transactions to be added to order. */\n refund: Refund;\n /** Side effect details related to refund */\n sideEffects?: RefundSideEffects;\n }\n interface RefundSideEffects {\n /** Inventory restock details as part of this refund. */\n restockInfo?: RestockInfo;\n /** Whether to send a refund confirmation email to the customer. */\n sendOrderRefundedEmail?: boolean;\n /** Custom message added to the refund confirmation email. */\n customMessage?: string | null;\n }\n interface RestockInfo {\n /** Restock type. */\n type?: RestockType;\n /** Restocked line items and quantities. Only relevant for `{\"type\": \"SOME_ITEMS\"}`. */\n items?: RestockItem[];\n }\n enum RestockType {\n NO_ITEMS = \"NO_ITEMS\",\n ALL_ITEMS = \"ALL_ITEMS\",\n SOME_ITEMS = \"SOME_ITEMS\"\n }\n interface RestockItem {\n /** ID of the line item being restocked. */\n lineItemId?: string;\n /** Line item quantity being restocked. */\n quantity?: number;\n }\n interface AddRefundResponse {\n /** Order ID and its associated transactions. */\n orderTransactions?: OrderTransactions;\n /** Created refund ID */\n refundId?: string;\n }\n /** Triggered when a refund is created. */\n interface RefundCreated {\n /** Updated order transactions. */\n orderTransactions?: OrderTransactions;\n /** ID of the created refund. */\n refundId?: string;\n /** Inventory restock details as part of this refund.. */\n restockInfo?: RestockInfo;\n /** Whether to send a refund confirmation email to the customer. */\n sendOrderRefundedEmail?: boolean;\n /** Custom message added to the refund confirmation email. */\n customMessage?: string | null;\n /** Refunded line items and quantities that are part of the created refund. */\n refundItems?: RefundItem[];\n }\n interface UpdatePaymentStatusRequest {\n /** Order ID. */\n orderId: string;\n /** Payment ID. */\n paymentId: string;\n /** Payment status. */\n status?: TransactionStatus;\n }\n interface UpdatePaymentStatusResponse {\n /** Order ID and its associated transactions after update. */\n orderTransactions?: OrderTransactions;\n }\n interface BulkUpdatePaymentStatusesRequest {\n /** Order and payment IDs for which to update payment status. */\n paymentAndOrderIds: PaymentAndOrderId[];\n /** Whether to return the full payment entity (`results.item`) in the response. */\n returnFullEntity?: boolean;\n /** Payment status. */\n status?: TransactionStatus;\n }\n interface PaymentAndOrderId {\n /** Order ID. */\n orderId?: string;\n /**\n * Payment ID.\n * todo: remove comment once UI will use BulkMarkOrderAsPaid\n */\n paymentId?: string;\n }\n interface BulkUpdatePaymentStatusesResponse {\n /** Bulk operation results. */\n results?: BulkPaymentResult[];\n /** Bulk operation metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkPaymentResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n /** Updated payment. Returned if `return_full_entity` set to `true`. */\n item?: Payment;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface TriggerRefundRequest {\n /** The order this refund related to */\n orderId: string;\n /**\n * Refund operations information\n * Currently, only *one* payment refund is supported per request\n */\n payments: PaymentRefund[];\n /** Business model of a refund */\n details?: RefundDetails;\n /** How to restock items as part of this refund */\n restockInfo?: RestockInfo;\n /** Should send a confirmation mail to the customer */\n sendOrderRefundedEmail?: boolean;\n /** Personal note added to the email */\n customMessage?: string | null;\n }\n interface PaymentRefund {\n /** Specific payment within the order to refund */\n paymentId?: string;\n /** Refund amount. Not relevant for membership refunds. */\n amount?: Price;\n /**\n * Whether refund is made externally and manually (on the payment provider's side)\n * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.\n * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.\n */\n externalRefund?: boolean;\n }\n interface TriggerRefundResponse {\n /** All order's transactions after the refunds were added */\n orderTransactions?: OrderTransactions;\n /** Created refund ID */\n refundId?: string;\n }\n interface CalculateRefundRequest {\n /** Order ID */\n orderId: string;\n /** Refunded line items and quantity */\n refundItems?: CalculateRefundItemRequest[];\n /** Should include shipping in refund calculation */\n refundShipping?: boolean;\n }\n interface CalculateRefundItemRequest {\n /** ID of the line item being refunded */\n lineItemId?: string;\n /** How much of that line item is being refunded */\n quantity?: number;\n /** Should this item be restocked (used for validation purposes) */\n restock?: boolean;\n }\n interface CalculateRefundResponse {\n /** Total refundable amount */\n total?: string;\n /** Tax cost of the order */\n tax?: string;\n /** Discount given for this order */\n discount?: string;\n /** Total cost of the order (without tax) */\n subtotal?: string;\n /** Previous refund given on that order */\n previouslyRefundedAmount?: string | null;\n /** The refundable items of that order */\n items?: CalculateRefundItemResponse[];\n }\n interface CalculateRefundItemResponse {\n /** Line item ID */\n lineItemId?: string;\n /** The line item's price */\n lineItemPrice?: number;\n }\n interface GetRefundabilityStatusRequest {\n /** Order ID. */\n orderId: string;\n }\n interface GetRefundabilityStatusResponse {\n /** Refundability details. */\n refundabilities?: Refundability[];\n /** Whether the order supports refunding per item. */\n refundablePerItem?: boolean;\n }\n interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {\n /** Reason why payment is not refundable. */\n nonRefundableReason?: NonRefundableReason;\n /** Reason why payment is only refundable manually. */\n manuallyRefundableReason?: ManuallyRefundableReason;\n /** Payment ID. */\n paymentId?: string;\n /** Payment refundability status. */\n refundabilityStatus?: RefundableStatus;\n /** Link to payment provider dashboard. */\n providerLink?: string | null;\n }\n /** @oneof */\n interface RefundabilityAdditionalRefundabilityInfoOneOf {\n /** Reason why payment is not refundable. */\n nonRefundableReason?: NonRefundableReason;\n /** Reason why payment is only refundable manually. */\n manuallyRefundableReason?: ManuallyRefundableReason;\n }\n enum RefundableStatus {\n NOT_REFUNDABLE = \"NOT_REFUNDABLE\",\n MANUAL = \"MANUAL\",\n REFUNDABLE = \"REFUNDABLE\"\n }\n enum NonRefundableReason {\n NONE = \"NONE\",\n ALREADY_REFUNDED = \"ALREADY_REFUNDED\",\n PROVIDER_IS_DOWN = \"PROVIDER_IS_DOWN\",\n INTERNAL_ERROR = \"INTERNAL_ERROR\",\n NOT_PAID = \"NOT_PAID\",\n ACCESS_DENIED = \"ACCESS_DENIED\",\n ZERO_PRICE = \"ZERO_PRICE\",\n DISABLED_BY_PROVIDER = \"DISABLED_BY_PROVIDER\",\n PARTIALLY_PAID = \"PARTIALLY_PAID\",\n DEPOSIT_ONLINE_ITEM = \"DEPOSIT_ONLINE_ITEM\",\n PENDING_REFUND = \"PENDING_REFUND\",\n FORBIDDEN = \"FORBIDDEN\"\n }\n enum ManuallyRefundableReason {\n EXPIRED = \"EXPIRED\",\n NOT_SUPPORTED = \"NOT_SUPPORTED\",\n NOT_FOUND = \"NOT_FOUND\",\n OFFLINE = \"OFFLINE\"\n }\n interface ListInvoicesForSingleOrderRequest {\n /** Order ID. */\n orderId: string;\n }\n interface ListInvoicesForSingleOrderResponse {\n /** List of invoices. */\n invoices?: InvoiceInfo[];\n }\n interface InvoiceInfo {\n /** Invoice ID. */\n _id?: string;\n /** ID of the app that set the invoice. */\n appId?: string;\n /** Invoice URL. */\n url?: string | null;\n /** Invoice creation date and time. */\n _createdDate?: Date;\n }\n interface ListInvoicesForMultipleOrdersRequest {\n /** Order IDs for which to retrieve invoices. */\n orderIds: string[];\n }\n interface ListInvoicesForMultipleOrdersResponse {\n /** List of order IDs and their associated invoices. */\n invoicesForOrder?: InvoicesForOrder[];\n }\n interface InvoicesForOrder {\n /** Order ID. */\n orderId?: string;\n /** Invoices info. */\n invoicesInfo?: InvoiceInfo[];\n }\n interface GenerateInvoiceRequest {\n /** Order ID. */\n orderId: string;\n }\n interface GenerateInvoiceResponse {\n /** Invoice ID. */\n invoiceId?: string;\n }\n interface BulkGenerateInvoicesRequest {\n /** Order IDs. */\n orderIds: string[];\n }\n interface BulkGenerateInvoicesResponse {\n results?: BulkInvoiceResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkInvoiceResult {\n itemMetadata?: ItemMetadata;\n item?: InvoiceForOrder;\n }\n interface InvoiceForOrder {\n /** Order ID. */\n orderId?: string;\n /** Invoice ID. */\n invoiceId?: string;\n }\n interface AddInvoiceToOrderRequest {\n /** Order ID. */\n orderId: string;\n /** Invoice info. */\n invoiceInfo: InvoiceInfo;\n }\n interface AddInvoiceToOrderResponse {\n /** List of order invoices. */\n orderInvoices?: InvoiceInfo[];\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves information about payments and refunds associated with a specified order.\n *\n *\n * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.\n * @param orderId - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listTransactionsForSingleOrder(orderId: string): Promise;\n /**\n * Retrieves information about payments and refunds associated with all specified orders.\n *\n *\n * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.\n * @param orderIds - Order IDs for which to retrieve transactions.\n * @public\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Read eCommerce - all read permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listTransactionsForMultipleOrders(orderIds: string[]): Promise;\n /**\n * Adds up to 50 payment records to an order.\n *\n *\n * The `addPayments()` function returns a Promise that resolves when the payment records are added to an order.\n *\n * > **Note:** This does **NOT** perform the actual charging - the order is only updated with records of the payments.\n * @param orderId - Order ID.\n * @param payments - Payments to be added to order.\n * @public\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField payments\n * @requiredField payments.amount\n * @requiredField payments.giftcardPaymentDetails.giftCardPaymentId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function addPayments(orderId: string, payments: Payment[]): Promise;\n interface AddRefundOptions {\n /** Side effect details related to refund */\n sideEffects?: RefundSideEffects;\n }\n /**\n * Updates the status of an order's payment.\n *\n *\n * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.orderId\n * @requiredField identifiers.paymentId\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updatePaymentStatus(identifiers: UpdatePaymentStatusIdentifiers, options?: UpdatePaymentStatusOptions): Promise;\n interface UpdatePaymentStatusIdentifiers {\n /** Payment ID. */\n paymentId: string;\n /** Order ID. */\n orderId: string;\n }\n interface UpdatePaymentStatusOptions {\n /** Payment status. */\n status?: TransactionStatus;\n }\n /**\n * Updates multiple order payments with a specified status.\n *\n *\n * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.\n * @param paymentAndOrderIds - Order and payment IDs for which to update payment status.\n * @public\n * @documentationMaturity preview\n * @requiredField paymentAndOrderIds\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage eCommerce - all permissions\n * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdatePaymentStatuses(paymentAndOrderIds: PaymentAndOrderId[], options?: BulkUpdatePaymentStatusesOptions): Promise;\n interface BulkUpdatePaymentStatusesOptions {\n /** Whether to return the full payment entity (`results.item`) in the response. */\n returnFullEntity?: boolean;\n /** Payment status. */\n status?: TransactionStatus;\n }\n interface TriggerRefundOptions {\n /** Business model of a refund */\n details?: RefundDetails;\n /** How to restock items as part of this refund */\n restockInfo?: RestockInfo;\n /** Should send a confirmation mail to the customer */\n sendOrderRefundedEmail?: boolean;\n /** Personal note added to the email */\n customMessage?: string | null;\n }\n interface CalculateRefundOptions {\n /** Refunded line items and quantity */\n refundItems?: CalculateRefundItemRequest[];\n /** Should include shipping in refund calculation */\n refundShipping?: boolean;\n }\n type ecomV1OrderTransactionsOrderTransactions_universal_d_OrderTransactions = OrderTransactions;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Payment = Payment;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentPaymentDetailsOneOf = PaymentPaymentDetailsOneOf;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RegularPaymentDetails = RegularPaymentDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_TransactionStatus = TransactionStatus;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_TransactionStatus: typeof TransactionStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_GiftCardPaymentDetails = GiftCardPaymentDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipPaymentDetails = MembershipPaymentDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipPaymentStatus = MembershipPaymentStatus;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipPaymentStatus: typeof MembershipPaymentStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipName = MembershipName;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Price = Price;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Refund = Refund;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundTransaction = RefundTransaction;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundStatus = RefundStatus;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_RefundStatus: typeof RefundStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundDetails = RefundDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundItem = RefundItem;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_SnapshotMessage = SnapshotMessage;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_IndexingMessage = IndexingMessage;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_DiffmatokyPayload = DiffmatokyPayload;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ErrorInformation = ErrorInformation;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_OrderRefunded = OrderRefunded;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Order = Order;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BuyerInfo = BuyerInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_IdentityType = IdentityType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_IdentityType: typeof IdentityType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_WeightUnit = WeightUnit;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_WeightUnit: typeof WeightUnit;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Totals = Totals;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BillingInfo = BillingInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Address = Address;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddressAddressLine1OptionsOneOf = AddressAddressLine1OptionsOneOf;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_FullName = FullName;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Street = Street;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_VatId = VatId;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_VatType = VatType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_VatType: typeof VatType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ShippingInfo = ShippingInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ShippingInfoDetailsOneOf = ShippingInfoDetailsOneOf;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ShipmentDetails = ShipmentDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_TrackingInfo = TrackingInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ShippingPriceData = ShippingPriceData;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PickupDetails = PickupDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PickupAddress = PickupAddress;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BuyerDetails = BuyerDetails;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentStatus = PaymentStatus;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentStatus: typeof PaymentStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentStatus = FulfillmentStatus;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentStatus: typeof FulfillmentStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_LineItem = LineItem;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_LineItemType = LineItemType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_LineItemType: typeof LineItemType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_OptionSelection = OptionSelection;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CustomTextFieldSelection = CustomTextFieldSelection;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_MediaItem = MediaItem;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_MediaItemType = MediaItemType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_MediaItemType: typeof MediaItemType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_LineItemPriceData = LineItemPriceData;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_DigitalFile = DigitalFile;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Activity = Activity;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ActivityType = ActivityType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_ActivityType: typeof ActivityType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_V2InvoiceInfo = V2InvoiceInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceSource = InvoiceSource;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceSource: typeof InvoiceSource;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Fulfillment = Fulfillment;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentLineItem = FulfillmentLineItem;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentTrackingInfo = FulfillmentTrackingInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Discount = Discount;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AppliedCoupon = AppliedCoupon;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CustomField = CustomField;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ChannelInfo = ChannelInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ChannelType = ChannelType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_ChannelType: typeof ChannelType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_EnteredBy = EnteredBy;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_EnteredByIdentityType = EnteredByIdentityType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_EnteredByIdentityType: typeof EnteredByIdentityType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionInfo = SubscriptionInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionSettings = SubscriptionSettings;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionFrequency = SubscriptionFrequency;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionFrequency: typeof SubscriptionFrequency;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionOptionInfo = SubscriptionOptionInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_V2Refund = V2Refund;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_GiftCard = GiftCard;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForSingleOrderRequest = ListTransactionsForSingleOrderRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForSingleOrderResponse = ListTransactionsForSingleOrderResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForMultipleOrdersRequest = ListTransactionsForMultipleOrdersRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForMultipleOrdersResponse = ListTransactionsForMultipleOrdersResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddPaymentsRequest = AddPaymentsRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddPaymentsResponse = AddPaymentsResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentsUpdated = PaymentsUpdated;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddRefundRequest = AddRefundRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundSideEffects = RefundSideEffects;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RestockInfo = RestockInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RestockType = RestockType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_RestockType: typeof RestockType;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RestockItem = RestockItem;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddRefundResponse = AddRefundResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundCreated = RefundCreated;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusRequest = UpdatePaymentStatusRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusResponse = UpdatePaymentStatusResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkUpdatePaymentStatusesRequest = BulkUpdatePaymentStatusesRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentAndOrderId = PaymentAndOrderId;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkUpdatePaymentStatusesResponse = BulkUpdatePaymentStatusesResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkPaymentResult = BulkPaymentResult;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ItemMetadata = ItemMetadata;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ApplicationError = ApplicationError;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkActionMetadata = BulkActionMetadata;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_TriggerRefundRequest = TriggerRefundRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentRefund = PaymentRefund;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_TriggerRefundResponse = TriggerRefundResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundRequest = CalculateRefundRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundItemRequest = CalculateRefundItemRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundResponse = CalculateRefundResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundItemResponse = CalculateRefundItemResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_GetRefundabilityStatusRequest = GetRefundabilityStatusRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_GetRefundabilityStatusResponse = GetRefundabilityStatusResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_Refundability = Refundability;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundabilityAdditionalRefundabilityInfoOneOf = RefundabilityAdditionalRefundabilityInfoOneOf;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_RefundableStatus = RefundableStatus;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_RefundableStatus: typeof RefundableStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_NonRefundableReason = NonRefundableReason;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_NonRefundableReason: typeof NonRefundableReason;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ManuallyRefundableReason = ManuallyRefundableReason;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_ManuallyRefundableReason: typeof ManuallyRefundableReason;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForSingleOrderRequest = ListInvoicesForSingleOrderRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForSingleOrderResponse = ListInvoicesForSingleOrderResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceInfo = InvoiceInfo;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForMultipleOrdersRequest = ListInvoicesForMultipleOrdersRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForMultipleOrdersResponse = ListInvoicesForMultipleOrdersResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_InvoicesForOrder = InvoicesForOrder;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_GenerateInvoiceRequest = GenerateInvoiceRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_GenerateInvoiceResponse = GenerateInvoiceResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkGenerateInvoicesRequest = BulkGenerateInvoicesRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkGenerateInvoicesResponse = BulkGenerateInvoicesResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkInvoiceResult = BulkInvoiceResult;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceForOrder = InvoiceForOrder;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddInvoiceToOrderRequest = AddInvoiceToOrderRequest;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddInvoiceToOrderResponse = AddInvoiceToOrderResponse;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_DomainEvent = DomainEvent;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_ActionEvent = ActionEvent;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_MessageEnvelope = MessageEnvelope;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_IdentificationData = IdentificationData;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_WebhookIdentityType = WebhookIdentityType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_listTransactionsForSingleOrder: typeof listTransactionsForSingleOrder;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_listTransactionsForMultipleOrders: typeof listTransactionsForMultipleOrders;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_addPayments: typeof addPayments;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_AddRefundOptions = AddRefundOptions;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_updatePaymentStatus: typeof updatePaymentStatus;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusIdentifiers = UpdatePaymentStatusIdentifiers;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusOptions = UpdatePaymentStatusOptions;\n const ecomV1OrderTransactionsOrderTransactions_universal_d_bulkUpdatePaymentStatuses: typeof bulkUpdatePaymentStatuses;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_BulkUpdatePaymentStatusesOptions = BulkUpdatePaymentStatusesOptions;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_TriggerRefundOptions = TriggerRefundOptions;\n type ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundOptions = CalculateRefundOptions;\n namespace ecomV1OrderTransactionsOrderTransactions_universal_d {\n export { ecomV1OrderTransactionsOrderTransactions_universal_d_OrderTransactions as OrderTransactions, ecomV1OrderTransactionsOrderTransactions_universal_d_Payment as Payment, ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOf, ecomV1OrderTransactionsOrderTransactions_universal_d_RegularPaymentDetails as RegularPaymentDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_TransactionStatus as TransactionStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_GiftCardPaymentDetails as GiftCardPaymentDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipPaymentDetails as MembershipPaymentDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipPaymentStatus as MembershipPaymentStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_MembershipName as MembershipName, ecomV1OrderTransactionsOrderTransactions_universal_d_Price as Price, ecomV1OrderTransactionsOrderTransactions_universal_d_Refund as Refund, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundTransaction as RefundTransaction, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundStatus as RefundStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundDetails as RefundDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundItem as RefundItem, ecomV1OrderTransactionsOrderTransactions_universal_d_SnapshotMessage as SnapshotMessage, ecomV1OrderTransactionsOrderTransactions_universal_d_IndexingMessage as IndexingMessage, ecomV1OrderTransactionsOrderTransactions_universal_d_DiffmatokyPayload as DiffmatokyPayload, ecomV1OrderTransactionsOrderTransactions_universal_d_ErrorInformation as ErrorInformation, ecomV1OrderTransactionsOrderTransactions_universal_d_OrderRefunded as OrderRefunded, ecomV1OrderTransactionsOrderTransactions_universal_d_Order as Order, ecomV1OrderTransactionsOrderTransactions_universal_d_BuyerInfo as BuyerInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_IdentityType as IdentityType, ecomV1OrderTransactionsOrderTransactions_universal_d_WeightUnit as WeightUnit, ecomV1OrderTransactionsOrderTransactions_universal_d_Totals as Totals, ecomV1OrderTransactionsOrderTransactions_universal_d_BillingInfo as BillingInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_Address as Address, ecomV1OrderTransactionsOrderTransactions_universal_d_AddressAddressLine1OptionsOneOf as AddressAddressLine1OptionsOneOf, ecomV1OrderTransactionsOrderTransactions_universal_d_FullName as FullName, ecomV1OrderTransactionsOrderTransactions_universal_d_Street as Street, ecomV1OrderTransactionsOrderTransactions_universal_d_VatId as VatId, ecomV1OrderTransactionsOrderTransactions_universal_d_VatType as VatType, ecomV1OrderTransactionsOrderTransactions_universal_d_ShippingInfo as ShippingInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_ShippingInfoDetailsOneOf as ShippingInfoDetailsOneOf, ecomV1OrderTransactionsOrderTransactions_universal_d_ShipmentDetails as ShipmentDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_TrackingInfo as TrackingInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_ShippingPriceData as ShippingPriceData, ecomV1OrderTransactionsOrderTransactions_universal_d_PickupDetails as PickupDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_PickupAddress as PickupAddress, ecomV1OrderTransactionsOrderTransactions_universal_d_BuyerDetails as BuyerDetails, ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentStatus as PaymentStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentStatus as FulfillmentStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_LineItem as LineItem, ecomV1OrderTransactionsOrderTransactions_universal_d_LineItemType as LineItemType, ecomV1OrderTransactionsOrderTransactions_universal_d_OptionSelection as OptionSelection, ecomV1OrderTransactionsOrderTransactions_universal_d_CustomTextFieldSelection as CustomTextFieldSelection, ecomV1OrderTransactionsOrderTransactions_universal_d_MediaItem as MediaItem, ecomV1OrderTransactionsOrderTransactions_universal_d_MediaItemType as MediaItemType, ecomV1OrderTransactionsOrderTransactions_universal_d_LineItemPriceData as LineItemPriceData, ecomV1OrderTransactionsOrderTransactions_universal_d_DigitalFile as DigitalFile, ecomV1OrderTransactionsOrderTransactions_universal_d_Activity as Activity, ecomV1OrderTransactionsOrderTransactions_universal_d_ActivityType as ActivityType, ecomV1OrderTransactionsOrderTransactions_universal_d_V2InvoiceInfo as V2InvoiceInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceSource as InvoiceSource, ecomV1OrderTransactionsOrderTransactions_universal_d_Fulfillment as Fulfillment, ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentLineItem as FulfillmentLineItem, ecomV1OrderTransactionsOrderTransactions_universal_d_FulfillmentTrackingInfo as FulfillmentTrackingInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_Discount as Discount, ecomV1OrderTransactionsOrderTransactions_universal_d_AppliedCoupon as AppliedCoupon, ecomV1OrderTransactionsOrderTransactions_universal_d_CustomField as CustomField, ecomV1OrderTransactionsOrderTransactions_universal_d_ChannelInfo as ChannelInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_ChannelType as ChannelType, ecomV1OrderTransactionsOrderTransactions_universal_d_EnteredBy as EnteredBy, ecomV1OrderTransactionsOrderTransactions_universal_d_EnteredByIdentityType as EnteredByIdentityType, ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionInfo as SubscriptionInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionSettings as SubscriptionSettings, ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionFrequency as SubscriptionFrequency, ecomV1OrderTransactionsOrderTransactions_universal_d_SubscriptionOptionInfo as SubscriptionOptionInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_V2Refund as V2Refund, ecomV1OrderTransactionsOrderTransactions_universal_d_GiftCard as GiftCard, ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForSingleOrderRequest as ListTransactionsForSingleOrderRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForSingleOrderResponse as ListTransactionsForSingleOrderResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForMultipleOrdersRequest as ListTransactionsForMultipleOrdersRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_ListTransactionsForMultipleOrdersResponse as ListTransactionsForMultipleOrdersResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_AddPaymentsRequest as AddPaymentsRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_AddPaymentsResponse as AddPaymentsResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentsUpdated as PaymentsUpdated, ecomV1OrderTransactionsOrderTransactions_universal_d_AddRefundRequest as AddRefundRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundSideEffects as RefundSideEffects, ecomV1OrderTransactionsOrderTransactions_universal_d_RestockInfo as RestockInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_RestockType as RestockType, ecomV1OrderTransactionsOrderTransactions_universal_d_RestockItem as RestockItem, ecomV1OrderTransactionsOrderTransactions_universal_d_AddRefundResponse as AddRefundResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundCreated as RefundCreated, ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusRequest as UpdatePaymentStatusRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusResponse as UpdatePaymentStatusResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkUpdatePaymentStatusesRequest as BulkUpdatePaymentStatusesRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentAndOrderId as PaymentAndOrderId, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkUpdatePaymentStatusesResponse as BulkUpdatePaymentStatusesResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkPaymentResult as BulkPaymentResult, ecomV1OrderTransactionsOrderTransactions_universal_d_ItemMetadata as ItemMetadata, ecomV1OrderTransactionsOrderTransactions_universal_d_ApplicationError as ApplicationError, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkActionMetadata as BulkActionMetadata, ecomV1OrderTransactionsOrderTransactions_universal_d_TriggerRefundRequest as TriggerRefundRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_PaymentRefund as PaymentRefund, ecomV1OrderTransactionsOrderTransactions_universal_d_TriggerRefundResponse as TriggerRefundResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundRequest as CalculateRefundRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundItemRequest as CalculateRefundItemRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundResponse as CalculateRefundResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundItemResponse as CalculateRefundItemResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_GetRefundabilityStatusRequest as GetRefundabilityStatusRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_GetRefundabilityStatusResponse as GetRefundabilityStatusResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_Refundability as Refundability, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOf, ecomV1OrderTransactionsOrderTransactions_universal_d_RefundableStatus as RefundableStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_NonRefundableReason as NonRefundableReason, ecomV1OrderTransactionsOrderTransactions_universal_d_ManuallyRefundableReason as ManuallyRefundableReason, ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForSingleOrderRequest as ListInvoicesForSingleOrderRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForSingleOrderResponse as ListInvoicesForSingleOrderResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceInfo as InvoiceInfo, ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForMultipleOrdersRequest as ListInvoicesForMultipleOrdersRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_ListInvoicesForMultipleOrdersResponse as ListInvoicesForMultipleOrdersResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_InvoicesForOrder as InvoicesForOrder, ecomV1OrderTransactionsOrderTransactions_universal_d_GenerateInvoiceRequest as GenerateInvoiceRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_GenerateInvoiceResponse as GenerateInvoiceResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkGenerateInvoicesRequest as BulkGenerateInvoicesRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkGenerateInvoicesResponse as BulkGenerateInvoicesResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkInvoiceResult as BulkInvoiceResult, ecomV1OrderTransactionsOrderTransactions_universal_d_InvoiceForOrder as InvoiceForOrder, ecomV1OrderTransactionsOrderTransactions_universal_d_AddInvoiceToOrderRequest as AddInvoiceToOrderRequest, ecomV1OrderTransactionsOrderTransactions_universal_d_AddInvoiceToOrderResponse as AddInvoiceToOrderResponse, ecomV1OrderTransactionsOrderTransactions_universal_d_DomainEvent as DomainEvent, ecomV1OrderTransactionsOrderTransactions_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, ecomV1OrderTransactionsOrderTransactions_universal_d_EntityCreatedEvent as EntityCreatedEvent, ecomV1OrderTransactionsOrderTransactions_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, ecomV1OrderTransactionsOrderTransactions_universal_d_EntityDeletedEvent as EntityDeletedEvent, ecomV1OrderTransactionsOrderTransactions_universal_d_ActionEvent as ActionEvent, ecomV1OrderTransactionsOrderTransactions_universal_d_MessageEnvelope as MessageEnvelope, ecomV1OrderTransactionsOrderTransactions_universal_d_IdentificationData as IdentificationData, ecomV1OrderTransactionsOrderTransactions_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, ecomV1OrderTransactionsOrderTransactions_universal_d_WebhookIdentityType as WebhookIdentityType, ecomV1OrderTransactionsOrderTransactions_universal_d_listTransactionsForSingleOrder as listTransactionsForSingleOrder, ecomV1OrderTransactionsOrderTransactions_universal_d_listTransactionsForMultipleOrders as listTransactionsForMultipleOrders, ecomV1OrderTransactionsOrderTransactions_universal_d_addPayments as addPayments, ecomV1OrderTransactionsOrderTransactions_universal_d_AddRefundOptions as AddRefundOptions, ecomV1OrderTransactionsOrderTransactions_universal_d_updatePaymentStatus as updatePaymentStatus, ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusIdentifiers as UpdatePaymentStatusIdentifiers, ecomV1OrderTransactionsOrderTransactions_universal_d_UpdatePaymentStatusOptions as UpdatePaymentStatusOptions, ecomV1OrderTransactionsOrderTransactions_universal_d_bulkUpdatePaymentStatuses as bulkUpdatePaymentStatuses, ecomV1OrderTransactionsOrderTransactions_universal_d_BulkUpdatePaymentStatusesOptions as BulkUpdatePaymentStatusesOptions, ecomV1OrderTransactionsOrderTransactions_universal_d_TriggerRefundOptions as TriggerRefundOptions, ecomV1OrderTransactionsOrderTransactions_universal_d_CalculateRefundOptions as CalculateRefundOptions, };\n }\n export { ecomV1BackInStockNotificationRequestBackInStockNotifications_universal_d as backInStockNotifications, ecomV1BackInStockSettingsBackInStockSettings_universal_d as backInStockSettings, ecomV1CartCart_universal_d as cart, ecomV1CheckoutCheckout_universal_d as checkout, ecomV1CheckoutSettingsCheckoutSettings_universal_d as checkoutSettings, ecomV1CheckoutTemplateCheckoutTemplates_universal_d as checkoutTemplates, ecomV1CartCurrentCart_universal_d as currentCart, ecomDiscountsV1DiscountRuleDiscountRules_universal_d as discountRules, ecomV1FulfillmentsOrderFulfillments_universal_d as orderFulfillments, ecomOrdersV1InvoiceOrderInvoices_universal_d as orderInvoices, ecomV1OrderTransactionsOrderTransactions_universal_d as orderTransactions, ecomV1OrderOrders_universal_d as orders, ecomV1OrdersSettingsOrdersSettings_universal_d as ordersSettings, ecomRecommendationsV1RecommendationRecommendations_universal_d as recommendations };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-pro-gallery-backend.d.ts", "content": "declare module \"wix-pro-gallery-backend\" {\n interface Gallery {\n /**\n * Gallery ID.\n * @readonly\n */\n _id?: string | null;\n /** Gallery name. */\n name?: string | null;\n /**\n * Total number of items in the gallery.\n * @readonly\n */\n totalItems?: number | null;\n /** Media items in the gallery. */\n items?: Item[];\n /**\n * Index that determines which position a gallery is displayed on the site.
\n *\n * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.\n */\n sortOrder?: number | null;\n /**\n * Date and time the gallery was created.\n * @readonly\n */\n _createdDate?: Date;\n }\n interface Item extends ItemMetadataOneOf {\n /** Details about the image. */\n image?: Image;\n /** Details about the video. */\n video?: Video;\n /** Details about the text file. */\n text?: Text;\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Index that determines which position a media item is displayed in the gallery.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n *\n * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.\n */\n sortOrder?: number | null;\n /** Item title. */\n title?: string | null;\n /** Item description. */\n description?: string | null;\n /** Link from the item. You can link to Wix sites or external URLs. */\n link?: Link;\n /** @readonly */\n type?: Type;\n /**\n * Date and time the item was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item tags. */\n tags?: Tags;\n }\n /** @oneof */\n interface ItemMetadataOneOf {\n /** Details about the image. */\n image?: Image;\n /** Details about the video. */\n video?: Video;\n /** Details about the text file. */\n text?: Text;\n }\n interface Link {\n /** Display text of the link. */\n text?: string | null;\n /** Target URL of the link. */\n url?: string | null;\n }\n enum LinkType {\n UNDEFINED = \"UNDEFINED\",\n /** external link */\n EXTERNAL = \"EXTERNAL\",\n /** for internal usage using wixLinkData */\n INTERNAL = \"INTERNAL\"\n }\n /** The link object generated by panels in the editor and used by applications in Wix */\n interface WixLink extends WixLinkLinkOneOf {\n /** External link type */\n external?: ExternalLink;\n /** Page link type */\n page?: PageLink;\n /** Anchor link type */\n anchor?: AnchorLink;\n /** Dynamic page link type */\n dynamicPage?: DynamicPageLink;\n /** Document link type */\n document?: DocumentLink;\n /** Email link type */\n email?: EmailLink;\n /** Phone link type */\n phone?: PhoneLink;\n /** Address link type */\n address?: AddressLink;\n /** WhatsApp link type */\n whatsApp?: WhatsAppLink;\n /** TPA link type */\n tpaPage?: TpaPageLink;\n }\n /** @oneof */\n interface WixLinkLinkOneOf {\n /** External link type */\n external?: ExternalLink;\n /** Page link type */\n page?: PageLink;\n /** Anchor link type */\n anchor?: AnchorLink;\n /** Dynamic page link type */\n dynamicPage?: DynamicPageLink;\n /** Document link type */\n document?: DocumentLink;\n /** Email link type */\n email?: EmailLink;\n /** Phone link type */\n phone?: PhoneLink;\n /** Address link type */\n address?: AddressLink;\n /** WhatsApp link type */\n whatsApp?: WhatsAppLink;\n /** TPA link type */\n tpaPage?: TpaPageLink;\n }\n interface ExternalLink {\n /** The url of the page */\n url?: string;\n /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */\n target?: string | null;\n }\n interface PageLink {\n /** The page id we want from the site */\n pageId?: string;\n /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */\n target?: string | null;\n /** rel of link */\n rel?: LinkRel[];\n }\n /**\n * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.\n * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel\n * Following are the accepted 'rel' types by Wix applications.\n */\n enum LinkRel {\n /** default (not implemented) */\n unknown_link_rel = \"unknown_link_rel\",\n /** Indicates that the current document's original author or publisher does not endorse the referenced document. */\n nofollow = \"nofollow\",\n /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */\n noopener = \"noopener\",\n /** No Referer header will be included. Additionally, has the same effect as noopener. */\n noreferrer = \"noreferrer\",\n /** Indicates a link that resulted from advertisements or paid placements. */\n sponsored = \"sponsored\"\n }\n interface AnchorLink {\n /** The name of the anchor */\n anchorName?: string;\n /** The data id (from the JSON page) of the anchor that should be used */\n anchorDataId?: string;\n /** The page id we want from the site */\n pageId?: string;\n /** rel of link */\n rel?: LinkRel[];\n }\n interface DynamicPageLink {\n /** The router that handles this link */\n routerId?: string;\n /** The path data we'd like */\n innerRoute?: string;\n /** The data id (from the JSON page) of the anchor that should be used */\n anchorDataId?: string | null;\n /** rel of link */\n rel?: LinkRel[];\n }\n interface DocumentLink {\n /** The id of the document */\n docId?: string;\n /** The name of the document for download purposes */\n name?: string | null;\n /** If this document can be indexed by scrapers, default is false */\n indexable?: boolean;\n }\n interface EmailLink {\n /** The email we will be sending a message to */\n recipient?: string;\n /** The subject of the email */\n subject?: string | null;\n /** The body of the email */\n body?: string | null;\n }\n interface PhoneLink {\n /** The phone number we want to link to */\n phoneNumber?: string;\n }\n interface AddressLink {\n /** An address that we can link to */\n address?: string;\n }\n interface WhatsAppLink {\n /** The whatsApp phone number we want to connect with */\n phoneNumber?: string;\n }\n /** Link to a TPA page */\n interface TpaPageLink {\n /** Type of item (e.g. 'wix.stores.sub_pages.product') */\n itemTypeIdentifier?: string;\n /** Id of linked item */\n itemId?: string;\n /** Id of linked page */\n pageId?: string;\n /** Id of app being linked to (AppDefId) */\n appDefinitionId?: string;\n /** The relativepath of linked page */\n path?: string;\n /** rel of link */\n rel?: LinkRel[];\n }\n enum Type {\n UNDEFINED = \"UNDEFINED\",\n IMAGE = \"IMAGE\",\n VIDEO = \"VIDEO\",\n TEXT = \"TEXT\"\n }\n interface Image {\n /** The image's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`. */\n imageInfo?: string;\n /** Focal point of the image. */\n focalPoint?: Point;\n /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */\n exif?: Record | null;\n /**\n * Image compression level.
\n *\n * Min: `30`
\n * Max: `100`\n */\n quality?: number | null;\n /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */\n unsharpMasking?: UnsharpMasking;\n }\n enum ImageType {\n UNDEFINED = \"UNDEFINED\",\n WIX_MEDIA = \"WIX_MEDIA\",\n EXTERNAL = \"EXTERNAL\"\n }\n interface Point {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n }\n interface UnsharpMasking {\n /**\n * Unsharp masking amount. Controls the sharpening strength.
\n *\n * Min: `0`
\n * Max: `5`\n */\n amount?: number | null;\n /** Unsharp masking radius in pixels. Controls the sharpening width. */\n radius?: number | null;\n /**\n * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply.
\n *\n * Min: `0`
\n * Max: `1`\n */\n threshold?: number | null;\n }\n interface Video {\n type?: VideoType;\n /**\n * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:\n *\n * Wix Media: `'wix:video://v1/6e6ea4_461425d7e7db4d5487a28e00c5ba6244/9e6ea4_461425d7e7db4d5487a28e00c5ba6277#posterUri=9e6ea4_461425d7e7db4d5487a28e00c5ba6277f000.jpg&posterWidth=960&posterHeight=540'`\n *\n * Vimeo: `'https://vimeo.com/378840916'`\n *\n * Youtube: `'https://www.youtube.com/results?search_query=uplifting+upbeat+music'`\n */\n videoInfo?: string;\n /** Manually defined video duration in milliseconds. */\n durationInMillis?: number | null;\n }\n enum VideoType {\n UNDEFINED = \"UNDEFINED\",\n WIX_MEDIA = \"WIX_MEDIA\",\n YOUTUBE = \"YOUTUBE\",\n VIMEO = \"VIMEO\"\n }\n interface VideoResolution {\n /** *Required.** Video URL. */\n url?: string;\n /** *Required.** Video height. */\n height?: number;\n /** *Required.** Video width. */\n width?: number;\n /** *Required.** Video format. For example, `mp4` or `hls`. */\n format?: string;\n /** Video quality. For example, `480p` or `720p`. */\n quality?: string | null;\n /** Video filename. */\n filename?: string | null;\n }\n interface Text {\n /** Text in HTML format. */\n html?: string | null;\n /**\n * Set of key-value pairs describing the [CSS style](https://en.wikipedia.org/wiki/CSS) of the text.\n *\n * __Note:__ The object structure is customizable. See the [`listGalleryItems()`](/pro-gallery/list-gallery-items) code example for supported values.\n */\n css?: Record | null;\n /** Reserved for internal use. */\n editorHtml?: string | null;\n /** Reserved for internal use. */\n editorFontId?: string | null;\n }\n interface Tags {\n /** List of tags assigned to the media item. */\n values?: string[];\n }\n interface SecondaryMedia extends SecondaryMediaMetadataOneOf {\n /** secondary media photo metadata (optional) */\n image?: Image;\n /** secondary media text metadata (optional) */\n text?: Text;\n }\n /** @oneof */\n interface SecondaryMediaMetadataOneOf {\n /** secondary media photo metadata (optional) */\n image?: Image;\n /** secondary media text metadata (optional) */\n text?: Text;\n }\n interface InvalidateCache extends InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n }\n interface App {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface GalleryPublished {\n /**\n * id of the gallery that will be published\n * @readonly\n */\n galleryId?: string;\n isRc?: boolean;\n /** @readonly */\n newRevision?: Date;\n /** @readonly */\n oldRevision?: Date;\n }\n interface CleanDeletedGalleriesEvent {\n /** @readonly */\n instanceId?: string;\n /** @readonly */\n metaSiteId?: string;\n /** @readonly */\n htmlSiteRevision?: string;\n /** @readonly */\n timeSitePublished?: Date;\n }\n interface ProgallerypublisherPublishGalleryRequest {\n /** id of the gallery that will be published */\n galleryId?: string;\n }\n interface ProgallerypublisherPublishGalleryResponse {\n }\n interface PublishGalleryItemRequest {\n /** id of the gallery that will be published */\n galleryId?: string;\n /** id of the item that will be published */\n itemId?: string;\n }\n interface PublishGalleryItemResponse {\n }\n interface PublishGalleryItemsRequest {\n /** id of the gallery that will be published */\n galleryId?: string;\n /** ids of the items that will be published */\n itemIds?: string[];\n }\n interface PublishGalleryItemsResponse {\n }\n interface Empty {\n }\n interface HtmlSitePublished {\n /** Application instance ID */\n appInstanceId?: string;\n /** Application type */\n appType?: string;\n /** Revision */\n revision?: string;\n /** MSID */\n metaSiteId?: string | null;\n /** optional branch id if publish is done from branch */\n branchId?: string | null;\n /** The site's last transactionId */\n lastTransactionId?: string | null;\n /** A list of the site's pages */\n pages?: EventsPage[];\n /** Site's publish date */\n publishDate?: string;\n }\n interface EventsPage {\n /** Page's Id */\n _id?: string;\n }\n interface HtmlSiteRCPublished {\n /** Application instance ID */\n appInstanceId?: string;\n /** Revision */\n revision?: string;\n /** Optional branch Id */\n branchId?: string | null;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n /** Information about a newly-created gallery. */\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: DocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update documents matching filter */\n updateByFilter?: UpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: UpdateExistingOperation;\n /** application which owns documents */\n appDefId?: string | null;\n /** type of the documents */\n documentType?: string | null;\n /** language of the documents */\n language?: string | null;\n /** site documents belong to */\n msId?: string | null;\n }\n /** @oneof */\n interface UpdateDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: DocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update documents matching filter */\n updateByFilter?: UpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: UpdateExistingOperation;\n }\n interface DocumentUpdateOperation {\n /** documents to index or update */\n documents?: IndexDocument[];\n }\n interface IndexDocument {\n /** data bag with non-searchable fields (url, image) */\n payload?: DocumentPayload;\n /** what type of users should documents be visible to */\n exposure?: Enum;\n /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */\n document?: Record | null;\n /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */\n permittedMemberGroups?: string[];\n /** if true SEO is disabled for this document */\n seoHidden?: boolean | null;\n /** if true the page is a lightbox popup */\n isPopup?: boolean | null;\n }\n interface DocumentPayload {\n /** url of the page representing the document */\n url?: string | null;\n /** image which represents the document */\n documentImage?: DocumentImage;\n }\n interface DocumentImage {\n /** the name of the image */\n name?: string;\n /** the width of the image */\n width?: number;\n /** the height of the image */\n height?: number;\n }\n enum Enum {\n /** Default value. Means that permission not set */\n UNKNOWN = \"UNKNOWN\",\n /** Protected exposure. Exposed to members and owners */\n PROTECTED = \"PROTECTED\",\n /** Private exposure. Exposed to owners */\n PRIVATE = \"PRIVATE\",\n /** Public exposure. Visible to everyone */\n PUBLIC = \"PUBLIC\",\n /** Used for partial updates, to state that exposure is not changing */\n UNCHANGED = \"UNCHANGED\",\n /** Protected to members of permitted groups and owners */\n GROUP_PROTECTED = \"GROUP_PROTECTED\"\n }\n interface DeleteByIdsOperation {\n /** ids of the documents to delete */\n documentIds?: string[];\n }\n interface DeleteByFilterOperation {\n /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */\n filter?: Record | null;\n }\n interface UpdateByFilterOperation {\n /** documents matching this filter will be updated */\n filter?: Record | null;\n /** partial document to apply */\n document?: IndexDocument;\n }\n interface UpdateExistingOperation {\n /** documents to update */\n documents?: IndexDocument[];\n }\n interface SearchIndexingNotification {\n /** new state of indexing for the site specified in ms_id */\n indexState?: SearchIndexingNotificationState;\n /** type of the document the notification is targeted for. Applies to all types if not provided */\n documentType?: string | null;\n /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */\n language?: string | null;\n /** site for which notification is targeted */\n msId?: string | null;\n }\n enum SearchIndexingNotificationState {\n /** default state */\n Unknown = \"Unknown\",\n /** metasite does not require site search indexing */\n Off = \"Off\",\n /** metasite requires site search indexing */\n On = \"On\"\n }\n interface ListGalleriesItemsRequest {\n /** IDs of the media items to retrieve. */\n itemsId?: ItemId[];\n }\n interface ItemId {\n /** Gallery ID. */\n galleryId?: string;\n /** Item ID. */\n itemId?: string;\n }\n interface ListGalleriesItemsResponse {\n /** Retrieved media items. */\n itemsInGalleries?: ItemsInGallery[];\n }\n interface ItemsInGallery {\n /** Gallery ID. */\n galleryId?: string;\n /** Retrieved media items. */\n items?: Item[];\n }\n interface GalleryItemCreated {\n /** Created gallery item. */\n item?: Item;\n }\n interface GalleryItemUpdated {\n /** Updated gallery item. */\n updatedItem?: Item;\n }\n interface GalleryItemDeleted {\n /** ID of the deleted gallery item. */\n itemId?: string;\n }\n interface ListGalleriesRequest {\n /** Number of galleries to list. Defaults to `10`. */\n itemLimit?: number | null;\n /** Number of galleries to skip in the returns. Defaults to `0`. */\n offset?: number | null;\n /** Number of galleries to list. Defaults to `10`. */\n limit?: number | null;\n }\n enum State {\n UNDEFINED = \"UNDEFINED\",\n /** The gallery in the Editor segment */\n SAVED = \"SAVED\",\n /** The gallery in the LiveSite segment */\n PUBLISHED = \"PUBLISHED\"\n }\n interface ListGalleriesResponse {\n /** Total number of galleries in the site. */\n totalGalleries?: number | null;\n /** List of galleries. Sorted by `_createdDate`. */\n galleries?: Gallery[];\n }\n interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {\n /** Gallery ID. */\n galleryId: string;\n /** Number of media items to skip in the returns. Defaults to `0`. */\n itemOffset?: number | null;\n /**\n * Maximum number of media items to return.
\n *\n * Min: `1`
\n * Max: `100`
\n * Default: `50`\n */\n itemLimit?: number | null;\n }\n /** @oneof */\n interface GetGalleryRequestVersionOneOf {\n }\n interface GetGalleryResponse {\n /** Returned gallery. */\n gallery?: Gallery;\n }\n interface ListGalleryItemsRequest {\n /** Gallery ID. */\n galleryId: string;\n /** Number of media items to skip in the returns. Defaults to `0`. */\n itemOffset?: number | null;\n /**\n * Maximum number of media items to return.
\n *\n * Min: `1`
\n * Max: `100`
\n * Default: `50`\n */\n itemLimit?: number | null;\n }\n interface ListGalleryItemsResponse {\n /** List of media items in the gallery. */\n items?: Item[];\n }\n interface GetGalleryItemRequest {\n /** Gallery ID. */\n galleryId: string;\n /** Item ID. */\n itemId: string;\n }\n interface GetGalleryItemResponse {\n /** Returned media item. */\n item?: Item;\n }\n interface CreateGalleryRequest {\n /** Gallery to create. */\n gallery?: Gallery;\n /** Gallery ID to clone from. */\n cloneFromGalleryId?: string | null;\n }\n interface CreateGalleryResponse {\n /** Created gallery. */\n gallery?: Gallery;\n }\n interface UpdateGalleryRequest {\n /** Gallery to update. */\n gallery: Gallery;\n }\n interface UpdateGalleryResponse {\n /** Updated gallery. */\n gallery?: Gallery;\n }\n interface DeleteGalleryRequest {\n /** ID of the gallery to delete. */\n galleryId: string;\n }\n interface DeleteGalleryResponse {\n /**\n * ID of the deleted gallery.\n * @readonly\n */\n galleryId?: string;\n }\n interface DeleteGalleryItemsRequest {\n /** Gallery ID. */\n galleryId: string;\n /** ID of the media item to delete. */\n itemsIds?: string[];\n }\n interface DeleteGalleryItemsResponse {\n /** Gallery that previously included the deleted media item. */\n gallery?: Gallery;\n }\n interface CreateGalleryItemRequest {\n /** Gallery ID. */\n galleryId: string;\n /** Media item to create. */\n item: Item;\n }\n interface CreateGalleryItemResponse {\n /** Created media item. */\n item?: Item;\n }\n interface CreateGalleryItemsRequest {\n /** Gallery ID. */\n galleryId?: string;\n /** Media items to create. */\n items?: Item[];\n }\n interface CreateGalleryItemsResponse {\n /** Created media items. */\n items?: Item[];\n }\n interface UpdateGalleryItemRequest {\n /** Gallery ID. */\n galleryId: string;\n /** The information for the media item being updated. */\n item: Item;\n }\n interface UpdateGalleryItemResponse {\n /** Updated media item. */\n item?: Item;\n }\n interface DeleteGalleryItemRequest {\n /** Gallery ID. */\n galleryId: string;\n /** ID of the media item to delete. */\n itemId: string;\n }\n interface DeleteGalleryItemResponse {\n /**\n * ID of the deleted media item.\n * @readonly\n */\n itemId?: string;\n }\n interface PublishGalleryRequest {\n /** ID of the gallery to publish. */\n galleryId: string;\n }\n interface PublishGalleryResponse {\n /** Published gallery. */\n gallery?: Gallery;\n }\n /**\n * Retrieves a list of galleries.\n *\n * This function retrieves a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the `offset` parameter.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when getting the list of galleries.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @permissionScope Read Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function listGalleries(options?: ListGalleriesOptions): Promise;\n interface ListGalleriesOptions {\n /** Number of galleries to list. Defaults to `10`. */\n itemLimit?: number | null;\n /** Number of galleries to skip in the returns. Defaults to `0`. */\n offset?: number | null;\n /** Number of galleries to list. Defaults to `10`. */\n limit?: number | null;\n }\n /**\n * Retrieves a gallery by ID.\n * @param galleryId - Gallery ID.\n * @public\n * @documentationMaturity preview\n * @requiredField galleryId\n * @param options - Options to use when getting the gallery.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @permissionScope Read Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns Returned gallery.\n */\n function getGallery(galleryId: string, options?: GetGalleryOptions): Promise;\n interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {\n /** Number of media items to skip in the returns. Defaults to `0`. */\n itemOffset?: number | null;\n /**\n * Maximum number of media items to return.
\n *\n * Min: `1`
\n * Max: `100`
\n * Default: `50`\n */\n itemLimit?: number | null;\n }\n /**\n * Retrieves a list of media items in a specified gallery.\n *\n * This function retrieves a list of up to 100 gallery items. The gallery items are listed by `sortOrder` in descending order.\n * @param galleryId - Gallery ID.\n * @public\n * @documentationMaturity preview\n * @requiredField galleryId\n * @param options - Options to use when getting the list of gallery items.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @permissionScope Read Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function listGalleryItems(galleryId: string, options?: ListGalleryItemsOptions): Promise;\n interface ListGalleryItemsOptions {\n /** Number of media items to skip in the returns. Defaults to `0`. */\n itemOffset?: number | null;\n /**\n * Maximum number of media items to return.
\n *\n * Min: `1`
\n * Max: `100`
\n * Default: `50`\n */\n itemLimit?: number | null;\n }\n /**\n * Retrieves a gallery item by ID.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.galleryId\n * @requiredField identifiers.itemId\n * @param identifiers - Gallery ID and Item ID.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @permissionScope Read Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns Returned media item.\n */\n function getGalleryItem(identifiers: GetGalleryItemIdentifiers, options?: GetGalleryItemOptions): Promise;\n interface GetGalleryItemIdentifiers {\n /** Gallery ID. */\n galleryId: string;\n /** Item ID. */\n itemId: string;\n }\n interface GetGalleryItemOptions {\n }\n /**\n * Creates a new gallery.\n *\n * You can create your own gallery by providing the gallery information, or clone an existing gallery using the ID of that existing gallery. When a gallery is cloned, the newly-created gallery includes the same properties as the existing gallery except for the gallery and item IDs, sort order, and created and updated dates.\n *\n * The newly-created gallery is only available on your backend, and doesn't appear on your live site. To display your backend gallery on your live site, you need to connect it to a gallery component on your live site. To do this, import the `createGallery()` function to your page code, and write code to convert the backend gallery object to the frontend gallery component object. Once converted, the newly created backend gallery is visible on your live site. For reference, check out the code example, \"Create a gallery and display it on your live site\". To learn more, see [Displaying a Pro Gallery on Your Site Using the Pro Gallery Backend API](https://support.wix.com/en/article/velo-tutorial-displaying-a-pro-gallery-on-your-site-using-the-pro-gallery-backend-api).\n *\n *
\n *\n * __Important:__\n * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n *\n *
\n * @public\n * @documentationMaturity preview\n * @requiredField options.gallery.items.image.imageInfo\n * @requiredField options.gallery.items.text.html\n * @requiredField options.gallery.items.video.videoInfo\n * @param options - Options to use when creating the gallery.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created gallery.\n */\n function createGallery(options?: CreateGalleryOptions): Promise;\n interface CreateGalleryOptions {\n /** Gallery to create. */\n gallery?: Gallery;\n /** Gallery ID to clone from. */\n cloneFromGalleryId?: string | null;\n }\n /**\n * Updates a gallery.\n *\n * Only the fields in the `gallery` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.\n *\n *
\n *\n * __Important:__\n * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n *\n *
\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField gallery\n * @requiredField gallery.items.image.imageInfo\n * @requiredField gallery.items.text.html\n * @requiredField gallery.items.video.videoInfo\n * @param _id - ID of the gallery to update.\n * @param gallery - The information for the gallery being updated.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated gallery.\n */\n function updateGallery(_id: string | null, gallery: UpdateGallery, options?: UpdateGalleryOptions): Promise;\n interface UpdateGallery {\n /**\n * Gallery ID.\n * @readonly\n */\n _id?: string | null;\n /** Gallery name. */\n name?: string | null;\n /**\n * Total number of items in the gallery.\n * @readonly\n */\n totalItems?: number | null;\n /** Media items in the gallery. */\n items?: Item[];\n /**\n * Index that determines which position a gallery is displayed on the site.
\n *\n * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.\n */\n sortOrder?: number | null;\n /**\n * Date and time the gallery was created.\n * @readonly\n */\n _createdDate?: Date;\n }\n interface UpdateGalleryOptions {\n }\n /**\n * Deletes a gallery.\n *\n * When a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](/pro-gallery/list-galleries) function.\n * @param galleryId - ID of the gallery to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField galleryId\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteGallery(galleryId: string, options?: DeleteGalleryOptions): Promise;\n interface DeleteGalleryOptions {\n }\n interface DeleteGalleryItemsOptions {\n /** ID of the media item to delete. */\n itemsIds?: string[];\n }\n /**\n * Creates a media item in a specified gallery.\n *\n * The `createGalleryItem()` function returns a Promise that resolves to a newly-created gallery item after it has successfully been created.\n *\n *
\n *\n * __Important:__\n * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n *\n *
\n *\n * #### Override permissions\n * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n *
\n *

Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.

\n *
\n * @param galleryId - Gallery ID.\n * @param item - Media item to create.\n * @public\n * @documentationMaturity preview\n * @requiredField galleryId\n * @requiredField item\n * @requiredField item.image.imageInfo\n * @requiredField item.text.html\n * @requiredField item.video.videoInfo\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created media item.\n */\n function createGalleryItem(galleryId: string, item: Item, options?: CreateGalleryItemOptions): Promise;\n interface CreateGalleryItemOptions {\n }\n /**\n * Updates a media item in a specified gallery.\n *\n * Only the fields in the `item` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.\n *\n *
\n *\n * __Important:__\n * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n *\n *
\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.galleryId\n * @requiredField identifiers.itemId\n * @requiredField item\n * @requiredField item.image.imageInfo\n * @requiredField item.text.html\n * @requiredField item.video.videoInfo\n * @param item - The information for the gallery item being updated.\n * @param identifiers - Gallery ID and Item ID.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated media item.\n */\n function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem, options?: UpdateGalleryItemOptions): Promise;\n interface UpdateGalleryItemIdentifiers {\n /** ID of the gallery containing the item to update. */\n galleryId: string;\n /**\n * ID of the item to update.\n * @readonly\n */\n itemId?: string | null;\n }\n interface UpdateGalleryItem {\n /** Details about the image. */\n image?: Image;\n /** Details about the video. */\n video?: Video;\n /** Details about the text file. */\n text?: Text;\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Index that determines which position a media item is displayed in the gallery.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n *\n * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.\n */\n sortOrder?: number | null;\n /** Item title. */\n title?: string | null;\n /** Item description. */\n description?: string | null;\n /** Link from the item. You can link to Wix sites or external URLs. */\n link?: Link;\n /** @readonly */\n type?: Type;\n /**\n * Date and time the item was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item tags. */\n tags?: Tags;\n }\n interface UpdateGalleryItemOptions {\n }\n /**\n * Deletes a media item from a gallery.\n *\n * When a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](/pro-gallery/list-gallery-items) function.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.galleryId\n * @requiredField identifiers.itemId\n * @param identifiers - Gallery ID and Item ID.\n * @permissionScope Manage Galleries\n * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers, options?: DeleteGalleryItemOptions): Promise;\n interface DeleteGalleryItemIdentifiers {\n /** Gallery ID. */\n galleryId: string;\n /** ID of the media item to delete. */\n itemId: string;\n }\n interface DeleteGalleryItemOptions {\n }\n type proGalleryV2GalleryProGallery_universal_d_Gallery = Gallery;\n type proGalleryV2GalleryProGallery_universal_d_Item = Item;\n type proGalleryV2GalleryProGallery_universal_d_ItemMetadataOneOf = ItemMetadataOneOf;\n type proGalleryV2GalleryProGallery_universal_d_Link = Link;\n type proGalleryV2GalleryProGallery_universal_d_LinkType = LinkType;\n const proGalleryV2GalleryProGallery_universal_d_LinkType: typeof LinkType;\n type proGalleryV2GalleryProGallery_universal_d_WixLink = WixLink;\n type proGalleryV2GalleryProGallery_universal_d_WixLinkLinkOneOf = WixLinkLinkOneOf;\n type proGalleryV2GalleryProGallery_universal_d_ExternalLink = ExternalLink;\n type proGalleryV2GalleryProGallery_universal_d_PageLink = PageLink;\n type proGalleryV2GalleryProGallery_universal_d_LinkRel = LinkRel;\n const proGalleryV2GalleryProGallery_universal_d_LinkRel: typeof LinkRel;\n type proGalleryV2GalleryProGallery_universal_d_AnchorLink = AnchorLink;\n type proGalleryV2GalleryProGallery_universal_d_DynamicPageLink = DynamicPageLink;\n type proGalleryV2GalleryProGallery_universal_d_DocumentLink = DocumentLink;\n type proGalleryV2GalleryProGallery_universal_d_EmailLink = EmailLink;\n type proGalleryV2GalleryProGallery_universal_d_PhoneLink = PhoneLink;\n type proGalleryV2GalleryProGallery_universal_d_AddressLink = AddressLink;\n type proGalleryV2GalleryProGallery_universal_d_WhatsAppLink = WhatsAppLink;\n type proGalleryV2GalleryProGallery_universal_d_TpaPageLink = TpaPageLink;\n type proGalleryV2GalleryProGallery_universal_d_Type = Type;\n const proGalleryV2GalleryProGallery_universal_d_Type: typeof Type;\n type proGalleryV2GalleryProGallery_universal_d_Image = Image;\n type proGalleryV2GalleryProGallery_universal_d_ImageType = ImageType;\n const proGalleryV2GalleryProGallery_universal_d_ImageType: typeof ImageType;\n type proGalleryV2GalleryProGallery_universal_d_Point = Point;\n type proGalleryV2GalleryProGallery_universal_d_UnsharpMasking = UnsharpMasking;\n type proGalleryV2GalleryProGallery_universal_d_Video = Video;\n type proGalleryV2GalleryProGallery_universal_d_VideoType = VideoType;\n const proGalleryV2GalleryProGallery_universal_d_VideoType: typeof VideoType;\n type proGalleryV2GalleryProGallery_universal_d_VideoResolution = VideoResolution;\n type proGalleryV2GalleryProGallery_universal_d_Text = Text;\n type proGalleryV2GalleryProGallery_universal_d_Tags = Tags;\n type proGalleryV2GalleryProGallery_universal_d_SecondaryMedia = SecondaryMedia;\n type proGalleryV2GalleryProGallery_universal_d_SecondaryMediaMetadataOneOf = SecondaryMediaMetadataOneOf;\n type proGalleryV2GalleryProGallery_universal_d_InvalidateCache = InvalidateCache;\n type proGalleryV2GalleryProGallery_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type proGalleryV2GalleryProGallery_universal_d_App = App;\n type proGalleryV2GalleryProGallery_universal_d_Page = Page;\n type proGalleryV2GalleryProGallery_universal_d_URI = URI;\n type proGalleryV2GalleryProGallery_universal_d_File = File;\n type proGalleryV2GalleryProGallery_universal_d_GalleryPublished = GalleryPublished;\n type proGalleryV2GalleryProGallery_universal_d_CleanDeletedGalleriesEvent = CleanDeletedGalleriesEvent;\n type proGalleryV2GalleryProGallery_universal_d_ProgallerypublisherPublishGalleryRequest = ProgallerypublisherPublishGalleryRequest;\n type proGalleryV2GalleryProGallery_universal_d_ProgallerypublisherPublishGalleryResponse = ProgallerypublisherPublishGalleryResponse;\n type proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemRequest = PublishGalleryItemRequest;\n type proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemResponse = PublishGalleryItemResponse;\n type proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemsRequest = PublishGalleryItemsRequest;\n type proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemsResponse = PublishGalleryItemsResponse;\n type proGalleryV2GalleryProGallery_universal_d_Empty = Empty;\n type proGalleryV2GalleryProGallery_universal_d_HtmlSitePublished = HtmlSitePublished;\n type proGalleryV2GalleryProGallery_universal_d_EventsPage = EventsPage;\n type proGalleryV2GalleryProGallery_universal_d_HtmlSiteRCPublished = HtmlSiteRCPublished;\n type proGalleryV2GalleryProGallery_universal_d_DomainEvent = DomainEvent;\n type proGalleryV2GalleryProGallery_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type proGalleryV2GalleryProGallery_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type proGalleryV2GalleryProGallery_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type proGalleryV2GalleryProGallery_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type proGalleryV2GalleryProGallery_universal_d_ActionEvent = ActionEvent;\n type proGalleryV2GalleryProGallery_universal_d_MessageEnvelope = MessageEnvelope;\n type proGalleryV2GalleryProGallery_universal_d_IdentificationData = IdentificationData;\n type proGalleryV2GalleryProGallery_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type proGalleryV2GalleryProGallery_universal_d_WebhookIdentityType = WebhookIdentityType;\n const proGalleryV2GalleryProGallery_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type proGalleryV2GalleryProGallery_universal_d_UpdateDocumentsEvent = UpdateDocumentsEvent;\n type proGalleryV2GalleryProGallery_universal_d_UpdateDocumentsEventOperationOneOf = UpdateDocumentsEventOperationOneOf;\n type proGalleryV2GalleryProGallery_universal_d_DocumentUpdateOperation = DocumentUpdateOperation;\n type proGalleryV2GalleryProGallery_universal_d_IndexDocument = IndexDocument;\n type proGalleryV2GalleryProGallery_universal_d_DocumentPayload = DocumentPayload;\n type proGalleryV2GalleryProGallery_universal_d_DocumentImage = DocumentImage;\n type proGalleryV2GalleryProGallery_universal_d_Enum = Enum;\n const proGalleryV2GalleryProGallery_universal_d_Enum: typeof Enum;\n type proGalleryV2GalleryProGallery_universal_d_DeleteByIdsOperation = DeleteByIdsOperation;\n type proGalleryV2GalleryProGallery_universal_d_DeleteByFilterOperation = DeleteByFilterOperation;\n type proGalleryV2GalleryProGallery_universal_d_UpdateByFilterOperation = UpdateByFilterOperation;\n type proGalleryV2GalleryProGallery_universal_d_UpdateExistingOperation = UpdateExistingOperation;\n type proGalleryV2GalleryProGallery_universal_d_SearchIndexingNotification = SearchIndexingNotification;\n type proGalleryV2GalleryProGallery_universal_d_SearchIndexingNotificationState = SearchIndexingNotificationState;\n const proGalleryV2GalleryProGallery_universal_d_SearchIndexingNotificationState: typeof SearchIndexingNotificationState;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleriesItemsRequest = ListGalleriesItemsRequest;\n type proGalleryV2GalleryProGallery_universal_d_ItemId = ItemId;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleriesItemsResponse = ListGalleriesItemsResponse;\n type proGalleryV2GalleryProGallery_universal_d_ItemsInGallery = ItemsInGallery;\n type proGalleryV2GalleryProGallery_universal_d_GalleryItemCreated = GalleryItemCreated;\n type proGalleryV2GalleryProGallery_universal_d_GalleryItemUpdated = GalleryItemUpdated;\n type proGalleryV2GalleryProGallery_universal_d_GalleryItemDeleted = GalleryItemDeleted;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleriesRequest = ListGalleriesRequest;\n type proGalleryV2GalleryProGallery_universal_d_State = State;\n const proGalleryV2GalleryProGallery_universal_d_State: typeof State;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleriesResponse = ListGalleriesResponse;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryRequest = GetGalleryRequest;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryRequestVersionOneOf = GetGalleryRequestVersionOneOf;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryResponse = GetGalleryResponse;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleryItemsRequest = ListGalleryItemsRequest;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleryItemsResponse = ListGalleryItemsResponse;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryItemRequest = GetGalleryItemRequest;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryItemResponse = GetGalleryItemResponse;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryRequest = CreateGalleryRequest;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryResponse = CreateGalleryResponse;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryRequest = UpdateGalleryRequest;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryResponse = UpdateGalleryResponse;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryRequest = DeleteGalleryRequest;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryResponse = DeleteGalleryResponse;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemsRequest = DeleteGalleryItemsRequest;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemsResponse = DeleteGalleryItemsResponse;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemRequest = CreateGalleryItemRequest;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemResponse = CreateGalleryItemResponse;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemsRequest = CreateGalleryItemsRequest;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemsResponse = CreateGalleryItemsResponse;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemRequest = UpdateGalleryItemRequest;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemResponse = UpdateGalleryItemResponse;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemRequest = DeleteGalleryItemRequest;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemResponse = DeleteGalleryItemResponse;\n type proGalleryV2GalleryProGallery_universal_d_PublishGalleryRequest = PublishGalleryRequest;\n type proGalleryV2GalleryProGallery_universal_d_PublishGalleryResponse = PublishGalleryResponse;\n const proGalleryV2GalleryProGallery_universal_d_listGalleries: typeof listGalleries;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleriesOptions = ListGalleriesOptions;\n const proGalleryV2GalleryProGallery_universal_d_getGallery: typeof getGallery;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryOptions = GetGalleryOptions;\n const proGalleryV2GalleryProGallery_universal_d_listGalleryItems: typeof listGalleryItems;\n type proGalleryV2GalleryProGallery_universal_d_ListGalleryItemsOptions = ListGalleryItemsOptions;\n const proGalleryV2GalleryProGallery_universal_d_getGalleryItem: typeof getGalleryItem;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryItemIdentifiers = GetGalleryItemIdentifiers;\n type proGalleryV2GalleryProGallery_universal_d_GetGalleryItemOptions = GetGalleryItemOptions;\n const proGalleryV2GalleryProGallery_universal_d_createGallery: typeof createGallery;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryOptions = CreateGalleryOptions;\n const proGalleryV2GalleryProGallery_universal_d_updateGallery: typeof updateGallery;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGallery = UpdateGallery;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryOptions = UpdateGalleryOptions;\n const proGalleryV2GalleryProGallery_universal_d_deleteGallery: typeof deleteGallery;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryOptions = DeleteGalleryOptions;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemsOptions = DeleteGalleryItemsOptions;\n const proGalleryV2GalleryProGallery_universal_d_createGalleryItem: typeof createGalleryItem;\n type proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemOptions = CreateGalleryItemOptions;\n const proGalleryV2GalleryProGallery_universal_d_updateGalleryItem: typeof updateGalleryItem;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemIdentifiers = UpdateGalleryItemIdentifiers;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItem = UpdateGalleryItem;\n type proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemOptions = UpdateGalleryItemOptions;\n const proGalleryV2GalleryProGallery_universal_d_deleteGalleryItem: typeof deleteGalleryItem;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemIdentifiers = DeleteGalleryItemIdentifiers;\n type proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemOptions = DeleteGalleryItemOptions;\n namespace proGalleryV2GalleryProGallery_universal_d {\n export { proGalleryV2GalleryProGallery_universal_d_Gallery as Gallery, proGalleryV2GalleryProGallery_universal_d_Item as Item, proGalleryV2GalleryProGallery_universal_d_ItemMetadataOneOf as ItemMetadataOneOf, proGalleryV2GalleryProGallery_universal_d_Link as Link, proGalleryV2GalleryProGallery_universal_d_LinkType as LinkType, proGalleryV2GalleryProGallery_universal_d_WixLink as WixLink, proGalleryV2GalleryProGallery_universal_d_WixLinkLinkOneOf as WixLinkLinkOneOf, proGalleryV2GalleryProGallery_universal_d_ExternalLink as ExternalLink, proGalleryV2GalleryProGallery_universal_d_PageLink as PageLink, proGalleryV2GalleryProGallery_universal_d_LinkRel as LinkRel, proGalleryV2GalleryProGallery_universal_d_AnchorLink as AnchorLink, proGalleryV2GalleryProGallery_universal_d_DynamicPageLink as DynamicPageLink, proGalleryV2GalleryProGallery_universal_d_DocumentLink as DocumentLink, proGalleryV2GalleryProGallery_universal_d_EmailLink as EmailLink, proGalleryV2GalleryProGallery_universal_d_PhoneLink as PhoneLink, proGalleryV2GalleryProGallery_universal_d_AddressLink as AddressLink, proGalleryV2GalleryProGallery_universal_d_WhatsAppLink as WhatsAppLink, proGalleryV2GalleryProGallery_universal_d_TpaPageLink as TpaPageLink, proGalleryV2GalleryProGallery_universal_d_Type as Type, proGalleryV2GalleryProGallery_universal_d_Image as Image, proGalleryV2GalleryProGallery_universal_d_ImageType as ImageType, proGalleryV2GalleryProGallery_universal_d_Point as Point, proGalleryV2GalleryProGallery_universal_d_UnsharpMasking as UnsharpMasking, proGalleryV2GalleryProGallery_universal_d_Video as Video, proGalleryV2GalleryProGallery_universal_d_VideoType as VideoType, proGalleryV2GalleryProGallery_universal_d_VideoResolution as VideoResolution, proGalleryV2GalleryProGallery_universal_d_Text as Text, proGalleryV2GalleryProGallery_universal_d_Tags as Tags, proGalleryV2GalleryProGallery_universal_d_SecondaryMedia as SecondaryMedia, proGalleryV2GalleryProGallery_universal_d_SecondaryMediaMetadataOneOf as SecondaryMediaMetadataOneOf, proGalleryV2GalleryProGallery_universal_d_InvalidateCache as InvalidateCache, proGalleryV2GalleryProGallery_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, proGalleryV2GalleryProGallery_universal_d_App as App, proGalleryV2GalleryProGallery_universal_d_Page as Page, proGalleryV2GalleryProGallery_universal_d_URI as URI, proGalleryV2GalleryProGallery_universal_d_File as File, proGalleryV2GalleryProGallery_universal_d_GalleryPublished as GalleryPublished, proGalleryV2GalleryProGallery_universal_d_CleanDeletedGalleriesEvent as CleanDeletedGalleriesEvent, proGalleryV2GalleryProGallery_universal_d_ProgallerypublisherPublishGalleryRequest as ProgallerypublisherPublishGalleryRequest, proGalleryV2GalleryProGallery_universal_d_ProgallerypublisherPublishGalleryResponse as ProgallerypublisherPublishGalleryResponse, proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemRequest as PublishGalleryItemRequest, proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemResponse as PublishGalleryItemResponse, proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemsRequest as PublishGalleryItemsRequest, proGalleryV2GalleryProGallery_universal_d_PublishGalleryItemsResponse as PublishGalleryItemsResponse, proGalleryV2GalleryProGallery_universal_d_Empty as Empty, proGalleryV2GalleryProGallery_universal_d_HtmlSitePublished as HtmlSitePublished, proGalleryV2GalleryProGallery_universal_d_EventsPage as EventsPage, proGalleryV2GalleryProGallery_universal_d_HtmlSiteRCPublished as HtmlSiteRCPublished, proGalleryV2GalleryProGallery_universal_d_DomainEvent as DomainEvent, proGalleryV2GalleryProGallery_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, proGalleryV2GalleryProGallery_universal_d_EntityCreatedEvent as EntityCreatedEvent, proGalleryV2GalleryProGallery_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, proGalleryV2GalleryProGallery_universal_d_EntityDeletedEvent as EntityDeletedEvent, proGalleryV2GalleryProGallery_universal_d_ActionEvent as ActionEvent, proGalleryV2GalleryProGallery_universal_d_MessageEnvelope as MessageEnvelope, proGalleryV2GalleryProGallery_universal_d_IdentificationData as IdentificationData, proGalleryV2GalleryProGallery_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, proGalleryV2GalleryProGallery_universal_d_WebhookIdentityType as WebhookIdentityType, proGalleryV2GalleryProGallery_universal_d_UpdateDocumentsEvent as UpdateDocumentsEvent, proGalleryV2GalleryProGallery_universal_d_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf, proGalleryV2GalleryProGallery_universal_d_DocumentUpdateOperation as DocumentUpdateOperation, proGalleryV2GalleryProGallery_universal_d_IndexDocument as IndexDocument, proGalleryV2GalleryProGallery_universal_d_DocumentPayload as DocumentPayload, proGalleryV2GalleryProGallery_universal_d_DocumentImage as DocumentImage, proGalleryV2GalleryProGallery_universal_d_Enum as Enum, proGalleryV2GalleryProGallery_universal_d_DeleteByIdsOperation as DeleteByIdsOperation, proGalleryV2GalleryProGallery_universal_d_DeleteByFilterOperation as DeleteByFilterOperation, proGalleryV2GalleryProGallery_universal_d_UpdateByFilterOperation as UpdateByFilterOperation, proGalleryV2GalleryProGallery_universal_d_UpdateExistingOperation as UpdateExistingOperation, proGalleryV2GalleryProGallery_universal_d_SearchIndexingNotification as SearchIndexingNotification, proGalleryV2GalleryProGallery_universal_d_SearchIndexingNotificationState as SearchIndexingNotificationState, proGalleryV2GalleryProGallery_universal_d_ListGalleriesItemsRequest as ListGalleriesItemsRequest, proGalleryV2GalleryProGallery_universal_d_ItemId as ItemId, proGalleryV2GalleryProGallery_universal_d_ListGalleriesItemsResponse as ListGalleriesItemsResponse, proGalleryV2GalleryProGallery_universal_d_ItemsInGallery as ItemsInGallery, proGalleryV2GalleryProGallery_universal_d_GalleryItemCreated as GalleryItemCreated, proGalleryV2GalleryProGallery_universal_d_GalleryItemUpdated as GalleryItemUpdated, proGalleryV2GalleryProGallery_universal_d_GalleryItemDeleted as GalleryItemDeleted, proGalleryV2GalleryProGallery_universal_d_ListGalleriesRequest as ListGalleriesRequest, proGalleryV2GalleryProGallery_universal_d_State as State, proGalleryV2GalleryProGallery_universal_d_ListGalleriesResponse as ListGalleriesResponse, proGalleryV2GalleryProGallery_universal_d_GetGalleryRequest as GetGalleryRequest, proGalleryV2GalleryProGallery_universal_d_GetGalleryRequestVersionOneOf as GetGalleryRequestVersionOneOf, proGalleryV2GalleryProGallery_universal_d_GetGalleryResponse as GetGalleryResponse, proGalleryV2GalleryProGallery_universal_d_ListGalleryItemsRequest as ListGalleryItemsRequest, proGalleryV2GalleryProGallery_universal_d_ListGalleryItemsResponse as ListGalleryItemsResponse, proGalleryV2GalleryProGallery_universal_d_GetGalleryItemRequest as GetGalleryItemRequest, proGalleryV2GalleryProGallery_universal_d_GetGalleryItemResponse as GetGalleryItemResponse, proGalleryV2GalleryProGallery_universal_d_CreateGalleryRequest as CreateGalleryRequest, proGalleryV2GalleryProGallery_universal_d_CreateGalleryResponse as CreateGalleryResponse, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryRequest as UpdateGalleryRequest, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryResponse as UpdateGalleryResponse, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryRequest as DeleteGalleryRequest, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryResponse as DeleteGalleryResponse, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemsRequest as DeleteGalleryItemsRequest, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemsResponse as DeleteGalleryItemsResponse, proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemRequest as CreateGalleryItemRequest, proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemResponse as CreateGalleryItemResponse, proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemsRequest as CreateGalleryItemsRequest, proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemsResponse as CreateGalleryItemsResponse, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemRequest as UpdateGalleryItemRequest, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemResponse as UpdateGalleryItemResponse, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemRequest as DeleteGalleryItemRequest, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemResponse as DeleteGalleryItemResponse, proGalleryV2GalleryProGallery_universal_d_PublishGalleryRequest as PublishGalleryRequest, proGalleryV2GalleryProGallery_universal_d_PublishGalleryResponse as PublishGalleryResponse, proGalleryV2GalleryProGallery_universal_d_listGalleries as listGalleries, proGalleryV2GalleryProGallery_universal_d_ListGalleriesOptions as ListGalleriesOptions, proGalleryV2GalleryProGallery_universal_d_getGallery as getGallery, proGalleryV2GalleryProGallery_universal_d_GetGalleryOptions as GetGalleryOptions, proGalleryV2GalleryProGallery_universal_d_listGalleryItems as listGalleryItems, proGalleryV2GalleryProGallery_universal_d_ListGalleryItemsOptions as ListGalleryItemsOptions, proGalleryV2GalleryProGallery_universal_d_getGalleryItem as getGalleryItem, proGalleryV2GalleryProGallery_universal_d_GetGalleryItemIdentifiers as GetGalleryItemIdentifiers, proGalleryV2GalleryProGallery_universal_d_GetGalleryItemOptions as GetGalleryItemOptions, proGalleryV2GalleryProGallery_universal_d_createGallery as createGallery, proGalleryV2GalleryProGallery_universal_d_CreateGalleryOptions as CreateGalleryOptions, proGalleryV2GalleryProGallery_universal_d_updateGallery as updateGallery, proGalleryV2GalleryProGallery_universal_d_UpdateGallery as UpdateGallery, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryOptions as UpdateGalleryOptions, proGalleryV2GalleryProGallery_universal_d_deleteGallery as deleteGallery, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryOptions as DeleteGalleryOptions, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemsOptions as DeleteGalleryItemsOptions, proGalleryV2GalleryProGallery_universal_d_createGalleryItem as createGalleryItem, proGalleryV2GalleryProGallery_universal_d_CreateGalleryItemOptions as CreateGalleryItemOptions, proGalleryV2GalleryProGallery_universal_d_updateGalleryItem as updateGalleryItem, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemIdentifiers as UpdateGalleryItemIdentifiers, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItem as UpdateGalleryItem, proGalleryV2GalleryProGallery_universal_d_UpdateGalleryItemOptions as UpdateGalleryItemOptions, proGalleryV2GalleryProGallery_universal_d_deleteGalleryItem as deleteGalleryItem, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemIdentifiers as DeleteGalleryItemIdentifiers, proGalleryV2GalleryProGallery_universal_d_DeleteGalleryItemOptions as DeleteGalleryItemOptions, };\n }\n export { proGalleryV2GalleryProGallery_universal_d as proGallery };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/interfaces-ecommerce-v1-additional-fees-provider.d.ts", "content": "declare module \"interfaces-ecommerce-v1-additional-fees-provider\" {\n interface AdditionalFeesProvider {\n /** GUID unique to this list for this site */\n _id?: string | null;\n }\n interface CalculateAdditionalFeesRequest {\n /** LineItems */\n lineItems?: LineItem[];\n /** Selected shipping option */\n shippingInfo?: ShippingInformation;\n /** Applied discounts */\n appliedDiscounts?: AppliedDiscount[];\n }\n interface LineItem {\n /** Line item ID. */\n _id?: string;\n /** Quantity. */\n quantity?: number | null;\n /** Catalog reference */\n catalogReference?: CatalogReference;\n /** Product/booking/event name. */\n productName?: string | null;\n /** Price. */\n price?: string;\n /** Physical properties (if applicable). */\n physicalProperties?: PhysicalProperties;\n /** Subscription settings. */\n subscriptionSettings?: SubscriptionSettings;\n /**\n * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType;\n /** Service properties. When relevant, this contains information such as date and number of participants. */\n serviceProperties?: ServiceProperties;\n /**\n * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + In most cases, this field has the same value as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n */\n rootCatalogItemId?: string | null;\n /**\n * Optional - partial amount of item's price to be paid now for checkout cases with DEPOSIT_ONLINE payment option\n * If omitted - item's price will not be split and is expected to be paid in single installment\n */\n depositAmount?: string | null;\n }\n /** Used for grouping line items and is sent on add to cart */\n interface CatalogReference {\n /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */\n catalogItemId?: string;\n /** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */\n appId?: string;\n /** Additional info in key:value form. For example, `{\"options\":{\"Size\": \"M\", \"Color\": \"Red\"}}` or `{\"variantId\": \"\"}`. */\n options?: Record | null;\n }\n interface PhysicalProperties {\n /** Line item weight. Measurement unit (KG or LB) is taken from `order.weightUnit`. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface Scope {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events) */\n namespace?: string;\n /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */\n group?: Group;\n }\n interface Group {\n /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n name?: string;\n /** Item ID (when the coupon scope is limited to just one item). */\n entityId?: string | null;\n }\n interface SubscriptionSettings {\n /** Frequency of recurring payment. Every day/week/month/year. */\n frequency?: SubscriptionFrequency;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType {\n /** The entire payment for given item will happen as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for given item will happen after the checkout. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Given item cannot be paid via monetary payment options, only via membership. When this option is used, price will always be 0. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /**\n * Partial payment for the given item to be paid upfront during the checkout.\n * Amount to be paid is defined by `deposit_amount` field on per-item basis.\n */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\"\n }\n interface ServiceProperties {\n /** Optional - The date and time for which the service is supposed to be provided. For example, the time of the class. */\n scheduledDate?: Date;\n /** Optional - The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface ShippingInformation {\n /** Shipping region. */\n region?: ShippingRegion;\n /** Selected shipping option. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption;\n /** All shipping options. */\n carrierServiceOptions?: CarrierServiceOption[];\n }\n interface ShippingRegion {\n /**\n * Shipping region ID.\n * @readonly\n */\n _id?: string;\n /** Shipping region name. */\n name?: string;\n }\n interface SelectedCarrierServiceOption {\n /** Unique identifier of selected option. For example, \"usps_std_overnight\". */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n * @readonly\n */\n title?: string;\n /**\n * Delivery logistics.\n * @readonly\n */\n logistics?: DeliveryLogistics;\n /**\n * Shipping costs.\n * @readonly\n */\n cost?: SelectedCarrierServiceOptionPrices;\n /**\n * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)\n * @readonly\n */\n requestedShippingOption?: boolean;\n /** Other charges */\n otherCharges?: SelectedCarrierServiceOptionOtherCharge[];\n /** This carrier's unique ID */\n carrierId?: string | null;\n }\n interface DeliveryLogistics {\n /** Expected delivery time, in free text. For example, \"3-5 business days\". */\n deliveryTime?: string | null;\n /** Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\". */\n instructions?: string | null;\n /** Pickup details. */\n pickupDetails?: PickupDetails;\n }\n interface PickupDetails {\n /** Pickup address. */\n address?: Address;\n /** Whether the pickup address is that of a business - this may effect tax calculation. */\n businessLocation?: boolean;\n /** Pickup method */\n pickupMethod?: PickupMethod;\n }\n /** Physical address */\n interface Address {\n /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address object, with number, name, and apartment number in separate fields. */\n streetAddress?: StreetAddress;\n /** Main address line (usually street name and number). */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains apt, suite, floor. */\n addressLine2?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n enum PickupMethod {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface SelectedCarrierServiceOptionPrices {\n /** Total shipping price, after discount and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails;\n /** Shipping discount before tax. */\n totalDiscount?: MultiCurrencyPrice;\n /** Shipping price before discount and before tax. */\n price?: MultiCurrencyPrice;\n }\n interface MultiCurrencyPrice {\n /** Amount. */\n amount?: string;\n /**\n * Converted amount.\n * @readonly\n */\n convertedAmount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n /**\n * Converted amount formatted with currency symbol.\n * @readonly\n */\n formattedConvertedAmount?: string;\n }\n interface ItemTaxFullDetails {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice;\n /** Tax rate %, as a decimal point between 0 and 1. */\n taxRate?: string;\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n totalTax?: MultiCurrencyPrice;\n /**\n * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`.\n * @readonly\n */\n rateBreakdown?: TaxRateBreakdown[];\n }\n interface TaxRateBreakdown {\n /** Type of tax against which the calculation was performed. */\n name?: string;\n /** Rate at which this tax detail was calculated. */\n rate?: string;\n /** Amount of tax for this tax detail. */\n tax?: MultiCurrencyPrice;\n }\n interface SelectedCarrierServiceOptionOtherCharge {\n /** Type of additional cost. */\n type?: ChargeType;\n /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */\n details?: string | null;\n /** Price of added charge. */\n cost?: SelectedCarrierServiceOptionPrices;\n }\n enum ChargeType {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface CarrierServiceOption {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption[];\n }\n interface ShippingOption {\n /**\n * Unique code of provided shipping option like \"usps_std_overnight\".\n * For legacy calculators this would be the UUID of the option.\n */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\n * For example, \"Standard\" or \"First-Class Package International\".\n */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics;\n /** Sipping price information. */\n cost?: ShippingPrice;\n }\n interface ShippingPrice {\n /** Shipping price. */\n price?: MultiCurrencyPrice;\n /** Other costs such as insurance, handling & packaging for fragile items, etc. */\n otherCharges?: OtherCharge[];\n }\n interface OtherCharge {\n /** Type of additional cost. */\n type?: ChargeType;\n /** Price of added cost. */\n price?: MultiCurrencyPrice;\n }\n interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {\n /** Discount type. */\n discountType?: DiscountType;\n /** IDs of line items the discount applies to. */\n lineItemIds?: string[];\n /** Coupon details. */\n coupon?: Coupon;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount;\n /** Discount rule */\n discountRule?: DiscountRule;\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf {\n /** Coupon details. */\n coupon?: Coupon;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount;\n /** Discount rule */\n discountRule?: DiscountRule;\n }\n enum DiscountType {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface Coupon {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon value. */\n amount?: MultiCurrencyPrice;\n /** Coupon name. */\n name?: string;\n }\n interface MerchantDiscount {\n /** Discount value. */\n amount?: MultiCurrencyPrice;\n }\n interface DiscountRule {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName;\n /** Discount value. */\n amount?: MultiCurrencyPrice;\n }\n interface DiscountRuleName {\n /** Original discount rule name (in site's default language). */\n original?: string;\n /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface CalculateAdditionalFeesResponse {\n /** Returned additional fees */\n additionalFees?: AdditionalFee[];\n /** Currency */\n currency?: string;\n }\n interface AdditionalFee {\n /** Additional fee's unique code (or ID) for future processing */\n code?: string | null;\n /** Translated additional fee's name */\n name?: string;\n /** Additional fee's price */\n price?: string;\n /** Tax details */\n taxDetails?: TaxDetails;\n }\n interface TaxDetails {\n /** Indication if additional fee is taxable or not */\n taxable?: boolean;\n }\n interface AdditionalFeesSPIConfig {\n }\n interface CalculateAdditionalFeesOptions {\n /** LineItems */\n lineItems?: LineItem[];\n /** Selected shipping option */\n shippingInfo?: ShippingInformation;\n /** Applied discounts */\n appliedDiscounts?: AppliedDiscount[];\n }\n export { AdditionalFee, AdditionalFeesProvider, AdditionalFeesSPIConfig, Address, AppliedDiscount, AppliedDiscountDiscountSourceOneOf, CalculateAdditionalFeesOptions, CalculateAdditionalFeesRequest, CalculateAdditionalFeesResponse, CarrierServiceOption, CatalogReference, ChargeType, Coupon, DeliveryLogistics, DiscountRule, DiscountRuleName, DiscountType, Group, ItemTaxFullDetails, LineItem, MerchantDiscount, MultiCurrencyPrice, OtherCharge, PaymentOptionType, PhysicalProperties, PickupDetails, PickupMethod, Scope, SelectedCarrierServiceOption, SelectedCarrierServiceOptionOtherCharge, SelectedCarrierServiceOptionPrices, ServiceProperties, ShippingInformation, ShippingOption, ShippingPrice, ShippingRegion, StreetAddress, SubscriptionFrequency, SubscriptionSettings, TaxDetails, TaxRateBreakdown };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/interfaces-ecommerce-v1-catalog-provider.d.ts", "content": "declare module \"interfaces-ecommerce-v1-catalog-provider\" {\n interface CatalogProvider {\n }\n interface GetCatalogItemsRequest {\n /** Catalog and items references and quantities. */\n catalogReferences?: CatalogReferenceAndQuantity[];\n /** Weight measurement unit. Defaults to site weight unit. */\n weightUnit?: WeightUnit;\n /** Currency code the items' prices will be presented in. For example, `\"USD\"` or `\"EUR\"`. Defaults to site currency. */\n currency?: string;\n /** Instance ID. Set only when calling HTTP providers. */\n instanceId?: string | null;\n }\n interface CatalogReferenceAndQuantity {\n /** Catalog and item reference info. */\n catalogReference?: CatalogReference;\n /** Item quantity. */\n quantity?: number;\n }\n /** Used for grouping line items and is sent on add to cart */\n interface CatalogReference {\n /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */\n catalogItemId?: string;\n /** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */\n appId?: string;\n /** Additional info in key:value form. For example, `{\"options\":{\"Size\": \"M\", \"Color\": \"Red\"}}` or `{\"variantId\": \"\"}`. */\n options?: Record | null;\n }\n enum WeightUnit {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface GetCatalogItemsResponse {\n /** Catalog info and item data. */\n catalogItems?: Item[];\n }\n interface Item {\n /** Catalog and item reference info. */\n catalogReference?: CatalogReference;\n /** Item data. */\n data?: ItemData;\n }\n interface ItemData {\n /**\n * *Required** - Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n */\n productName?: ProductName;\n /**\n * Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.\n * The URL is optional and if not provided, the site URL will be used.\n */\n url?: string;\n /** *Required** - Item type. Either a preset type or custom. */\n itemType?: ItemType;\n /** *Required** - Item price **after** catalog-defined discount. */\n price?: string;\n /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: string | null;\n /**\n * Optional - Line item description lines. Line item description lines. Used for displaying the cart, checkout and order.\n * For example, if you want `Size: Large` to appear under the item name, create a description line with `{\"name\": {\"original\": \"Size\"}}` and `{\"plainText\": {\"original\": \"Large\"}}`.\n */\n descriptionLines?: DescriptionLine[];\n /**\n * Optional - Line item image.\n * + Pass at least media ID, width, and height. You should be able to get these values when you upload an image to Wix media manager.\n * + Given a full image URL of https://static.wixstatic.com/media/5cc69183e7954e2c9760fa2383870992.jpg, `media.id` would be \"5cc69183e7954e2c9760fa2383870992.jpg\".\n * + We only support images coming from Wix media manager, if you want to use an image from another source you must first upload it to Wix media manager.\n * + We are working on removing `altText` as it is not being used by our systems.\n */\n media?: string;\n /**\n * Optional - Item quantity available for purchase. Only return this if inventory is managed.\n * Not returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart.\n */\n quantityAvailable?: number | null;\n /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */\n physicalProperties?: PhysicalProperties;\n /**\n * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType;\n /**\n * Optional - Service properties. When relevant, this contains information such as date and number of participants.\n * Used, among other things, when checking for valid memberships.\n */\n serviceProperties?: ServiceProperties;\n /**\n * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n * + in most cases, this field is the name as `catalogReference.catalogItemId`.\n * + Used in membership validation.\n */\n rootCatalogItemId?: string | null;\n /** Optional - Additional description for the price. For example, when passing `\"price\": \"0\"` but additional details about the actual price are needed - \"Starts at $67\". */\n priceDescription?: PriceDescription;\n /**\n * Optional - partial payment for the given item to be paid upfront during the checkout.\n * Eligible for catalog items with type `DEPOSIT_ONLINE`.\n * If omitted - item's price will not be split and is expected to be paid in single installment\n */\n depositAmount?: string | null;\n }\n interface ProductName {\n /** *Required** - Original item name (in site's default language). */\n original?: string;\n /** Optional - Translated item name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface ItemType extends ItemTypeItemTypeDataOneOf {\n /** Preset item type. */\n preset?: ItemTypeItemType;\n /** Custom item type. */\n custom?: string;\n }\n /** @oneof */\n interface ItemTypeItemTypeDataOneOf {\n /** Preset item type. */\n preset?: ItemTypeItemType;\n /** Custom item type. */\n custom?: string;\n }\n enum ItemTypeItemType {\n UNRECOGNISED = \"UNRECOGNISED\",\n PHYSICAL = \"PHYSICAL\",\n DIGITAL = \"DIGITAL\",\n GIFT_CARD = \"GIFT_CARD\",\n SERVICE = \"SERVICE\"\n }\n interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {\n /** Description line name. */\n name?: DescriptionLineName;\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf {\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf {\n }\n interface DescriptionLineName {\n /** Optional - Description line name in site's default language. */\n original?: string;\n /** Optional - Translated description line item according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface PlainTextValue {\n /** Optional - Description line plain text value in site's default language. */\n original?: string;\n /** Optional - Translated description line plain text value according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface Color {\n /** Optional - Description line color name in site's default language. */\n original?: string;\n /** Optional - Translated description line color name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n /** Optional - HEX or RGB color code for display. */\n code?: string | null;\n }\n enum DescriptionLineType {\n UNRECOGNISED = \"UNRECOGNISED\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n COLOR = \"COLOR\"\n }\n interface PhysicalProperties {\n /** Line item weight. Measurement unit (KG or LB) is taken from `order.weightUnit`. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n interface Scope {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events) */\n namespace?: string;\n /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */\n group?: Group;\n }\n interface Group {\n /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n name?: string;\n /** Item ID (when the coupon scope is limited to just one item). */\n entityId?: string | null;\n }\n interface SubscriptionOptionInfo {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings;\n /** Subscription option title. */\n title?: Title;\n /** Subscription option description. */\n description?: Description;\n }\n interface SubscriptionSettings {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency;\n /** Whether subscription is renewed automatically at the end of each period. */\n autoRenewal?: boolean;\n /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */\n billingCycles?: number | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface Title {\n /** Subscription option name. */\n original?: string;\n /** Translated subscription option name. */\n translated?: string | null;\n }\n interface Description {\n /** Subscription option description. */\n original?: string;\n /** Translated subscription option name. */\n translated?: string | null;\n }\n interface SecuredMedia {\n /** Media ID in media manager. */\n _id?: string;\n /** Original file name. */\n fileName?: string;\n /** File type. */\n fileType?: FileType;\n }\n enum FileType {\n UNSPECIFIED = \"UNSPECIFIED\",\n SECURE_PICTURE = \"SECURE_PICTURE\",\n SECURE_VIDEO = \"SECURE_VIDEO\",\n SECURE_DOCUMENT = \"SECURE_DOCUMENT\",\n SECURE_MUSIC = \"SECURE_MUSIC\",\n SECURE_ARCHIVE = \"SECURE_ARCHIVE\"\n }\n /** Type of selected payment option for catalog item */\n enum PaymentOptionType {\n /** The entire payment for given item will happen as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for given item will happen after the checkout. */\n FULL_PAYMENT_OFFLINE = \"FULL_PAYMENT_OFFLINE\",\n /** Given item cannot be paid via monetary payment options, only via membership. When this option is used, price will always be 0. */\n MEMBERSHIP = \"MEMBERSHIP\",\n /**\n * Partial payment for the given item to be paid upfront during the checkout.\n * Amount to be paid is defined by `deposit_amount` field on per-item basis.\n */\n DEPOSIT_ONLINE = \"DEPOSIT_ONLINE\"\n }\n interface ServiceProperties {\n /** Optional - The date and time for which the service is supposed to be provided. For example, the time of the class. */\n scheduledDate?: Date;\n /** Optional - The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */\n numberOfParticipants?: number | null;\n }\n interface PriceDescription {\n /** *Required** - Original price description (in site's default language). */\n original?: string;\n /** Optional - Translated product name according to buyer language. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface QueryCatalogItemsRequest {\n /** A list of itemIDs to filter by. If exists, the result will only include the items with the IDs passed. */\n catalogItemIds?: string[] | null;\n /** An item name to filter by. If exists, the result will only include items with name that starts with this string. */\n catalogItemName?: string | null;\n /** Paging options to limit and skip a number of items. */\n paging?: Paging;\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryCatalogItemsResponse {\n /** Catalog info and item data. */\n catalogItems?: BasicItem[];\n /** Paging metadata. */\n metadata?: PagingMetadata;\n }\n interface BasicItem {\n /** The ID of the the item. */\n _id?: string;\n /** The name of the item. */\n name?: string;\n /** Item Media items. */\n image?: string[];\n /** The current status of the inventory */\n inStock?: boolean;\n }\n interface NumericPropertyRange {\n /** Minimum value. */\n minValue?: number;\n /** Maximum value. */\n maxValue?: number;\n }\n interface PagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface CatalogSPIConfig {\n /** The enablement and UI configuration for discount of all items in the catalog */\n allItemsDiscount?: DiscountConfig;\n /** The enablement and UI configuration for discount of specific items in the catalog */\n specificItemsDiscount?: DiscountConfig;\n }\n /** Configuration for discount functionality on the catalog */\n interface DiscountConfig {\n /** Signifies if the discount is enabled in the service */\n enabled?: boolean;\n /** The translation key to get the text to display to the user */\n translationKey?: string;\n }\n /**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled(event: OrderCanceledEvent, context: Context) {\n * ...\n * }\n * ```\n */\n interface Context {\n /** A unique identifier for each request. Can be used for logging / troubleshooting */\n requestId?: string | null;\n /** 3 capital letters string representing a currency according to ISO-4217 */\n currency?: string | null;\n /** The identification type and identity data */\n identity?: IdentificationData;\n /** A string representing a language and region in the format of \"xx-XX\". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2 */\n languages?: string[];\n /** App instance ID of SPI in context */\n instanceId?: string | null;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** @readonly */\n identityType?: IdentityType;\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n interface GetCatalogItemsOptions {\n /** Catalog and items references and quantities. */\n catalogReferences?: CatalogReferenceAndQuantity[];\n /** Weight measurement unit. Defaults to site weight unit. */\n weightUnit?: WeightUnit;\n /** Currency code the items' prices will be presented in. For example, `\"USD\"` or `\"EUR\"`. Defaults to site currency. */\n currency?: string;\n /** Instance ID. Set only when calling HTTP providers. */\n instanceId?: string | null;\n }\n interface QueryCatalogItemsOptions {\n /** A list of itemIDs to filter by. If exists, the result will only include the items with the IDs passed. */\n catalogItemIds?: string[] | null;\n /** An item name to filter by. If exists, the result will only include items with name that starts with this string. */\n catalogItemName?: string | null;\n /** Paging options to limit and skip a number of items. */\n paging?: Paging;\n }\n export { BasicItem, CatalogProvider, CatalogReference, CatalogReferenceAndQuantity, CatalogSPIConfig, Color, Context, Description, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineValueOneOf, DiscountConfig, FileType, GetCatalogItemsOptions, GetCatalogItemsRequest, GetCatalogItemsResponse, Group, IdentificationData, IdentificationDataIdOneOf, IdentityType, Item, ItemData, ItemType, ItemTypeItemType, ItemTypeItemTypeDataOneOf, NumericPropertyRange, Paging, PagingMetadata, PaymentOptionType, PhysicalProperties, PlainTextValue, PriceDescription, ProductName, QueryCatalogItemsOptions, QueryCatalogItemsRequest, QueryCatalogItemsResponse, Scope, SecuredMedia, ServiceProperties, SubscriptionFrequency, SubscriptionOptionInfo, SubscriptionSettings, Title, WeightUnit };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/interfaces-ecom-v1-shipping-rates-provider.d.ts", "content": "declare module \"interfaces-ecom-v1-shipping-rates-provider\" {\n interface ShippingRatesProvider {\n }\n interface GetShippingRatesRequest {\n /** All items included to be sent */\n lineItems?: ProductItem[];\n /** Destination of the items */\n shippingDestination?: Address;\n /**\n * Where the items are sent from - this may be needed for some carriers.\n * For now it will simply be the business location of the store.\n */\n shippingOrigin?: Address;\n /** Contact details */\n buyerContactDetails?: FullAddressContactDetails;\n /** Measure unit */\n weightUnit?: WeightUnit;\n /** If tax should be added to price */\n taxIncludedInPrices?: boolean;\n }\n interface ProductItem {\n /** product's name */\n name?: string;\n /** The amount of items for that specific product */\n quantity?: number;\n /** Fully qualified identifier of the product */\n catalogReference?: CatalogReference;\n /** Physical properties of the product, e.g weight */\n physicalProperties?: PhysicalProperties;\n /** final price after all discounts (catalog discount + merchant discount + coupon discounts) what the user actually will pay */\n price?: string;\n /** price for all the quantity in the line item before coupons and before auto discounts. */\n totalPriceBeforeDiscount?: string | null;\n /** price for a single item before platform discounts (as above) */\n priceBeforeDiscount?: string | null;\n /** final price after discounts for the whole quantity of the line item */\n totalPrice?: string | null;\n }\n /** Used for grouping line items and is sent on add to cart */\n interface CatalogReference {\n /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */\n catalogItemId?: string;\n /** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */\n appId?: string;\n /** Additional info in key:value form. For example, `{\"options\":{\"Size\": \"M\", \"Color\": \"Red\"}}` or `{\"variantId\": \"\"}`. */\n options?: Record | null;\n }\n interface PhysicalProperties {\n /** Line item weight. Measurement unit (KG or LB) is taken from `order.weightUnit`. */\n weight?: number | null;\n /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */\n sku?: string | null;\n /** Whether this line item is shippable. */\n shippable?: boolean;\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** Street name and number. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf {\n /** Street name and number. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n enum SubdivisionType {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails {\n /** Contact first name */\n firstName?: string | null;\n /** Contact last name */\n lastName?: string | null;\n /** Contact phone number */\n phone?: string | null;\n /** Contact's company */\n company?: string | null;\n /** Email associated with the address */\n email?: string | null;\n /** tax info (Currently usable only in Brazil) */\n vatId?: VatId;\n }\n interface VatId {\n /** Customer's tax ID */\n _id?: string;\n /** tax type */\n type?: VatType;\n }\n /** tax info types */\n enum VatType {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n enum WeightUnit {\n /** Weight unit can't be classified, due to an error */\n UNSPECIFIED_WEIGHT_UNIT = \"UNSPECIFIED_WEIGHT_UNIT\",\n /** Kilograms */\n KG = \"KG\",\n /** Pounds */\n LB = \"LB\"\n }\n interface GetShippingRatesResponse {\n /** Shipping rates this carrier gives */\n shippingRates?: ShippingOption[];\n }\n interface ShippingOption {\n /**\n * Unique code of provided shipping option like \"usps_std_overnight\".\n * For legacy calculators this would be the UUID of the option.\n */\n code?: string;\n /**\n * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale)\n * e.g \"Standard\" or \"First-Class Package International\" (in legacy its called \"option title\")\n */\n title?: string;\n /** Logistics of how delivery will be */\n logistics?: DeliveryLogistics;\n /** Cost information for the rates option */\n cost?: ShippingPrice;\n }\n interface DeliveryLogistics {\n /** When the item is expected to be delivered in free text, e.g \"3-5 business days\" */\n deliveryTime?: string | null;\n /** Instructions for caller, e.g for pickup: \"Ensure to come during Opening Hours, and please don't park in disabled-spot\" */\n instructions?: string | null;\n /** Additional pickup details if it's a pickup */\n pickupDetails?: PickupDetails;\n }\n interface PickupDetails {\n /** Pickup address */\n address?: Address;\n /** Pickup method */\n pickupMethod?: PickupMethod;\n }\n enum PickupMethod {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface ShippingPrice {\n /** Amount charged for actual shipping rate */\n price?: string;\n /** Currency of the price - can differ from each Carrier, e.g US Carrier gives price in USD but London Carrier in EUR. */\n currency?: string;\n /** Additional costs such as insurance, handling & packaging for fragile items etc. */\n additionalCharges?: AdditionalCharge[];\n }\n interface AdditionalCharge {\n /** The reason for the additional cost */\n type?: ChargeType;\n /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment' */\n details?: string | null;\n /** Cost of the charge */\n price?: string;\n }\n enum ChargeType {\n HANDLING_FEE = \"HANDLING_FEE\"\n }\n interface MissingPostalCodeError {\n error?: ApplicationError;\n }\n interface ApplicationError {\n code?: string;\n description?: string;\n data?: Record | null;\n }\n interface InvalidPostalCodeError {\n error?: ApplicationError;\n }\n interface InvalidAddressError {\n fields?: FieldViolation[];\n }\n interface FieldViolation {\n field?: string;\n description?: string;\n violatedRule?: RuleType;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n enum RuleType {\n VALIDATION = \"VALIDATION\",\n OTHER = \"OTHER\",\n MAX = \"MAX\",\n MIN = \"MIN\",\n MAX_LENGTH = \"MAX_LENGTH\",\n MIN_LENGTH = \"MIN_LENGTH\",\n MAX_SIZE = \"MAX_SIZE\",\n MIN_SIZE = \"MIN_SIZE\",\n FORMAT = \"FORMAT\",\n DECIMAL_LTE = \"DECIMAL_LTE\",\n DECIMAL_GTE = \"DECIMAL_GTE\",\n DECIMAL_LT = \"DECIMAL_LT\",\n DECIMAL_GT = \"DECIMAL_GT\",\n DECIMAL_MAX_SCALE = \"DECIMAL_MAX_SCALE\",\n INVALID_ENUM_VALUE = \"INVALID_ENUM_VALUE\",\n REQUIRED_FIELD = \"REQUIRED_FIELD\"\n }\n interface GenericShippingRatesError {\n errors?: ApplicationError[];\n }\n interface ShippingRatesConfig {\n /** Short name */\n name?: string;\n /** Carrier description */\n description?: string | null;\n /** Carrier learn more url */\n learnMoreUrl?: string | null;\n /** Dashboard URL for Carrier */\n dashboardUrl?: string | null;\n /** Require site owner to define fallback rate. Turn it on if you do not provide rate as part of the integration */\n fallbackDefinitionMandatory?: boolean;\n }\n /**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled(event: OrderCanceledEvent, context: Context) {\n * ...\n * }\n * ```\n */\n interface Context {\n /** A unique identifier for each request. Can be used for logging / troubleshooting */\n requestId?: string | null;\n /** 3 capital letters string representing a currency according to ISO-4217 */\n currency?: string | null;\n /** The identification type and identity data */\n identity?: IdentificationData;\n /** A string representing a language and region in the format of \"xx-XX\". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2 */\n languages?: string[];\n /** App instance ID of SPI in context */\n instanceId?: string | null;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** @readonly */\n identityType?: IdentityType;\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n interface GetShippingRatesOptions {\n /** All items included to be sent */\n lineItems?: ProductItem[];\n /** Destination of the items */\n shippingDestination?: Address;\n /**\n * Where the items are sent from - this may be needed for some carriers.\n * For now it will simply be the business location of the store.\n */\n shippingOrigin?: Address;\n /** Contact details */\n buyerContactDetails?: FullAddressContactDetails;\n /** Measure unit */\n weightUnit?: WeightUnit;\n /** If tax should be added to price */\n taxIncludedInPrices?: boolean;\n }\n export { AdditionalCharge, Address, AddressLocation, AddressStreetOneOf, ApplicationError, CatalogReference, ChargeType, Context, DeliveryLogistics, FieldViolation, FullAddressContactDetails, GenericShippingRatesError, GetShippingRatesOptions, GetShippingRatesRequest, GetShippingRatesResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, InvalidAddressError, InvalidPostalCodeError, MissingPostalCodeError, PhysicalProperties, PickupDetails, PickupMethod, ProductItem, RuleType, ShippingOption, ShippingPrice, ShippingRatesConfig, ShippingRatesProvider, StreetAddress, Subdivision, SubdivisionType, VatId, VatType, WeightUnit };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-events.v2.d.ts", "content": "declare module \"wix-events.v2\" {\n /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */\n interface ScheduleItem$1 {\n /**\n * Schedule item ID.\n * @readonly\n */\n _id?: string;\n /** Whether a schedule item is hidden from guests. */\n hidden?: boolean;\n /** Schedule item name. */\n name?: string;\n /** Time slot of a schedule item. */\n timeSlot?: TimeInterval$1;\n /** Rich text schedule item description. */\n description?: string;\n /** Stage or room name in which the session takes place. */\n stageName?: string;\n /** Schedule item tags. They're used to organize the items to a theme. */\n tags?: string[];\n /**\n * Schedule item status. Possible values:\n * - `SCHEDULED`: An item is scheduled.\n * - `CANCELED`: An item is canceled.\n */\n status?: ScheduleStatus$1;\n /**\n * Date and time when the schedule item was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the schedule item was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Event ID to which the schedule belongs.\n * @readonly\n */\n eventId?: string;\n /**\n * Whether the schedule item is draft.\n * @readonly\n */\n draft?: boolean;\n }\n /** Time interval on the timeline between two points in time. */\n interface TimeInterval$1 {\n /** Start of the interval. Inclusive. */\n start?: Date;\n /** End of the interval. Non-inclusive. */\n end?: Date;\n /**\n * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`.\n * Default: `Etc/UTC`.\n */\n timeZoneId?: string | null;\n }\n enum ScheduleStatus$1 {\n /** Item is scheduled for a future date */\n SCHEDULED = \"SCHEDULED\",\n /** Item was canceled */\n CANCELED = \"CANCELED\"\n }\n interface ListScheduleItemsRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId?: string[];\n /**\n * Schedule item state filter. Possible values:\n * - `PUBLISHED`: The schedule item is published.\n * - `DRAFT`: The schedule item is in the draft. You need the \"WIX_EVENTS.MANAGE_AGENDA\" permissions to change this state.\n * - `VISIBLE`: The schedule item is visible to guests.\n * - `HIDDEN`: The schedule item is hidden from guests. You need the \"WIX_EVENTS.MANAGE_AGENDA\" permissions to change this state.\n * Default: Filters by the `PUBLISHED` and `VISIBLE` states.\n */\n state?: StateFilter$1[];\n /** Filters schedule items starting on or after specified point in time. Inclusive. */\n startingFrom?: Date;\n /** Filters schedule items starting before specified point in time. Non-inclusive. */\n startingBefore?: Date;\n /**\n * Deprecated, use `paging`.\n * Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n * @deprecated\n */\n offset?: number;\n /**\n * Deprecated, use `paging`.\n * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n * @deprecated\n */\n limit?: number;\n /**\n * Filter facets.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).\n */\n facet?: string[];\n /** Schedule item ID. */\n itemId?: string[];\n /** Schedule item tags. They're used to organize the items to a theme. */\n tag?: string[];\n /** Stage or room name in which the session takes place. */\n stageName?: string[];\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$7;\n }\n enum StateFilter$1 {\n /** Schedule item is published. */\n PUBLISHED = \"PUBLISHED\",\n /** Opposite of `PUBLISHED`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */\n DRAFT = \"DRAFT\",\n /** Schedule item is visible to the public. */\n VISIBLE = \"VISIBLE\",\n /** Opposite of `VISIBLE`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */\n HIDDEN = \"HIDDEN\"\n }\n interface Paging$7 {\n /** Number of items to load per page. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListScheduleItemsResponse$1 {\n /**\n * Deprecated, use `paging_metadata.total`.\n * Total schedule items matching the given filters.\n * @readonly\n * @deprecated\n */\n total?: number;\n /**\n * Deprecated.\n * Limit.\n * @deprecated\n */\n limit?: number;\n /**\n * Deprecated, use `paging_metadata.offset`.\n * Offset.\n * @deprecated\n */\n offset?: number;\n /** Schedule items. */\n items?: ScheduleItem$1[];\n /**\n * Facets.\n * @readonly\n */\n facets?: Record;\n /**\n * Whether there are draft changes which have not been published yet.\n * Returned only when filtering by single `event_id` with `WIX_EVENTS.MANAGE_AGENDA` permission.\n * @readonly\n */\n draftNotPublished?: boolean | null;\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2$7;\n }\n interface FacetCounts$7 {\n /** Facet counts aggregated per value. */\n counts?: Record;\n }\n interface PagingMetadataV2$7 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$7;\n }\n interface Cursors$7 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryScheduleItemsRequest$1 {\n query?: QueryV2$7;\n }\n interface QueryV2$7 extends QueryV2PagingMethodOneOf$7 {\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$7;\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */\n filter?: Record | null;\n /**\n * Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).\n */\n sort?: Sorting$7[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$7 {\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$7;\n }\n interface Sorting$7 {\n /** Name of the field to sort by */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\n order?: SortOrder$7;\n }\n enum SortOrder$7 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryScheduleItemsResponse$1 {\n pagingMetadata?: PagingMetadataV2$7;\n /** Schedule items. */\n items?: ScheduleItem$1[];\n }\n interface GetScheduleItemRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId?: string;\n /** Schedule item ID. */\n itemId: string;\n /** Whether to include draft schedules in the response. */\n includeDraft?: boolean;\n }\n interface GetScheduleItemResponse$1 {\n /** Schedule item. */\n item?: ScheduleItem$1;\n /** Draft of the Schedule item. */\n draft?: ScheduleItem$1;\n }\n interface AddScheduleItemRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item. */\n item?: ScheduleItemData$1;\n }\n /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */\n interface ScheduleItemData$1 {\n /** Whether a schedule item is hidden from guests. */\n hidden?: boolean;\n /** Schedule item name. */\n name?: string;\n /** Time slot of a schedule item. */\n timeSlot?: TimeInterval$1;\n /** Rich text schedule item description. */\n description?: string;\n /** Stage or room name in which the session takes place. */\n stageName?: string;\n /** Schedule item tags. They're used to organize the items to a theme. */\n tags?: string[];\n /**\n * Schedule item status. Possible values:\n * - `SCHEDULED`: An item is scheduled.\n * - `CANCELED`: An item is canceled.\n */\n status?: ScheduleStatus$1;\n }\n interface AddScheduleItemResponse$1 {\n /** Schedule item. */\n item?: ScheduleItem$1;\n }\n interface UpdateScheduleItemRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item ID. */\n itemId: string;\n /** Schedule item. */\n item?: ScheduleItemData$1;\n }\n interface UpdateScheduleItemResponse$1 {\n /** Schedule item. */\n item?: ScheduleItem$1;\n }\n interface DeleteScheduleItemRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule items to delete. */\n itemIds?: string[];\n }\n interface DeleteScheduleItemResponse$1 {\n }\n interface DiscardDraftRequest$2 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface DiscardDraftResponse$2 {\n }\n interface PublishDraftRequest$2 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface PublishDraftResponse$2 {\n }\n interface RescheduleDraftRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /**\n * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`.\n * Default: `Etc/UTC`.\n */\n timeZoneId: string;\n /** Offset added or subtracted from the start and end times of schedule items. */\n timeSlotOffset?: GoogleProtoDuration$1;\n }\n interface RescheduleDraftResponse$1 {\n }\n interface ListBookmarksRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface ListBookmarksResponse$1 {\n /** Schedule items. */\n items?: ScheduleItem$1[];\n }\n interface CreateBookmarkRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item ID. */\n itemId: string;\n }\n interface CreateBookmarkResponse$1 {\n }\n interface DeleteBookmarkRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item ID. */\n itemId: string;\n }\n interface DeleteBookmarkResponse$1 {\n }\n type GoogleProtoDuration$1 = any;\n /**\n * Retrieves a list of up to 100 schedule items\n * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_AGENDA\n * @applicableIdentity VISITOR\n */\n function listScheduleItems(options?: ListScheduleItemsOptions): Promise;\n interface ListScheduleItemsOptions {\n /** Event ID to which the schedule belongs. */\n eventId?: string[];\n /**\n * Schedule item state filter. Possible values:\n * - `PUBLISHED`: The schedule item is published.\n * - `DRAFT`: The schedule item is in the draft. You need the \"WIX_EVENTS.MANAGE_AGENDA\" permissions to change this state.\n * - `VISIBLE`: The schedule item is visible to guests.\n * - `HIDDEN`: The schedule item is hidden from guests. You need the \"WIX_EVENTS.MANAGE_AGENDA\" permissions to change this state.\n * Default: Filters by the `PUBLISHED` and `VISIBLE` states.\n */\n state?: StateFilter$1[];\n /** Filters schedule items starting on or after specified point in time. Inclusive. */\n startingFrom?: Date;\n /** Filters schedule items starting before specified point in time. Non-inclusive. */\n startingBefore?: Date;\n /**\n * Deprecated, use `paging`.\n * Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n * @deprecated\n */\n offset?: number;\n /**\n * Deprecated, use `paging`.\n * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n * @deprecated\n */\n limit?: number;\n /**\n * Filter facets.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).\n */\n facet?: string[];\n /** Schedule item ID. */\n itemId?: string[];\n /** Schedule item tags. They're used to organize the items to a theme. */\n tag?: string[];\n /** Stage or room name in which the session takes place. */\n stageName?: string[];\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$7;\n }\n /**\n * Creates a query to retrieve a list of schedule items.\n *\n * The `queryScheduleItems( )` function builds a query to retrieve a list of schedule items and returns a [`ItemsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder) object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder/find) function.\n *\n * You can refine the query by chaining `ItemsQueryBuilder` functions onto the query. `ItemsQueryBuilder` functions enable you to sort, filter, and control the results `queryScheduleItems( )` returns.\n *\n * `queryScheduleItems( )` runs with these `ItemsQueryBuilder` defaults, which you can override:\n *\n * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder/limit)\n * - [`descending(\"_createdDate\")`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder/descending)\n *\n * The functions that are chained to `queryScheduleItems( )` are applied in the order they're called. For example, if you apply `ascending('name')` and then `descending('stageName')`, the results are sorted first by the `name`, and then, if there are multiple results with the same `name`, the items are sorted by `stageName`.\n * @public\n * @permissionId WIX_EVENTS.READ_AGENDA\n * @applicableIdentity VISITOR\n */\n function queryScheduleItems(): ItemsQueryBuilder;\n interface QueryCursorResult$4 {\n cursors: Cursors$7;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ItemsQueryResult extends QueryCursorResult$4 {\n items: ScheduleItem$1[];\n query: ItemsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ItemsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"name\" | \"description\" | \"stageName\" | \"_createdDate\" | \"_updatedDate\" | \"eventId\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"name\" | \"description\" | \"stageName\" | \"_createdDate\" | \"_updatedDate\" | \"eventId\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"name\" | \"description\" | \"stageName\" | \"_createdDate\" | \"_updatedDate\" | \"eventId\">) => ItemsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"name\" | \"description\" | \"stageName\" | \"_createdDate\" | \"_updatedDate\" | \"eventId\">) => ItemsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => ItemsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => ItemsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Retrieves schedule item by ID.\n * @param itemId - Schedule item ID.\n * @public\n * @requiredField itemId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_AGENDA\n * @applicableIdentity VISITOR\n * @returns Schedule item.\n */\n function getScheduleItem(itemId: string, options?: GetScheduleItemOptions): Promise;\n interface GetScheduleItemOptions {\n /** Event ID to which the schedule belongs. */\n eventId?: string;\n /** Whether to include draft schedules in the response. */\n includeDraft?: boolean;\n }\n /**\n * Adds a schedule item to the draft schedule.\n * @public\n * @requiredField eventId\n * @requiredField options.item.name\n * @requiredField options.item.timeSlot\n * @requiredField options.item.timeSlot.end\n * @requiredField options.item.timeSlot.start\n * @param eventId - Event ID to which the schedule belongs.\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function addScheduleItem(eventId: string, options?: AddScheduleItemOptions): Promise;\n interface AddScheduleItemOptions {\n /** Schedule item. */\n item?: ScheduleItemData$1;\n }\n /**\n * Updates a schedule item in a draft schedule.\n * @param itemId - Schedule item ID.\n * @public\n * @requiredField eventId\n * @requiredField itemId\n * @param eventId - Event ID to which the schedule belongs.\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateScheduleItem(itemId: string, eventId: string, options?: UpdateScheduleItemOptions): Promise;\n interface UpdateScheduleItemOptions {\n /** Schedule item. */\n item?: ScheduleItemData$1;\n }\n /**\n * Deletes schedule items from the draft schedule.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the schedule belongs.\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteScheduleItem(eventId: string, options?: DeleteScheduleItemOptions): Promise;\n interface DeleteScheduleItemOptions {\n /** Schedule items to delete. */\n itemIds?: string[];\n }\n /**\n * Clears all changes to the draft schedule.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the schedule belongs.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function discardDraft$1(eventId: string): Promise;\n /**\n * Publishes the draft schedule.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the schedule belongs.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function publishDraft$1(eventId: string): Promise;\n /**\n * Adjusts the time of all draft schedule items at once per event.\n * @public\n * @requiredField eventId\n * @requiredField options.timeZoneId\n * @param eventId - Event ID to which the schedule belongs.\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function rescheduleDraft(eventId: string, options?: RescheduleDraftOptions): Promise;\n interface RescheduleDraftOptions {\n /**\n * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`.\n * Default: `Etc/UTC`.\n */\n timeZoneId: string;\n /** Offset added or subtracted from the start and end times of schedule items. */\n timeSlotOffset?: GoogleProtoDuration$1;\n }\n const eventsScheduleV1ScheduleItemSchedule_universal_d_listScheduleItems: typeof listScheduleItems;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsOptions = ListScheduleItemsOptions;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_queryScheduleItems: typeof queryScheduleItems;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ItemsQueryResult = ItemsQueryResult;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ItemsQueryBuilder = ItemsQueryBuilder;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_getScheduleItem: typeof getScheduleItem;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemOptions = GetScheduleItemOptions;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_addScheduleItem: typeof addScheduleItem;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemOptions = AddScheduleItemOptions;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_updateScheduleItem: typeof updateScheduleItem;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemOptions = UpdateScheduleItemOptions;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_deleteScheduleItem: typeof deleteScheduleItem;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemOptions = DeleteScheduleItemOptions;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_rescheduleDraft: typeof rescheduleDraft;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftOptions = RescheduleDraftOptions;\n namespace eventsScheduleV1ScheduleItemSchedule_universal_d {\n export { ScheduleItem$1 as ScheduleItem, TimeInterval$1 as TimeInterval, ScheduleStatus$1 as ScheduleStatus, ListScheduleItemsRequest$1 as ListScheduleItemsRequest, StateFilter$1 as StateFilter, Paging$7 as Paging, ListScheduleItemsResponse$1 as ListScheduleItemsResponse, FacetCounts$7 as FacetCounts, PagingMetadataV2$7 as PagingMetadataV2, Cursors$7 as Cursors, QueryScheduleItemsRequest$1 as QueryScheduleItemsRequest, QueryV2$7 as QueryV2, QueryV2PagingMethodOneOf$7 as QueryV2PagingMethodOneOf, Sorting$7 as Sorting, SortOrder$7 as SortOrder, QueryScheduleItemsResponse$1 as QueryScheduleItemsResponse, GetScheduleItemRequest$1 as GetScheduleItemRequest, GetScheduleItemResponse$1 as GetScheduleItemResponse, AddScheduleItemRequest$1 as AddScheduleItemRequest, ScheduleItemData$1 as ScheduleItemData, AddScheduleItemResponse$1 as AddScheduleItemResponse, UpdateScheduleItemRequest$1 as UpdateScheduleItemRequest, UpdateScheduleItemResponse$1 as UpdateScheduleItemResponse, DeleteScheduleItemRequest$1 as DeleteScheduleItemRequest, DeleteScheduleItemResponse$1 as DeleteScheduleItemResponse, DiscardDraftRequest$2 as DiscardDraftRequest, DiscardDraftResponse$2 as DiscardDraftResponse, PublishDraftRequest$2 as PublishDraftRequest, PublishDraftResponse$2 as PublishDraftResponse, RescheduleDraftRequest$1 as RescheduleDraftRequest, RescheduleDraftResponse$1 as RescheduleDraftResponse, ListBookmarksRequest$1 as ListBookmarksRequest, ListBookmarksResponse$1 as ListBookmarksResponse, CreateBookmarkRequest$1 as CreateBookmarkRequest, CreateBookmarkResponse$1 as CreateBookmarkResponse, DeleteBookmarkRequest$1 as DeleteBookmarkRequest, DeleteBookmarkResponse$1 as DeleteBookmarkResponse, eventsScheduleV1ScheduleItemSchedule_universal_d_listScheduleItems as listScheduleItems, eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsOptions as ListScheduleItemsOptions, eventsScheduleV1ScheduleItemSchedule_universal_d_queryScheduleItems as queryScheduleItems, eventsScheduleV1ScheduleItemSchedule_universal_d_ItemsQueryResult as ItemsQueryResult, eventsScheduleV1ScheduleItemSchedule_universal_d_ItemsQueryBuilder as ItemsQueryBuilder, eventsScheduleV1ScheduleItemSchedule_universal_d_getScheduleItem as getScheduleItem, eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemOptions as GetScheduleItemOptions, eventsScheduleV1ScheduleItemSchedule_universal_d_addScheduleItem as addScheduleItem, eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemOptions as AddScheduleItemOptions, eventsScheduleV1ScheduleItemSchedule_universal_d_updateScheduleItem as updateScheduleItem, eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemOptions as UpdateScheduleItemOptions, eventsScheduleV1ScheduleItemSchedule_universal_d_deleteScheduleItem as deleteScheduleItem, eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemOptions as DeleteScheduleItemOptions, discardDraft$1 as discardDraft, publishDraft$1 as publishDraft, eventsScheduleV1ScheduleItemSchedule_universal_d_rescheduleDraft as rescheduleDraft, eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftOptions as RescheduleDraftOptions, };\n }\n interface Category$3 {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category name. */\n name?: string;\n /**\n * Date and time when category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$3;\n /**\n * Category state. Possible values:\n * - `MANUAL`: Category is created manually by the user.\n * - `AUTO`: Category is created automatically.\n * - `RECURRING_EVENT`: Category is created automatically when publishing recurring events.\n * - `HIDDEN`: Category can't be seen.\n *\n * Default: `MANUAL`.\n *\n * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use states other than `MANUAL`.\n */\n states?: State$6[];\n }\n interface CategoryCounts$3 {\n /** Total number of published events assigned to the category. Deleted events are excluded. */\n assignedEventsCount?: number | null;\n /** Total number of draft events assigned to the category. */\n assignedDraftEventsCount?: number | null;\n }\n enum State$6 {\n /** Created manually by the user. */\n MANUAL = \"MANUAL\",\n /** Created automatically. */\n AUTO = \"AUTO\",\n /** Created when publishing recurring events. */\n RECURRING_EVENT = \"RECURRING_EVENT\",\n /** Category is hidden. */\n HIDDEN = \"HIDDEN\",\n /** Category is used to store component events. */\n COMPONENT = \"COMPONENT\"\n }\n interface CreateCategoryRequest {\n /** Category to create. */\n category: Category$3;\n }\n interface CreateCategoryResponse {\n /** Created category. */\n category?: Category$3;\n }\n interface BulkCreateCategoryRequest {\n /** Categories to create. */\n categories: Category$3[];\n }\n interface BulkCreateCategoryResponse {\n /** Bulk create results. */\n results?: BulkCategoryResult[];\n /** Metadata of results. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCategoryResult {\n /** Metadata. */\n itemMetadata?: ItemMetadata;\n /** Created categories. */\n item?: Category$3;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details due to exceeding the threshold for detailed failures. */\n undetailedFailures?: number;\n }\n interface UpdateCategoryRequest {\n /** Category to update. */\n category: Category$3;\n }\n interface UpdateCategoryResponse {\n /** Updated category. */\n category?: Category$3;\n }\n interface DeleteCategoryRequest {\n /** ID of category to be deleted. */\n categoryId: string;\n }\n interface DeleteCategoryResponse {\n }\n interface QueryCategoriesRequest {\n /** Options to use when querying categories. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query: QueryV2$6;\n /**\n * Predefined sets of fields to return.\n * - `COUNTS`: Returns `assignedEventsCount`.\n */\n fieldset?: CategoryFieldset[];\n }\n interface QueryV2$6 extends QueryV2PagingMethodOneOf$6 {\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$6;\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */\n filter?: Record | null;\n /**\n * Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).\n */\n sort?: Sorting$6[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$6 {\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$6;\n }\n interface Sorting$6 {\n /** Name of the field to sort by */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\n order?: SortOrder$6;\n }\n enum SortOrder$6 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$6 {\n /** Number of items to load per page. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n enum CategoryFieldset {\n /** Include `assignedEventsCount` in the response. */\n COUNTS = \"COUNTS\"\n }\n interface QueryCategoriesResponse {\n /** List of categories. */\n categories?: Category$3[];\n /** Metadata for the paginated results. */\n metaData?: PagingMetadataV2$6;\n }\n interface PagingMetadataV2$6 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$6;\n }\n interface Cursors$6 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface AssignEventsRequest {\n /** ID of category to which events should be assigned. */\n categoryId: string;\n /** A list of events IDs. */\n eventId: string[];\n }\n interface AssignEventsResponse {\n }\n interface BulkAssignEventsRequest {\n /** A list of category IDs to which events should be assigned. */\n categoryId: string[];\n /** A list of events IDs. */\n eventId: string[];\n }\n interface BulkAssignEventsResponse {\n /** Bulk assign results. */\n results?: BulkCategoryResult[];\n /** Metadata of results. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkAssignEventsAsyncRequest {\n /** Category IDs. */\n categoryId: string[];\n /**\n * Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:\n * - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n * - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n */\n filter: Record | null;\n }\n interface BulkAssignEventsAsyncResponse {\n }\n interface UnassignEventsRequest {\n /** Category ID. */\n categoryId: string;\n /** A list of events IDs. */\n eventId: string[];\n }\n interface UnassignEventsResponse {\n }\n interface BulkUnassignEventsRequest {\n /** A list of category IDs. */\n categoryId: string[];\n /** A list of events IDs. */\n eventId?: string[];\n }\n interface BulkUnassignEventsResponse {\n /** Results. */\n results?: BulkCategoryResult[];\n /** Metadata of results. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkUnassignEventsAsyncRequest {\n /** Category ID. */\n categoryId: string[];\n /**\n * Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:\n * - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n * - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n */\n filter: Record | null;\n }\n interface BulkUnassignEventsAsyncResponse {\n }\n interface ListEventCategoriesRequest {\n /** Event ID. */\n eventId: string;\n }\n interface ListEventCategoriesResponse {\n /** A list of categories. */\n categories?: Category$3[];\n }\n interface ReorderCategoryEventsRequest extends ReorderCategoryEventsRequestReferenceEventOneOf {\n /** Move the event before defined `eventId`. */\n beforeEventId?: string;\n /** Move the event after defined `eventId`. */\n afterEventId?: string;\n /** Category ID. */\n categoryId: string;\n /** Event ID. */\n eventId?: string;\n }\n /** @oneof */\n interface ReorderCategoryEventsRequestReferenceEventOneOf {\n /** Move the event before defined `eventId`. */\n beforeEventId?: string;\n /** Move the event after defined `eventId`. */\n afterEventId?: string;\n }\n interface ReorderCategoryEventsResponse {\n }\n interface DomainEvent$5 extends DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n }\n interface EntityCreatedEvent$5 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n }\n interface RestoreInfo$2 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$5 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$5 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$9 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$9;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$9 extends IdentificationDataIdOneOf$9 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$9;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$9 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$9 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a category.\n * @public\n * @requiredField category\n * @param category - Category to create.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created category.\n */\n function createCategory(category: Category$3): Promise;\n /**\n * Creates multipe categories at once.\n * @param categories - Categories to create.\n * @public\n * @requiredField categories\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateCategory(categories: Category$3[]): Promise;\n /**\n * Updates an existing category.\n * @param _id - Category ID.\n * @public\n * @requiredField _id\n * @requiredField category\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated category.\n */\n function updateCategory(_id: string, category: UpdateCategory): Promise;\n interface UpdateCategory {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category name. */\n name?: string;\n /**\n * Date and time when category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$3;\n /**\n * Category state. Possible values:\n * - `MANUAL`: Category is created manually by the user.\n * - `AUTO`: Category is created automatically.\n * - `RECURRING_EVENT`: Category is created automatically when publishing recurring events.\n * - `HIDDEN`: Category can't be seen.\n *\n * Default: `MANUAL`.\n *\n * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use states other than `MANUAL`.\n */\n states?: State$6[];\n }\n /**\n * Deletes a category.\n * @param categoryId - ID of category to be deleted.\n * @public\n * @requiredField categoryId\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteCategory(categoryId: string): Promise;\n /**\n * Creates a query to retrieve a list of categories.\n *\n *\n * The `queryCategories()` function builds a query to retrieve a list of categories and returns a [`CategoriesQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder) object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/find) function.\n *\n * You can refine the query by chaining `CategoriesQueryBuilder` functions onto the query. `CategoriesQueryBuilder` functions enable you to sort, filter, and control the results `queryCategories()` returns.\n *\n * `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override:\n *\n * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/limit)\n * @public\n * @param options - Options to use when querying categories.\n * @permissionId WIX_EVENTS.READ_CATEGORIES\n * @applicableIdentity VISITOR\n */\n function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;\n interface QueryCategoriesOptions {\n /**\n * Predefined sets of fields to return.\n * - `COUNTS`: Returns `assignedEventsCount`.\n */\n fieldset?: CategoryFieldset[] | undefined;\n }\n interface QueryOffsetResult$1 {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CategoriesQueryResult extends QueryOffsetResult$1 {\n items: Category$3[];\n query: CategoriesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CategoriesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"name\", value: any) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_createdDate\">) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_createdDate\">) => CategoriesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => CategoriesQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => CategoriesQueryBuilder;\n find: () => Promise;\n }\n /**\n * Assigns events to a single category.\n * @param categoryId - ID of category to which events should be assigned.\n * @param eventId - A list of events IDs.\n * @public\n * @requiredField categoryId\n * @requiredField eventId\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function assignEvents(categoryId: string, eventId: string[]): Promise;\n /**\n * Assigns events to multiple categories at once.\n * @param categoryId - A list of category IDs to which events should be assigned.\n * @public\n * @requiredField categoryId\n * @requiredField options\n * @requiredField options.eventId\n * @param options - Options to use when assigning events to multiple categories.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkAssignEvents(categoryId: string[], options: BulkAssignEventsOptions): Promise;\n interface BulkAssignEventsOptions {\n /** A list of events IDs. */\n eventId: string[];\n }\n /**\n * Assigns events that match given filter criteria to multiple categories.\n *\n * Unlike the [`bulkAssignEvents()`](https://www.wix.com/velo/reference/wix-events-v2/categories/bulkassignevents) function, this function can handle numerous requests and is less prone to failures.\n *\n * However, the events will not be instantly assigned to the categories (as with `bulkAssignEvents()`), but rather after some time. In this case, if try to [`listEventCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/listeventcategories) or [`queryCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/querycategories), you might not get the correct response.\n * @param categoryId - Category IDs.\n * @public\n * @requiredField categoryId\n * @requiredField options\n * @requiredField options.filter\n * @param options - Options to use when assigning events to multiple categories.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkAssignEventsAsync(categoryId: string[], options: BulkAssignEventsAsyncOptions): Promise;\n interface BulkAssignEventsAsyncOptions {\n /**\n * Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:\n * - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n * - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n */\n filter: Record | null;\n }\n /**\n * Unassigns events from a category.\n * @param categoryId - Category ID.\n * @param eventId - A list of events IDs.\n * @public\n * @requiredField categoryId\n * @requiredField eventId\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function unassignEvents(categoryId: string, eventId: string[]): Promise;\n /**\n * Unassigns events from multiple categories at once.\n * @param categoryId - A list of category IDs.\n * @public\n * @requiredField categoryId\n * @param options - Options to use when removing events from multiple categories.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUnassignEvents(categoryId: string[], options?: BulkUnassignEventsOptions): Promise;\n interface BulkUnassignEventsOptions {\n /** A list of events IDs. */\n eventId?: string[];\n }\n /**\n * Removes events that match given filter criteria from multiple categories.\n *\n * Unlike the [`bulkUnassignEvents()`](https://www.wix.com/velo/reference/wix-events-v2/categories/bulkunassignevents) function, this function can handle numerous requests and is less prone to failures.\n *\n * However, the events will not be instantly removed from the categories (as with `bulkUnassignEvents()`), but rather after some time. In this case, if try to [`listEventCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/listeventcategories) or [`queryCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/querycategories), you might not get the correct response.\n * @param categoryId - Category ID.\n * @public\n * @requiredField categoryId\n * @requiredField options\n * @requiredField options.filter\n * @param options - Options to use when removing events from multiple categories.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUnassignEventsAsync(categoryId: string[], options: BulkUnassignEventsAsyncOptions): Promise;\n interface BulkUnassignEventsAsyncOptions {\n /**\n * Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:\n * - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n * - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)\n */\n filter: Record | null;\n }\n /**\n * Retrieves a list of categories that are not in the `HIDDEN` state.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @permissionId WIX_EVENTS.READ_CATEGORIES\n * @applicableIdentity VISITOR\n */\n function listEventCategories(eventId: string): Promise;\n /**\n * Change the order of events that are assigned to the same category on the Events Widget.\n *\n *\n * For more information see [this article](https://support.wix.com/en/article/creating-and-displaying-event-categories)\n * @param categoryId - Category ID.\n * @public\n * @requiredField categoryId\n * @param options - Options to use when reordering events.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function reorderCategoryEvents(categoryId: string, options?: ReorderCategoryEventsOptions): Promise;\n interface ReorderCategoryEventsOptions extends ReorderCategoryEventsRequestReferenceEventOneOf {\n /** Event ID. */\n eventId?: string;\n /** Move the event before defined `eventId`. */\n beforeEventId?: string;\n /** Move the event after defined `eventId`. */\n afterEventId?: string;\n }\n type eventsV1CategoryCategories_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type eventsV1CategoryCategories_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type eventsV1CategoryCategories_universal_d_BulkCreateCategoryRequest = BulkCreateCategoryRequest;\n type eventsV1CategoryCategories_universal_d_BulkCreateCategoryResponse = BulkCreateCategoryResponse;\n type eventsV1CategoryCategories_universal_d_BulkCategoryResult = BulkCategoryResult;\n type eventsV1CategoryCategories_universal_d_ItemMetadata = ItemMetadata;\n type eventsV1CategoryCategories_universal_d_ApplicationError = ApplicationError;\n type eventsV1CategoryCategories_universal_d_BulkActionMetadata = BulkActionMetadata;\n type eventsV1CategoryCategories_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type eventsV1CategoryCategories_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type eventsV1CategoryCategories_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type eventsV1CategoryCategories_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type eventsV1CategoryCategories_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type eventsV1CategoryCategories_universal_d_CategoryFieldset = CategoryFieldset;\n const eventsV1CategoryCategories_universal_d_CategoryFieldset: typeof CategoryFieldset;\n type eventsV1CategoryCategories_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type eventsV1CategoryCategories_universal_d_AssignEventsRequest = AssignEventsRequest;\n type eventsV1CategoryCategories_universal_d_AssignEventsResponse = AssignEventsResponse;\n type eventsV1CategoryCategories_universal_d_BulkAssignEventsRequest = BulkAssignEventsRequest;\n type eventsV1CategoryCategories_universal_d_BulkAssignEventsResponse = BulkAssignEventsResponse;\n type eventsV1CategoryCategories_universal_d_BulkAssignEventsAsyncRequest = BulkAssignEventsAsyncRequest;\n type eventsV1CategoryCategories_universal_d_BulkAssignEventsAsyncResponse = BulkAssignEventsAsyncResponse;\n type eventsV1CategoryCategories_universal_d_UnassignEventsRequest = UnassignEventsRequest;\n type eventsV1CategoryCategories_universal_d_UnassignEventsResponse = UnassignEventsResponse;\n type eventsV1CategoryCategories_universal_d_BulkUnassignEventsRequest = BulkUnassignEventsRequest;\n type eventsV1CategoryCategories_universal_d_BulkUnassignEventsResponse = BulkUnassignEventsResponse;\n type eventsV1CategoryCategories_universal_d_BulkUnassignEventsAsyncRequest = BulkUnassignEventsAsyncRequest;\n type eventsV1CategoryCategories_universal_d_BulkUnassignEventsAsyncResponse = BulkUnassignEventsAsyncResponse;\n type eventsV1CategoryCategories_universal_d_ListEventCategoriesRequest = ListEventCategoriesRequest;\n type eventsV1CategoryCategories_universal_d_ListEventCategoriesResponse = ListEventCategoriesResponse;\n type eventsV1CategoryCategories_universal_d_ReorderCategoryEventsRequest = ReorderCategoryEventsRequest;\n type eventsV1CategoryCategories_universal_d_ReorderCategoryEventsRequestReferenceEventOneOf = ReorderCategoryEventsRequestReferenceEventOneOf;\n type eventsV1CategoryCategories_universal_d_ReorderCategoryEventsResponse = ReorderCategoryEventsResponse;\n const eventsV1CategoryCategories_universal_d_createCategory: typeof createCategory;\n const eventsV1CategoryCategories_universal_d_bulkCreateCategory: typeof bulkCreateCategory;\n const eventsV1CategoryCategories_universal_d_updateCategory: typeof updateCategory;\n type eventsV1CategoryCategories_universal_d_UpdateCategory = UpdateCategory;\n const eventsV1CategoryCategories_universal_d_deleteCategory: typeof deleteCategory;\n const eventsV1CategoryCategories_universal_d_queryCategories: typeof queryCategories;\n type eventsV1CategoryCategories_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n type eventsV1CategoryCategories_universal_d_CategoriesQueryResult = CategoriesQueryResult;\n type eventsV1CategoryCategories_universal_d_CategoriesQueryBuilder = CategoriesQueryBuilder;\n const eventsV1CategoryCategories_universal_d_assignEvents: typeof assignEvents;\n const eventsV1CategoryCategories_universal_d_bulkAssignEvents: typeof bulkAssignEvents;\n type eventsV1CategoryCategories_universal_d_BulkAssignEventsOptions = BulkAssignEventsOptions;\n const eventsV1CategoryCategories_universal_d_bulkAssignEventsAsync: typeof bulkAssignEventsAsync;\n type eventsV1CategoryCategories_universal_d_BulkAssignEventsAsyncOptions = BulkAssignEventsAsyncOptions;\n const eventsV1CategoryCategories_universal_d_unassignEvents: typeof unassignEvents;\n const eventsV1CategoryCategories_universal_d_bulkUnassignEvents: typeof bulkUnassignEvents;\n type eventsV1CategoryCategories_universal_d_BulkUnassignEventsOptions = BulkUnassignEventsOptions;\n const eventsV1CategoryCategories_universal_d_bulkUnassignEventsAsync: typeof bulkUnassignEventsAsync;\n type eventsV1CategoryCategories_universal_d_BulkUnassignEventsAsyncOptions = BulkUnassignEventsAsyncOptions;\n const eventsV1CategoryCategories_universal_d_listEventCategories: typeof listEventCategories;\n const eventsV1CategoryCategories_universal_d_reorderCategoryEvents: typeof reorderCategoryEvents;\n type eventsV1CategoryCategories_universal_d_ReorderCategoryEventsOptions = ReorderCategoryEventsOptions;\n namespace eventsV1CategoryCategories_universal_d {\n export { Category$3 as Category, CategoryCounts$3 as CategoryCounts, State$6 as State, eventsV1CategoryCategories_universal_d_CreateCategoryRequest as CreateCategoryRequest, eventsV1CategoryCategories_universal_d_CreateCategoryResponse as CreateCategoryResponse, eventsV1CategoryCategories_universal_d_BulkCreateCategoryRequest as BulkCreateCategoryRequest, eventsV1CategoryCategories_universal_d_BulkCreateCategoryResponse as BulkCreateCategoryResponse, eventsV1CategoryCategories_universal_d_BulkCategoryResult as BulkCategoryResult, eventsV1CategoryCategories_universal_d_ItemMetadata as ItemMetadata, eventsV1CategoryCategories_universal_d_ApplicationError as ApplicationError, eventsV1CategoryCategories_universal_d_BulkActionMetadata as BulkActionMetadata, eventsV1CategoryCategories_universal_d_UpdateCategoryRequest as UpdateCategoryRequest, eventsV1CategoryCategories_universal_d_UpdateCategoryResponse as UpdateCategoryResponse, eventsV1CategoryCategories_universal_d_DeleteCategoryRequest as DeleteCategoryRequest, eventsV1CategoryCategories_universal_d_DeleteCategoryResponse as DeleteCategoryResponse, eventsV1CategoryCategories_universal_d_QueryCategoriesRequest as QueryCategoriesRequest, QueryV2$6 as QueryV2, QueryV2PagingMethodOneOf$6 as QueryV2PagingMethodOneOf, Sorting$6 as Sorting, SortOrder$6 as SortOrder, Paging$6 as Paging, eventsV1CategoryCategories_universal_d_CategoryFieldset as CategoryFieldset, eventsV1CategoryCategories_universal_d_QueryCategoriesResponse as QueryCategoriesResponse, PagingMetadataV2$6 as PagingMetadataV2, Cursors$6 as Cursors, eventsV1CategoryCategories_universal_d_AssignEventsRequest as AssignEventsRequest, eventsV1CategoryCategories_universal_d_AssignEventsResponse as AssignEventsResponse, eventsV1CategoryCategories_universal_d_BulkAssignEventsRequest as BulkAssignEventsRequest, eventsV1CategoryCategories_universal_d_BulkAssignEventsResponse as BulkAssignEventsResponse, eventsV1CategoryCategories_universal_d_BulkAssignEventsAsyncRequest as BulkAssignEventsAsyncRequest, eventsV1CategoryCategories_universal_d_BulkAssignEventsAsyncResponse as BulkAssignEventsAsyncResponse, eventsV1CategoryCategories_universal_d_UnassignEventsRequest as UnassignEventsRequest, eventsV1CategoryCategories_universal_d_UnassignEventsResponse as UnassignEventsResponse, eventsV1CategoryCategories_universal_d_BulkUnassignEventsRequest as BulkUnassignEventsRequest, eventsV1CategoryCategories_universal_d_BulkUnassignEventsResponse as BulkUnassignEventsResponse, eventsV1CategoryCategories_universal_d_BulkUnassignEventsAsyncRequest as BulkUnassignEventsAsyncRequest, eventsV1CategoryCategories_universal_d_BulkUnassignEventsAsyncResponse as BulkUnassignEventsAsyncResponse, eventsV1CategoryCategories_universal_d_ListEventCategoriesRequest as ListEventCategoriesRequest, eventsV1CategoryCategories_universal_d_ListEventCategoriesResponse as ListEventCategoriesResponse, eventsV1CategoryCategories_universal_d_ReorderCategoryEventsRequest as ReorderCategoryEventsRequest, eventsV1CategoryCategories_universal_d_ReorderCategoryEventsRequestReferenceEventOneOf as ReorderCategoryEventsRequestReferenceEventOneOf, eventsV1CategoryCategories_universal_d_ReorderCategoryEventsResponse as ReorderCategoryEventsResponse, DomainEvent$5 as DomainEvent, DomainEventBodyOneOf$5 as DomainEventBodyOneOf, EntityCreatedEvent$5 as EntityCreatedEvent, RestoreInfo$2 as RestoreInfo, EntityUpdatedEvent$5 as EntityUpdatedEvent, EntityDeletedEvent$5 as EntityDeletedEvent, ActionEvent$5 as ActionEvent, MessageEnvelope$9 as MessageEnvelope, IdentificationData$9 as IdentificationData, IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, WebhookIdentityType$9 as WebhookIdentityType, eventsV1CategoryCategories_universal_d_createCategory as createCategory, eventsV1CategoryCategories_universal_d_bulkCreateCategory as bulkCreateCategory, eventsV1CategoryCategories_universal_d_updateCategory as updateCategory, eventsV1CategoryCategories_universal_d_UpdateCategory as UpdateCategory, eventsV1CategoryCategories_universal_d_deleteCategory as deleteCategory, eventsV1CategoryCategories_universal_d_queryCategories as queryCategories, eventsV1CategoryCategories_universal_d_QueryCategoriesOptions as QueryCategoriesOptions, eventsV1CategoryCategories_universal_d_CategoriesQueryResult as CategoriesQueryResult, eventsV1CategoryCategories_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder, eventsV1CategoryCategories_universal_d_assignEvents as assignEvents, eventsV1CategoryCategories_universal_d_bulkAssignEvents as bulkAssignEvents, eventsV1CategoryCategories_universal_d_BulkAssignEventsOptions as BulkAssignEventsOptions, eventsV1CategoryCategories_universal_d_bulkAssignEventsAsync as bulkAssignEventsAsync, eventsV1CategoryCategories_universal_d_BulkAssignEventsAsyncOptions as BulkAssignEventsAsyncOptions, eventsV1CategoryCategories_universal_d_unassignEvents as unassignEvents, eventsV1CategoryCategories_universal_d_bulkUnassignEvents as bulkUnassignEvents, eventsV1CategoryCategories_universal_d_BulkUnassignEventsOptions as BulkUnassignEventsOptions, eventsV1CategoryCategories_universal_d_bulkUnassignEventsAsync as bulkUnassignEventsAsync, eventsV1CategoryCategories_universal_d_BulkUnassignEventsAsyncOptions as BulkUnassignEventsAsyncOptions, eventsV1CategoryCategories_universal_d_listEventCategories as listEventCategories, eventsV1CategoryCategories_universal_d_reorderCategoryEvents as reorderCategoryEvents, eventsV1CategoryCategories_universal_d_ReorderCategoryEventsOptions as ReorderCategoryEventsOptions, };\n }\n interface TicketingTicket$1 {\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber?: string;\n /** Associated order number. */\n orderNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket name. */\n name?: string;\n /** Ticket price. */\n price?: Money$6;\n /**\n * Whether ticket requires payment.\n * @readonly\n */\n free?: boolean;\n /** Ticket and event policies. */\n policy?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$3;\n /**\n * Associated order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is declined.\n */\n orderStatus?: OrderStatus$2;\n /** Whether order and ticket are visible in order list. */\n orderArchived?: boolean;\n /** Buyer full name. */\n orderFullName?: string;\n /** Guest full name. */\n guestFullName?: string | null;\n /** Guest personal details. */\n guestDetails?: GuestDetails$2;\n /** Whether the ticket is visible in an order. */\n archived?: boolean;\n /** Ticket owner member ID. */\n memberId?: string | null;\n /**\n * Whether ticket was anonymized by GDPR delete.\n * Anonymized tickets no longer contain personally identifiable information (PII).\n */\n anonymized?: boolean;\n /**\n * Ticket check-in URL.\n * Shown as QR code image in PDF.\n *\n * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`\n *\n * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`\n */\n checkInUrl?: string;\n /** URL for ticket PDF download. */\n ticketPdfUrl?: string;\n /** Associated order checkout channel type. */\n channel?: ChannelType$1;\n /**\n * An URL to download a ticket in the `.pkpass` format for Apple Wallet.\n * @readonly\n */\n walletPassUrl?: string;\n }\n interface Money$6 {\n /** *Deprecated:** Use `value` instead. */\n amount?: string;\n /** Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`. */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface CheckIn$3 {\n /** Time of a ticket check-in. */\n created?: Date;\n }\n enum OrderStatus$2 {\n /** Order status not available for this request fieldset */\n NA_ORDER_STATUS = \"NA_ORDER_STATUS\",\n /** Order is confirmed, no payment required */\n FREE = \"FREE\",\n /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */\n PENDING = \"PENDING\",\n /** Order paid via payment gateway */\n PAID = \"PAID\",\n /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */\n OFFLINE_PENDING = \"OFFLINE_PENDING\",\n /** Order is awaiting for payment in Cashier */\n INITIATED = \"INITIATED\",\n /** Order was canceled */\n CANCELED = \"CANCELED\",\n /** Order payment was declined */\n DECLINED = \"DECLINED\"\n }\n interface GuestDetails$2 {\n /** Whether ticket belongs to assigned guest. */\n guestAssigned?: boolean;\n /** Guest first name. */\n firstName?: string | null;\n /** Guest last name. */\n lastName?: string | null;\n /** Guest email. */\n email?: string | null;\n /** Full form response. */\n form?: FormResponse$3;\n /** Contact ID associated with this guest. */\n contactId?: string | null;\n }\n interface FormResponse$3 {\n /** Form field inputs. */\n inputValues?: InputValue$3[];\n }\n interface InputValue$3 {\n /** Form field input name. */\n inputName?: string;\n /** Form field value. */\n value?: string;\n /** Form field values. */\n values?: string[];\n }\n interface FormattedAddress$3 {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address$7;\n }\n /** Physical address */\n interface Address$7 extends AddressStreetOneOf$7 {\n /** Street name and number. */\n streetAddress?: StreetAddress$7;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf$7 {\n /** Street name and number. */\n streetAddress?: StreetAddress$7;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$7 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$7 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$7 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /** Standard organizations details (e.g. ISO). */\n standardDetails?: StandardDetails$3;\n }\n enum SubdivisionType$7 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n /** Subdivision Concordance values */\n interface StandardDetails$3 {\n /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */\n iso31662?: string | null;\n }\n enum ChannelType$1 {\n /** Buyer created order via one of the online channels (website, mobile app, etc.) */\n ONLINE = \"ONLINE\",\n /** Order created and money collected by the sales person */\n OFFLINE_POS = \"OFFLINE_POS\"\n }\n interface TicketDetails$2 {\n /** Unique seat id in the event venue. */\n seatId?: string | null;\n /**\n * Optional sector label.\n * @readonly\n */\n sectionLabel?: string | null;\n /**\n * Area label.\n * @readonly\n */\n areaLabel?: string | null;\n /**\n * Table label.\n * @readonly\n */\n tableLabel?: string | null;\n /**\n * Row label.\n * @readonly\n */\n rowLabel?: string | null;\n /**\n * Seat label in a row or table.\n * @readonly\n */\n seatLabel?: string | null;\n /** Number of places in the spot. If not provided - defaults to 1. */\n capacity?: number | null;\n /** Custom pricing of ticket. */\n priceOverride?: string | null;\n /** Pricing option id. */\n pricingOptionId?: string | null;\n /**\n * Pricing option name.\n * @readonly\n */\n pricingOptionName?: string | null;\n }\n interface ListTicketsRequest {\n /** Event IDs. */\n eventId: string[];\n /** Offset. See [Pagination](/wix-events-v2/pagination). */\n offset?: number;\n /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /** Order numbers. */\n orderNumber?: string[];\n /** Ticket numbers. */\n ticketNumber?: string[];\n /** Searches in the `orderFullName`, `guestFullName`, and `ticketNumber` fields. */\n searchPhrase?: string;\n /** Order statuses. */\n orderStatus?: OrderStatus$2[];\n /**\n * Predefined sets of fields to return.\n * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.\n * - `GUEST_DETAILS`: Returns `guestDetails`.\n * - `GUEST_FORM`: Returns `guestDetails.form`.\n *\n * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.\n */\n fieldset?: TicketFieldset[];\n /**\n * Ticket states. Possible values:\n * - `ORDER_ARCHIVED`: Returns tickets of the archived orders.\n * - `ORDER_ACTIVE`: Returns tickets of the non-archived orders.\n * - `TICKET_ARCHIVED`: Returns archived tickets.\n * - `TICKET_ACTIVE`: Returns non-archived tickets.\n * - `CHECKED_IN`: Returns checked-in tickets.\n * - `NON_CHECKED_IN`: Returns tickets that are not checked in.\n * - `FREE`: Returns free tickets.\n * - `PAID`: Return paid tickets.\n * - `MEMBER`: Return members' tickets.\n */\n state?: State$5[];\n /** Site member IDs. */\n memberId?: string[];\n /** Filter facets. */\n facet?: string[];\n /** Sort order. Defaults to \"ticket_number:asc\". */\n sort?: string;\n /** Guest contact IDs. */\n contactId?: string[];\n /** Ticket definition IDs. */\n ticketDefinitionId?: string[];\n }\n enum TicketFieldset {\n /** Include guest details in ticket response */\n GUEST_DETAILS = \"GUEST_DETAILS\",\n /** Include ticket details in ticket response */\n TICKET_DETAILS = \"TICKET_DETAILS\",\n /** Include individual guest form in ticket response */\n GUEST_FORM = \"GUEST_FORM\"\n }\n enum State$5 {\n /** Returns only archived orders' tickets */\n ORDER_ARCHIVED = \"ORDER_ARCHIVED\",\n /** Returns only non-archived orders' tickets */\n ORDER_ACTIVE = \"ORDER_ACTIVE\",\n /** Returns only archived tickets */\n TICKET_ARCHIVED = \"TICKET_ARCHIVED\",\n /** Returns only non-archived tickets */\n TICKET_ACTIVE = \"TICKET_ACTIVE\",\n /** Returns only checked-in tickets */\n CHECKED_IN = \"CHECKED_IN\",\n /** Returns only non-checked-in tickets */\n NON_CHECKED_IN = \"NON_CHECKED_IN\",\n /** Returns only free tickets */\n FREE = \"FREE\",\n /** Returns only paid tickets */\n PAID = \"PAID\",\n /** Returns only member tickets */\n MEMBER = \"MEMBER\"\n }\n interface ListTicketsResponse {\n /** Total tickets matching the given filters. */\n total?: number;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Tickets. */\n tickets?: TicketingTicket$1[];\n /** Facets. */\n facets?: Record;\n }\n interface FacetCounts$6 {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface TicketFacets {\n /** Filter facets. */\n facets?: Record;\n }\n interface TicketFacetCounts {\n /** Facet totals, aggregated per filter. */\n counts?: Record;\n }\n interface Counts$2 {\n /** Number of tickets. */\n count?: number;\n /** Number of checked in tickets. */\n checkedIn?: number;\n }\n interface GetTicketRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber: string;\n /**\n * Predefined sets of fields to return.\n * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.\n * - `GUEST_DETAILS`: Returns `guestDetails`.\n * - `GUEST_FORM`: Returns `guestDetails.form`.\n *\n * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.\n */\n fieldset?: TicketFieldset[];\n }\n interface GetTicketResponse {\n /** Ticket. */\n ticket?: TicketingTicket$1;\n }\n interface CheckInTicketRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** Tickets to check-in. */\n ticketNumber?: string[];\n }\n interface CheckInTicketResponse {\n /** Updated tickets. */\n tickets?: TicketingTicket$1[];\n }\n interface OrderUpdated$2 {\n /** Order updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: string | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID to which the ticket belongs. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp.\n * @readonly\n */\n created?: Date;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date;\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse$3;\n /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */\n confirmed?: boolean;\n /** Order status. */\n status?: OrderStatus$2;\n /** Payment method used for paid tickets purchase, i.e. \"payPal\", \"creditCard\", etc. */\n method?: string | null;\n /** Tickets generated after payment. */\n tickets?: Ticket$2[];\n /** Whether order was archived and excluded from results. */\n archived?: boolean;\n /** Whether event was triggered by GDPR delete request. */\n triggeredByAnonymizeRequest?: boolean;\n }\n interface Ticket$2 {\n /** Unique issued ticket number. */\n ticketNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$3;\n /** Ticket price. */\n price?: Money$6;\n /** Whether ticket is archived. */\n archived?: boolean;\n /** Guest first name. */\n firstName?: string | null;\n /** Guest last name. */\n lastName?: string | null;\n /** Guest email. */\n email?: string | null;\n /** Contact ID associated with this ticket. */\n contactId?: string | null;\n /** Whether ticket is confirmed */\n confirmed?: boolean;\n /** Member ID associated with this ticket. */\n memberId?: string | null;\n /** Ticket form response (only assigned tickets contain separate forms). */\n form?: FormResponse$3;\n /** Ticket name. */\n ticketName?: string;\n /** Anonymized tickets no longer contain personally identifiable information (PII). */\n anonymized?: boolean;\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$3;\n }\n interface OnlineConferencingLogin$3 {\n /**\n * Link URL to the online conference.\n * @readonly\n */\n link?: string;\n /**\n * Password for the online conference.\n * @readonly\n */\n password?: string | null;\n }\n interface DeleteTicketCheckInRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** Ticket numbers which check-ins to delete. */\n ticketNumber?: string[];\n }\n interface DeleteTicketCheckInResponse {\n /** Updated tickets. */\n tickets?: TicketingTicket$1[];\n }\n interface UpdateTicketRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber: string;\n /** Whether to archive the tickets. */\n archived?: boolean;\n /** Assigned guest details. */\n guestDetails?: GuestDetailsUpdate;\n }\n interface GuestDetailsUpdate {\n /** Form of a guest assigned to a ticket. */\n form?: FormResponse$3;\n }\n interface UpdateTicketResponse {\n /** Updated ticket. */\n ticket?: TicketingTicket$1;\n }\n interface BulkUpdateTicketsRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber?: string[];\n /** Whether tickets are archived. */\n archived?: boolean;\n }\n interface BulkUpdateTicketsResponse {\n /** Updated tickets. */\n tickets?: TicketingTicket$1[];\n }\n interface GetDemoTicketRequest {\n /** Ticket definition ID. */\n definitionId?: string;\n }\n interface GetDemoTicketResponse {\n /** Ticket. */\n ticket?: TicketingTicket$1;\n }\n interface MessageEnvelope$8 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$8;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$8 extends IdentificationDataIdOneOf$8 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$8;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$8 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$8 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves a list of up to 100 tickets.\n *\n * \n * @param eventId - Event IDs.\n * @public\n * @requiredField eventId\n * @param options - Options for defining the returned list of tickets.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Read Event Tickets and Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function listTickets(eventId: string[], options?: ListTicketsOptions): Promise;\n interface ListTicketsOptions {\n /**\n *\n * Offset. See [Pagination](/wix-events-v2/pagination).\n */\n offset?: number;\n /** Number of items to load per page. See [Pagination](/wix-events-v2/pagination). */\n limit?: number;\n /** Order numbers. */\n orderNumber?: string[];\n /** Ticket numbers. */\n ticketNumber?: string[];\n /** Textual search filter - search is performed on `\"orderFullName\"`, `\"guestFullName\"`, and `\"ticketNumber\"`. */\n searchPhrase?: string;\n /** Order statuses. */\n orderStatus?: OrderStatus$2[];\n /**\n * Predefined sets of fields to return.\n * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.\n * - `GUEST_DETAILS`: Returns `guestDetails`.\n * - `GUEST_FORM`: Returns `guestDetails.form`.\n *\n * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.\n */\n fieldset?: TicketFieldset[];\n /**\n * Ticket states. Possible values:\n * - `ORDER_ARCHIVED`: Returns tickets of the archived orders.\n * - `ORDER_ACTIVE`: Returns tickets of the non-archived orders.\n * - `TICKET_ARCHIVED`: Returns archived tickets.\n * - `TICKET_ACTIVE`: Returns non-archived tickets.\n * - `CHECKED_IN`: Returns checked-in tickets.\n * - `NON_CHECKED_IN`: Returns tickets that are not checked in.\n * - `FREE`: Returns free tickets.\n * - `PAID`: Return paid tickets.\n * - `MEMBER`: Return members' tickets.\n */\n state?: State$5[];\n /** Site member IDs. */\n memberId?: string[];\n /** Filter facets. */\n facet?: string[];\n /**\n * Sort order.\n *\n * Default: `\"ticketNumber\"`:`\"asc\"`.\n */\n sort?: string;\n /** Guest contact IDs. */\n contactId?: string[];\n /** Ticket definition IDs. */\n ticketDefinitionId?: string[];\n }\n /**\n * Retrieves a ticket by the unique ticket number.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.ticketNumber\n * @param identifiers - Details for the ticket to retrieve.\n * @param options - Options for the returned ticket data.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Read Event Tickets and Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n * @returns Ticket.\n */\n function getTicket(identifiers: GetTicketIdentifiers, options?: GetTicketOptions): Promise;\n interface GetTicketIdentifiers {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber: string;\n }\n interface GetTicketOptions {\n /**\n * Predefined sets of fields to return.\n * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.\n * - `GUEST_DETAILS`: Returns `guestDetails`.\n * - `GUEST_FORM`: Returns `guestDetails.form`.\n *\n * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.\n */\n fieldset?: TicketFieldset[];\n }\n /**\n * Checks in 1 or more tickets.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the ticket belongs.\n * @param options - Options for tickets to check-in.\n * @adminMethod\n */\n function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise;\n interface CheckInTicketsOptions {\n /** Tickets to check-in. */\n ticketNumber?: string[];\n }\n /**\n * Deletes check-ins for 1 or more tickets.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the ticket belongs.\n * @param options - Options for tickets to delete.\n * @adminMethod\n */\n function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise;\n interface DeleteTicketCheckInsOptions {\n /** Ticket numbers which check-ins to delete. */\n ticketNumber?: string[];\n }\n /**\n * Updates a ticket.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.ticketNumber\n * @param identifiers - Details for the ticket to update.\n * @param options - Ticket details to update.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateTicket(identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions): Promise;\n interface UpdateTicketIdentifiers {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber: string;\n }\n interface UpdateTicketOptions {\n /** Whether to archive the ticket. */\n archived?: boolean;\n /** Assigned guest details. */\n guestDetails?: GuestDetailsUpdate;\n }\n /**\n * Archives multiple tickets.\n * @public\n * @requiredField eventId\n * @param options - Options for updating the tickets.\n * @param eventId - Event ID to which the ticket belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateTickets(eventId: string, options?: BulkUpdateTicketsOptions): Promise;\n interface BulkUpdateTicketsOptions {\n /** A unique ticket number which is assigned automatically when creating a ticket. */\n ticketNumber?: string[];\n /** Whether tickets are archived. */\n archived?: boolean;\n }\n type eventsV1TicketTickets_universal_d_ListTicketsRequest = ListTicketsRequest;\n type eventsV1TicketTickets_universal_d_TicketFieldset = TicketFieldset;\n const eventsV1TicketTickets_universal_d_TicketFieldset: typeof TicketFieldset;\n type eventsV1TicketTickets_universal_d_ListTicketsResponse = ListTicketsResponse;\n type eventsV1TicketTickets_universal_d_TicketFacets = TicketFacets;\n type eventsV1TicketTickets_universal_d_TicketFacetCounts = TicketFacetCounts;\n type eventsV1TicketTickets_universal_d_GetTicketRequest = GetTicketRequest;\n type eventsV1TicketTickets_universal_d_GetTicketResponse = GetTicketResponse;\n type eventsV1TicketTickets_universal_d_CheckInTicketRequest = CheckInTicketRequest;\n type eventsV1TicketTickets_universal_d_CheckInTicketResponse = CheckInTicketResponse;\n type eventsV1TicketTickets_universal_d_DeleteTicketCheckInRequest = DeleteTicketCheckInRequest;\n type eventsV1TicketTickets_universal_d_DeleteTicketCheckInResponse = DeleteTicketCheckInResponse;\n type eventsV1TicketTickets_universal_d_UpdateTicketRequest = UpdateTicketRequest;\n type eventsV1TicketTickets_universal_d_GuestDetailsUpdate = GuestDetailsUpdate;\n type eventsV1TicketTickets_universal_d_UpdateTicketResponse = UpdateTicketResponse;\n type eventsV1TicketTickets_universal_d_BulkUpdateTicketsRequest = BulkUpdateTicketsRequest;\n type eventsV1TicketTickets_universal_d_BulkUpdateTicketsResponse = BulkUpdateTicketsResponse;\n type eventsV1TicketTickets_universal_d_GetDemoTicketRequest = GetDemoTicketRequest;\n type eventsV1TicketTickets_universal_d_GetDemoTicketResponse = GetDemoTicketResponse;\n const eventsV1TicketTickets_universal_d_listTickets: typeof listTickets;\n type eventsV1TicketTickets_universal_d_ListTicketsOptions = ListTicketsOptions;\n const eventsV1TicketTickets_universal_d_getTicket: typeof getTicket;\n type eventsV1TicketTickets_universal_d_GetTicketIdentifiers = GetTicketIdentifiers;\n type eventsV1TicketTickets_universal_d_GetTicketOptions = GetTicketOptions;\n const eventsV1TicketTickets_universal_d_checkInTickets: typeof checkInTickets;\n type eventsV1TicketTickets_universal_d_CheckInTicketsOptions = CheckInTicketsOptions;\n const eventsV1TicketTickets_universal_d_deleteTicketCheckIns: typeof deleteTicketCheckIns;\n type eventsV1TicketTickets_universal_d_DeleteTicketCheckInsOptions = DeleteTicketCheckInsOptions;\n const eventsV1TicketTickets_universal_d_updateTicket: typeof updateTicket;\n type eventsV1TicketTickets_universal_d_UpdateTicketIdentifiers = UpdateTicketIdentifiers;\n type eventsV1TicketTickets_universal_d_UpdateTicketOptions = UpdateTicketOptions;\n const eventsV1TicketTickets_universal_d_bulkUpdateTickets: typeof bulkUpdateTickets;\n type eventsV1TicketTickets_universal_d_BulkUpdateTicketsOptions = BulkUpdateTicketsOptions;\n namespace eventsV1TicketTickets_universal_d {\n export { TicketingTicket$1 as TicketingTicket, Money$6 as Money, CheckIn$3 as CheckIn, OrderStatus$2 as OrderStatus, GuestDetails$2 as GuestDetails, FormResponse$3 as FormResponse, InputValue$3 as InputValue, FormattedAddress$3 as FormattedAddress, Address$7 as Address, AddressStreetOneOf$7 as AddressStreetOneOf, StreetAddress$7 as StreetAddress, AddressLocation$7 as AddressLocation, Subdivision$7 as Subdivision, SubdivisionType$7 as SubdivisionType, StandardDetails$3 as StandardDetails, ChannelType$1 as ChannelType, TicketDetails$2 as TicketDetails, eventsV1TicketTickets_universal_d_ListTicketsRequest as ListTicketsRequest, eventsV1TicketTickets_universal_d_TicketFieldset as TicketFieldset, State$5 as State, eventsV1TicketTickets_universal_d_ListTicketsResponse as ListTicketsResponse, FacetCounts$6 as FacetCounts, eventsV1TicketTickets_universal_d_TicketFacets as TicketFacets, eventsV1TicketTickets_universal_d_TicketFacetCounts as TicketFacetCounts, Counts$2 as Counts, eventsV1TicketTickets_universal_d_GetTicketRequest as GetTicketRequest, eventsV1TicketTickets_universal_d_GetTicketResponse as GetTicketResponse, eventsV1TicketTickets_universal_d_CheckInTicketRequest as CheckInTicketRequest, eventsV1TicketTickets_universal_d_CheckInTicketResponse as CheckInTicketResponse, OrderUpdated$2 as OrderUpdated, Ticket$2 as Ticket, OnlineConferencingLogin$3 as OnlineConferencingLogin, eventsV1TicketTickets_universal_d_DeleteTicketCheckInRequest as DeleteTicketCheckInRequest, eventsV1TicketTickets_universal_d_DeleteTicketCheckInResponse as DeleteTicketCheckInResponse, eventsV1TicketTickets_universal_d_UpdateTicketRequest as UpdateTicketRequest, eventsV1TicketTickets_universal_d_GuestDetailsUpdate as GuestDetailsUpdate, eventsV1TicketTickets_universal_d_UpdateTicketResponse as UpdateTicketResponse, eventsV1TicketTickets_universal_d_BulkUpdateTicketsRequest as BulkUpdateTicketsRequest, eventsV1TicketTickets_universal_d_BulkUpdateTicketsResponse as BulkUpdateTicketsResponse, eventsV1TicketTickets_universal_d_GetDemoTicketRequest as GetDemoTicketRequest, eventsV1TicketTickets_universal_d_GetDemoTicketResponse as GetDemoTicketResponse, MessageEnvelope$8 as MessageEnvelope, IdentificationData$8 as IdentificationData, IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf, WebhookIdentityType$8 as WebhookIdentityType, eventsV1TicketTickets_universal_d_listTickets as listTickets, eventsV1TicketTickets_universal_d_ListTicketsOptions as ListTicketsOptions, eventsV1TicketTickets_universal_d_getTicket as getTicket, eventsV1TicketTickets_universal_d_GetTicketIdentifiers as GetTicketIdentifiers, eventsV1TicketTickets_universal_d_GetTicketOptions as GetTicketOptions, eventsV1TicketTickets_universal_d_checkInTickets as checkInTickets, eventsV1TicketTickets_universal_d_CheckInTicketsOptions as CheckInTicketsOptions, eventsV1TicketTickets_universal_d_deleteTicketCheckIns as deleteTicketCheckIns, eventsV1TicketTickets_universal_d_DeleteTicketCheckInsOptions as DeleteTicketCheckInsOptions, eventsV1TicketTickets_universal_d_updateTicket as updateTicket, eventsV1TicketTickets_universal_d_UpdateTicketIdentifiers as UpdateTicketIdentifiers, eventsV1TicketTickets_universal_d_UpdateTicketOptions as UpdateTicketOptions, eventsV1TicketTickets_universal_d_bulkUpdateTickets as bulkUpdateTickets, eventsV1TicketTickets_universal_d_BulkUpdateTicketsOptions as BulkUpdateTicketsOptions, };\n }\n interface Rsvp {\n /** RSVP ID. */\n _id?: string;\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string;\n /** RSVP created timestamp. */\n created?: Date;\n /** RSVP modified timestamp. */\n modified?: Date;\n /** First name. */\n firstName?: string;\n /** Last name. */\n lastName?: string;\n /** Guest email. */\n email?: string;\n /** RSVP form response. */\n rsvpForm?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /** Total number of attendees. */\n totalGuests?: number;\n /** List of guests. */\n guests?: Guest$2[];\n /** Whether RSVP is anonymized by GDPR delete. */\n anonymized?: boolean;\n }\n interface FormResponse$2 {\n /** Input form fields. */\n inputValues?: InputValue$2[];\n }\n interface InputValue$2 {\n /** Form field name. */\n inputName?: string;\n /** Form field value. */\n value?: string;\n /** Multiple form field values. */\n values?: string[];\n }\n interface FormattedAddress$2 {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address$6;\n }\n /** Physical address */\n interface Address$6 extends AddressStreetOneOf$6 {\n /** Street name and number. */\n streetAddress?: StreetAddress$6;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf$6 {\n /** Street name and number. */\n streetAddress?: StreetAddress$6;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$6 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$6 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$6 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /** Standard organizations details (e.g. ISO). */\n standardDetails?: StandardDetails$2;\n }\n enum SubdivisionType$6 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n /** Subdivision Concordance values */\n interface StandardDetails$2 {\n /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */\n iso31662?: string | null;\n }\n enum RsvpStatus$1 {\n YES = \"YES\",\n NO = \"NO\",\n WAITING = \"WAITING\"\n }\n interface Guest$2 {\n /** Index in the RSVP guest list. */\n index?: number;\n /** Guest full name. */\n fullName?: string;\n /** Guest check-in. */\n checkIn?: CheckIn$2;\n /** Unique guest ID per RSVP. */\n _id?: number;\n }\n interface CheckIn$2 {\n /** Time of check-in */\n created?: Date;\n }\n interface ListRsvpRequest {\n /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number;\n /** Number of items to load. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /**\n * Set of fields to return. Possible values:\n * - `DETAILS`: Returns `created`, `modified`, `firstName`, `lastName` fields.\n * - `FORM`: Returns `rsvpForm` field.\n * - `CONTACT_DETAILS`: Returns `email` field.\n */\n fieldset?: RsvpFieldset[];\n /** Event ID to which RSVP belongs. */\n eventId?: string[];\n /** RSVP ID. */\n rsvpId?: string[];\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1[];\n /** Site member ID. */\n memberId?: string[];\n /**\n * Facet counts to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n facet?: string[];\n /** Textual search filter - search is performed on \"full_name\" and \"email\". */\n searchPhrase?: string;\n /** Event creator id filter, by default any. */\n eventCreatorId?: string[];\n /**\n * Sort order, defaults to `\"created:asc\"`.\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n sort?: string;\n /** Contact ID. */\n contactId?: string[];\n /** RSVP tag */\n tag?: RsvpTag[];\n }\n enum RsvpFieldset {\n /** Include RSVP details: created, modified, first_name, last_name, etc. */\n DETAILS = \"DETAILS\",\n /** Include rsvp_form. */\n FORM = \"FORM\",\n /** Include RSVP email. */\n CONTACT_DETAILS = \"CONTACT_DETAILS\"\n }\n enum RsvpTag {\n /** Return only rsvps with all guests checked-in */\n FULLY_CHECKED_IN = \"FULLY_CHECKED_IN\",\n /** Return only rsvps with not all guests checked-in */\n NOT_FULLY_CHECKED_IN = \"NOT_FULLY_CHECKED_IN\",\n /** Return only member rsvp */\n MEMBER = \"MEMBER\"\n }\n interface ListRsvpResponse {\n /** Total RSVPs matching the given filters. */\n total?: number;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** RSVP list. */\n rsvps?: Rsvp[];\n /** Facet query result. */\n facets?: Record;\n /** Rsvp data enriched facets. */\n rsvpFacets?: RsvpFacets;\n }\n interface FacetCounts$5 {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface RsvpFacets {\n /** Filter facets. */\n facets?: Record;\n }\n interface RsvpFacetCounts {\n /** Facet totals, aggregated per filter. */\n counts?: Record;\n }\n interface Counts$1 {\n /** Number of RSVPs. */\n count?: number;\n /** Number of guests within RSVPs. */\n guests?: number;\n /** Number of guests who have checked-in. */\n guestsCheckIn?: number;\n }\n interface QueryRsvpRequest {\n /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number;\n /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /**\n * Set of fields to return. Possible values:\n * - `DETAILS`: Returns `created`, `modified`, `firstName`, `lastName` fields.\n * - `FORM`: Returns `rsvpForm` field.\n * - `CONTACT_DETAILS`: Returns `email` field.\n */\n fieldset?: RsvpFieldset[];\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps). */\n filter?: Record | null;\n /** Site member ID. */\n memberId?: string[];\n /**\n * Filter facets to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n facet?: string[];\n /** Textual search filter - search is performed on \"guests.full_name\". */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Sort order, defaults to `\"created:asc\"`.\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n sort?: string;\n /** Contact ID. */\n contactId?: string[];\n /** RSVP tag */\n tag?: RsvpTag[];\n }\n interface QueryRsvpResponse {\n /** Total RSVPs matching the given filters. */\n total?: number;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** RSVP list. */\n rsvps?: Rsvp[];\n /** Facet query result. */\n facets?: Record;\n /** Rsvp data enriched facets. */\n rsvpFacets?: RsvpFacets;\n }\n interface GetRsvpRequest {\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId: string;\n /**\n * Set of fields to return. Possible values:\n * - `DETAILS`: Returns `created`, `modified`, `firstName`, `lastName` fields.\n * - `FORM`: Returns `rsvpForm` field.\n * - `CONTACT_DETAILS`: Returns `email` field.\n */\n fieldset?: RsvpFieldset[];\n }\n interface GetRsvpResponse {\n /** RSVP. */\n rsvp?: Rsvp;\n }\n interface CreateRsvpRequest {\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** RSVP form response. */\n form?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /** Member ID of the RSVP. */\n memberId?: string | null;\n /**\n * Add RSVP options.\n * **Note:** WIX_EVENTS.MANAGE_RSVP permission is required.\n */\n options?: ModificationOptions;\n }\n interface ModificationOptions {\n /** Whether to ignore notification settings (when hen true, no notifications to contact or user are sent). */\n silent?: boolean;\n /** Whether to create/update regardless of event guest limit. */\n ignoreLimits?: boolean;\n /** Whether to ignore the form validation. */\n ignoreFormValidation?: boolean;\n }\n interface CreateRsvpResponse {\n /** Created RSVP. */\n rsvp?: Rsvp;\n /** \"Add to calendar\" links. */\n calendarLinks?: CalendarLinks$4;\n }\n interface CalendarLinks$4 {\n /** \"Add to Google calendar\" URL. */\n google?: string;\n /** \"Download ICS calendar file\" URL. */\n ics?: string;\n }\n interface RsvpCreated$1 {\n /** RSVP created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when RSVP created */\n language?: string | null;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string | null;\n /** Guest first name. */\n firstName?: string;\n /** Guest last name. */\n lastName?: string;\n /** Guest email. */\n email?: string;\n /** RSVP form response. */\n rsvpForm?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /** List of all guests. */\n guests?: Guest$2[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$2;\n }\n interface OnlineConferencingLogin$2 {\n /**\n * Link URL to the online conference.\n * @readonly\n */\n link?: string;\n /**\n * Password for the online conference.\n * @readonly\n */\n password?: string | null;\n }\n interface UpdateRsvpRequest {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVP ID. */\n rsvpId: string;\n /** RSVP form response. */\n rsvpForm?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /**\n * Update RSVP options.\n * WIX_EVENTS.MANAGE_RSVP permission is required.\n */\n options?: ModificationOptions;\n }\n interface UpdateRsvpResponse {\n /** Updated RSVP. */\n rsvp?: Rsvp;\n }\n interface RsvpUpdated$1 {\n /** RSVP updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when RSVP created */\n language?: string | null;\n /** Locale in which Rsvp was created. */\n locale?: string | null;\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string | null;\n /** RSVP created timestamp. */\n created?: Date;\n /** Guest first name. */\n firstName?: string;\n /** Guest last name. */\n lastName?: string;\n /** Guest email. */\n email?: string;\n /** RSVP form response. */\n rsvpForm?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /** List of the guests. */\n guests?: Guest$2[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$2;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n }\n interface BulkUpdateRsvpRequest {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVPs to update. */\n rsvpId?: string[];\n /**\n * New RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n }\n interface BulkUpdateRsvpResponse {\n /** Updated RSVPs. */\n rsvps?: Rsvp[];\n }\n interface DeleteRsvpRequest {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVPs to delete. When not returned, all RSVPs associated with this event are deleted. */\n rsvps?: string[];\n }\n interface DeleteRsvpResponse {\n }\n interface RsvpDeleted$1 {\n /** RSVP deleted timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string | null;\n /** Whether RSVP was anonymized by GDPR delete. */\n anonymized?: boolean;\n }\n interface CheckInRsvpRequest {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVP ID to check-in. */\n rsvpId: string;\n /** Guest IDs to check-in. */\n guestId?: number[];\n }\n interface CheckInRsvpResponse {\n /** Updated RSVP. */\n rsvp?: Rsvp;\n }\n interface DeleteRsvpCheckInRequest {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVP ID to delete check-in. */\n rsvpId: string;\n /** Guest IDs to delete check-in. */\n guestId?: number[];\n }\n interface DeleteRsvpCheckInResponse {\n /** Updated RSVP. */\n rsvp?: Rsvp;\n }\n interface MessageEnvelope$7 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$7;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$7;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$7 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$7 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves a list of up to 100 RSVPs.\n * @public\n * @param options - Optional fields.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Read Event Tickets and Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function listRsvp(options?: ListRsvpOptions): Promise;\n interface ListRsvpOptions {\n /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number;\n /** Number of items to load. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /**\n * Set of fields to return. Possible values:\n * - `DETAILS`: Returns `created`, `modified`, `firstName`, `lastName` fields.\n * - `FORM`: Returns `rsvpForm` field.\n * - `CONTACT_DETAILS`: Returns `email` field.\n */\n fieldset?: RsvpFieldset[];\n /** Event ID to which RSVP belongs. */\n eventId?: string[];\n /** RSVP ID. */\n rsvpId?: string[];\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1[];\n /** Site member ID. */\n memberId?: string[];\n /**\n * Facet counts to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n facet?: string[];\n /** Textual search filter - search is performed on \"full_name\" and \"email\". */\n searchPhrase?: string;\n /** Event creator id filter, by default any. */\n eventCreatorId?: string[];\n /**\n * Sort order, defaults to `\"created:asc\"`.\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n sort?: string;\n /** Contact ID. */\n contactId?: string[];\n /** RSVP tag */\n tag?: RsvpTag[];\n }\n /**\n * Retrieves a list of up to 100 RSVPs.\n * @public\n * @param options - Optional fields.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Read Event Tickets and Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryRsvp(options?: QueryRsvpOptions): Promise;\n interface QueryRsvpOptions {\n /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number;\n /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /**\n * Set of fields to return. Possible values:\n * - `DETAILS`: Returns `created`, `modified`, `firstName`, `lastName` fields.\n * - `FORM`: Returns `rsvpForm` field.\n * - `CONTACT_DETAILS`: Returns `email` field.\n */\n fieldset?: RsvpFieldset[];\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps). */\n filter?: Record | null;\n /** Site member ID. */\n memberId?: string[];\n /**\n * Filter facets to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n facet?: string[];\n /** Textual search filter - search is performed on \"guests.full_name\". */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Sort order, defaults to `\"created:asc\"`.\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).\n */\n sort?: string;\n /** Contact ID. */\n contactId?: string[];\n /** RSVP tag */\n tag?: RsvpTag[];\n }\n /**\n * Retrieves an RSVP.\n * @param rsvpId - RSVP ID.\n * @public\n * @requiredField rsvpId\n * @param options - Optional fields.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Read Event Tickets and Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n * @returns RSVP.\n */\n function getRsvp(rsvpId: string, options?: GetRsvpOptions): Promise;\n interface GetRsvpOptions {\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /**\n * Set of fields to return. Possible values:\n * - `DETAILS`: Returns `created`, `modified`, `firstName`, `lastName` fields.\n * - `FORM`: Returns `rsvpForm` field.\n * - `CONTACT_DETAILS`: Returns `email` field.\n */\n fieldset?: RsvpFieldset[];\n }\n /**\n * Creates an RSVP, associated with a contact of the site.\n * @public\n * @param options - Optional fields.\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function createRsvp(options?: CreateRsvpOptions): Promise;\n interface CreateRsvpOptions {\n /** Event ID to which RSVP belongs. */\n eventId?: string;\n /** RSVP form response. */\n form?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /** Member ID of the RSVP. */\n memberId?: string | null;\n /**\n * Add RSVP options.\n * **Note:** WIX_EVENTS.MANAGE_RSVP permission is required.\n */\n options?: ModificationOptions;\n }\n /**\n * Updates an RSVP.\n * @param rsvpId - RSVP ID.\n * @public\n * @requiredField eventId\n * @requiredField rsvpId\n * @param eventId - Event ID to which RSVP belongs.\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateRsvp(rsvpId: string, eventId: string, options?: UpdateRsvpOptions): Promise;\n interface UpdateRsvpOptions {\n /** RSVP form response. */\n rsvpForm?: FormResponse$2;\n /**\n * RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n /**\n * Update RSVP options.\n * WIX_EVENTS.MANAGE_RSVP permission is required.\n */\n options?: ModificationOptions;\n }\n /**\n * Updates statuses of multiple RSVPs.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which RSVP belongs.\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateRsvp(eventId: string, options?: BulkUpdateRsvpOptions): Promise;\n interface BulkUpdateRsvpOptions {\n /** RSVPs to update. */\n rsvpId?: string[];\n /**\n * New RSVP response status. Possible values:\n * - `Yes`\n * - `No`\n * - `Waiting`: a guest is in the waitlist.\n */\n status?: RsvpStatus$1;\n }\n /**\n * Deletes an RSVP.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which RSVP belongs.\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteRsvp(eventId: string, options?: DeleteRsvpOptions): Promise;\n interface DeleteRsvpOptions {\n /** RSVPs to delete. When not defined, all RSVPs associated with this event are deleted. */\n rsvps?: string[];\n }\n /**\n * Checks-in an RSVP.\n * @public\n * @requiredField eventId\n * @requiredField options.rsvpId\n * @param eventId - Event ID to which RSVP belongs.\n * @param options - Optional fields.\n * @adminMethod\n */\n function checkInRsvp(eventId: string, options?: CheckInRsvpOptions): Promise;\n interface CheckInRsvpOptions {\n /** RSVP ID to check-in. */\n rsvpId: string;\n /** Guest IDs to check-in. */\n guestId?: number[];\n }\n /**\n * Deletes an RSVP check-in.\n * @public\n * @requiredField eventId\n * @requiredField options.rsvpId\n * @param eventId - Event ID to which RSVP belongs.\n * @param options - Optional fields.\n * @adminMethod\n */\n function deleteRsvpCheckIn(eventId: string, options?: DeleteRsvpCheckInOptions): Promise;\n interface DeleteRsvpCheckInOptions {\n /** RSVP ID to delete check-in. */\n rsvpId: string;\n /** Guest IDs to delete check-in. */\n guestId?: number[];\n }\n type eventsV1RsvpRsvp_universal_d_Rsvp = Rsvp;\n type eventsV1RsvpRsvp_universal_d_ListRsvpRequest = ListRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_RsvpFieldset = RsvpFieldset;\n const eventsV1RsvpRsvp_universal_d_RsvpFieldset: typeof RsvpFieldset;\n type eventsV1RsvpRsvp_universal_d_RsvpTag = RsvpTag;\n const eventsV1RsvpRsvp_universal_d_RsvpTag: typeof RsvpTag;\n type eventsV1RsvpRsvp_universal_d_ListRsvpResponse = ListRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_RsvpFacets = RsvpFacets;\n type eventsV1RsvpRsvp_universal_d_RsvpFacetCounts = RsvpFacetCounts;\n type eventsV1RsvpRsvp_universal_d_QueryRsvpRequest = QueryRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_QueryRsvpResponse = QueryRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_GetRsvpRequest = GetRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_GetRsvpResponse = GetRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_CreateRsvpRequest = CreateRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_ModificationOptions = ModificationOptions;\n type eventsV1RsvpRsvp_universal_d_CreateRsvpResponse = CreateRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_UpdateRsvpRequest = UpdateRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_UpdateRsvpResponse = UpdateRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_BulkUpdateRsvpRequest = BulkUpdateRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_BulkUpdateRsvpResponse = BulkUpdateRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_DeleteRsvpRequest = DeleteRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_DeleteRsvpResponse = DeleteRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_CheckInRsvpRequest = CheckInRsvpRequest;\n type eventsV1RsvpRsvp_universal_d_CheckInRsvpResponse = CheckInRsvpResponse;\n type eventsV1RsvpRsvp_universal_d_DeleteRsvpCheckInRequest = DeleteRsvpCheckInRequest;\n type eventsV1RsvpRsvp_universal_d_DeleteRsvpCheckInResponse = DeleteRsvpCheckInResponse;\n const eventsV1RsvpRsvp_universal_d_listRsvp: typeof listRsvp;\n type eventsV1RsvpRsvp_universal_d_ListRsvpOptions = ListRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_queryRsvp: typeof queryRsvp;\n type eventsV1RsvpRsvp_universal_d_QueryRsvpOptions = QueryRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_getRsvp: typeof getRsvp;\n type eventsV1RsvpRsvp_universal_d_GetRsvpOptions = GetRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_createRsvp: typeof createRsvp;\n type eventsV1RsvpRsvp_universal_d_CreateRsvpOptions = CreateRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_updateRsvp: typeof updateRsvp;\n type eventsV1RsvpRsvp_universal_d_UpdateRsvpOptions = UpdateRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_bulkUpdateRsvp: typeof bulkUpdateRsvp;\n type eventsV1RsvpRsvp_universal_d_BulkUpdateRsvpOptions = BulkUpdateRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_deleteRsvp: typeof deleteRsvp;\n type eventsV1RsvpRsvp_universal_d_DeleteRsvpOptions = DeleteRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_checkInRsvp: typeof checkInRsvp;\n type eventsV1RsvpRsvp_universal_d_CheckInRsvpOptions = CheckInRsvpOptions;\n const eventsV1RsvpRsvp_universal_d_deleteRsvpCheckIn: typeof deleteRsvpCheckIn;\n type eventsV1RsvpRsvp_universal_d_DeleteRsvpCheckInOptions = DeleteRsvpCheckInOptions;\n namespace eventsV1RsvpRsvp_universal_d {\n export { eventsV1RsvpRsvp_universal_d_Rsvp as Rsvp, FormResponse$2 as FormResponse, InputValue$2 as InputValue, FormattedAddress$2 as FormattedAddress, Address$6 as Address, AddressStreetOneOf$6 as AddressStreetOneOf, StreetAddress$6 as StreetAddress, AddressLocation$6 as AddressLocation, Subdivision$6 as Subdivision, SubdivisionType$6 as SubdivisionType, StandardDetails$2 as StandardDetails, RsvpStatus$1 as RsvpStatus, Guest$2 as Guest, CheckIn$2 as CheckIn, eventsV1RsvpRsvp_universal_d_ListRsvpRequest as ListRsvpRequest, eventsV1RsvpRsvp_universal_d_RsvpFieldset as RsvpFieldset, eventsV1RsvpRsvp_universal_d_RsvpTag as RsvpTag, eventsV1RsvpRsvp_universal_d_ListRsvpResponse as ListRsvpResponse, FacetCounts$5 as FacetCounts, eventsV1RsvpRsvp_universal_d_RsvpFacets as RsvpFacets, eventsV1RsvpRsvp_universal_d_RsvpFacetCounts as RsvpFacetCounts, Counts$1 as Counts, eventsV1RsvpRsvp_universal_d_QueryRsvpRequest as QueryRsvpRequest, eventsV1RsvpRsvp_universal_d_QueryRsvpResponse as QueryRsvpResponse, eventsV1RsvpRsvp_universal_d_GetRsvpRequest as GetRsvpRequest, eventsV1RsvpRsvp_universal_d_GetRsvpResponse as GetRsvpResponse, eventsV1RsvpRsvp_universal_d_CreateRsvpRequest as CreateRsvpRequest, eventsV1RsvpRsvp_universal_d_ModificationOptions as ModificationOptions, eventsV1RsvpRsvp_universal_d_CreateRsvpResponse as CreateRsvpResponse, CalendarLinks$4 as CalendarLinks, RsvpCreated$1 as RsvpCreated, OnlineConferencingLogin$2 as OnlineConferencingLogin, eventsV1RsvpRsvp_universal_d_UpdateRsvpRequest as UpdateRsvpRequest, eventsV1RsvpRsvp_universal_d_UpdateRsvpResponse as UpdateRsvpResponse, RsvpUpdated$1 as RsvpUpdated, eventsV1RsvpRsvp_universal_d_BulkUpdateRsvpRequest as BulkUpdateRsvpRequest, eventsV1RsvpRsvp_universal_d_BulkUpdateRsvpResponse as BulkUpdateRsvpResponse, eventsV1RsvpRsvp_universal_d_DeleteRsvpRequest as DeleteRsvpRequest, eventsV1RsvpRsvp_universal_d_DeleteRsvpResponse as DeleteRsvpResponse, RsvpDeleted$1 as RsvpDeleted, eventsV1RsvpRsvp_universal_d_CheckInRsvpRequest as CheckInRsvpRequest, eventsV1RsvpRsvp_universal_d_CheckInRsvpResponse as CheckInRsvpResponse, eventsV1RsvpRsvp_universal_d_DeleteRsvpCheckInRequest as DeleteRsvpCheckInRequest, eventsV1RsvpRsvp_universal_d_DeleteRsvpCheckInResponse as DeleteRsvpCheckInResponse, MessageEnvelope$7 as MessageEnvelope, IdentificationData$7 as IdentificationData, IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf, WebhookIdentityType$7 as WebhookIdentityType, eventsV1RsvpRsvp_universal_d_listRsvp as listRsvp, eventsV1RsvpRsvp_universal_d_ListRsvpOptions as ListRsvpOptions, eventsV1RsvpRsvp_universal_d_queryRsvp as queryRsvp, eventsV1RsvpRsvp_universal_d_QueryRsvpOptions as QueryRsvpOptions, eventsV1RsvpRsvp_universal_d_getRsvp as getRsvp, eventsV1RsvpRsvp_universal_d_GetRsvpOptions as GetRsvpOptions, eventsV1RsvpRsvp_universal_d_createRsvp as createRsvp, eventsV1RsvpRsvp_universal_d_CreateRsvpOptions as CreateRsvpOptions, eventsV1RsvpRsvp_universal_d_updateRsvp as updateRsvp, eventsV1RsvpRsvp_universal_d_UpdateRsvpOptions as UpdateRsvpOptions, eventsV1RsvpRsvp_universal_d_bulkUpdateRsvp as bulkUpdateRsvp, eventsV1RsvpRsvp_universal_d_BulkUpdateRsvpOptions as BulkUpdateRsvpOptions, eventsV1RsvpRsvp_universal_d_deleteRsvp as deleteRsvp, eventsV1RsvpRsvp_universal_d_DeleteRsvpOptions as DeleteRsvpOptions, eventsV1RsvpRsvp_universal_d_checkInRsvp as checkInRsvp, eventsV1RsvpRsvp_universal_d_CheckInRsvpOptions as CheckInRsvpOptions, eventsV1RsvpRsvp_universal_d_deleteRsvpCheckIn as deleteRsvpCheckIn, eventsV1RsvpRsvp_universal_d_DeleteRsvpCheckInOptions as DeleteRsvpCheckInOptions, };\n }\n interface TicketDefinition$2 {\n /**\n * Ticket definition ID.\n * @readonly\n */\n _id?: string | null;\n /** Event ID to which the ticket definition belongs. */\n eventId?: string | null;\n /**\n * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time when the ticket definition was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the ticket definition was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Ticket definition name. */\n name?: string | null;\n /** Ticket definition description. */\n description?: string | null;\n /** Ticket definition policy. */\n policyText?: string | null;\n /** Whether this ticket definition is hidden to site visitors and can't be purchased. */\n hidden?: boolean;\n /**\n * Whether the ticket has a limited maximum quantity.\n * @readonly\n */\n limited?: boolean;\n /** The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead. */\n initialLimit?: number | null;\n /**\n * The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.\n * @readonly\n */\n actualLimit?: number | null;\n /** Ticket pricing method. */\n pricingMethod?: PricingMethod;\n /**\n * Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:\n * - `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.\n * - `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total.\n */\n feeType?: Type$3;\n /** Ticket sale period. */\n salePeriod?: SalePeriod;\n /**\n * Ticket sale status. Possible values:\n * - `SALE_SCHEDULED`: Tickets are not on sale yet.\n * - `SALE_STARTED`: Tickets are on sale.\n * - `SALE_ENDED`: Tickets are not on sale.\n * @readonly\n */\n saleStatus?: SaleStatusEnumStatus;\n /**\n * Ticket sales information.
\n * **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.\n */\n salesDetails?: SalesDetails;\n /**\n * Number of tickets that can be purchased per checkout.
\n * **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.\n * @readonly\n */\n limitPerCheckout?: number | null;\n }\n interface PricingMethod extends PricingMethodPriceOneOf {\n /** Same ticket price for everyone. */\n fixedPrice?: CommonMoney;\n /** Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout. */\n guestPrice?: CommonMoney;\n /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */\n pricingOptions?: PricingOptions$2;\n /**\n * Ticket price type. Possible values:\n * - `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`.\n * - `DONATION`: All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method.\n * @readonly\n */\n pricingType?: PricingTypeEnumType;\n /**\n * Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.\n * @readonly\n */\n free?: boolean;\n }\n /** @oneof */\n interface PricingMethodPriceOneOf {\n /** Same ticket price for everyone. */\n fixedPrice?: CommonMoney;\n /** Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout. */\n guestPrice?: CommonMoney;\n /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */\n pricingOptions?: PricingOptions$2;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface CommonMoney {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */\n currency?: string;\n }\n interface PricingOptions$2 {\n /** Ticket price option details. */\n optionDetails?: OptionDetails[];\n }\n interface OptionDetails {\n /** Ticket price option ID. */\n optionId?: string | null;\n /** Ticket price option name, such as \"Child Ticket\". */\n name?: string | null;\n /** Ticket price. */\n price?: CommonMoney;\n }\n enum PricingTypeEnumType {\n UNKNOWN_PRICING_TYPE = \"UNKNOWN_PRICING_TYPE\",\n STANDARD = \"STANDARD\",\n DONATION = \"DONATION\"\n }\n enum Type$3 {\n UNKNOWN_FEE_TYPE = \"UNKNOWN_FEE_TYPE\",\n /** Seller absorbs the fee. It is deducted from the ticket price. */\n FEE_INCLUDED = \"FEE_INCLUDED\",\n /** Fee is added to the ticket price at checkout. */\n FEE_ADDED_AT_CHECKOUT = \"FEE_ADDED_AT_CHECKOUT\",\n /** Service fee is not collected - available only for free tickets and legacy users. */\n NO_FEE = \"NO_FEE\"\n }\n interface SalePeriod {\n /** Ticket sale start timestamp. */\n startDate?: Date;\n /** Ticket sale end timestamp. */\n endDate?: Date;\n /** Whether to display the ticket if it's not available to buy. */\n displayNotOnSale?: boolean;\n }\n enum SaleStatusEnumStatus {\n UNKNOWN_SALE_STATUS = \"UNKNOWN_SALE_STATUS\",\n /** Ticket sale is scheduled to start */\n SALE_SCHEDULED = \"SALE_SCHEDULED\",\n /** Ticket sale has started */\n SALE_STARTED = \"SALE_STARTED\",\n /** Ticket sale has ended */\n SALE_ENDED = \"SALE_ENDED\"\n }\n interface SalesDetails {\n /**\n * Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.\n * @readonly\n */\n unsoldCount?: number | null;\n /**\n * Number of purchased tickets.\n * @readonly\n */\n soldCount?: number | null;\n /**\n * Number of reserved tickets.\n * @readonly\n */\n reservedCount?: number | null;\n /**\n * Whether the tickets are sold out.\n * @readonly\n */\n soldOut?: boolean | null;\n }\n interface InvalidateCache extends InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n }\n interface App {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface GetTicketDefinitionSummaryRequest {\n /** Ticket definition id. */\n ticketDefinitionId?: string | null;\n }\n interface GetTicketDefinitionSummaryResponse {\n /** Summary. */\n summary?: TicketDefinitionSummary;\n }\n interface TicketDefinitionSummary {\n /**\n * Ticket definition ID.\n * @readonly\n */\n definitionId?: string | null;\n /**\n * Event ID to which the ticket definition summary belongs.\n * @readonly\n */\n eventId?: string | null;\n /**\n * Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Reserved count.\n * @readonly\n */\n reservedCount?: number;\n /**\n * Sold count.\n * @readonly\n */\n soldCount?: number;\n /**\n * Paid exists.\n * @readonly\n */\n paidExists?: boolean;\n }\n interface ListEventTicketingSummaryRequest {\n /** Event ID. */\n eventId?: string[];\n }\n interface ListEventTicketingSummaryResponse {\n /** Ticketing summaries. */\n summaries?: EventTicketingSummary[];\n }\n interface EventTicketingSummary {\n /**\n * Event ID to which the ticketing summary belongs.\n * @readonly\n */\n eventId?: string | null;\n /**\n * Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Whether all tickets are sold for this event.\n * @readonly\n */\n soldOut?: boolean | null;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: CommonMoney;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: CommonMoney;\n /** Currency used in event transactions. */\n currency?: string | null;\n /**\n * Formatted price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPriceFormatted?: string | null;\n /**\n * Formatted price of highest priced ticket.\n * @readonly\n */\n highestTicketPriceFormatted?: string | null;\n }\n interface DomainEvent$4 extends DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n }\n interface EntityCreatedEvent$4 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$4 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$4 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface Empty$3 {\n }\n interface ReservationCreated$1 {\n /** Reservation created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /**\n * Reservation ID.\n * Can be used to retrieve a reservation invoice.\n */\n reservationId?: string;\n /** Reservation expiration timestamp. */\n expires?: Date;\n /** Reservation status. */\n status?: ReservationStatus$1;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity$1[];\n /** Reservation update timestamp. */\n _updatedDate?: Date;\n /** Reservation counts. */\n counts?: ReservationCount$1[];\n }\n enum ReservationStatus$1 {\n /**\n * Reservation is pending confirmation.\n * The reservation will expire after the expiration due time.\n */\n RESERVATION_PENDING = \"RESERVATION_PENDING\",\n /** The reservation was confirmed and will not expire. */\n RESERVATION_CONFIRMED = \"RESERVATION_CONFIRMED\",\n /** The reservation was canceled because of non payment. */\n RESERVATION_CANCELED = \"RESERVATION_CANCELED\",\n /** The reservation was canceled manually by the buyer. */\n RESERVATION_CANCELED_MANUALLY = \"RESERVATION_CANCELED_MANUALLY\",\n /** The reservation has expired. */\n RESERVATION_EXPIRED = \"RESERVATION_EXPIRED\"\n }\n interface TicketQuantity$1 {\n /** Ticket definition ID. */\n ticketDefinitionId?: string | null;\n /** Quantity. */\n quantity?: number | null;\n /** Quantity update timestamp. */\n _updatedDate?: Date;\n }\n interface ReservationCount$1 {\n /** Reservation Count snapshot timestamp. */\n timestamp?: Date;\n /** Ticket Definition ID. */\n ticketDefinitionId?: string;\n /** Confirmed reservation count. */\n confirmedCount?: number;\n /** Pending reservation count. */\n pendingCount?: number;\n /** True if paid ticket reservation exist. */\n paidExists?: boolean;\n }\n interface ReservationUpdated$1 {\n /** Reservation updated timestamp. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /**\n * Reservation ID.\n * Can be used to retrieve a reservation invoice.\n */\n reservationId?: string;\n /** Reservation status. */\n status?: ReservationStatus$1;\n /** Reservation expiration timestamp. */\n expires?: Date;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity$1[];\n /** Reservation update timestamp. */\n _updatedDate?: Date;\n /** Reservation counts. */\n counts?: ReservationCount$1[];\n }\n interface EventDeleted$2 {\n /** Event deleted timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n }\n interface UpdateEventTicketingSummaryRequest {\n /** Event ID. */\n eventId?: string;\n }\n interface MessageEnvelope$6 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$6;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$6 extends IdentificationDataIdOneOf$6 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$6;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$6 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$6 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface CreateTicketDefinitionRequest$1 {\n /** Ticket definition info. */\n ticketDefinition: TicketDefinition$2;\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n enum Field {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */\n SALES_DETAILS = \"SALES_DETAILS\"\n }\n interface CreateTicketDefinitionResponse$1 {\n /** Created ticket definition. */\n ticketDefinition?: TicketDefinition$2;\n }\n interface UpdateTicketDefinitionRequest$1 {\n /** Ticket definition to update. */\n ticketDefinition: TicketDefinition$2;\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n interface UpdateTicketDefinitionResponse$1 {\n /** The updated ticket definition. */\n ticketDefinition?: TicketDefinition$2;\n }\n interface SalePeriodUpdated {\n /** Ticket definition sale period after update. */\n afterUpdate?: SalePeriod;\n }\n interface GetTicketDefinitionRequest$1 {\n /** Ticket definition ID. */\n ticketDefinitionId: string;\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n interface GetTicketDefinitionResponse$1 {\n /** The requested ticket definition. */\n ticketDefinition?: TicketDefinition$2;\n }\n interface DeleteTicketDefinitionRequest$1 {\n /** ID of the ticket definition to delete. */\n ticketDefinitionId: string;\n }\n interface DeleteTicketDefinitionResponse$1 {\n }\n interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {\n /** Move the given `definitionId` before the referenced ticket definition. */\n beforeDefinitionId?: string;\n /** Move the given `definitionId` after the referenced ticket definition. */\n afterDefinitionId?: string;\n /** Event ID. */\n eventId: string;\n /** Ticket definition ID. */\n ticketDefinitionId: string;\n }\n /** @oneof */\n interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {\n /** Move the given `definitionId` before the referenced ticket definition. */\n beforeDefinitionId?: string;\n /** Move the given `definitionId` after the referenced ticket definition. */\n afterDefinitionId?: string;\n }\n interface ReorderTicketDefinitionsResponse {\n }\n interface UpdateTicketDefinitionSortIndexRequest {\n /** Ticket definition ID */\n ticketDefinitionId?: string;\n /** The revision of the ticket definition */\n revision?: string;\n /** the sort index of a ticket definition to set */\n sortIndex?: number;\n /** Requested fields. */\n fields?: Field[];\n }\n interface UpdateTicketDefinitionSortIndexResponse {\n /** the updated ticket definition */\n ticketDefinition?: TicketDefinition$2;\n }\n interface QueryTicketDefinitionsRequest$1 {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query: QueryV2$5;\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$5;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */\n cursorPaging?: CursorPaging$4;\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\", \"fieldName2\":{\"$operator\":\"value2\"} }`.

**Example:**
`\"filter\" : { \"id\": \"2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5\", \"revision\": {\"$ne\":\"1\"} }` */\n filter?: Record | null;\n /** Sort object in the following format:
`[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`

**Example:**
`[{\"fieldName\":\"createdDate\",\"direction\":\"DESC\"}]`

See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information. */\n sort?: Sorting$5[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$5 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$5;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */\n cursorPaging?: CursorPaging$4;\n }\n interface Sorting$5 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Defaults to `ASC` */\n order?: SortOrder$5;\n }\n enum SortOrder$5 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$5 {\n /** Number of items to load per page. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$4 {\n /** Number of items to load per page. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryTicketDefinitionsResponse$1 {\n /** List of ticket definitions. */\n ticketDefinitions?: TicketDefinition$2[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadataV2$5;\n }\n interface PagingMetadataV2$5 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$5;\n }\n interface Cursors$5 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryAvailableTicketDefinitionsRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query: QueryV2$5;\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n interface QueryAvailableTicketDefinitionsResponse {\n /** List of ticket definitions. */\n ticketDefinitions?: TicketDefinition$2[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadataV2$5;\n }\n interface CountTicketDefinitionsRequest {\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`. */\n filter?: Record | null;\n /**\n * Parameters to count ticket definitions by.\n *\n * - Max: 20 facets.\n */\n facet?: string[];\n }\n interface CountTicketDefinitionsResponse {\n /** Metadata for the paginated results. */\n metadata?: PagingMetadataV2$5;\n /** Filter facets. */\n facets?: Record;\n }\n interface FacetCounts$4 {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface CountAvailableTicketDefinitionsRequest {\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`. */\n filter?: Record | null;\n }\n interface CountAvailableTicketDefinitionsResponse {\n /** Metadata for the paginated results. */\n metadata?: PagingMetadataV2$5;\n /** Filter facets. */\n facets?: Record;\n }\n interface BulkDeleteTicketDefinitionsByFilterRequest {\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.

**Example:**
`\"filter\" : { \"eventId\": \"3d3d5c04-ece0-45a8-85f0-11a58edaa192\" }` */\n filter: Record | null;\n }\n interface BulkDeleteTicketDefinitionsByFilterResponse {\n }\n interface ChangeCurrencyRequest$1 {\n /** Event ID. */\n eventId: string;\n /** Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */\n currency: string;\n }\n interface ChangeCurrencyResponse$1 {\n }\n interface BulkCopyTicketDefinitionsByEventIdRequest$1 {\n /** Origin instance ID. */\n originInstanceId?: string | null;\n /** Origin Event ID. */\n originEventId?: string;\n /** Target Event ID. */\n targetEventId?: string;\n }\n interface BulkCopyTicketDefinitionsByEventIdResponse$1 {\n /** Copied ticket definitions. */\n definitions?: CopiedTicketDefinition$1[];\n }\n interface CopiedTicketDefinition$1 {\n /** Origin Ticket definition ID. */\n originTicketDefinitionId?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n }\n interface EventCanceled$1 {\n /** Event canceled timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event title */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n }\n interface EventEnded$1 {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n }\n interface EventCreated$1 {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$4;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$3;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus$3;\n /** Instance ID. Indicates the original app instance which current event was derived from. */\n derivedFromInstanceId?: string | null;\n /** Event ID. Indicates the original event which current event was derived from. */\n derivedFromEventId?: string | null;\n /** Event that was created. */\n event?: Event$2;\n }\n interface Location$4 {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates$3;\n /** Single line address representation. */\n address?: string | null;\n /** Location type. */\n type?: LocationType$4;\n /**\n * Full address derived from formatted single line `address`.\n * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.\n * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.\n *\n * Migration notes:\n * - `full_address.formatted_address` is equivalent to `address`.\n * - `full_address.geocode` is equivalent to `coordinates`.\n */\n fullAddress?: Address$5;\n /**\n * Defines event location as TBD (To Be Determined).\n * When event location is not yet defined, `name` is displayed instead of location address.\n * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.\n */\n tbd?: boolean | null;\n }\n interface MapCoordinates$3 {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationType$4 {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$5 extends AddressStreetOneOf$5 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$5;\n /** Main address line (usually street and number) as free text */\n addressLine1?: string | null;\n /** country code */\n country?: string | null;\n /** subdivision (usually state or region) code according to ISO 3166-2 */\n subdivision?: string | null;\n /** city name */\n city?: string | null;\n /** zip/postal code */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */\n addressLine2?: string | null;\n /** A string containing the human-readable address of this location */\n formatted?: string | null;\n /** coordinates of the physical address */\n location?: AddressLocation$5;\n }\n /** @oneof */\n interface AddressStreetOneOf$5 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$5;\n /** Main address line (usually street and number) as free text */\n addressLine?: string | null;\n }\n interface StreetAddress$5 {\n /** street number */\n number?: string;\n /** street name */\n name?: string;\n }\n interface AddressLocation$5 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$5 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n }\n enum SubdivisionType$5 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface ScheduleConfig$3 {\n /**\n * Defines event as TBD (To Be Determined) schedule.\n * When event time is not yet defined, TBD message is displayed instead of event start and end times.\n * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.\n */\n scheduleTbd?: boolean;\n /** TBD message. */\n scheduleTbdMessage?: string | null;\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether end date is hidden in the formatted schedule. */\n endDateHidden?: boolean;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n /** Event recurrences. */\n recurrences?: Recurrences$4;\n }\n interface Recurrences$4 {\n /** Event occurrences. */\n occurrences?: Occurrence$4[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status$4;\n }\n interface Occurrence$4 {\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n }\n enum Status$4 {\n /** Event occurs only once. */\n ONE_TIME = \"ONE_TIME\",\n /** Event is recurring. */\n RECURRING = \"RECURRING\",\n /** Marks the next upcoming occurrence of the recurring event. */\n RECURRING_NEXT = \"RECURRING_NEXT\",\n /** Marks the most recent ended occurrence of the recurring event. */\n RECURRING_LAST_ENDED = \"RECURRING_LAST_ENDED\",\n /** Marks the most recent canceled occurrence of the recurring event. */\n RECURRING_LAST_CANCELED = \"RECURRING_LAST_CANCELED\"\n }\n enum EventStatus$3 {\n /** Event is public and scheduled to start */\n SCHEDULED = \"SCHEDULED\",\n /** Event has started */\n STARTED = \"STARTED\",\n /** Event has ended */\n ENDED = \"ENDED\",\n /** Event was canceled */\n CANCELED = \"CANCELED\",\n /** Event is not public and needs to be published */\n DRAFT = \"DRAFT\"\n }\n interface Event$2 {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location$4;\n /** Event scheduling. */\n scheduling?: Scheduling$2;\n /** Event title. */\n title?: string;\n /** Event description. */\n description?: string;\n /** Rich-text content displayed in Wix UI - \"About Event\" section (HTML). */\n about?: string;\n /** Main event image. */\n mainImage?: string;\n /** Event slug URL (generated from event title). */\n slug?: string;\n /** ISO 639-1 language code of the event (used in content translations). */\n language?: string;\n /** Event creation timestamp. */\n created?: Date;\n /** Event modified timestamp. */\n modified?: Date;\n /** Event status. */\n status?: EventStatus$3;\n /** RSVP or ticketing registration details. */\n registration?: Registration$2;\n /** \"Add to calendar\" URLs. */\n calendarLinks?: CalendarLinks$3;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl$2;\n /** Event registration form. */\n form?: Form$2;\n /** Event dashboard summary of RSVP / ticket sales. */\n dashboard?: Dashboard$4;\n /** Instance ID of the site where event is hosted. */\n instanceId?: string;\n /** Guest list configuration. */\n guestListConfig?: GuestListConfig$2;\n /** Event creator user ID. */\n userId?: string;\n /** Event discussion feed. For internal use. */\n feed?: Feed$2;\n /** Online conferencing details. */\n onlineConferencing?: OnlineConferencing$2;\n /** SEO settings. */\n seoSettings?: SeoSettings$2;\n /** Assigned contacts label key. */\n assignedContactsLabel?: string | null;\n /** Agenda details. */\n agenda?: Agenda$2;\n /** Categories this event is assigned to. */\n categories?: Category$2[];\n /** Visual settings for event. */\n eventDisplaySettings?: EventDisplaySettings$2;\n }\n interface Scheduling$2 {\n /** Schedule configuration. */\n config?: ScheduleConfig$3;\n /** Formatted schedule representation. */\n formatted?: string;\n /** Formatted start date of the event (empty for TBD schedules). */\n startDateFormatted?: string;\n /** Formatted start time of the event (empty for TBD schedules). */\n startTimeFormatted?: string;\n /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */\n endDateFormatted?: string;\n /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */\n endTimeFormatted?: string;\n }\n interface Registration$2 {\n /** Event type. */\n type?: EventType$3;\n /** Event registration status. */\n status?: RegistrationStatus$2;\n /** RSVP collection details. */\n rsvpCollection?: RsvpCollection$2;\n /** Ticketing details. */\n ticketing?: Ticketing$2;\n /** External registration details. */\n external?: ExternalEvent$2;\n /** Types of users allowed to register. */\n restrictedTo?: VisitorType$2;\n /** Initial event type which was set when creating an event. */\n initialType?: EventType$3;\n }\n enum EventType$3 {\n /** Type not available for this request fieldset */\n NA_EVENT_TYPE = \"NA_EVENT_TYPE\",\n /** Registration via RSVP */\n RSVP = \"RSVP\",\n /** Registration via ticket purchase */\n TICKETS = \"TICKETS\",\n /** External registration */\n EXTERNAL = \"EXTERNAL\",\n /** Registration not available */\n NO_REGISTRATION = \"NO_REGISTRATION\"\n }\n enum RegistrationStatus$2 {\n /** Registration status is not applicable */\n NA_REGISTRATION_STATUS = \"NA_REGISTRATION_STATUS\",\n /** Registration to event is closed */\n CLOSED = \"CLOSED\",\n /** Registration to event is closed manually */\n CLOSED_MANUALLY = \"CLOSED_MANUALLY\",\n /** Registration is open via RSVP */\n OPEN_RSVP = \"OPEN_RSVP\",\n /** Registration to event waitlist is open via RSVP */\n OPEN_RSVP_WAITLIST = \"OPEN_RSVP_WAITLIST\",\n /** Registration is open via ticket purchase */\n OPEN_TICKETS = \"OPEN_TICKETS\",\n /** Registration is open via external URL */\n OPEN_EXTERNAL = \"OPEN_EXTERNAL\",\n /** Registration will be open via RSVP */\n SCHEDULED_RSVP = \"SCHEDULED_RSVP\"\n }\n interface RsvpCollection$2 {\n /** RSVP collection configuration. */\n config?: RsvpCollectionConfig$2;\n }\n interface RsvpCollectionConfig$2 {\n /** Defines the supported RSVP statuses. */\n rsvpStatusOptions?: RsvpStatusOptions$2;\n /**\n * Total guest limit available to register to the event.\n * Additional guests per RSVP are counted towards total guests.\n */\n limit?: number | null;\n /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */\n waitlist?: boolean;\n /** Registration start timestamp. */\n startDate?: Date;\n /** Registration end timestamp. */\n endDate?: Date;\n }\n enum RsvpStatusOptions$2 {\n /** Only YES RSVP status is available for RSVP registration */\n YES_ONLY = \"YES_ONLY\",\n /** YES and NO RSVP status options are available for the registration */\n YES_AND_NO = \"YES_AND_NO\"\n }\n interface Ticketing$2 {\n /** Deprecated. */\n lowestPrice?: string | null;\n /** Deprecated. */\n highestPrice?: string | null;\n /** Currency used in event transactions. */\n currency?: string | null;\n /** Ticketing configuration. */\n config?: TicketingConfig$2;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: Money$5;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: Money$5;\n /**\n * Formatted price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPriceFormatted?: string | null;\n /**\n * Formatted price of highest priced ticket.\n * @readonly\n */\n highestTicketPriceFormatted?: string | null;\n /**\n * Whether all tickets are sold for this event.\n * @readonly\n */\n soldOut?: boolean | null;\n }\n interface TicketingConfig$2 {\n /** Whether the form must be filled out separately for each ticket. */\n guestAssignedTickets?: boolean;\n /** Tax configuration. */\n taxConfig?: TaxConfig$2;\n /** Limit of tickets that can be purchased per order, default 20. */\n ticketLimitPerOrder?: number;\n /** Duration for which the tickets being bought are reserved. */\n reservationDurationInMinutes?: number | null;\n }\n interface TaxConfig$2 {\n /** Tax application settings. */\n type?: TaxType$4;\n /** Tax name. */\n name?: string | null;\n /** Tax rate (e.g.,`21.55`). */\n rate?: string | null;\n /** Applies taxes for donations, default true. */\n appliesToDonations?: boolean | null;\n }\n enum TaxType$4 {\n /** Tax is included in the ticket price */\n INCLUDED = \"INCLUDED\",\n /** Tax is added to the order at the checkout */\n ADDED = \"ADDED\",\n /** Tax is added to the final total at the checkout */\n ADDED_AT_CHECKOUT = \"ADDED_AT_CHECKOUT\"\n }\n interface Money$5 {\n /** *Deprecated:** Use `value` instead. */\n amount?: string;\n /** ISO 4217 format of the currency i.e. `USD`. */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface ExternalEvent$2 {\n /** External event registration URL. */\n registration?: string;\n }\n enum VisitorType$2 {\n /** Site visitor (including member) */\n VISITOR = \"VISITOR\",\n /** Site member */\n MEMBER = \"MEMBER\",\n /** Site visitor or member */\n VISITOR_OR_MEMBER = \"VISITOR_OR_MEMBER\"\n }\n interface CalendarLinks$3 {\n /** \"Add to Google calendar\" URL. */\n google?: string;\n /** \"Download ICS calendar file\" URL. */\n ics?: string;\n }\n /** Site URL components */\n interface SiteUrl$2 {\n /**\n * Base URL. For premium sites, this will be the domain.\n * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)\n */\n base?: string;\n /** The path to that page - e.g `/my-events/weekly-meetup-2` */\n path?: string;\n }\n /**\n * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).\n * It also contains customizable messages and labels.\n *\n *\n * A form is an ordered list of controls (blocks), which accept guest information into a field input.\n *\n * Each control contains one or more nested inputs. For example, `Name` control has two inputs:\n * - First Name\n * - Last Name\n *\n * By default, name and email controls are always required and are pinned to the top of the form.\n */\n interface Form$2 {\n /** Nested fields as an ordered list. */\n controls?: InputControl$2[];\n /** Set of configured form messages. */\n messages?: FormMessages$2;\n }\n /**\n * A block of nested fields.\n * Used to aggregate similar inputs like First Name and Last Name.\n */\n interface InputControl$2 {\n /** Field control type. */\n type?: InputControlType$2;\n /** Whether control is mandatory (such as name & email). When true, only label can be changed. */\n system?: boolean;\n /** Deprecated: Use `id`. */\n name?: string;\n /** Child inputs. */\n inputs?: Input$2[];\n /** Deprecated: use `inputs.label`. */\n label?: string;\n /** Field controls are sorted by this value in ascending order. */\n orderIndex?: number;\n /** Unique control ID. */\n _id?: string;\n /**\n * Whether input control is deleted.\n * @readonly\n */\n deleted?: boolean | null;\n }\n enum InputControlType$2 {\n /** Single text value field. */\n INPUT = \"INPUT\",\n /** Single text value field. */\n TEXTAREA = \"TEXTAREA\",\n /** Single-choice field of predefined values. */\n DROPDOWN = \"DROPDOWN\",\n /** Single-choice field of predefined values. */\n RADIO = \"RADIO\",\n /** Multiple-choice field of predefined values. */\n CHECKBOX = \"CHECKBOX\",\n /** First and last name fields. */\n NAME = \"NAME\",\n /** Additional guests and respective guest names fields. */\n GUEST_CONTROL = \"GUEST_CONTROL\",\n /** Single-line address field. */\n ADDRESS_SHORT = \"ADDRESS_SHORT\",\n /** Full address field. */\n ADDRESS_FULL = \"ADDRESS_FULL\",\n /** Year, month and day fields. */\n DATE = \"DATE\"\n }\n /** An input of one or multiple text values */\n interface Input$2 {\n /** Field name. */\n name?: string;\n /** Deprecated: use `ValueType.TEXT_ARRAY`. */\n array?: boolean;\n /** Main field label */\n label?: string;\n /** Additional labels for multi-valued fields such as address. */\n additionalLabels?: Record;\n /** Predefined choice options for fields, such as dropdown. */\n options?: string[];\n /** Whether field is mandatory. */\n mandatory?: boolean;\n /** Maximum number of accepted characters (relevant for text fields). */\n maxLength?: number;\n /**\n * Type which determines field format.\n * Used to validate submitted response.\n */\n type?: ValueType$2;\n /**\n * A maximum accepted values for array input.\n * Only applicable for inputs of valueType: TEXT_ARRAY.\n */\n maxSize?: number | null;\n /**\n * Preselected option.\n * Currently only applicable for dropdown.\n */\n defaultOptionSelection?: OptionSelection$2;\n /**\n * Additional labels for multi-valued fields such as address.\n * @readonly\n */\n labels?: Label$2[];\n }\n enum ValueType$2 {\n TEXT = \"TEXT\",\n NUMBER = \"NUMBER\",\n TEXT_ARRAY = \"TEXT_ARRAY\",\n DATE_TIME = \"DATE_TIME\",\n ADDRESS = \"ADDRESS\"\n }\n /**\n * Describes initially selected option when an input has multiple choices.\n * Defaults to first (0th) option if not configured.\n */\n interface OptionSelection$2 extends OptionSelectionSelectedOptionOneOf$2 {\n /** 0-based index from predefined `input.options` which is selected initially. */\n optionIndex?: number;\n /**\n * Placeholder hint describing expected choices (such as \"Please select\").\n * Considered an empty choice.\n */\n placeholderText?: string;\n }\n /** @oneof */\n interface OptionSelectionSelectedOptionOneOf$2 {\n /** 0-based index from predefined `input.options` which is selected initially. */\n optionIndex?: number;\n /**\n * Placeholder hint describing expected choices (such as \"Please select\").\n * Considered an empty choice.\n */\n placeholderText?: string;\n }\n interface Label$2 {\n /** Field name. */\n name?: string;\n /** Field label. */\n label?: string;\n }\n /**\n * Defines form messages shown in UI before, during, and after registration flow.\n * It enables configuration of form titles, response labels, \"thank you\" messages, and call-to-action texts.\n */\n interface FormMessages$2 {\n /** RSVP form messages. */\n rsvp?: RsvpFormMessages$2;\n /** Checkout form messages. */\n checkout?: CheckoutFormMessages$2;\n /** Messages shown when event registration is closed. */\n registrationClosed?: RegistrationClosedMessages$2;\n /** Messages shown when event tickets are unavailable. */\n ticketsUnavailable?: TicketsUnavailableMessages$2;\n }\n interface RsvpFormMessages$2 {\n /** Label text indicating RSVP `YES` response. */\n rsvpYesOption?: string;\n /** Label text indicating RSVP `NO` response. */\n rsvpNoOption?: string;\n /** Messages shown for RSVP = `YES`. */\n positiveMessages?: Positive$2;\n /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */\n waitlistMessages?: Positive$2;\n /** Messages shown for RSVP = `NO`. */\n negativeMessages?: Negative$2;\n /** \"Submit form\" call-to-action label text. */\n submitActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface PositiveResponseConfirmation$2 {\n /** Confirmation message title. */\n title?: string;\n /** Confirmation message text. */\n message?: string;\n /** \"Add to calendar\" call-to-action label text. */\n addToCalendarActionLabel?: string;\n /** \"Share event\" call-to-action label text. */\n shareActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface NegativeResponseConfirmation$2 {\n /** Confirmation message title. */\n title?: string;\n /** \"Share event\" call-to-action label text. */\n shareActionLabel?: string;\n }\n /** Set of messages shown during registration when RSVP response is positive. */\n interface Positive$2 {\n /** Main form title for positive response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: PositiveResponseConfirmation$2;\n }\n /** A set of messages shown during registration with negative response */\n interface Negative$2 {\n /** Main form title for negative response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: NegativeResponseConfirmation$2;\n }\n interface CheckoutFormMessages$2 {\n /** Main form title for response. */\n title?: string;\n /** Submit form call-to-action label text. */\n submitActionLabel?: string;\n /** Confirmation messages shown after checkout. */\n confirmation?: ResponseConfirmation$2;\n }\n /** Confirmation messages shown after checkout. */\n interface ResponseConfirmation$2 {\n /** Confirmation message title. */\n title?: string;\n /** Confirmation message text. */\n message?: string;\n /** \"Download tickets\" call-to-action label text. */\n downloadTicketsLabel?: string;\n /** \"Add to calendar\" call-to-action label text. */\n addToCalendarLabel?: string;\n /** \"Share event\" call-to-action label text. */\n shareEventLabel?: string;\n }\n interface RegistrationClosedMessages$2 {\n /** Message shown when event registration is closed. */\n message?: string;\n /** \"Explore other events\" call-to-action label text. */\n exploreEventsActionLabel?: string;\n }\n interface TicketsUnavailableMessages$2 {\n /** Message shown when event tickets are unavailable. */\n message?: string;\n /** \"Explore other events\" call-to-action label text. */\n exploreEventsActionLabel?: string;\n }\n interface Dashboard$4 {\n /** Guest RSVP summary. */\n rsvpSummary?: RsvpSummary$2;\n /**\n * Summary of revenue and tickets sold.\n * (Archived orders are not included).\n */\n ticketingSummary?: TicketingSummary$2;\n }\n interface RsvpSummary$2 {\n /** Total number of RSVPs. */\n total?: number;\n /** Number of RSVPs with status `YES`. */\n yes?: number;\n /** Number of RSVPs with status `NO`. */\n no?: number;\n /** Number of RSVPs in waitlist. */\n waitlist?: number;\n }\n interface TicketingSummary$2 {\n /** Number of tickets sold. */\n tickets?: number;\n /**\n * Total revenue, excluding fees.\n * (taxes and payment provider fees are not deducted.)\n */\n revenue?: Money$5;\n /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */\n currencyLocked?: boolean;\n /** Number of orders placed. */\n orders?: number;\n /** Total balance of confirmed transactions. */\n totalSales?: Money$5;\n }\n interface GuestListConfig$2 {\n /** Whether members can see other members attending the event (defaults to true). */\n publicGuestList?: boolean;\n }\n interface Feed$2 {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing$2 {\n config?: OnlineConferencingConfig$2;\n session?: OnlineConferencingSession$2;\n }\n interface OnlineConferencingConfig$2 {\n /**\n * Whether online conferencing is enabled (not supported for TBD schedules).\n * When enabled, links to join conferencing are generated and provided to guests.\n */\n enabled?: boolean;\n /** Conferencing provider ID. */\n providerId?: string | null;\n /** Conference type */\n conferenceType?: ConferenceType$2;\n }\n enum ConferenceType$2 {\n /** Everyone in the meeting can publish and subscribe video and audio. */\n MEETING = \"MEETING\",\n /** Guests can only subscribe to video and audio. */\n WEBINAR = \"WEBINAR\"\n }\n interface OnlineConferencingSession$2 {\n /**\n * Link for event host to start the online conference session.\n * @readonly\n */\n hostLink?: string;\n /**\n * Link for guests to join the online conference session.\n * @readonly\n */\n guestLink?: string;\n /**\n * The password required to join online conferencing session (when relevant).\n * @readonly\n */\n password?: string | null;\n /**\n * Indicates that session was created successfully on providers side.\n * @readonly\n */\n sessionCreated?: boolean | null;\n /**\n * Unique session id\n * @readonly\n */\n sessionId?: string | null;\n }\n interface SeoSettings$2 {\n /** URL slug */\n slug?: string;\n /** Advanced SEO data */\n advancedSeoData?: SeoSchema$2;\n /**\n * Hidden from SEO Site Map\n * @readonly\n */\n hidden?: boolean | null;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema$2 {\n /** SEO tag information. */\n tags?: Tag$2[];\n /** SEO general settings. */\n settings?: Settings$2;\n }\n interface Keyword$2 {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n }\n interface Tag$2 {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings$2 {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword$2[];\n }\n interface Agenda$2 {\n /** Whether the schedule is enabled for the event. */\n enabled?: boolean;\n /**\n * Agenda page URL.\n * @readonly\n */\n pageUrl?: SiteUrl$2;\n }\n interface Category$2 {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category name. */\n name?: string;\n /**\n * Category creation timestamp.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Assigned and assigned draft event counts.\n * @readonly\n */\n counts?: CategoryCounts$2;\n /**\n * Category state. Default - MANUAL.\n * WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.\n * Field will be ignored on update requests.\n */\n states?: CategoryStateState[];\n }\n interface CategoryCounts$2 {\n /** Assigned events count. Deleted events are excluded. */\n assignedEventsCount?: number | null;\n /** Assigned draft events count. */\n assignedDraftEventsCount?: number | null;\n }\n enum CategoryStateState {\n /** Created manually by the user. */\n MANUAL = \"MANUAL\",\n /** Created automatically. */\n AUTO = \"AUTO\",\n /** Created when publishing recurring events. */\n RECURRING_EVENT = \"RECURRING_EVENT\",\n /** Category is hidden. */\n HIDDEN = \"HIDDEN\",\n /** Category is used to store component events. */\n COMPONENT = \"COMPONENT\"\n }\n interface EventDisplaySettings$2 {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n }\n interface LabellingSettings$2 {\n }\n interface EventUpdated$2 {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$4;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$3;\n /** Event title. */\n title?: string;\n /** Whether schedule configuration was updated. */\n scheduleConfigUpdated?: boolean;\n /** Updated event */\n event?: Event$2;\n }\n interface SeatingPlanCategoriesSummaryUpdated {\n /** Seating plan id */\n seatingPlanId?: string;\n /** External seating plan id */\n externalSeatingPlanId?: string | null;\n /** Ticket counts by category */\n categories?: CategoryDetails[];\n /**\n * Summary revision.\n * @readonly\n */\n revision?: string | null;\n }\n interface CategoryDetails {\n /**\n * Seating plan id\n * @readonly\n */\n seatingPlanId?: string | null;\n /**\n * External seating plan id\n * @readonly\n */\n externalSeatingPlanId?: string | null;\n /**\n * External category id\n * @readonly\n */\n externalCategoryId?: string | null;\n /**\n * Total capacity in the category\n * @readonly\n */\n totalCapacity?: number | null;\n /**\n * Already reserved capacity\n * @readonly\n */\n reserved?: number | null;\n }\n interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned;\n /** A meta site id. */\n metaSiteId?: string;\n /** A meta site version. Monotonically increasing. */\n version?: string;\n /** A timestamp of the event. */\n timestamp?: string;\n /** A list of \"assets\" (applications). The same as MetaSiteContext. */\n assets?: Asset[];\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned;\n }\n interface Asset {\n /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */\n appDefId?: string;\n /** An instance id. For legacy reasons may be UUID or a string. */\n instanceId?: string;\n /** An application state. */\n state?: State$4;\n }\n enum State$4 {\n UNKNOWN = \"UNKNOWN\",\n ENABLED = \"ENABLED\",\n DISABLED = \"DISABLED\",\n PENDING = \"PENDING\",\n DEMO = \"DEMO\"\n }\n interface SiteCreated {\n /** A template identifier (empty if not created from a template). */\n originTemplateId?: string;\n /** An account id of the owner. */\n ownerId?: string;\n /** A context in which meta site was created. */\n context?: SiteCreatedContext;\n /**\n * A meta site id from which this site was created.\n *\n * In case of a creation from a template it's a template id.\n * In case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.\n */\n originMetaSiteId?: string | null;\n /** A meta site name (URL slug). */\n siteName?: string;\n /** A namespace. */\n namespace?: Namespace;\n }\n enum SiteCreatedContext {\n /** A valid option, we don't expose all reasons why site might be created. */\n OTHER = \"OTHER\",\n /** A meta site was created from template. */\n FROM_TEMPLATE = \"FROM_TEMPLATE\",\n /** A meta site was created by copying of the transfferred meta site. */\n DUPLICATE_BY_SITE_TRANSFER = \"DUPLICATE_BY_SITE_TRANSFER\",\n /** A copy of existing meta site. */\n DUPLICATE = \"DUPLICATE\",\n /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */\n OLD_SITE_TRANSFER = \"OLD_SITE_TRANSFER\",\n /** deprecated A meta site was created for Flash editor. */\n FLASH = \"FLASH\"\n }\n enum Namespace {\n UNKNOWN_NAMESPACE = \"UNKNOWN_NAMESPACE\",\n /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */\n WIX = \"WIX\",\n /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n SHOUT_OUT = \"SHOUT_OUT\",\n /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ALBUMS = \"ALBUMS\",\n /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n WIX_STORES_TEST_DRIVE = \"WIX_STORES_TEST_DRIVE\",\n /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n HOTELS = \"HOTELS\",\n /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n CLUBS = \"CLUBS\",\n /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ONBOARDING_DRAFT = \"ONBOARDING_DRAFT\",\n /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_SITE = \"DEV_SITE\",\n /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n LOGOS = \"LOGOS\",\n /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n VIDEO_MAKER = \"VIDEO_MAKER\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n PARTNER_DASHBOARD = \"PARTNER_DASHBOARD\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_CENTER_COMPANY = \"DEV_CENTER_COMPANY\",\n /**\n * A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n *\n * Meta site with this namespace will *not* be shown in a user's site list by default.\n */\n HTML_DRAFT = \"HTML_DRAFT\",\n /**\n * the user-journey for Fitness users who want to start from managing their business instead of designing their website.\n * Will be accessible from Site List and will not have a website app.\n * Once the user attaches a site, the site will become a regular wixsite.\n */\n SITELESS_BUSINESS = \"SITELESS_BUSINESS\",\n /** Belongs to \"strategic products\" company. Supports new product in the creator's economy space. */\n CREATOR_ECONOMY = \"CREATOR_ECONOMY\",\n /** It is to be used in the Business First efforts. */\n DASHBOARD_FIRST = \"DASHBOARD_FIRST\",\n /** Bookings business flow with no site. */\n ANYWHERE = \"ANYWHERE\",\n /** Namespace for Headless Backoffice with no editor */\n HEADLESS = \"HEADLESS\",\n /**\n * Namespace for master site that will exist in parent account that will be referenced by subaccounts\n * The site will be used for account level CSM feature for enterprise\n */\n ACCOUNT_MASTER_CMS = \"ACCOUNT_MASTER_CMS\",\n /** Rise.ai Siteless account management for Gift Cards and Store Credit. */\n RISE = \"RISE\",\n /**\n * As part of the branded app new funnel, users now can create a meta site that will be branded app first.\n * There's a blank site behind the scene but it's blank).\n * The Mobile company will be the owner of this namespace.\n */\n BRANDED_FIRST = \"BRANDED_FIRST\"\n }\n /** Site transferred to another user. */\n interface SiteTransferred {\n /** A previous owner id (user that transfers meta site). */\n oldOwnerId?: string;\n /** A new owner id (user that accepts meta site). */\n newOwnerId?: string;\n }\n /** Soft deletion of the meta site. Could be restored. */\n interface SiteDeleted {\n /** A deletion context. */\n deleteContext?: DeleteContext;\n }\n interface DeleteContext {\n /** When the meta site was deleted. */\n dateDeleted?: Date;\n /** A status. */\n deleteStatus?: DeleteStatus;\n /** A reason (flow). */\n deleteOrigin?: string;\n /** A service that deleted it. */\n initiatorId?: string | null;\n }\n enum DeleteStatus {\n UNKNOWN = \"UNKNOWN\",\n TRASH = \"TRASH\",\n DELETED = \"DELETED\",\n PENDING_PURGE = \"PENDING_PURGE\"\n }\n /** Restoration of the meta site. */\n interface SiteUndeleted {\n }\n /** First publish of a meta site. Or subsequent publish after unpublish. */\n interface SitePublished {\n }\n interface SiteUnpublished {\n /** A list of URLs previously associated with the meta site. */\n urls?: string[];\n }\n interface SiteMarkedAsTemplate {\n }\n interface SiteMarkedAsWixSite {\n }\n interface ServiceProvisioned {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** An instance id from which this instance is originated. */\n originInstanceId?: string;\n /** A version. */\n version?: string | null;\n }\n interface ServiceRemoved {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** A version. */\n version?: string | null;\n }\n /** Rename of the site. Meaning, free public url has been changed as well. */\n interface SiteRenamed {\n /** A new meta site name (URL slug). */\n newSiteName?: string;\n /** A previous meta site name (URL slug). */\n oldSiteName?: string;\n }\n /**\n * Hard deletion of the meta site.\n *\n * Could not be restored. Therefore it's desirable to cleanup data.\n */\n interface SiteHardDeleted {\n /** A deletion context. */\n deleteContext?: DeleteContext;\n }\n interface NamespaceChanged {\n /** A previous namespace. */\n oldNamespace?: Namespace;\n /** A new namespace. */\n newNamespace?: Namespace;\n }\n /** Assigned Studio editor */\n interface StudioAssigned {\n }\n /** Unassigned Studio editor */\n interface StudioUnassigned {\n }\n interface GetTicketDefinitionFromTrashBinRequest {\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Requested fields. Not implemented. */\n fields?: Field[];\n }\n interface GetTicketDefinitionFromTrashBinResponse {\n /** The requested ticket definition. */\n ticketDefinition?: TicketDefinition$2;\n }\n interface ScheduleTimecapsuleTaskRequest {\n /** Definition ID. */\n _id?: string;\n /** Sale period. */\n salePeriod?: SalePeriod;\n }\n interface RescheduleTimecapsuleTaskRequest {\n /** Definition ID. */\n _id?: string;\n /** Sale period. */\n salePeriod?: SalePeriod;\n }\n interface CancelTimecapsuleTaskRequest {\n /** Definition ID. */\n _id?: string;\n }\n /**\n * > **Note:** This function replaces the deprecated `createTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/createticketdefinition).\n *\n *\n * Creates a ticket definition.\n *\n *\n * It is allowed to create up to 100 definitions per event.\n * @param ticketDefinition - Ticket definition info.\n * @public\n * @requiredField ticketDefinition\n * @requiredField ticketDefinition.eventId\n * @requiredField ticketDefinition.feeType\n * @requiredField ticketDefinition.name\n * @requiredField ticketDefinition.pricingMethod\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created ticket definition.\n */\n function createTicketDefinition$1(ticketDefinition: TicketDefinition$2, options?: CreateTicketDefinitionOptions$1): Promise;\n interface CreateTicketDefinitionOptions$1 {\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n /**\n * > **Note:** This function replaces the deprecated `updateTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/updateticketdefinition).\n *\n * Updates a ticket definition.\n *\n *\n * Each time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.\n * @param _id - Ticket definition ID.\n * @public\n * @requiredField _id\n * @requiredField ticketDefinition\n * @requiredField ticketDefinition.revision\n * @param options - Optional fields.\n * @param ticketDefinition - Ticket definition to update.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated ticket definition.\n */\n function updateTicketDefinition$1(_id: string | null, ticketDefinition: UpdateTicketDefinition, options?: UpdateTicketDefinitionOptions$1): Promise;\n interface UpdateTicketDefinition {\n /**\n * Ticket definition ID.\n * @readonly\n */\n _id?: string | null;\n /** Event ID to which the ticket definition belongs. */\n eventId?: string | null;\n /**\n * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time when the ticket definition was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the ticket definition was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Ticket definition name. */\n name?: string | null;\n /** Ticket definition description. */\n description?: string | null;\n /** Ticket definition policy. */\n policyText?: string | null;\n /** Whether this ticket definition is hidden to site visitors and can't be purchased. */\n hidden?: boolean;\n /**\n * Whether the ticket has a limited maximum quantity.\n * @readonly\n */\n limited?: boolean;\n /** The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead. */\n initialLimit?: number | null;\n /**\n * The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.\n * @readonly\n */\n actualLimit?: number | null;\n /** Ticket pricing method. */\n pricingMethod?: PricingMethod;\n /**\n * Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:\n * - `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.\n * - `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total.\n */\n feeType?: Type$3;\n /** Ticket sale period. */\n salePeriod?: SalePeriod;\n /**\n * Ticket sale status. Possible values:\n * - `SALE_SCHEDULED`: Tickets are not on sale yet.\n * - `SALE_STARTED`: Tickets are on sale.\n * - `SALE_ENDED`: Tickets are not on sale.\n * @readonly\n */\n saleStatus?: SaleStatusEnumStatus;\n /**\n * Ticket sales information.
\n * **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.\n */\n salesDetails?: SalesDetails;\n /**\n * Number of tickets that can be purchased per checkout.
\n * **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.\n * @readonly\n */\n limitPerCheckout?: number | null;\n }\n interface UpdateTicketDefinitionOptions$1 {\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n /**\n * > **Note:** This function replaces the deprecated `getTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/getticketdefinition).\n *\n * Retrieves a ticket definition by ID.\n * @param ticketDefinitionId - Ticket definition ID.\n * @public\n * @requiredField ticketDefinitionId\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n * @returns The requested ticket definition.\n */\n function getTicketDefinition$1(ticketDefinitionId: string, options?: GetTicketDefinitionOptions$1): Promise;\n interface GetTicketDefinitionOptions$1 {\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n /**\n * > **Note:** This function replaces the deprecated `deleteTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/deleteticketdefinition).\n *\n * Permanently deletes a ticket definition.\n * @param ticketDefinitionId - ID of the ticket definition to delete.\n * @public\n * @requiredField ticketDefinitionId\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteTicketDefinition$1(ticketDefinitionId: string): Promise;\n /**\n * Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.\n * > **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @requiredField options.ticketDefinitionId\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function reorderTicketDefinitions(eventId: string, options?: ReorderTicketDefinitionsOptions): Promise;\n interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {\n /** Ticket definition ID. */\n ticketDefinitionId: string;\n /** Move the given `definitionId` before the referenced ticket definition. */\n beforeDefinitionId?: string;\n /** Move the given `definitionId` after the referenced ticket definition. */\n afterDefinitionId?: string;\n }\n /**\n * > **Note:** This function replaces the deprecated `listTicketDefinition()` and `queryTicketDefinitions` functions. The deprecated functions will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/queryticketdefinitions).\n *\n * Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting.\n * Query Ticket Definitions runs with these defaults, which you can override:\n * - `createdDate` is sorted in `ASC` order\n * - `paging.limit` is `100`\n * - `paging.offset` is `0`\n * @param query - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.\n * @public\n * @requiredField query\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryTicketDefinitions$1(query: QueryV2$5, options?: QueryTicketDefinitionsOptions$1): Promise;\n interface QueryTicketDefinitionsOptions$1 {\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[];\n }\n /**\n * Retrieves a list of available (visible) ticket definitions. Differs from QueryTicketDefinitions by these points:\n * - only visible tickets are returned (not(`hidden`))\n * - required permission is less strict (allowed for site visitors)\n * - `salesDetails` always empty\n * @public\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryAvailableTicketDefinitions(options?: QueryAvailableTicketDefinitionsOptions): TicketDefinitionsQueryBuilder;\n interface QueryAvailableTicketDefinitionsOptions {\n /**\n * Predefined sets of fields to return.\n * - `SALES_DETAILS`: Returns `salesDetails`.\n */\n fields?: Field[] | undefined;\n }\n interface QueryCursorResult$3 {\n cursors: Cursors$5;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TicketDefinitionsQueryResult extends QueryCursorResult$3 {\n items: TicketDefinition$2[];\n query: TicketDefinitionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface TicketDefinitionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"eventId\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"pricingMethod.fixedPrice.value\" | \"pricingMethod.fixedPrice.currency\" | \"pricingMethod.pricingType\" | \"pricingMethod.free\" | \"feeType\" | \"saleStatus\", value: any) => TicketDefinitionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"eventId\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"pricingMethod.fixedPrice.value\" | \"pricingMethod.fixedPrice.currency\" | \"pricingMethod.pricingType\" | \"pricingMethod.free\" | \"feeType\" | \"saleStatus\", value: any) => TicketDefinitionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => TicketDefinitionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => TicketDefinitionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => TicketDefinitionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => TicketDefinitionsQueryBuilder;\n in: (propertyName: \"_id\" | \"eventId\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"pricingMethod.fixedPrice.value\" | \"pricingMethod.fixedPrice.currency\" | \"pricingMethod.pricingType\" | \"pricingMethod.free\" | \"feeType\" | \"saleStatus\", value: any) => TicketDefinitionsQueryBuilder;\n exists: (propertyName: \"_id\" | \"eventId\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"pricingMethod.fixedPrice.value\" | \"pricingMethod.fixedPrice.currency\" | \"pricingMethod.pricingType\" | \"pricingMethod.free\" | \"feeType\" | \"saleStatus\", value: boolean) => TicketDefinitionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"eventId\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"pricingMethod.fixedPrice.value\" | \"pricingMethod.fixedPrice.currency\" | \"pricingMethod.pricingType\" | \"pricingMethod.free\" | \"feeType\" | \"saleStatus\">) => TicketDefinitionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"eventId\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"pricingMethod.fixedPrice.value\" | \"pricingMethod.fixedPrice.currency\" | \"pricingMethod.pricingType\" | \"pricingMethod.free\" | \"feeType\" | \"saleStatus\">) => TicketDefinitionsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => TicketDefinitionsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => TicketDefinitionsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Counts ticket definitions by the `saleStatus` and `hidden` fields.

\n * To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n * @public\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function countTicketDefinitions(options?: CountTicketDefinitionsOptions): Promise;\n interface CountTicketDefinitionsOptions {\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`. */\n filter?: Record | null;\n /**\n * Parameters to count ticket definitions by.\n *\n * - Max: 20 facets.\n */\n facet?: string[];\n }\n /**\n * Counts available ticket definitions.

\n * To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n * @public\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function countAvailableTicketDefinitions(options?: CountAvailableTicketDefinitionsOptions): Promise;\n interface CountAvailableTicketDefinitionsOptions {\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`. */\n filter?: Record | null;\n }\n /**\n * Deletes multiple ticket definitions.\n *\n * All ticket definitions that meet the specified `filter` criteria are deleted.\n * @param filter - Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\" }`.

**Example:**
`\"filter\" : { \"eventId\": \"3d3d5c04-ece0-45a8-85f0-11a58edaa192\" }`\n * @public\n * @requiredField filter\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteTicketDefinitionsByFilter(filter: Record | null): Promise;\n /**\n * > **Note:** This function replaces the deprecated `changeCurrency()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/changecurrency).\n *\n * Changes ticket price currency per event.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @requiredField options\n * @requiredField options.currency\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function changeCurrency$1(eventId: string, options: ChangeCurrencyOptions$1): Promise;\n interface ChangeCurrencyOptions$1 {\n /** Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */\n currency: string;\n }\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingMethod = PricingMethod;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingMethodPriceOneOf = PricingMethodPriceOneOf;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CommonMoney = CommonMoney;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_OptionDetails = OptionDetails;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingTypeEnumType = PricingTypeEnumType;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingTypeEnumType: typeof PricingTypeEnumType;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SalePeriod = SalePeriod;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SaleStatusEnumStatus = SaleStatusEnumStatus;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SaleStatusEnumStatus: typeof SaleStatusEnumStatus;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SalesDetails = SalesDetails;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_InvalidateCache = InvalidateCache;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_App = App;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Page = Page;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_URI = URI;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_File = File;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionSummaryRequest = GetTicketDefinitionSummaryRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionSummaryResponse = GetTicketDefinitionSummaryResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_TicketDefinitionSummary = TicketDefinitionSummary;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ListEventTicketingSummaryRequest = ListEventTicketingSummaryRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ListEventTicketingSummaryResponse = ListEventTicketingSummaryResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_EventTicketingSummary = EventTicketingSummary;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateEventTicketingSummaryRequest = UpdateEventTicketingSummaryRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Field = Field;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Field: typeof Field;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SalePeriodUpdated = SalePeriodUpdated;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsRequest = ReorderTicketDefinitionsRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsRequestReferenceDefinitionOneOf = ReorderTicketDefinitionsRequestReferenceDefinitionOneOf;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsResponse = ReorderTicketDefinitionsResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateTicketDefinitionSortIndexRequest = UpdateTicketDefinitionSortIndexRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateTicketDefinitionSortIndexResponse = UpdateTicketDefinitionSortIndexResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_QueryAvailableTicketDefinitionsRequest = QueryAvailableTicketDefinitionsRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_QueryAvailableTicketDefinitionsResponse = QueryAvailableTicketDefinitionsResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountTicketDefinitionsRequest = CountTicketDefinitionsRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountTicketDefinitionsResponse = CountTicketDefinitionsResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountAvailableTicketDefinitionsRequest = CountAvailableTicketDefinitionsRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountAvailableTicketDefinitionsResponse = CountAvailableTicketDefinitionsResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_BulkDeleteTicketDefinitionsByFilterRequest = BulkDeleteTicketDefinitionsByFilterRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_BulkDeleteTicketDefinitionsByFilterResponse = BulkDeleteTicketDefinitionsByFilterResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CategoryStateState = CategoryStateState;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CategoryStateState: typeof CategoryStateState;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SeatingPlanCategoriesSummaryUpdated = SeatingPlanCategoriesSummaryUpdated;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CategoryDetails = CategoryDetails;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Asset = Asset;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteCreated = SiteCreated;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteCreatedContext = SiteCreatedContext;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Namespace = Namespace;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Namespace: typeof Namespace;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteTransferred = SiteTransferred;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteDeleted = SiteDeleted;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_DeleteContext = DeleteContext;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_DeleteStatus = DeleteStatus;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_DeleteStatus: typeof DeleteStatus;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteUndeleted = SiteUndeleted;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SitePublished = SitePublished;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteUnpublished = SiteUnpublished;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ServiceProvisioned = ServiceProvisioned;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ServiceRemoved = ServiceRemoved;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteRenamed = SiteRenamed;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteHardDeleted = SiteHardDeleted;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_NamespaceChanged = NamespaceChanged;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_StudioAssigned = StudioAssigned;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_StudioUnassigned = StudioUnassigned;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionFromTrashBinRequest = GetTicketDefinitionFromTrashBinRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionFromTrashBinResponse = GetTicketDefinitionFromTrashBinResponse;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ScheduleTimecapsuleTaskRequest = ScheduleTimecapsuleTaskRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_RescheduleTimecapsuleTaskRequest = RescheduleTimecapsuleTaskRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CancelTimecapsuleTaskRequest = CancelTimecapsuleTaskRequest;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateTicketDefinition = UpdateTicketDefinition;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_reorderTicketDefinitions: typeof reorderTicketDefinitions;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsOptions = ReorderTicketDefinitionsOptions;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_queryAvailableTicketDefinitions: typeof queryAvailableTicketDefinitions;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_QueryAvailableTicketDefinitionsOptions = QueryAvailableTicketDefinitionsOptions;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_TicketDefinitionsQueryResult = TicketDefinitionsQueryResult;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_TicketDefinitionsQueryBuilder = TicketDefinitionsQueryBuilder;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_countTicketDefinitions: typeof countTicketDefinitions;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountTicketDefinitionsOptions = CountTicketDefinitionsOptions;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_countAvailableTicketDefinitions: typeof countAvailableTicketDefinitions;\n type eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountAvailableTicketDefinitionsOptions = CountAvailableTicketDefinitionsOptions;\n const eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_bulkDeleteTicketDefinitionsByFilter: typeof bulkDeleteTicketDefinitionsByFilter;\n namespace eventsV3TicketDefinitionTicketDefinitionsV2_universal_d {\n export { TicketDefinition$2 as TicketDefinition, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingMethod as PricingMethod, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingMethodPriceOneOf as PricingMethodPriceOneOf, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CommonMoney as CommonMoney, PricingOptions$2 as PricingOptions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_OptionDetails as OptionDetails, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_PricingTypeEnumType as PricingTypeEnumType, Type$3 as Type, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SalePeriod as SalePeriod, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SaleStatusEnumStatus as SaleStatusEnumStatus, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SalesDetails as SalesDetails, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_InvalidateCache as InvalidateCache, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_App as App, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Page as Page, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_URI as URI, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_File as File, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionSummaryRequest as GetTicketDefinitionSummaryRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionSummaryResponse as GetTicketDefinitionSummaryResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_TicketDefinitionSummary as TicketDefinitionSummary, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ListEventTicketingSummaryRequest as ListEventTicketingSummaryRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ListEventTicketingSummaryResponse as ListEventTicketingSummaryResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_EventTicketingSummary as EventTicketingSummary, DomainEvent$4 as DomainEvent, DomainEventBodyOneOf$4 as DomainEventBodyOneOf, EntityCreatedEvent$4 as EntityCreatedEvent, EntityUpdatedEvent$4 as EntityUpdatedEvent, EntityDeletedEvent$4 as EntityDeletedEvent, ActionEvent$4 as ActionEvent, Empty$3 as Empty, ReservationCreated$1 as ReservationCreated, ReservationStatus$1 as ReservationStatus, TicketQuantity$1 as TicketQuantity, ReservationCount$1 as ReservationCount, ReservationUpdated$1 as ReservationUpdated, EventDeleted$2 as EventDeleted, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateEventTicketingSummaryRequest as UpdateEventTicketingSummaryRequest, MessageEnvelope$6 as MessageEnvelope, IdentificationData$6 as IdentificationData, IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf, WebhookIdentityType$6 as WebhookIdentityType, CreateTicketDefinitionRequest$1 as CreateTicketDefinitionRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Field as Field, CreateTicketDefinitionResponse$1 as CreateTicketDefinitionResponse, UpdateTicketDefinitionRequest$1 as UpdateTicketDefinitionRequest, UpdateTicketDefinitionResponse$1 as UpdateTicketDefinitionResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SalePeriodUpdated as SalePeriodUpdated, GetTicketDefinitionRequest$1 as GetTicketDefinitionRequest, GetTicketDefinitionResponse$1 as GetTicketDefinitionResponse, DeleteTicketDefinitionRequest$1 as DeleteTicketDefinitionRequest, DeleteTicketDefinitionResponse$1 as DeleteTicketDefinitionResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsRequest as ReorderTicketDefinitionsRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsRequestReferenceDefinitionOneOf as ReorderTicketDefinitionsRequestReferenceDefinitionOneOf, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsResponse as ReorderTicketDefinitionsResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateTicketDefinitionSortIndexRequest as UpdateTicketDefinitionSortIndexRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateTicketDefinitionSortIndexResponse as UpdateTicketDefinitionSortIndexResponse, QueryTicketDefinitionsRequest$1 as QueryTicketDefinitionsRequest, QueryV2$5 as QueryV2, QueryV2PagingMethodOneOf$5 as QueryV2PagingMethodOneOf, Sorting$5 as Sorting, SortOrder$5 as SortOrder, Paging$5 as Paging, CursorPaging$4 as CursorPaging, QueryTicketDefinitionsResponse$1 as QueryTicketDefinitionsResponse, PagingMetadataV2$5 as PagingMetadataV2, Cursors$5 as Cursors, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_QueryAvailableTicketDefinitionsRequest as QueryAvailableTicketDefinitionsRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_QueryAvailableTicketDefinitionsResponse as QueryAvailableTicketDefinitionsResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountTicketDefinitionsRequest as CountTicketDefinitionsRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountTicketDefinitionsResponse as CountTicketDefinitionsResponse, FacetCounts$4 as FacetCounts, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountAvailableTicketDefinitionsRequest as CountAvailableTicketDefinitionsRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountAvailableTicketDefinitionsResponse as CountAvailableTicketDefinitionsResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_BulkDeleteTicketDefinitionsByFilterRequest as BulkDeleteTicketDefinitionsByFilterRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_BulkDeleteTicketDefinitionsByFilterResponse as BulkDeleteTicketDefinitionsByFilterResponse, ChangeCurrencyRequest$1 as ChangeCurrencyRequest, ChangeCurrencyResponse$1 as ChangeCurrencyResponse, BulkCopyTicketDefinitionsByEventIdRequest$1 as BulkCopyTicketDefinitionsByEventIdRequest, BulkCopyTicketDefinitionsByEventIdResponse$1 as BulkCopyTicketDefinitionsByEventIdResponse, CopiedTicketDefinition$1 as CopiedTicketDefinition, EventCanceled$1 as EventCanceled, EventEnded$1 as EventEnded, EventCreated$1 as EventCreated, Location$4 as Location, MapCoordinates$3 as MapCoordinates, LocationType$4 as LocationType, Address$5 as Address, AddressStreetOneOf$5 as AddressStreetOneOf, StreetAddress$5 as StreetAddress, AddressLocation$5 as AddressLocation, Subdivision$5 as Subdivision, SubdivisionType$5 as SubdivisionType, ScheduleConfig$3 as ScheduleConfig, Recurrences$4 as Recurrences, Occurrence$4 as Occurrence, Status$4 as Status, EventStatus$3 as EventStatus, Event$2 as Event, Scheduling$2 as Scheduling, Registration$2 as Registration, EventType$3 as EventType, RegistrationStatus$2 as RegistrationStatus, RsvpCollection$2 as RsvpCollection, RsvpCollectionConfig$2 as RsvpCollectionConfig, RsvpStatusOptions$2 as RsvpStatusOptions, Ticketing$2 as Ticketing, TicketingConfig$2 as TicketingConfig, TaxConfig$2 as TaxConfig, TaxType$4 as TaxType, Money$5 as Money, ExternalEvent$2 as ExternalEvent, VisitorType$2 as VisitorType, CalendarLinks$3 as CalendarLinks, SiteUrl$2 as SiteUrl, Form$2 as Form, InputControl$2 as InputControl, InputControlType$2 as InputControlType, Input$2 as Input, ValueType$2 as ValueType, OptionSelection$2 as OptionSelection, OptionSelectionSelectedOptionOneOf$2 as OptionSelectionSelectedOptionOneOf, Label$2 as Label, FormMessages$2 as FormMessages, RsvpFormMessages$2 as RsvpFormMessages, PositiveResponseConfirmation$2 as PositiveResponseConfirmation, NegativeResponseConfirmation$2 as NegativeResponseConfirmation, Positive$2 as Positive, Negative$2 as Negative, CheckoutFormMessages$2 as CheckoutFormMessages, ResponseConfirmation$2 as ResponseConfirmation, RegistrationClosedMessages$2 as RegistrationClosedMessages, TicketsUnavailableMessages$2 as TicketsUnavailableMessages, Dashboard$4 as Dashboard, RsvpSummary$2 as RsvpSummary, TicketingSummary$2 as TicketingSummary, GuestListConfig$2 as GuestListConfig, Feed$2 as Feed, OnlineConferencing$2 as OnlineConferencing, OnlineConferencingConfig$2 as OnlineConferencingConfig, ConferenceType$2 as ConferenceType, OnlineConferencingSession$2 as OnlineConferencingSession, SeoSettings$2 as SeoSettings, SeoSchema$2 as SeoSchema, Keyword$2 as Keyword, Tag$2 as Tag, Settings$2 as Settings, Agenda$2 as Agenda, Category$2 as Category, CategoryCounts$2 as CategoryCounts, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CategoryStateState as CategoryStateState, EventDisplaySettings$2 as EventDisplaySettings, LabellingSettings$2 as LabellingSettings, EventUpdated$2 as EventUpdated, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SeatingPlanCategoriesSummaryUpdated as SeatingPlanCategoriesSummaryUpdated, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CategoryDetails as CategoryDetails, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Asset as Asset, State$4 as State, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteCreated as SiteCreated, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteCreatedContext as SiteCreatedContext, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_Namespace as Namespace, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteTransferred as SiteTransferred, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteDeleted as SiteDeleted, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_DeleteContext as DeleteContext, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_DeleteStatus as DeleteStatus, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteUndeleted as SiteUndeleted, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SitePublished as SitePublished, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteUnpublished as SiteUnpublished, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ServiceProvisioned as ServiceProvisioned, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ServiceRemoved as ServiceRemoved, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteRenamed as SiteRenamed, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_SiteHardDeleted as SiteHardDeleted, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_NamespaceChanged as NamespaceChanged, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_StudioAssigned as StudioAssigned, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_StudioUnassigned as StudioUnassigned, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionFromTrashBinRequest as GetTicketDefinitionFromTrashBinRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_GetTicketDefinitionFromTrashBinResponse as GetTicketDefinitionFromTrashBinResponse, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ScheduleTimecapsuleTaskRequest as ScheduleTimecapsuleTaskRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_RescheduleTimecapsuleTaskRequest as RescheduleTimecapsuleTaskRequest, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CancelTimecapsuleTaskRequest as CancelTimecapsuleTaskRequest, createTicketDefinition$1 as createTicketDefinition, CreateTicketDefinitionOptions$1 as CreateTicketDefinitionOptions, updateTicketDefinition$1 as updateTicketDefinition, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_UpdateTicketDefinition as UpdateTicketDefinition, UpdateTicketDefinitionOptions$1 as UpdateTicketDefinitionOptions, getTicketDefinition$1 as getTicketDefinition, GetTicketDefinitionOptions$1 as GetTicketDefinitionOptions, deleteTicketDefinition$1 as deleteTicketDefinition, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_reorderTicketDefinitions as reorderTicketDefinitions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_ReorderTicketDefinitionsOptions as ReorderTicketDefinitionsOptions, queryTicketDefinitions$1 as queryTicketDefinitions, QueryTicketDefinitionsOptions$1 as QueryTicketDefinitionsOptions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_queryAvailableTicketDefinitions as queryAvailableTicketDefinitions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_QueryAvailableTicketDefinitionsOptions as QueryAvailableTicketDefinitionsOptions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_TicketDefinitionsQueryResult as TicketDefinitionsQueryResult, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_TicketDefinitionsQueryBuilder as TicketDefinitionsQueryBuilder, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_countTicketDefinitions as countTicketDefinitions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountTicketDefinitionsOptions as CountTicketDefinitionsOptions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_countAvailableTicketDefinitions as countAvailableTicketDefinitions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_CountAvailableTicketDefinitionsOptions as CountAvailableTicketDefinitionsOptions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d_bulkDeleteTicketDefinitionsByFilter as bulkDeleteTicketDefinitionsByFilter, changeCurrency$1 as changeCurrency, ChangeCurrencyOptions$1 as ChangeCurrencyOptions, };\n }\n interface Order {\n /** Unique order number. */\n orderNumber?: string;\n /** Reservation ID. */\n reservationId?: string;\n /**\n * Payment snapshot ID. Empty for the `FREE` order.\n * @readonly\n */\n snapshotId?: string;\n /** Event ID to which the order belongs. */\n eventId?: string;\n /** Contact ID of buyer (resolved using email address). */\n contactId?: string;\n /** Buyer member ID, if applicable. */\n memberId?: string;\n /**\n * RSVP created timestamp.\n * @readonly\n */\n created?: Date;\n /** Guest first name. */\n firstName?: string;\n /** Guest last name. */\n lastName?: string;\n /** Guest email. */\n email?: string;\n /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */\n checkoutForm?: FormResponse$1;\n /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */\n confirmed?: boolean;\n /**\n * Order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is payment is declined.\n */\n status?: OrderStatus$1;\n /** Payment method used for purchase, e.g., \"payPal\", \"creditCard\", etc. */\n method?: string;\n /** Quantity of ordered tickets. */\n ticketsQuantity?: number;\n /** Total order price. */\n totalPrice?: Money$4;\n /** Ticket PDF URL. */\n ticketsPdf?: string;\n /** Tickets (generated after payment). */\n tickets?: TicketingTicket[];\n /** Whether the order is archived. */\n archived?: boolean;\n /** Whether the order is anonymized by GDPR delete. */\n anonymized?: boolean;\n /** Guest full name. */\n fullName?: string;\n /** Order invoice. */\n invoice?: Invoice$1;\n /** Whether all tickets in order are checked-in. */\n fullyCheckedIn?: boolean;\n /** Internal order payment details */\n paymentDetails?: PaymentDetails;\n /** Checkout channel type */\n channel?: ChannelType;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date;\n }\n interface FormResponse$1 {\n /** Input fields for a checkout form. */\n inputValues?: InputValue$1[];\n }\n interface InputValue$1 {\n /** Input field name. */\n inputName?: string;\n /** Input field value. */\n value?: string;\n /** Multiple input field values. */\n values?: string[];\n }\n interface FormattedAddress$1 {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address$4;\n }\n /** Physical address */\n interface Address$4 extends AddressStreetOneOf$4 {\n /** Street name and number. */\n streetAddress?: StreetAddress$4;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf$4 {\n /** Street name and number. */\n streetAddress?: StreetAddress$4;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$4 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$4 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$4 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /** Standard organizations details (e.g. ISO). */\n standardDetails?: StandardDetails$1;\n }\n enum SubdivisionType$4 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n /** Subdivision Concordance values */\n interface StandardDetails$1 {\n /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */\n iso31662?: string | null;\n }\n enum OrderStatus$1 {\n /** Order status not available for this request fieldset */\n NA_ORDER_STATUS = \"NA_ORDER_STATUS\",\n /** Order is confirmed, no payment required */\n FREE = \"FREE\",\n /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */\n PENDING = \"PENDING\",\n /** Order paid via payment gateway */\n PAID = \"PAID\",\n /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */\n OFFLINE_PENDING = \"OFFLINE_PENDING\",\n /** Order is awaiting for payment in Cashier */\n INITIATED = \"INITIATED\",\n /** Order was canceled */\n CANCELED = \"CANCELED\",\n /** Order payment was declined */\n DECLINED = \"DECLINED\"\n }\n interface Money$4 {\n /** *Deprecated:** Use `value` instead. */\n amount?: string;\n /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface TicketingTicket {\n /** Unique ticket number (issued automatically). */\n ticketNumber?: string;\n /** Associated order number. */\n orderNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket name. */\n name?: string;\n /** Ticket price. */\n price?: Money$4;\n /**\n * Whether the ticket requires payment.\n * @readonly\n */\n free?: boolean;\n /** Event and ticket policies. */\n policy?: string;\n /** Deprecated, use `check_in_url`. */\n qrCode?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$1;\n /** Associated order status. */\n orderStatus?: OrderStatus$1;\n /** Whether order and ticket are visible in order list. */\n orderArchived?: boolean;\n /** Buyer full name. */\n orderFullName?: string;\n /** Guest full name. */\n guestFullName?: string | null;\n /** Guest personal details. */\n guestDetails?: GuestDetails$1;\n /** Whether ticket is visible in guest list. */\n archived?: boolean;\n /** Deprecated, use `ticket_pdf_url`. */\n ticketPdf?: string;\n /** Ticket owner member ID. */\n memberId?: string | null;\n /**\n * Whether ticket was anonymized by GDPR delete.\n * Anonymized tickets no longer contain personally identifiable information (PII).\n */\n anonymized?: boolean;\n /**\n * Ticket check-in URL.\n * Shown as a QR code image in PDF.\n * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`.\n * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`\n */\n checkInUrl?: string;\n /** URL for ticket PDF download. */\n ticketPdfUrl?: string;\n /** Associated order checkout channel type */\n channel?: ChannelType;\n /**\n * URL to download ticket in the `.pkpass` format for Apple Wallet\n * @readonly\n */\n walletPassUrl?: string;\n }\n interface CheckIn$1 {\n /** Time of check-in */\n created?: Date;\n }\n interface GuestDetails$1 {\n /** Whether ticket belongs to assigned guest. */\n guestAssigned?: boolean;\n /** Guest first name. */\n firstName?: string | null;\n /** Guest last name. */\n lastName?: string | null;\n /** Guest email. */\n email?: string | null;\n /** Full form response. */\n form?: FormResponse$1;\n /** Contact ID associated with this guest. */\n contactId?: string | null;\n }\n enum ChannelType {\n /** Buyer created order via one of the online channels (website, mobile app, etc.) */\n ONLINE = \"ONLINE\",\n /** Order created and money collected by the sales person */\n OFFLINE_POS = \"OFFLINE_POS\"\n }\n interface TicketDetails$1 {\n /** Unique seat id in the event venue. */\n seatId?: string | null;\n /**\n * Optional sector label.\n * @readonly\n */\n sectionLabel?: string | null;\n /**\n * Area label.\n * @readonly\n */\n areaLabel?: string | null;\n /**\n * Table label.\n * @readonly\n */\n tableLabel?: string | null;\n /**\n * Row label.\n * @readonly\n */\n rowLabel?: string | null;\n /**\n * Seat label in a row or table.\n * @readonly\n */\n seatLabel?: string | null;\n /** Number of places in the spot. If not provided - defaults to 1. */\n capacity?: number | null;\n /** Custom pricing of ticket. */\n priceOverride?: string | null;\n /** Pricing option id. */\n pricingOptionId?: string | null;\n /**\n * Pricing option name.\n * @readonly\n */\n pricingOptionName?: string | null;\n }\n interface Invoice$1 {\n /** Items listed in the invoice. */\n items?: Item$1[];\n /** Total cart amount. */\n total?: Money$4;\n /** Discount applied to a cart. */\n discount?: Discount$1;\n /** Tax applied to cart. */\n tax?: Tax$1;\n /** Total cart amount before discount, tax, and fees. */\n subTotal?: Money$4;\n /**\n * Total amount of cart after discount, tax, and fees.\n * Grand total is calculated in the following order:\n * 1. Total prices of all items in the cart are calculated.\n * 2. Discount is subtracted from the cart (if applicable).\n * 3. Tax is added (if applicable).\n * 4. Wix service fee is added.\n */\n grandTotal?: Money$4;\n /**\n * Fees applied to the cart.\n * @readonly\n */\n fees?: Fee$1[];\n /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */\n revenue?: Money$4;\n /** Invoice preview URL. This value is only returned when the order is paid. */\n previewUrl?: string | null;\n }\n interface Item$1 {\n /** Unique line item ID. */\n _id?: string;\n /** Line item quantity. */\n quantity?: number;\n /** Line item mame. */\n name?: string;\n /** Line item price. */\n price?: Money$4;\n /** Total price for line items. It's calculated by multiplying price and item quantity. */\n total?: Money$4;\n /** Discount applied to the line item. */\n discount?: Discount$1;\n /** Tax applied to the item. */\n tax?: Tax$1;\n /**\n * Fees applied to the item.\n * @readonly\n */\n fees?: Fee$1[];\n }\n interface Discount$1 {\n /** Total discount amount. */\n amount?: Money$4;\n /** Total sum after the discount. */\n afterDiscount?: Money$4;\n /** Discount coupon code. */\n code?: string;\n /** Discount coupon name. */\n name?: string;\n /** Discount coupon ID. */\n couponId?: string;\n /** Discount items. */\n discounts?: DiscountItem$1[];\n }\n interface DiscountItem$1 extends DiscountItemDiscountOneOf$1 {\n /** Coupon discount. */\n coupon?: CouponDiscount$1;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount$1;\n /** Total discount amount. */\n amount?: Money$4;\n }\n /** @oneof */\n interface DiscountItemDiscountOneOf$1 {\n /** Coupon discount. */\n coupon?: CouponDiscount$1;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount$1;\n }\n interface CouponDiscount$1 {\n /** Discount coupon name. */\n name?: string;\n /** Discount coupon code. */\n code?: string;\n /** Discount coupon ID. */\n couponId?: string;\n }\n interface PaidPlanDiscount$1 extends PaidPlanDiscountDiscountOneOf$1 {\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount$1;\n /** Name of pricing plan. */\n name?: string;\n }\n /** @oneof */\n interface PaidPlanDiscountDiscountOneOf$1 {\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount$1;\n }\n interface PercentDiscount$1 {\n /** Percent rate. */\n rate?: string;\n /** Number of discounted tickets. */\n quantityDiscounted?: number;\n }\n interface Tax$1 {\n /** Tax type. */\n type?: TaxType$3;\n /**\n * Tax name.\n * @readonly\n */\n name?: string;\n /** Tax rate. */\n rate?: string;\n /** Taxable amount. */\n taxable?: Money$4;\n /** Total tax amount. */\n amount?: Money$4;\n }\n enum TaxType$3 {\n /** Tax is included in the ticket price */\n INCLUDED = \"INCLUDED\",\n /** Tax is added to the order at the checkout */\n ADDED = \"ADDED\",\n /** Tax is added to the final total at the checkout */\n ADDED_AT_CHECKOUT = \"ADDED_AT_CHECKOUT\"\n }\n interface Fee$1 {\n /** Fee identifier. */\n name?: FeeName$1;\n /** How fee is calculated. */\n type?: FeeType$2;\n /**\n * Fee rate.\n * @readonly\n */\n rate?: string;\n /** Total amount of fee charges. */\n amount?: Money$4;\n }\n enum FeeName$1 {\n /** Wix service fee charges applied to the line item. */\n WIX_FEE = \"WIX_FEE\"\n }\n enum FeeType$2 {\n /** Fee is added to the ticket price at checkout */\n FEE_ADDED = \"FEE_ADDED\",\n /** Seller absorbs the fee. It is deducted from the ticket price */\n FEE_INCLUDED = \"FEE_INCLUDED\",\n /** Fee is added to the ticket price at checkout */\n FEE_ADDED_AT_CHECKOUT = \"FEE_ADDED_AT_CHECKOUT\"\n }\n interface PaymentDetails {\n /** Wix Payments transaction */\n transaction?: PaymentTransaction;\n }\n interface PaymentTransaction {\n /**\n * Wix Payments transaction id\n * @readonly\n */\n transactionId?: string;\n /**\n * Transaction Payment method e.g., \"payPal\", \"creditCard\", etc.\n * @readonly\n */\n method?: string;\n }\n interface OrderDeleted$1 {\n /** Order deleted timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID to which the order belongs. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp.\n * @readonly\n */\n created?: Date;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date;\n /** Whether order was anonymized by GDPR delete. */\n anonymized?: boolean;\n /** Order type. */\n orderType?: OrderType$1;\n /** Whether event was triggered by GDPR delete request. */\n triggeredByAnonymizeRequest?: boolean;\n /** Tickets generated after payment. */\n tickets?: Ticket$1[];\n }\n enum OrderType$1 {\n /** Buyer form is used for all tickets */\n UNASSIGNED_TICKETS = \"UNASSIGNED_TICKETS\",\n /** Each order ticket has its own form */\n ASSIGNED_TICKETS = \"ASSIGNED_TICKETS\"\n }\n interface Ticket$1 {\n /** Unique issued ticket number. */\n ticketNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$1;\n /** Ticket price. */\n price?: Money$4;\n /** Whether ticket is archived. */\n archived?: boolean;\n /** Guest first name. */\n firstName?: string | null;\n /** Guest last name. */\n lastName?: string | null;\n /** Guest email. */\n email?: string | null;\n /** Contact ID associated with this ticket. */\n contactId?: string | null;\n /** Whether ticket is confirmed */\n confirmed?: boolean;\n /** Member ID associated with this ticket. */\n memberId?: string | null;\n /** Ticket form response (only assigned tickets contain separate forms). */\n form?: FormResponse$1;\n /** Ticket name. */\n ticketName?: string;\n /** Anonymized tickets no longer contain personally identifiable information (PII). */\n anonymized?: boolean;\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$1;\n }\n interface OnlineConferencingLogin$1 {\n /**\n * Link URL to the online conference.\n * @readonly\n */\n link?: string;\n /**\n * Password for the online conference.\n * @readonly\n */\n password?: string | null;\n }\n interface ListOrdersRequest {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /**\n * Predefined sets of fields to return.\n * - `TICKETS`: Returns `tickets`.\n * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.\n * - `FORM` : Returns `checkoutForm`.\n * - `INVOICE`: Returns `invoice`.\n *\n * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.\n *\n */\n fieldset?: OrderFieldset[];\n /**\n * Order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is payment is declined.\n */\n status?: OrderStatus$1[];\n /** Event ID to which the order belongs. */\n eventId?: string[];\n /** Order number. */\n orderNumber?: string[];\n /** Site member ID. */\n memberId?: string[];\n /** Field facets, */\n facet?: string[];\n /** Search filter. You can search `fullName`, `email` and `orderNumber`. */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Sort order.\n * Default: `created:asc`.\n */\n sort?: string;\n /** Order tag. */\n tag?: OrderTag[];\n /** Guest contact IDs. */\n contactId?: string[];\n }\n enum OrderFieldset {\n /** Include tickets in response */\n TICKETS = \"TICKETS\",\n /** Include order details: status, first_name, last_name, email, created, etc. */\n DETAILS = \"DETAILS\",\n /** Include checkout_form */\n FORM = \"FORM\",\n /** Include invoice */\n INVOICE = \"INVOICE\"\n }\n enum OrderTag {\n /** Return only confirmed orders */\n CONFIRMED = \"CONFIRMED\",\n /** Return only unconfirmed orders */\n UNCONFIRMED = \"UNCONFIRMED\",\n /** Return only member orders */\n MEMBER = \"MEMBER\",\n /** Return only archived orders */\n ARCHIVED = \"ARCHIVED\",\n /** Return only non archived orders */\n NON_ARCHIVED = \"NON_ARCHIVED\",\n /** Return only orders with all guests checked-in */\n FULLY_CHECKED_IN = \"FULLY_CHECKED_IN\",\n /** Return only orders with no guests checked-in */\n NOT_FULLY_CHECKED_IN = \"NOT_FULLY_CHECKED_IN\"\n }\n interface ListOrdersResponse {\n /** Total orders matching the given filters. */\n total?: number;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Orders. */\n orders?: Order[];\n /** Filter facets. */\n facets?: Record;\n /** Order data enriched facets. */\n orderFacets?: OrderFacets;\n }\n interface FacetCounts$3 {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface OrderFacets {\n /** Filter facets. */\n facets?: Record;\n }\n interface OrderFacetCounts {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface Counts {\n /** Number or orders */\n count?: number;\n /** Number of tickets within orders */\n tickets?: number;\n /** Number of tickets with check-in */\n ticketsCheckIn?: number;\n }\n interface GetOrderRequest {\n /** Event ID to which the order belongs. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /**\n * Predefined sets of fields to return.\n * - `TICKETS`: Returns `tickets`.\n * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.\n * - `FORM` : Returns `checkoutForm`.\n * - `INVOICE`: Returns `invoice`.\n *\n * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.\n *\n */\n fieldset?: OrderFieldset[];\n }\n interface GetOrderResponse {\n /** Requested order. */\n order?: Order;\n /** \"Add to calendar\" links. */\n calendarLinks?: CalendarLinks$2;\n }\n interface CalendarLinks$2 {\n /** \"Add to Google calendar\" URL. */\n google?: string;\n /** \"Download ICS calendar file\" URL. */\n ics?: string;\n }\n interface UpdateOrderRequest {\n /** Event ID to which the order belongs. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /** Checkout form. */\n checkoutForm?: FormResponse$1;\n /** Whether order is archived. */\n archived?: boolean;\n }\n interface UpdateOrderResponse {\n /** Updated order. */\n order?: Order;\n }\n interface OrderUpdated$1 {\n /** Order updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: string | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID to which the order belongs. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp.\n * @readonly\n */\n created?: Date;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date;\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse$1;\n /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */\n confirmed?: boolean;\n /**\n * Order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is payment is declined.\n */\n status?: OrderStatus$1;\n /** Payment method used for paid tickets purchase, i.e. \"payPal\", \"creditCard\", etc. */\n method?: string | null;\n /** Tickets generated after payment. */\n tickets?: Ticket$1[];\n /** Whether order was archived and excluded from results. */\n archived?: boolean;\n /** Whether event was triggered by GDPR delete request. */\n triggeredByAnonymizeRequest?: boolean;\n }\n interface BulkUpdateOrdersRequest {\n /** Event ID to which the order belongs. */\n eventId: string;\n orderNumber?: string[];\n /** Whether to archive the order. */\n archived?: boolean;\n }\n interface BulkUpdateOrdersResponse {\n /** Updated orders. */\n orders?: Order[];\n }\n interface ConfirmOrderRequest {\n /** Event ID to which the order belongs. */\n eventId: string;\n /** Order numbers. */\n orderNumber?: string[];\n }\n interface ConfirmOrderResponse {\n /** Confirmed orders. */\n orders?: Order[];\n }\n interface GetSummaryRequest {\n /** Event ID. */\n eventId?: string | null;\n }\n interface GetSummaryResponse {\n /** Ticket sales grouped by currency. */\n sales?: TicketSales[];\n }\n interface TicketSales {\n /** Total balance of confirmed transactions. */\n total?: Money$4;\n /** Total number of confirmed orders. */\n totalOrders?: number;\n /** Total number of tickets purchased. */\n totalTickets?: number;\n /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */\n revenue?: Money$4;\n }\n interface GetInvoicePreviewRequest {\n /** Event ID to which the invoice belongs. */\n eventId: string;\n /** Order number. */\n orderNumber: string;\n }\n interface RawHttpResponse {\n body?: Uint8Array;\n statusCode?: number | null;\n headers?: HeadersEntry[];\n }\n interface HeadersEntry {\n key?: string;\n value?: string;\n }\n interface GetPaymentInfoRequest {\n /** Event ID. */\n eventId?: string;\n /** Order number. */\n orderNumber?: string;\n }\n interface GetPaymentInfoResponse {\n transactions?: PaymentTransactionSummary[];\n status?: string | null;\n /** @readonly */\n transactionId?: string | null;\n }\n interface PaymentTransactionSummary {\n /**\n * Wix Payments transaction id\n * @readonly\n */\n transactionId?: string;\n /**\n * Final transaction status\n * @readonly\n */\n finalTransactionStatus?: string;\n /** Transaction events */\n events?: PaymentTransactionEvent[];\n }\n interface PaymentTransactionEvent {\n /**\n * Order snapshot id\n * @readonly\n */\n snapshotId?: string;\n /**\n * Transaction status\n * @readonly\n */\n transactionStatus?: string;\n /**\n * Transaction Payment method e.g., \"payPal\", \"creditCard\", etc.\n * @readonly\n */\n paymentMethod?: string;\n /**\n * Transaction payment amount\n * @readonly\n */\n paymentAmount?: Money$4;\n /**\n * Crated date\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Reason code\n * @readonly\n */\n reasonCode?: string | null;\n /**\n * Refunded amount\n * @readonly\n */\n refundedAmount?: Money$4;\n }\n interface MessageEnvelope$5 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$5;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$5;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$5 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface OrderConfirmed$1 {\n /** Order confirmation timestamp in ISO UTC. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: string | null;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID to which the order belongs. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp\n * @readonly\n */\n created?: Date;\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email address. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse$1;\n /**\n * Order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is payment is declined.\n */\n status?: OrderStatus$1;\n /** Payment method used for paid tickets purchase, i.e. \"payPal\", \"creditCard\", etc. */\n method?: string | null;\n /** Tickets (generated after payment). */\n tickets?: Ticket$1[];\n /** Invoice. */\n invoice?: Invoice$1;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface OrderPaid {\n /** Order paid timestamp in ISO UTC. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: string | null;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID to which the order belongs. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp\n * @readonly\n */\n created?: Date;\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email address. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse$1;\n /** Order status. */\n status?: OrderStatus$1;\n /** Payment method used for paid tickets purchase, i.e. \"payPal\", \"creditCard\", etc. */\n method?: string | null;\n /** Tickets (generated after payment). */\n tickets?: Ticket$1[];\n /** Invoice. */\n invoice?: Invoice$1;\n }\n interface ReservationCreated {\n /** Reservation created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID to which the reservation belongs. */\n eventId?: string;\n /**\n * Reservation ID.\n * Can be used to retrieve a reservation invoice.\n */\n reservationId?: string;\n /** Reservation expiration timestamp. */\n expires?: Date;\n /** Reservation status. */\n status?: ReservationStatus;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity[];\n /** Reservation update timestamp. */\n _updatedDate?: Date;\n /** Reservation counts. */\n counts?: ReservationCount[];\n }\n enum ReservationStatus {\n /**\n * Reservation is pending confirmation.\n * The reservation will expire after the expiration due time.\n */\n RESERVATION_PENDING = \"RESERVATION_PENDING\",\n /** The reservation was confirmed and will not expire. */\n RESERVATION_CONFIRMED = \"RESERVATION_CONFIRMED\",\n /** The reservation was canceled because of non payment. */\n RESERVATION_CANCELED = \"RESERVATION_CANCELED\",\n /** The reservation was canceled manually by the buyer. */\n RESERVATION_CANCELED_MANUALLY = \"RESERVATION_CANCELED_MANUALLY\",\n /** The reservation has expired. */\n RESERVATION_EXPIRED = \"RESERVATION_EXPIRED\"\n }\n interface TicketQuantity {\n /** Ticket definition ID. */\n ticketDefinitionId?: string | null;\n /** Quantity. */\n quantity?: number | null;\n /** Quantity update timestamp. */\n _updatedDate?: Date;\n }\n interface ReservationCount {\n /** Reservation Count snapshot timestamp. */\n timestamp?: Date;\n /** Ticket Definition ID. */\n ticketDefinitionId?: string;\n /** Confirmed reservation count. */\n confirmedCount?: number;\n /** Pending reservation count. */\n pendingCount?: number;\n /** True if paid ticket reservation exist. */\n paidExists?: boolean;\n }\n interface ReservationUpdated {\n /** Reservation updated timestamp. */\n timestamp?: Date;\n /** Event ID to which the reservation belongs. */\n eventId?: string;\n /**\n * Reservation ID.\n * Can be used to retrieve a reservation invoice.\n */\n reservationId?: string;\n /** Reservation status. */\n status?: ReservationStatus;\n /** Reservation expiration timestamp. */\n expires?: Date;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity[];\n /** Reservation update timestamp. */\n _updatedDate?: Date;\n /** Reservation counts. */\n counts?: ReservationCount[];\n }\n interface GetCheckoutOptionsRequest {\n }\n interface GetCheckoutOptionsResponse {\n /** Whether any payment method is configured and available for payment. */\n paymentMethodConfigured?: boolean;\n /** Whether coupons are accepted at checkout. */\n acceptCoupons?: boolean;\n /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature \"events_sell_tickets\". */\n premiumServices?: boolean;\n /** Whether there are any paid tickets available for sale. */\n paidTickets?: boolean;\n }\n interface ListAvailableTicketsRequest {\n /** Event ID. If not provided, available tickets for all events in the site will be returned. */\n eventId?: string;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /**\n * Sort order.\n * Default: `created:asc`.\n */\n sort?: string;\n state?: State$3[];\n }\n enum State$3 {\n INCLUDE_HIDDEN_NOT_ON_SALE = \"INCLUDE_HIDDEN_NOT_ON_SALE\"\n }\n interface ListAvailableTicketsResponse {\n /** Ticket definitions meta data. */\n metaData?: ResponseMetaData$1;\n /** Ticket definitions. */\n definitions?: TicketDefinition$1[];\n }\n interface ResponseMetaData$1 {\n /** Number of items in the response. */\n count?: number;\n /** Offset of items. */\n offset?: number;\n /** Total number of matching items. */\n total?: number;\n }\n interface TicketDefinition$1 {\n /** Ticket definition ID. */\n _id?: string;\n /** Ticket price. */\n price?: Money$4;\n /** Whether the ticket is free (read only). */\n free?: boolean;\n /** Ticket name. */\n name?: string;\n /** Ticket description. */\n description?: string;\n /** Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets. */\n limitPerCheckout?: number;\n /** Custom sort index. */\n orderIndex?: number;\n /** Event and ticket policies. */\n policy?: string;\n /** Sensitive dashboard data. */\n dashboard?: Dashboard$3;\n /** Event ID associated with the ticket. */\n eventId?: string;\n /**\n * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.\n * @readonly\n */\n wixFeeConfig?: WixFeeConfig$1;\n /** Ticket sale period. */\n salePeriod?: TicketSalePeriod$1;\n /**\n * Ticket sale status.\n * @readonly\n */\n saleStatus?: TicketSaleStatus$1;\n /** Ticket state. */\n state?: State$3[];\n /** Ticket pricing. */\n pricing?: TicketPricing$1;\n }\n interface Dashboard$3 {\n /** Whether ticket is hidden and cannot be sold. */\n hidden?: boolean;\n /** Number of tickets sold and reserved. */\n sold?: number;\n /** Whether the ticket has limited quantity. */\n limited?: boolean;\n /** Ticket limit. `NULL` if the tickets are unlimited. */\n quantity?: number | null;\n /** Number of unsold tickets. `NULL` if the tickets are unlimited. */\n unsold?: number | null;\n /** Number of tickets sold. */\n ticketsSold?: number;\n /** Number of tickets reserved. */\n ticketsReserved?: number;\n }\n interface WixFeeConfig$1 {\n /** Fee calculation method. */\n type?: FeeType$2;\n }\n interface TicketSalePeriod$1 {\n /** Ticket sale start timestamp. */\n startDate?: Date;\n /** Ticket sale end timestamp. */\n endDate?: Date;\n /** Whether to hide this ticket if it's not on sale */\n hideNotOnSale?: boolean;\n }\n enum TicketSaleStatus$1 {\n /** Ticket sale is scheduled to start */\n SALE_SCHEDULED = \"SALE_SCHEDULED\",\n /** Ticket sale has started */\n SALE_STARTED = \"SALE_STARTED\",\n /** Ticket sale has ended */\n SALE_ENDED = \"SALE_ENDED\"\n }\n interface TicketPricing$1 extends TicketPricingPriceOneOf$1 {\n /** Ticket price which is read only. */\n fixedPrice?: Money$4;\n /** Min price per ticket, customizable. */\n minPrice?: Money$4;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions$1;\n /**\n * Ticket pricing type.\n * @readonly\n */\n pricingType?: Type$2;\n }\n /** @oneof */\n interface TicketPricingPriceOneOf$1 {\n /** Ticket price which is read only. */\n fixedPrice?: Money$4;\n /** Min price per ticket, customizable. */\n minPrice?: Money$4;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions$1;\n }\n interface PricingOptions$1 {\n /** Multiple ticket pricing options. */\n options?: PricingOption$1[];\n }\n interface PricingOption$1 {\n /** Ticket pricing option ID. */\n _id?: string | null;\n /** Ticket pricing option name. */\n name?: string | null;\n /** Ticket pricing option price. */\n price?: Money$4;\n }\n enum Type$2 {\n STANDARD = \"STANDARD\",\n DONATION = \"DONATION\"\n }\n interface QueryAvailableTicketsRequest {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Ticket definition. */\n filter?: Record | null;\n fieldset?: TicketDefinitionFieldset$1[];\n /**\n * Sort order.\n * Default: `created:asc`.\n */\n sort?: string;\n }\n enum TicketDefinitionFieldset$1 {\n /** Include policy in the response. */\n POLICY = \"POLICY\",\n /** Include dashboard in the response. */\n DASHBOARD = \"DASHBOARD\"\n }\n interface QueryAvailableTicketsResponse {\n /** Ticket definitions meta data. */\n metaData?: ResponseMetaData$1;\n /** Ticket definitions. */\n definitions?: TicketDefinition$1[];\n }\n interface CreateReservationRequest {\n /** Event ID to which the reservation belongs. */\n eventId: string;\n /** Tickets to reserve. */\n ticketQuantities?: TicketReservationQuantity[];\n /** Whether to ignore the available ticket limits upon reservation. */\n ignoreLimits?: boolean;\n /** Whether to allow reservation for hidden tickets. */\n allowHiddenTickets?: boolean;\n }\n interface TicketReservationQuantity {\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Quantity of tickets to reserve. */\n quantity?: number;\n /** Override the predefined ticket price. */\n priceOverride?: string | null;\n /** Optional ticket details */\n ticketDetails?: TicketDetails$1[];\n }\n interface CreateReservationResponse {\n /** Reservation ID. */\n _id?: string;\n /** Reservation expiration timestamp. */\n expires?: Date;\n /** Ticket reservations. */\n reservations?: TicketReservation[];\n /** Reservation invoice. */\n invoice?: Invoice$1;\n }\n interface TicketReservation {\n /** Quantity of reserved tickets. */\n quantity?: number;\n /** An object containing ticket information. */\n ticket?: TicketDefinition$1;\n /** Optional ticket details. */\n ticketDetails?: TicketDetails$1[];\n }\n interface CancelReservationRequest {\n /** Event ID to which the reservation belongs. */\n eventId: string;\n /** Reservation ID. */\n _id: string;\n }\n interface CancelReservationResponse {\n }\n interface GetInvoiceRequest {\n /** Event ID to which the invoice belongs. */\n eventId: string;\n /** Reservation ID. */\n reservationId: string;\n /** Optional discount to be applied on the returned invoice. */\n withDiscount?: DiscountRequest;\n /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */\n paidPlanBenefit?: PaidPlanBenefit;\n }\n interface DiscountRequest {\n /** Discount coupon code. */\n couponCode?: string;\n }\n interface PaidPlanBenefit {\n /** Pricing plan ID. */\n planOrderId?: string;\n /** Pricing plan benefit ID. */\n benefitId?: string;\n }\n interface GetInvoiceResponse {\n /** Invoice with applied discount. */\n invoice?: Invoice$1;\n /** Discount errors, if relevant. */\n discountErrors?: DiscountErrors;\n /** Reservation expiration time. */\n expires?: Date;\n /**\n * Reservation status. Possible values:\n * - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time.\n * - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire.\n * - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid.\n * - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer.\n * - `RESERVATION_EXPIRED`: The reservation has expired.\n */\n reservationStatus?: ReservationStatus;\n /** Whether this reservation is already used in checkout. */\n reservationOccupied?: boolean;\n /** Ticket reservations. */\n reservations?: TicketReservation[];\n }\n interface DiscountErrors {\n /** Object containing error information. */\n error?: Error[];\n }\n interface Error {\n /** A code identifying the error type. */\n code?: string;\n }\n interface CheckoutRequest {\n /** Event ID to which the checkout belongs. */\n eventId: string;\n /** Ticket reservation ID. */\n reservationId?: string;\n /** Member ID (if empty - no site member is associated to this order). */\n memberId?: string;\n /** Discount to apply on the invoice. */\n discount?: DiscountRequest;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest$1[];\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n /** Options controlling the checkout process. */\n options?: CheckoutOptions;\n }\n interface Buyer {\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email. */\n email?: string;\n }\n interface Guest$1 {\n /** Specific guest info. */\n form?: FormResponse$1;\n }\n interface CheckoutOptions {\n /** Whether to ignore settings to notify contacts or users. */\n silent?: boolean;\n /** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */\n payInPerson?: boolean;\n /** Whether to ignore form validation. */\n ignoreFormValidation?: boolean;\n /** Marks payment as already paid */\n markAsPaid?: boolean | null;\n }\n interface CheckoutResponse {\n /** Created order. */\n order?: Order;\n /**\n * Order expiration time.\n * **Note:** Only applicable to orders with the `INITIATED` status.\n */\n expires?: Date;\n /** Ticket reservations. */\n reservations?: TicketReservation[];\n /** Order page URL. */\n orderPageUrl?: string | null;\n }\n interface OrderInitiated {\n /** Order initiated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: string | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID to which the order belongs. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp.\n * @readonly\n */\n created?: Date;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date;\n /** Guest first name. */\n firstName?: string;\n /** Guest last name. */\n lastName?: string;\n /** Guest email address. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse$1;\n /**\n * Order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is payment is declined.\n */\n status?: OrderStatus$1;\n /** Invoice. */\n invoice?: Invoice$1;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n /** Order was marked as paid. */\n markedAsPaid?: boolean | null;\n }\n interface UpdateCheckoutRequest {\n /** Event ID to which the checkout belongs. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest$1[];\n /** Member ID (if empty - no site member is associated to this order). */\n memberId?: string | null;\n /** Discount to apply on the invoice. */\n discount?: DiscountRequest;\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n }\n interface UpdateCheckoutResponse {\n /** Updated order. */\n order?: Order;\n /** Order page URL. */\n orderPageUrl?: string | null;\n }\n interface OrderPageUrls {\n /** Success order page URL. */\n success?: string | null;\n /** Pending order page URL. */\n pending?: string | null;\n /** Canceled order page URL. */\n canceled?: string | null;\n /** Error order page URL. */\n error?: string | null;\n }\n interface PosCheckoutRequest {\n /** Event ID to which the checkout belongs. */\n eventId: string;\n /** Ticket reservation ID. */\n reservationId: string;\n /**\n * Payment details ID.\n * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.\n */\n paymentDetailsId?: string | null;\n }\n interface PosCheckoutResponse {\n /** Created order. */\n order?: Order;\n /** Time when the order expires, applies to orders with status = INITIATED. */\n expires?: Date;\n /** Ticket reservations. */\n reservations?: TicketReservation[];\n }\n /**\n * Retrieves a list of orders, including ticket data.\n * @public\n * @param options - An object representing the available options for retrieving a list of orders.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Basic Events Order Info\n * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listOrders(options?: ListOrdersOptions): Promise;\n interface ListOrdersOptions {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /**\n * Predefined sets of fields to return.\n * - `TICKETS`: Returns `tickets`.\n * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.\n * - `FORM` : Returns `checkoutForm`.\n * - `INVOICE`: Returns `invoice`.\n *\n * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.\n */\n fieldset?: OrderFieldset[];\n /**\n * Order status. Possible values:\n * - `FREE`: The order is confirmed, no payment is required.\n * - `PENDING`: The order was paid, but the payment gateway suspended the payment.\n * - `PAID`: The order is paid.\n * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.\n * - `INITIATED`: The order is awaiting for payment.\n * - `CANCELED`: The order is canceled.\n * - `DECLINED`: The order is payment is declined.\n */\n status?: OrderStatus$1[];\n /** Event ID to which the order belongs. */\n eventId?: string[];\n /** Order number. */\n orderNumber?: string[];\n /** Site member ID. */\n memberId?: string[];\n /** Field facets. */\n facet?: string[];\n /** Search filter. You can search `fullName`, `email` and `orderNumber`. */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Sort order.\n * Default: `created:asc`.\n */\n sort?: string;\n /** Order tag. */\n tag?: OrderTag[];\n /** Guest contact IDs. */\n contactId?: string[];\n }\n /**\n * Retrieves an order, including ticket data.\n * \n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n * @param options - An object representing the available options for getting an order.\n * @param identifiers - An object containing identifiers for the order to be retrieved.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Basic Events Order Info\n * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Requested order.\n */\n function getOrder(identifiers: GetOrderIdentifiers, options?: GetOrderOptions): Promise;\n interface GetOrderIdentifiers {\n /** Event ID to which the order belongs. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n }\n interface GetOrderOptions {\n /**\n * Predefined sets of fields to return.\n * - `TICKETS`: Returns `tickets`.\n * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.\n * - `FORM` : Returns `checkoutForm`.\n * - `INVOICE`: Returns `invoice`.\n *\n * Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.\n */\n fieldset?: OrderFieldset[];\n }\n /**\n * Updates an order.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n * @param options - An object representing the available options for updating an order.\n * @param identifiers - An object containing identifiers for the order to be updated.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateOrder(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions): Promise;\n interface UpdateOrderIdentifiers {\n /** Event ID to which the order belongs. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n }\n interface UpdateOrderOptions {\n /** Checkout form. */\n checkoutForm?: FormResponse$1;\n /** Whether order is archived. */\n archived?: boolean;\n }\n /**\n * Archives multiple orders.\n * @public\n * @requiredField eventId\n * @param options - An object representing the available options for confirming an order.\n * @param eventId - Event ID to which the order belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise;\n interface BulkUpdateOrdersOptions {\n /** Unique order number. */\n orderNumber?: string[];\n /** Whether to archive the order. */\n archived?: boolean;\n }\n /**\n * Confirms an order.\n *\n *\n * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.\n * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).\n * @public\n * @requiredField eventId\n * @param options - An object representing the available options for confirming an order.\n * @param eventId - Event ID to which the order belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise;\n interface ConfirmOrderOptions {\n /** Order numbers. */\n orderNumber?: string[];\n }\n /**\n * Retrieves a summary of total ticket sales.\n * \n * @public\n * @param options - An object representing the available options for retrieving a summary of total ticket sales.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Basic Events Order Info\n * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function getSummary(options?: GetSummaryOptions): Promise;\n interface GetSummaryOptions {\n /** Event ID. */\n eventId?: string | null;\n }\n interface GetInvoicePreviewIdentifiers {\n /** Event ID to which the invoice belongs. */\n eventId: string;\n /** Order number. */\n orderNumber: string;\n }\n /**\n * Retrieves checkout details.\n * @public\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function getCheckoutOptions(): Promise;\n /**\n * Returns tickets available to reserve.\n * \n * @public\n * @param options - An object representing the available options for retrieving a list of tickets available for reservation.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise;\n interface ListAvailableTicketsOptions {\n /** Event ID. If not provided, available tickets for all events in the site will be returned. */\n eventId?: string;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /**\n * Sort order.\n * Default: `created:asc`.\n */\n sort?: string;\n state?: State$3[];\n }\n /**\n * Returns tickets available to reserve.\n * \n * @public\n * @param options - An object representing the available options for retrieving a list of tickets available for reservation.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise;\n interface QueryAvailableTicketsOptions {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Ticket definition. */\n filter?: Record | null;\n fieldset?: TicketDefinitionFieldset$1[];\n /**\n * Sort order.\n * Default: `created:asc`.\n */\n sort?: string;\n }\n /**\n * Reserves tickets for 20 minutes.\n *\n *\n * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.\n * When the reservation expires, the tickets are added back to the stock.\n * @public\n * @requiredField eventId\n * @param options - An object representing the available options for creating a reservation.\n * @param eventId - Event ID to which the reservation belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function createReservation(eventId: string, options?: CreateReservationOptions): Promise;\n interface CreateReservationOptions {\n /** Tickets to reserve. */\n ticketQuantities?: TicketReservationQuantity[];\n /** Whether to ignore the available ticket limits upon reservation. */\n ignoreLimits?: boolean;\n /** Whether to allow reservation for hidden tickets. */\n allowHiddenTickets?: boolean;\n }\n /**\n * Cancels ticket reservation and returns tickets to stock.\n * \n * @param _id - Reservation ID.\n * @public\n * @requiredField _id\n * @requiredField eventId\n * @param identifiers - An object containing identifiers for the reservation to be cancelled.\n * @param eventId - Event ID to which the reservation belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function cancelReservation(_id: string, eventId: string): Promise;\n /**\n * Generates a preview of an invoice, including the given coupon or pricing plan.\n * @param reservationId - Reservation ID.\n * @public\n * @requiredField eventId\n * @requiredField reservationId\n * @param options - An object representing the available options for generating a preview of a reservation invoice.\n * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.\n * @param eventId - Event ID to which the invoice belongs.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Basic Events Order Info\n * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise;\n interface GetInvoiceOptions {\n /** Optional discount to be applied on the returned invoice. */\n withDiscount?: DiscountRequest;\n /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */\n paidPlanBenefit?: PaidPlanBenefit;\n }\n /**\n * Checkouts the reserved tickets.\n *\n *\n * Creates an order and associates it with a site visitor contact.\n * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.\n *\n * There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.\n * To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:\n * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`\n *\n * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`\n * @public\n * @requiredField eventId\n * @requiredField options.guests.form\n * @param options - An object representing the available options for checking out a reserved ticket.\n * @param eventId - Event ID to which the checkout belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function checkout(eventId: string, options?: CheckoutOptionsForRequest): Promise;\n interface CheckoutOptionsForRequest {\n /** Ticket reservation ID. */\n reservationId?: string;\n /** Member ID (if empty - no site member is associated to this order). */\n memberId?: string;\n /** Discount to apply on the invoice. */\n discount?: DiscountRequest;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest$1[];\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n /** Options controlling the checkout process. */\n options?: CheckoutOptions;\n }\n /**\n * Updates order and tickets.\n *\n *\n * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.\n * @param orderNumber - Unique order number.\n * @public\n * @requiredField eventId\n * @requiredField orderNumber\n * @param options - An object representing the available options for updating an order and tickets.\n * @param identifiers - An object containing identifiers for the order and tickets to be updated.\n * @param eventId - Event ID to which the checkout belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise;\n interface UpdateCheckoutOptions {\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest$1[];\n /** Member ID (if empty - no site member is associated to this order). */\n memberId?: string | null;\n /** Discount to apply on the invoice. */\n discount?: DiscountRequest;\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n }\n interface PosCheckoutOptions {\n /** Ticket reservation ID. */\n reservationId: string;\n /**\n * Payment details ID.\n * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.\n */\n paymentDetailsId?: string | null;\n }\n type eventsV1OrderOrders_universal_d_Order = Order;\n type eventsV1OrderOrders_universal_d_TicketingTicket = TicketingTicket;\n type eventsV1OrderOrders_universal_d_ChannelType = ChannelType;\n const eventsV1OrderOrders_universal_d_ChannelType: typeof ChannelType;\n type eventsV1OrderOrders_universal_d_PaymentDetails = PaymentDetails;\n type eventsV1OrderOrders_universal_d_PaymentTransaction = PaymentTransaction;\n type eventsV1OrderOrders_universal_d_ListOrdersRequest = ListOrdersRequest;\n type eventsV1OrderOrders_universal_d_OrderFieldset = OrderFieldset;\n const eventsV1OrderOrders_universal_d_OrderFieldset: typeof OrderFieldset;\n type eventsV1OrderOrders_universal_d_OrderTag = OrderTag;\n const eventsV1OrderOrders_universal_d_OrderTag: typeof OrderTag;\n type eventsV1OrderOrders_universal_d_ListOrdersResponse = ListOrdersResponse;\n type eventsV1OrderOrders_universal_d_OrderFacets = OrderFacets;\n type eventsV1OrderOrders_universal_d_OrderFacetCounts = OrderFacetCounts;\n type eventsV1OrderOrders_universal_d_Counts = Counts;\n type eventsV1OrderOrders_universal_d_GetOrderRequest = GetOrderRequest;\n type eventsV1OrderOrders_universal_d_GetOrderResponse = GetOrderResponse;\n type eventsV1OrderOrders_universal_d_UpdateOrderRequest = UpdateOrderRequest;\n type eventsV1OrderOrders_universal_d_UpdateOrderResponse = UpdateOrderResponse;\n type eventsV1OrderOrders_universal_d_BulkUpdateOrdersRequest = BulkUpdateOrdersRequest;\n type eventsV1OrderOrders_universal_d_BulkUpdateOrdersResponse = BulkUpdateOrdersResponse;\n type eventsV1OrderOrders_universal_d_ConfirmOrderRequest = ConfirmOrderRequest;\n type eventsV1OrderOrders_universal_d_ConfirmOrderResponse = ConfirmOrderResponse;\n type eventsV1OrderOrders_universal_d_GetSummaryRequest = GetSummaryRequest;\n type eventsV1OrderOrders_universal_d_GetSummaryResponse = GetSummaryResponse;\n type eventsV1OrderOrders_universal_d_TicketSales = TicketSales;\n type eventsV1OrderOrders_universal_d_GetInvoicePreviewRequest = GetInvoicePreviewRequest;\n type eventsV1OrderOrders_universal_d_RawHttpResponse = RawHttpResponse;\n type eventsV1OrderOrders_universal_d_HeadersEntry = HeadersEntry;\n type eventsV1OrderOrders_universal_d_GetPaymentInfoRequest = GetPaymentInfoRequest;\n type eventsV1OrderOrders_universal_d_GetPaymentInfoResponse = GetPaymentInfoResponse;\n type eventsV1OrderOrders_universal_d_PaymentTransactionSummary = PaymentTransactionSummary;\n type eventsV1OrderOrders_universal_d_PaymentTransactionEvent = PaymentTransactionEvent;\n type eventsV1OrderOrders_universal_d_OrderPaid = OrderPaid;\n type eventsV1OrderOrders_universal_d_ReservationCreated = ReservationCreated;\n type eventsV1OrderOrders_universal_d_ReservationStatus = ReservationStatus;\n const eventsV1OrderOrders_universal_d_ReservationStatus: typeof ReservationStatus;\n type eventsV1OrderOrders_universal_d_TicketQuantity = TicketQuantity;\n type eventsV1OrderOrders_universal_d_ReservationCount = ReservationCount;\n type eventsV1OrderOrders_universal_d_ReservationUpdated = ReservationUpdated;\n type eventsV1OrderOrders_universal_d_GetCheckoutOptionsRequest = GetCheckoutOptionsRequest;\n type eventsV1OrderOrders_universal_d_GetCheckoutOptionsResponse = GetCheckoutOptionsResponse;\n type eventsV1OrderOrders_universal_d_ListAvailableTicketsRequest = ListAvailableTicketsRequest;\n type eventsV1OrderOrders_universal_d_ListAvailableTicketsResponse = ListAvailableTicketsResponse;\n type eventsV1OrderOrders_universal_d_QueryAvailableTicketsRequest = QueryAvailableTicketsRequest;\n type eventsV1OrderOrders_universal_d_QueryAvailableTicketsResponse = QueryAvailableTicketsResponse;\n type eventsV1OrderOrders_universal_d_CreateReservationRequest = CreateReservationRequest;\n type eventsV1OrderOrders_universal_d_TicketReservationQuantity = TicketReservationQuantity;\n type eventsV1OrderOrders_universal_d_CreateReservationResponse = CreateReservationResponse;\n type eventsV1OrderOrders_universal_d_TicketReservation = TicketReservation;\n type eventsV1OrderOrders_universal_d_CancelReservationRequest = CancelReservationRequest;\n type eventsV1OrderOrders_universal_d_CancelReservationResponse = CancelReservationResponse;\n type eventsV1OrderOrders_universal_d_GetInvoiceRequest = GetInvoiceRequest;\n type eventsV1OrderOrders_universal_d_DiscountRequest = DiscountRequest;\n type eventsV1OrderOrders_universal_d_PaidPlanBenefit = PaidPlanBenefit;\n type eventsV1OrderOrders_universal_d_GetInvoiceResponse = GetInvoiceResponse;\n type eventsV1OrderOrders_universal_d_DiscountErrors = DiscountErrors;\n type eventsV1OrderOrders_universal_d_Error = Error;\n type eventsV1OrderOrders_universal_d_CheckoutRequest = CheckoutRequest;\n type eventsV1OrderOrders_universal_d_Buyer = Buyer;\n type eventsV1OrderOrders_universal_d_CheckoutOptions = CheckoutOptions;\n type eventsV1OrderOrders_universal_d_CheckoutResponse = CheckoutResponse;\n type eventsV1OrderOrders_universal_d_OrderInitiated = OrderInitiated;\n type eventsV1OrderOrders_universal_d_UpdateCheckoutRequest = UpdateCheckoutRequest;\n type eventsV1OrderOrders_universal_d_UpdateCheckoutResponse = UpdateCheckoutResponse;\n type eventsV1OrderOrders_universal_d_OrderPageUrls = OrderPageUrls;\n type eventsV1OrderOrders_universal_d_PosCheckoutRequest = PosCheckoutRequest;\n type eventsV1OrderOrders_universal_d_PosCheckoutResponse = PosCheckoutResponse;\n const eventsV1OrderOrders_universal_d_listOrders: typeof listOrders;\n type eventsV1OrderOrders_universal_d_ListOrdersOptions = ListOrdersOptions;\n const eventsV1OrderOrders_universal_d_getOrder: typeof getOrder;\n type eventsV1OrderOrders_universal_d_GetOrderIdentifiers = GetOrderIdentifiers;\n type eventsV1OrderOrders_universal_d_GetOrderOptions = GetOrderOptions;\n const eventsV1OrderOrders_universal_d_updateOrder: typeof updateOrder;\n type eventsV1OrderOrders_universal_d_UpdateOrderIdentifiers = UpdateOrderIdentifiers;\n type eventsV1OrderOrders_universal_d_UpdateOrderOptions = UpdateOrderOptions;\n const eventsV1OrderOrders_universal_d_bulkUpdateOrders: typeof bulkUpdateOrders;\n type eventsV1OrderOrders_universal_d_BulkUpdateOrdersOptions = BulkUpdateOrdersOptions;\n const eventsV1OrderOrders_universal_d_confirmOrder: typeof confirmOrder;\n type eventsV1OrderOrders_universal_d_ConfirmOrderOptions = ConfirmOrderOptions;\n const eventsV1OrderOrders_universal_d_getSummary: typeof getSummary;\n type eventsV1OrderOrders_universal_d_GetSummaryOptions = GetSummaryOptions;\n type eventsV1OrderOrders_universal_d_GetInvoicePreviewIdentifiers = GetInvoicePreviewIdentifiers;\n const eventsV1OrderOrders_universal_d_getCheckoutOptions: typeof getCheckoutOptions;\n const eventsV1OrderOrders_universal_d_listAvailableTickets: typeof listAvailableTickets;\n type eventsV1OrderOrders_universal_d_ListAvailableTicketsOptions = ListAvailableTicketsOptions;\n const eventsV1OrderOrders_universal_d_queryAvailableTickets: typeof queryAvailableTickets;\n type eventsV1OrderOrders_universal_d_QueryAvailableTicketsOptions = QueryAvailableTicketsOptions;\n const eventsV1OrderOrders_universal_d_createReservation: typeof createReservation;\n type eventsV1OrderOrders_universal_d_CreateReservationOptions = CreateReservationOptions;\n const eventsV1OrderOrders_universal_d_cancelReservation: typeof cancelReservation;\n const eventsV1OrderOrders_universal_d_getInvoice: typeof getInvoice;\n type eventsV1OrderOrders_universal_d_GetInvoiceOptions = GetInvoiceOptions;\n const eventsV1OrderOrders_universal_d_checkout: typeof checkout;\n type eventsV1OrderOrders_universal_d_CheckoutOptionsForRequest = CheckoutOptionsForRequest;\n const eventsV1OrderOrders_universal_d_updateCheckout: typeof updateCheckout;\n type eventsV1OrderOrders_universal_d_UpdateCheckoutOptions = UpdateCheckoutOptions;\n type eventsV1OrderOrders_universal_d_PosCheckoutOptions = PosCheckoutOptions;\n namespace eventsV1OrderOrders_universal_d {\n export { eventsV1OrderOrders_universal_d_Order as Order, FormResponse$1 as FormResponse, InputValue$1 as InputValue, FormattedAddress$1 as FormattedAddress, Address$4 as Address, AddressStreetOneOf$4 as AddressStreetOneOf, StreetAddress$4 as StreetAddress, AddressLocation$4 as AddressLocation, Subdivision$4 as Subdivision, SubdivisionType$4 as SubdivisionType, StandardDetails$1 as StandardDetails, OrderStatus$1 as OrderStatus, Money$4 as Money, eventsV1OrderOrders_universal_d_TicketingTicket as TicketingTicket, CheckIn$1 as CheckIn, GuestDetails$1 as GuestDetails, eventsV1OrderOrders_universal_d_ChannelType as ChannelType, TicketDetails$1 as TicketDetails, Invoice$1 as Invoice, Item$1 as Item, Discount$1 as Discount, DiscountItem$1 as DiscountItem, DiscountItemDiscountOneOf$1 as DiscountItemDiscountOneOf, CouponDiscount$1 as CouponDiscount, PaidPlanDiscount$1 as PaidPlanDiscount, PaidPlanDiscountDiscountOneOf$1 as PaidPlanDiscountDiscountOneOf, PercentDiscount$1 as PercentDiscount, Tax$1 as Tax, TaxType$3 as TaxType, Fee$1 as Fee, FeeName$1 as FeeName, FeeType$2 as FeeType, eventsV1OrderOrders_universal_d_PaymentDetails as PaymentDetails, eventsV1OrderOrders_universal_d_PaymentTransaction as PaymentTransaction, OrderDeleted$1 as OrderDeleted, OrderType$1 as OrderType, Ticket$1 as Ticket, OnlineConferencingLogin$1 as OnlineConferencingLogin, eventsV1OrderOrders_universal_d_ListOrdersRequest as ListOrdersRequest, eventsV1OrderOrders_universal_d_OrderFieldset as OrderFieldset, eventsV1OrderOrders_universal_d_OrderTag as OrderTag, eventsV1OrderOrders_universal_d_ListOrdersResponse as ListOrdersResponse, FacetCounts$3 as FacetCounts, eventsV1OrderOrders_universal_d_OrderFacets as OrderFacets, eventsV1OrderOrders_universal_d_OrderFacetCounts as OrderFacetCounts, eventsV1OrderOrders_universal_d_Counts as Counts, eventsV1OrderOrders_universal_d_GetOrderRequest as GetOrderRequest, eventsV1OrderOrders_universal_d_GetOrderResponse as GetOrderResponse, CalendarLinks$2 as CalendarLinks, eventsV1OrderOrders_universal_d_UpdateOrderRequest as UpdateOrderRequest, eventsV1OrderOrders_universal_d_UpdateOrderResponse as UpdateOrderResponse, OrderUpdated$1 as OrderUpdated, eventsV1OrderOrders_universal_d_BulkUpdateOrdersRequest as BulkUpdateOrdersRequest, eventsV1OrderOrders_universal_d_BulkUpdateOrdersResponse as BulkUpdateOrdersResponse, eventsV1OrderOrders_universal_d_ConfirmOrderRequest as ConfirmOrderRequest, eventsV1OrderOrders_universal_d_ConfirmOrderResponse as ConfirmOrderResponse, eventsV1OrderOrders_universal_d_GetSummaryRequest as GetSummaryRequest, eventsV1OrderOrders_universal_d_GetSummaryResponse as GetSummaryResponse, eventsV1OrderOrders_universal_d_TicketSales as TicketSales, eventsV1OrderOrders_universal_d_GetInvoicePreviewRequest as GetInvoicePreviewRequest, eventsV1OrderOrders_universal_d_RawHttpResponse as RawHttpResponse, eventsV1OrderOrders_universal_d_HeadersEntry as HeadersEntry, eventsV1OrderOrders_universal_d_GetPaymentInfoRequest as GetPaymentInfoRequest, eventsV1OrderOrders_universal_d_GetPaymentInfoResponse as GetPaymentInfoResponse, eventsV1OrderOrders_universal_d_PaymentTransactionSummary as PaymentTransactionSummary, eventsV1OrderOrders_universal_d_PaymentTransactionEvent as PaymentTransactionEvent, MessageEnvelope$5 as MessageEnvelope, IdentificationData$5 as IdentificationData, IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, WebhookIdentityType$5 as WebhookIdentityType, OrderConfirmed$1 as OrderConfirmed, eventsV1OrderOrders_universal_d_OrderPaid as OrderPaid, eventsV1OrderOrders_universal_d_ReservationCreated as ReservationCreated, eventsV1OrderOrders_universal_d_ReservationStatus as ReservationStatus, eventsV1OrderOrders_universal_d_TicketQuantity as TicketQuantity, eventsV1OrderOrders_universal_d_ReservationCount as ReservationCount, eventsV1OrderOrders_universal_d_ReservationUpdated as ReservationUpdated, eventsV1OrderOrders_universal_d_GetCheckoutOptionsRequest as GetCheckoutOptionsRequest, eventsV1OrderOrders_universal_d_GetCheckoutOptionsResponse as GetCheckoutOptionsResponse, eventsV1OrderOrders_universal_d_ListAvailableTicketsRequest as ListAvailableTicketsRequest, State$3 as State, eventsV1OrderOrders_universal_d_ListAvailableTicketsResponse as ListAvailableTicketsResponse, ResponseMetaData$1 as ResponseMetaData, TicketDefinition$1 as TicketDefinition, Dashboard$3 as Dashboard, WixFeeConfig$1 as WixFeeConfig, TicketSalePeriod$1 as TicketSalePeriod, TicketSaleStatus$1 as TicketSaleStatus, TicketPricing$1 as TicketPricing, TicketPricingPriceOneOf$1 as TicketPricingPriceOneOf, PricingOptions$1 as PricingOptions, PricingOption$1 as PricingOption, Type$2 as Type, eventsV1OrderOrders_universal_d_QueryAvailableTicketsRequest as QueryAvailableTicketsRequest, TicketDefinitionFieldset$1 as TicketDefinitionFieldset, eventsV1OrderOrders_universal_d_QueryAvailableTicketsResponse as QueryAvailableTicketsResponse, eventsV1OrderOrders_universal_d_CreateReservationRequest as CreateReservationRequest, eventsV1OrderOrders_universal_d_TicketReservationQuantity as TicketReservationQuantity, eventsV1OrderOrders_universal_d_CreateReservationResponse as CreateReservationResponse, eventsV1OrderOrders_universal_d_TicketReservation as TicketReservation, eventsV1OrderOrders_universal_d_CancelReservationRequest as CancelReservationRequest, eventsV1OrderOrders_universal_d_CancelReservationResponse as CancelReservationResponse, eventsV1OrderOrders_universal_d_GetInvoiceRequest as GetInvoiceRequest, eventsV1OrderOrders_universal_d_DiscountRequest as DiscountRequest, eventsV1OrderOrders_universal_d_PaidPlanBenefit as PaidPlanBenefit, eventsV1OrderOrders_universal_d_GetInvoiceResponse as GetInvoiceResponse, eventsV1OrderOrders_universal_d_DiscountErrors as DiscountErrors, eventsV1OrderOrders_universal_d_Error as Error, eventsV1OrderOrders_universal_d_CheckoutRequest as CheckoutRequest, eventsV1OrderOrders_universal_d_Buyer as Buyer, Guest$1 as Guest, eventsV1OrderOrders_universal_d_CheckoutOptions as CheckoutOptions, eventsV1OrderOrders_universal_d_CheckoutResponse as CheckoutResponse, eventsV1OrderOrders_universal_d_OrderInitiated as OrderInitiated, eventsV1OrderOrders_universal_d_UpdateCheckoutRequest as UpdateCheckoutRequest, eventsV1OrderOrders_universal_d_UpdateCheckoutResponse as UpdateCheckoutResponse, eventsV1OrderOrders_universal_d_OrderPageUrls as OrderPageUrls, eventsV1OrderOrders_universal_d_PosCheckoutRequest as PosCheckoutRequest, eventsV1OrderOrders_universal_d_PosCheckoutResponse as PosCheckoutResponse, eventsV1OrderOrders_universal_d_listOrders as listOrders, eventsV1OrderOrders_universal_d_ListOrdersOptions as ListOrdersOptions, eventsV1OrderOrders_universal_d_getOrder as getOrder, eventsV1OrderOrders_universal_d_GetOrderIdentifiers as GetOrderIdentifiers, eventsV1OrderOrders_universal_d_GetOrderOptions as GetOrderOptions, eventsV1OrderOrders_universal_d_updateOrder as updateOrder, eventsV1OrderOrders_universal_d_UpdateOrderIdentifiers as UpdateOrderIdentifiers, eventsV1OrderOrders_universal_d_UpdateOrderOptions as UpdateOrderOptions, eventsV1OrderOrders_universal_d_bulkUpdateOrders as bulkUpdateOrders, eventsV1OrderOrders_universal_d_BulkUpdateOrdersOptions as BulkUpdateOrdersOptions, eventsV1OrderOrders_universal_d_confirmOrder as confirmOrder, eventsV1OrderOrders_universal_d_ConfirmOrderOptions as ConfirmOrderOptions, eventsV1OrderOrders_universal_d_getSummary as getSummary, eventsV1OrderOrders_universal_d_GetSummaryOptions as GetSummaryOptions, eventsV1OrderOrders_universal_d_GetInvoicePreviewIdentifiers as GetInvoicePreviewIdentifiers, eventsV1OrderOrders_universal_d_getCheckoutOptions as getCheckoutOptions, eventsV1OrderOrders_universal_d_listAvailableTickets as listAvailableTickets, eventsV1OrderOrders_universal_d_ListAvailableTicketsOptions as ListAvailableTicketsOptions, eventsV1OrderOrders_universal_d_queryAvailableTickets as queryAvailableTickets, eventsV1OrderOrders_universal_d_QueryAvailableTicketsOptions as QueryAvailableTicketsOptions, eventsV1OrderOrders_universal_d_createReservation as createReservation, eventsV1OrderOrders_universal_d_CreateReservationOptions as CreateReservationOptions, eventsV1OrderOrders_universal_d_cancelReservation as cancelReservation, eventsV1OrderOrders_universal_d_getInvoice as getInvoice, eventsV1OrderOrders_universal_d_GetInvoiceOptions as GetInvoiceOptions, eventsV1OrderOrders_universal_d_checkout as checkout, eventsV1OrderOrders_universal_d_CheckoutOptionsForRequest as CheckoutOptionsForRequest, eventsV1OrderOrders_universal_d_updateCheckout as updateCheckout, eventsV1OrderOrders_universal_d_UpdateCheckoutOptions as UpdateCheckoutOptions, eventsV1OrderOrders_universal_d_PosCheckoutOptions as PosCheckoutOptions, };\n }\n interface EventGuest {\n /** Guest ID. */\n _id?: string | null;\n /** Event ID. */\n eventId?: string | null;\n /** RSVP ID.

**Note:** Only applicable when `guestType` is `RSVP`. */\n rsvpId?: string | null;\n /** Order number.

**Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`. */\n orderNumber?: string | null;\n /** Ticket number.

**Note:** Only applicable when `guestType` is `TICKET_HOLDER`. */\n ticketNumber?: string | null;\n /** List of names, numbers, and definition IDs for each ticket. */\n tickets?: TicketDetails[];\n /** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */\n contactId?: string | null;\n /** Guest details.

Returned only when the `guestDetails` fieldset is sent in the request. */\n guestDetails?: GuestDetails;\n /** Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping).

**Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */\n attendanceStatus?: AttendanceStatus;\n /** 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. */\n secondaryLanguageCode?: string | null;\n /** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */\n _createdDate?: Date | null;\n /** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */\n _updatedDate?: Date | null;\n /** Date and time of guest's latest attendance status update. */\n attendanceStatusUpdatedDate?: Date | null;\n /** Site member ID. */\n memberId?: string | null;\n /** Guest type. */\n guestType?: GuestType;\n /** Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. */\n locale?: string | null;\n /**\n * Number of total guests in an event (registered guests + additional ones).\n * @readonly\n */\n totalGuests?: number | null;\n /**\n * Revision number, which increments by 1 each time the guest is updated.\n * @readonly\n */\n revision?: string | null;\n }\n interface TicketDetails {\n /** Ticket number. */\n number?: string;\n /** Ticket definition ID. */\n definitionId?: string | null;\n /** Ticket name. */\n name?: string | null;\n }\n interface TicketGuestDetails {\n /** The login details for the guest to access the online conference event. */\n onlineConferencingLogin?: OnlineConferencingLogin;\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n }\n interface OnlineConferencingLogin {\n /**\n * Link URL to the online conference.\n * @readonly\n */\n link?: string;\n /**\n * Password for the online conference.\n * @readonly\n */\n password?: string | null;\n }\n interface GuestDetails {\n /** Email. */\n email?: string | null;\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Form response. */\n formResponse?: FormResponse;\n /** Whether the guest has checked into the event. */\n checkedIn?: boolean;\n /** The login details for the guest to access the online conference event. */\n onlineConferencingLogin?: OnlineConferencingLogin;\n /** Phone extracted from form response. If multiples phone inputs are present, first one is returned. */\n phone?: string | null;\n /** Address extracted from form response. If multiples address inputs are present, first one is returned. */\n address?: string | null;\n }\n interface FormResponse {\n inputValues?: InputValue[];\n }\n interface InputValue {\n inputName?: string;\n value?: string;\n values?: string[];\n }\n interface FormattedAddress {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address$3;\n }\n /** Physical address */\n interface Address$3 extends AddressStreetOneOf$3 {\n /** Street name and number. */\n streetAddress?: StreetAddress$3;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf$3 {\n /** Street name and number. */\n streetAddress?: StreetAddress$3;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$3 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$3 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$3 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n enum SubdivisionType$3 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n /** Subdivision Concordance values */\n interface StandardDetails {\n /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */\n iso31662?: string | null;\n }\n enum AttendanceStatus {\n /** Not attending. */\n NOT_ATTENDING = \"NOT_ATTENDING\",\n /** Attending. */\n ATTENDING = \"ATTENDING\",\n /** In a waiting list. */\n IN_WAITLIST = \"IN_WAITLIST\"\n }\n enum GuestType {\n /** An invited guest, no ticket necessary. */\n RSVP = \"RSVP\",\n /** The guest who bought the ticket. */\n BUYER = \"BUYER\",\n /** The guest for whom the ticket was bought. */\n TICKET_HOLDER = \"TICKET_HOLDER\"\n }\n interface GuestCountUpdated {\n /** Guest. */\n guest?: EventGuest;\n /** Guest count updates. */\n guestCountUpdates?: GuestCountUpdate[];\n }\n interface GuestCountUpdate {\n /** Attendance status. */\n attendanceStatus?: AttendanceStatus;\n /** Total guest count change. */\n totalGuestsDelta?: number;\n /** Guest count change. */\n countDelta?: number;\n }\n interface MemberEventStatusUpdated {\n /** Event id. */\n eventId?: string | null;\n /** Member id. */\n memberId?: string | null;\n /** Member event status. */\n status?: MemberEventStatusUpdatedEventType;\n }\n enum MemberEventStatusUpdatedEventType {\n /**\n * Triggered every time a guest with a specified member ID is added to the event.\n * This event can also be triggered if an existing guest changed their member ID.\n */\n MEMBER_JOINED = \"MEMBER_JOINED\",\n /**\n * Triggered every time a guest with a specified member ID is removed from the event.\n * This event can also be triggered if an existing guest changed their member ID.\n */\n MEMBER_LEFT = \"MEMBER_LEFT\",\n /**\n * Triggered every time a guest with a specified member ID whose status is `ATTENDING` is added to the event.\n * This event can also be triggered if an existing guest changed their member ID or changed their status to `ATTENDING`.\n */\n ATTENDING_MEMBER_JOINED = \"ATTENDING_MEMBER_JOINED\",\n /**\n * Triggered when the last guest with a specified member ID is removed from the event or their status changes to `ATTENDING`.\n * Once triggered there are no more attending guests with a specified member ID in the event.\n * This event can also be triggered if the last existing guest changed their member ID or their status to `NOT_ATTENDING`.\n */\n LAST_ATTENDING_MEMBER_LEFT = \"LAST_ATTENDING_MEMBER_LEFT\"\n }\n interface ContactEventStatusUpdated {\n /** Event id. */\n eventId?: string | null;\n /** Contact id. */\n contactId?: string | null;\n /** Contact event status. */\n status?: EventType$2;\n }\n enum EventType$2 {\n /**\n * Triggered every time a guest with a specified contact ID is added to the event.\n * This event can also be triggered if an existing guest changed their contact ID.\n */\n CONTACT_JOINED = \"CONTACT_JOINED\",\n /**\n * Triggered every time a guest with a specified contact ID is removed from the event.\n * This event can also be triggered if an existing guest changed their contact ID.\n */\n CONTACT_LEFT = \"CONTACT_LEFT\",\n /**\n * Triggred when the last guest with a specified contact ID is removed from the event.\n * Once triggered there are no more guests with a specified contact ID in the event.\n * This event can also be triggered if the last existing guest changed their contact ID.\n */\n LAST_CONTACT_LEFT = \"LAST_CONTACT_LEFT\"\n }\n interface GuestCheckedIn {\n /** Event guest */\n guest?: EventGuest;\n /** Event details */\n eventDetails?: EventDetails;\n }\n interface EventDetails {\n /**\n * Event title.\n * @readonly\n */\n title?: string | null;\n /**\n * Event short description.\n * @readonly\n */\n shortDescription?: string | null;\n /**\n * Event location.\n * @readonly\n */\n location?: Location$3;\n /**\n * Event date and time settings.\n * @readonly\n */\n dateAndTimeSettings?: DateAndTimeSettings$1;\n /**\n * Event page URL components.\n * @readonly\n */\n eventPageUrl?: string;\n /**\n * Event status.\n * @readonly\n */\n status?: Status$3;\n }\n interface Location$3 {\n /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */\n name?: string | null;\n /** Location type. */\n type?: LocationType$3;\n /** Exact location address. */\n address?: CommonAddress$1;\n /** Whether the event location is TBD. */\n locationTbd?: boolean | null;\n }\n enum LocationType$3 {\n /** Unknown location type. */\n UNKNOWN_LOCATION = \"UNKNOWN_LOCATION\",\n /** Event is on-site at a specific physical location. */\n VENUE = \"VENUE\",\n /** Event is online, such as a virtual video conference. */\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {\n /** Street address. */\n streetAddress?: CommonStreetAddress$1;\n /** Primary address information (street and building number). */\n addressLine1?: string | null;\n /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip or postal code. */\n postalCode?: string | null;\n /** Secondary address information (suite or apartment number and room number). */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface CommonAddressStreetOneOf$1 {\n /** Street address. */\n streetAddress?: CommonStreetAddress$1;\n /** Primary address information (street and building number). */\n addressLine?: string | null;\n }\n interface CommonStreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface CommonAddressLocation$1 {\n /** Address latitude coordinates. */\n latitude?: number | null;\n /** Address longitude coordinates. */\n longitude?: number | null;\n }\n interface CommonSubdivision$1 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n enum SubdivisionSubdivisionType$1 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface DateAndTimeSettings$1 {\n /** Whether the event date and time are TBD. */\n dateAndTimeTbd?: boolean | null;\n /** Message that is displayed when time and date is TBD. */\n dateAndTimeTbdMessage?: string | null;\n /** Event start date. */\n startDate?: Date | null;\n /** Event end date. */\n endDate?: Date | null;\n /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */\n timeZoneId?: string | null;\n /** Whether the end date is hidden in the formatted date and time. */\n hideEndDate?: boolean | null;\n /** Whether the time zone is displayed in the formatted schedule. */\n showTimeZone?: boolean | null;\n /**\n * Repeating event status.\n * @readonly\n */\n recurrenceStatus?: RecurrenceStatusStatus$1;\n /** Event repetitions. */\n recurringEvents?: Recurrences$3;\n /** Formatted date and time settings. */\n formatted?: Formatted$1;\n }\n enum RecurrenceStatusStatus$1 {\n /** Unknown recurrance status. */\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Event happens only once and can last multiple days. */\n ONE_TIME = \"ONE_TIME\",\n /** A series of events that repeat. */\n RECURRING = \"RECURRING\",\n /** Next event in a schedule of recurring events. */\n RECURRING_UPCOMING = \"RECURRING_UPCOMING\",\n /** Latest event that ended in a schedule of recurring events. */\n RECURRING_RECENTLY_ENDED = \"RECURRING_RECENTLY_ENDED\",\n /** Latest canceled event in a schedule of recurring events */\n RECURRING_RECENTLY_CANCELED = \"RECURRING_RECENTLY_CANCELED\"\n }\n interface Recurrences$3 {\n /** Individual event dates. */\n individualEventDates?: Occurrence$3[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n }\n interface Occurrence$3 {\n /** Event start date. */\n startDate?: Date | null;\n /** Event end date. */\n endDate?: Date | null;\n /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */\n timeZoneId?: string | null;\n /** Whether the time zone is displayed in a formatted schedule. */\n showTimeZone?: boolean;\n }\n interface Formatted$1 {\n /**\n * Formatted date and time representation.
\n * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
\n * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.\n * @readonly\n */\n dateAndTime?: string | null;\n /**\n * Formatted start date of the event. Empty for TBD schedules.\n * @readonly\n */\n startDate?: string | null;\n /**\n * Formatted start time of the event. Empty for TBD schedules.\n * @readonly\n */\n startTime?: string | null;\n /**\n * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.\n * @readonly\n */\n endDate?: string | null;\n /**\n * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.\n * @readonly\n */\n endTime?: string | null;\n }\n enum Status$3 {\n /** Unknown event status. */\n UNKNOWN_EVENT_STATUS = \"UNKNOWN_EVENT_STATUS\",\n /** Event is published and scheduled to start. */\n UPCOMING = \"UPCOMING\",\n /** Event has started. */\n STARTED = \"STARTED\",\n /** Event has ended. */\n ENDED = \"ENDED\",\n /** Event is canceled. */\n CANCELED = \"CANCELED\",\n /** Event is not public. */\n DRAFT = \"DRAFT\"\n }\n interface NotifyGuestAction {\n /** Event guest. */\n guest?: EventGuest;\n /** Task context. */\n taskContext?: TaskContext;\n }\n interface TaskContext {\n /** Task id. */\n _id?: string | null;\n /** Notify action type. */\n type?: NotifyActionType;\n /** Timing. Used for EVENT_STARTS */\n timing?: Timing;\n /** Event context. */\n event?: EventDetails;\n /** Order context. */\n order?: OrderDetails;\n }\n enum NotifyActionType {\n UNKNOWN = \"UNKNOWN\",\n EMAIL = \"EMAIL\",\n AUTOMATION_TRIGGER = \"AUTOMATION_TRIGGER\",\n PUSH = \"PUSH\",\n EVENT_CANCELED = \"EVENT_CANCELED\",\n EVENT_STARTS = \"EVENT_STARTS\",\n ORDER_CANCELED = \"ORDER_CANCELED\"\n }\n enum Timing {\n /** Unknown event start time. */\n UNKNOWN_TIMING = \"UNKNOWN_TIMING\",\n /** Instant. */\n NOW = \"NOW\",\n /** 24 hours prior. */\n STARTS_IN_1_DAY = \"STARTS_IN_1_DAY\",\n /** 3 days prior. */\n STARTS_IN_3_DAYS = \"STARTS_IN_3_DAYS\",\n /** 7 days prior. */\n STARTS_IN_1_WEEK = \"STARTS_IN_1_WEEK\",\n /** 1 hour prior. */\n STARTS_IN_1_HOUR = \"STARTS_IN_1_HOUR\",\n /** 30 minutes prior. */\n STARTS_IN_30_MINUTES = \"STARTS_IN_30_MINUTES\",\n /** 2 hours prior. */\n STARTS_IN_2_HOURS = \"STARTS_IN_2_HOURS\"\n }\n interface OrderDetails {\n /** Order status */\n orderStatus?: OrderStatus;\n /** Invoice */\n invoice?: Invoice;\n }\n enum OrderStatus {\n /** Order status not available for this request fieldset. */\n NA_ORDER_STATUS = \"NA_ORDER_STATUS\",\n /** Order is confirmed and payment isn't required. */\n FREE = \"FREE\",\n /** Order is paid for but the payment gateway has suspended the payment. */\n PENDING = \"PENDING\",\n /** Order is paid via a payment gateway. */\n PAID = \"PAID\",\n /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */\n OFFLINE_PENDING = \"OFFLINE_PENDING\",\n /** Order is awaiting payment at the cashier. */\n INITIATED = \"INITIATED\",\n /** Order is canceled. */\n CANCELED = \"CANCELED\",\n /** Order payment is declined. */\n DECLINED = \"DECLINED\",\n /** Order payment is authorized. */\n AUTHORIZED = \"AUTHORIZED\",\n /** Order payment is voided. */\n VOIDED = \"VOIDED\",\n /** Order is partially paid with less than the total amount. */\n PARTIALLY_PAID = \"PARTIALLY_PAID\"\n }\n interface Invoice {\n items?: Item[];\n /**\n * Total cart amount.\n * @deprecated\n */\n total?: Money$3;\n /** Discount applied to cart. */\n discount?: Discount;\n /** Tax applied to cart. */\n tax?: Tax;\n /** Total cart amount before discount, tax, and fees. */\n subTotal?: Money$3;\n /**\n * Total amount of cart after discount, tax, and fees.\n * Grand total is calculated in the following order:\n * 1. Total prices of all items in the cart are calculated.\n * 2. Discount is subtracted from the cart (if applicable).\n * 3. Tax is added (if applicable).\n * 4. Wix ticket service fee is added.\n */\n grandTotal?: Money$3;\n /**\n * Fees applied to the cart.\n * @readonly\n */\n fees?: Fee[];\n /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */\n revenue?: Money$3;\n /** URL to invoice preview. Returned only if order is paid. */\n previewUrl?: string | null;\n }\n interface Item {\n /** Unique line item ID. */\n _id?: string;\n /** Line item quantity. */\n quantity?: number;\n /** Line item name. */\n name?: string;\n /** Line item price. */\n price?: Money$3;\n /** Total price for line items. Always equal to price * quantity. */\n total?: Money$3;\n /** Discount applied to the line item. */\n discount?: Discount;\n /** Tax applied to the item. */\n tax?: Tax;\n /**\n * Fees applied to the item.\n * @readonly\n */\n fees?: Fee[];\n }\n interface Money$3 {\n /**\n * *Deprecated:** Use `value` instead.\n * @deprecated\n */\n amount?: string;\n /** ISO 4217 format of the currency e.g., `USD`. */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface Discount {\n /** Total discount amount. */\n amount?: Money$3;\n /** Total charge after applied discount. */\n afterDiscount?: Money$3;\n /**\n * Discount coupon code.\n * @deprecated\n */\n code?: string;\n /**\n * Discount coupon name.\n * @deprecated\n */\n name?: string;\n /**\n * Discount coupon ID.\n * @deprecated\n */\n couponId?: string;\n /** Discount items. */\n discounts?: DiscountItem[];\n }\n interface DiscountItem extends DiscountItemDiscountOneOf {\n /** Coupon discount. */\n coupon?: CouponDiscount;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount;\n /** Total discount amount. */\n amount?: Money$3;\n }\n /** @oneof */\n interface DiscountItemDiscountOneOf {\n /** Coupon discount. */\n coupon?: CouponDiscount;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount;\n }\n interface CouponDiscount {\n /** Discount coupon name. */\n name?: string;\n /** Discount coupon code. */\n code?: string;\n /** Discount coupon ID. */\n couponId?: string;\n }\n interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount;\n /** Name of pricing plan. */\n name?: string;\n }\n /** @oneof */\n interface PaidPlanDiscountDiscountOneOf {\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount;\n }\n interface PercentDiscount {\n /** Percent rate. */\n rate?: string;\n /** Number of discounted tickets. */\n quantityDiscounted?: number;\n }\n interface Tax {\n /** Tax type. */\n type?: TaxType$2;\n /**\n * Tax name.\n * @readonly\n */\n name?: string;\n /** Tax rate. */\n rate?: string;\n /** Taxable amount. */\n taxable?: Money$3;\n /** Total tax amount. */\n amount?: Money$3;\n }\n enum TaxType$2 {\n /** Tax is included in the ticket price. */\n INCLUDED = \"INCLUDED\",\n /** Tax is added to the order at the checkout. */\n ADDED = \"ADDED\",\n /** Tax is added to the final total at the checkout. */\n ADDED_AT_CHECKOUT = \"ADDED_AT_CHECKOUT\"\n }\n interface Fee {\n /** Fee identifier. */\n name?: FeeName;\n /** How fee is calculated. */\n type?: FeeType$1;\n /**\n * Fee rate.\n * @readonly\n */\n rate?: string;\n /** Total amount of fee charges. */\n amount?: Money$3;\n }\n enum FeeName {\n /** Wix ticket service fee charges applied to the line item. */\n WIX_FEE = \"WIX_FEE\"\n }\n enum FeeType$1 {\n /** Fee is added to the ticket price at checkout. */\n FEE_ADDED = \"FEE_ADDED\",\n /** Seller absorbs the fee. It is deducted from the ticket price. */\n FEE_INCLUDED = \"FEE_INCLUDED\",\n /** Fee is added to the ticket price at checkout. */\n FEE_ADDED_AT_CHECKOUT = \"FEE_ADDED_AT_CHECKOUT\"\n }\n interface GuestEventCanceled {\n /** Event guest. */\n guest?: EventGuest;\n /** Event context. */\n event?: EventDetails;\n }\n interface GuestEventStarts {\n /** Event guest. */\n guest?: EventGuest;\n /** Event context. */\n event?: EventDetails;\n /** Timing */\n timing?: Timing;\n }\n interface GuestOrderCanceled {\n /** Event guest. */\n guest?: EventGuest;\n /** Event context. */\n event?: EventDetails;\n /** Order context. */\n order?: OrderDetails;\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$4 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$4;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$4;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$4 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface QueryEventGuestsRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query: QueryV2$4;\n /** Predefined sets of fields to return. */\n fields?: RequestedFieldsEnumRequestedFields[];\n }\n interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$4;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$3;\n /** Filter object in the following format:
`\"filter\" : { \"fieldName1\": \"value1\", \"fieldName2\":{\"$operator\":\"value2\"} }`.

**Example:**
`\"filter\" : { \"eventId\": \"sd3f-jhds-4fs77\", \"ticketNumber\": {\"$startsWith\":\"478\"} }`

See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */\n filter?: Record | null;\n /** Sort object in the following format:
`[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`

**Example:**
`[{\"fieldName\":\"createdDate\",\"direction\":\"DESC\"}]`

See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */\n sort?: Sorting$4[];\n /**\n * Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details.

See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.\n * @deprecated Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details.

See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.\n * @replacedBy fields\n * @targetRemovalDate 2024-06-30\n */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$4 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$4;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$3;\n }\n interface Sorting$4 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$4;\n }\n enum SortOrder$4 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$4 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$3 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n enum RequestedFieldsEnumRequestedFields {\n /** Unknown requested field. */\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Returns `guestDetails` and `tickets`. */\n GUEST_DETAILS = \"GUEST_DETAILS\",\n /** Returns `totalGuests`. */\n GUEST_TOTAL = \"GUEST_TOTAL\"\n }\n interface QueryEventGuestsResponse {\n /** List of guests. */\n guests?: EventGuest[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$4;\n }\n interface PagingMetadataV2$4 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$4;\n }\n interface Cursors$4 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface StreamEventGuestsRequest {\n /** Filter. */\n filter?: Record | null;\n /** Task context. */\n taskContext?: TaskContext;\n }\n interface Empty$2 {\n }\n interface SecondaryLanguagesRequest {\n /** Guest event id. */\n eventId?: string;\n }\n interface SecondaryLanguagesResponse {\n /** Aggregated guests secondary languages. */\n secondaryLanguages?: string[];\n /** Aggregated guests languages. */\n languages?: Language[];\n }\n interface Language {\n /** Guest language. */\n language?: string | null;\n /** Guest locale. */\n locale?: string | null;\n }\n interface RsvpCreated {\n /** RSVP created timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Site language when RSVP created */\n language?: string | null;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n /** Event ID. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string | null;\n /** Guest first name. */\n firstName?: string;\n /** Guest last name. */\n lastName?: string;\n /** Guest email. */\n email?: string;\n /** RSVP form response. */\n rsvpForm?: FormResponse;\n /** RSVP response status. */\n status?: RsvpStatus;\n /** List of all guests. */\n guests?: Guest[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin;\n }\n enum RsvpStatus {\n YES = \"YES\",\n NO = \"NO\",\n WAITING = \"WAITING\"\n }\n interface Guest {\n /** Index in the RSVP guest list. */\n index?: number;\n /** Guest full name. */\n fullName?: string;\n /** Guest check-in. */\n checkIn?: CheckIn;\n /** Unique guest ID per RSVP. */\n _id?: number;\n }\n interface CheckIn {\n /** Time of check-in */\n created?: Date | null;\n }\n interface RsvpUpdated {\n /** RSVP updated timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Site language when RSVP created */\n language?: string | null;\n /** Locale in which Rsvp was created. */\n locale?: string | null;\n /** Event ID. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string | null;\n /** RSVP created timestamp. */\n created?: Date | null;\n /** Guest first name. */\n firstName?: string;\n /** Guest last name. */\n lastName?: string;\n /** Guest email. */\n email?: string;\n /** RSVP form response. */\n rsvpForm?: FormResponse;\n /** RSVP response status. */\n status?: RsvpStatus;\n /** List of the guests. */\n guests?: Guest[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n }\n interface RsvpDeleted {\n /** RSVP deleted timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** RSVP ID. */\n rsvpId?: string;\n /** Contact ID associated with this RSVP. */\n contactId?: string;\n /** Member ID associated with this RSVP. */\n memberId?: string | null;\n /** Whether RSVP was anonymized by GDPR delete. */\n anonymized?: boolean;\n }\n interface OrderConfirmed {\n /** Order confirmation timestamp in ISO UTC. */\n timestamp?: Date | null;\n /** Site language when Order initiated */\n language?: string | null;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp\n * @readonly\n */\n created?: Date | null;\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email address. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse;\n /** Order status. */\n status?: OrderStatus;\n /** Payment method used for paid tickets purchase, i.e. \"payPal\", \"creditCard\", etc. */\n method?: string | null;\n /** Tickets (generated after payment). */\n tickets?: Ticket[];\n /** Invoice. */\n invoice?: Invoice;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface Ticket {\n /** Unique issued ticket number. */\n ticketNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn;\n /** Ticket price. */\n price?: Money$3;\n /** Whether ticket is archived. */\n archived?: boolean;\n /** Guest first name. */\n firstName?: string | null;\n /** Guest last name. */\n lastName?: string | null;\n /** Guest email. */\n email?: string | null;\n /** Contact ID associated with this ticket. */\n contactId?: string | null;\n /** Whether ticket is confirmed */\n confirmed?: boolean;\n /** Member ID associated with this ticket. */\n memberId?: string | null;\n /** Ticket form response (only assigned tickets contain separate forms). */\n form?: FormResponse;\n /** Ticket name. */\n ticketName?: string;\n /** Anonymized tickets no longer contain personally identifiable information (PII). */\n anonymized?: boolean;\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin;\n }\n interface OrderUpdated {\n /** Order updated timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Site language when Order initiated */\n language?: string | null;\n /** Locale in which Order was created. */\n locale?: string | null;\n /** Event ID. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp.\n * @readonly\n */\n created?: Date | null;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date | null;\n /** Buyer first name. */\n firstName?: string;\n /** Buyer last name. */\n lastName?: string;\n /** Buyer email. */\n email?: string;\n /** Checkout form response. */\n checkoutForm?: FormResponse;\n /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */\n confirmed?: boolean;\n /** Order status. */\n status?: OrderStatus;\n /** Payment method used for paid tickets purchase, i.e. \"payPal\", \"creditCard\", etc. */\n method?: string | null;\n /** Tickets generated after payment. */\n tickets?: Ticket[];\n /** Whether order was archived and excluded from results. */\n archived?: boolean;\n /** Whether event was triggered by GDPR delete request. */\n triggeredByAnonymizeRequest?: boolean;\n }\n interface OrderDeleted {\n /** Order deleted timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order */\n contactId?: string;\n /** Member ID associated with this order. */\n memberId?: string | null;\n /**\n * Order created timestamp.\n * @readonly\n */\n created?: Date | null;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date | null;\n /** Whether order was anonymized by GDPR delete. */\n anonymized?: boolean;\n /** Order type. */\n orderType?: OrderType;\n /** Whether event was triggered by GDPR delete request. */\n triggeredByAnonymizeRequest?: boolean;\n /** Tickets generated after payment. */\n tickets?: Ticket[];\n }\n enum OrderType {\n /** Buyer form is used for all tickets. */\n UNASSIGNED_TICKETS = \"UNASSIGNED_TICKETS\",\n /** Each order ticket has its own form. */\n ASSIGNED_TICKETS = \"ASSIGNED_TICKETS\"\n }\n interface EventDeleted$1 {\n /** Event deleted timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n }\n interface Task {\n key?: TaskKey;\n executeAt?: Date | null;\n payload?: string | null;\n }\n interface TaskKey {\n appId?: string;\n instanceId?: string;\n subjectId?: string | null;\n }\n interface ListGuestListPreviewsRequest {\n /** Event ids. */\n eventIds: string[];\n /** Cursor paging. */\n cursorPaging?: CursorPaging$3;\n /** Requested fields. */\n fields?: RequestedFields$2[];\n }\n enum RequestedFields$2 {\n /** Unknown requested field. */\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Member guests. */\n MEMBER_GUESTS = \"MEMBER_GUESTS\",\n /** Waitlist count. */\n WAITLIST_COUNT = \"WAITLIST_COUNT\"\n }\n interface ListGuestListPreviewsResponse {\n /** List of guests. */\n previews?: GuestListPreview[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$4;\n }\n interface GuestListPreview {\n /** Event id. */\n eventId?: string;\n /** Latest attending members. */\n latestAttendingMembers?: EventGuests;\n /** Attending guests count. */\n attending?: GuestCount;\n /** Waiting guests count. */\n inWaitlist?: GuestCount;\n /** Not attending guests count. */\n notAttending?: GuestCount;\n }\n interface EventGuests {\n guests?: EventGuest[];\n }\n interface GuestCount {\n /** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */\n totalEventGuests?: number;\n /** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */\n count?: number;\n }\n interface UpdateGuestRequest {\n /** Updated guest */\n guest?: EventGuest;\n /** Guest revision */\n revision?: string | null;\n }\n interface UpdateGuestResponse {\n /** Updated guest */\n guest?: EventGuest;\n }\n /**\n * Creates a query to retrieve a list of guests.\n *\n *\n * The `queryGuests()` function builds a query to retrieve a list of guests and returns a [GuestsQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder) object.\n *\n * The returned object contains the query definition which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `GuestsQueryBuilder` functions onto the query. `GuestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryGuests.find()` returns.\n *\n * The query runs with the following `GuestsQueryBuilder` defaults that you can override:\n *\n * - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/skipto)\n * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/limit)\n * - [`descending(\"_createdDate\")`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/descending)\n *\n * The functions 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.\n *\n * The table below shows which `GuestsQueryBuilder` functions are supported for `queryGuests()`. You can only use one filter function for each property. Only the first filter will work if a property is used in more than one filter.\n * @public\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Read Event Tickets and Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST\n * @permissionId WIX_EVENTS.READ_GUESTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;\n interface QueryEventGuestsOptions {\n /** Predefined sets of fields to return. */\n fields?: RequestedFieldsEnumRequestedFields[] | undefined;\n }\n interface QueryCursorResult$2 {\n cursors: Cursors$4;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface GuestsQueryResult extends QueryCursorResult$2 {\n items: EventGuest[];\n query: GuestsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface GuestsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"eventId\" | \"rsvpId\" | \"orderNumber\" | \"ticketNumber\" | \"contactId\" | \"guestDetails.checkedIn\" | \"attendanceStatus\" | \"secondaryLanguageCode\" | \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\" | \"memberId\" | \"guestType\", value: any) => GuestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"eventId\" | \"rsvpId\" | \"orderNumber\" | \"ticketNumber\" | \"contactId\" | \"guestDetails.checkedIn\" | \"attendanceStatus\" | \"secondaryLanguageCode\" | \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\" | \"memberId\" | \"guestType\", value: any) => GuestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\", value: any) => GuestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\", value: any) => GuestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\", value: any) => GuestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\", value: any) => GuestsQueryBuilder;\n in: (propertyName: \"_id\" | \"eventId\" | \"rsvpId\" | \"orderNumber\" | \"ticketNumber\" | \"contactId\" | \"attendanceStatus\" | \"secondaryLanguageCode\" | \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\" | \"memberId\" | \"guestType\", value: any) => GuestsQueryBuilder;\n exists: (propertyName: \"_id\" | \"eventId\" | \"rsvpId\" | \"orderNumber\" | \"ticketNumber\" | \"tickets\" | \"contactId\" | \"guestDetails.checkedIn\" | \"secondaryLanguageCode\" | \"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\" | \"memberId\", value: boolean) => GuestsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\">) => GuestsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_createdDate\" | \"_updatedDate\" | \"attendanceStatusUpdatedDate\">) => GuestsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => GuestsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => GuestsQueryBuilder;\n find: () => Promise;\n }\n interface ListGuestListPreviewsOptions {\n /** Cursor paging. */\n cursorPaging?: CursorPaging$3;\n /** Requested fields. */\n fields?: RequestedFields$2[];\n }\n type eventsGuestsV1GuestGuests_universal_d_EventGuest = EventGuest;\n type eventsGuestsV1GuestGuests_universal_d_TicketDetails = TicketDetails;\n type eventsGuestsV1GuestGuests_universal_d_TicketGuestDetails = TicketGuestDetails;\n type eventsGuestsV1GuestGuests_universal_d_OnlineConferencingLogin = OnlineConferencingLogin;\n type eventsGuestsV1GuestGuests_universal_d_GuestDetails = GuestDetails;\n type eventsGuestsV1GuestGuests_universal_d_FormResponse = FormResponse;\n type eventsGuestsV1GuestGuests_universal_d_InputValue = InputValue;\n type eventsGuestsV1GuestGuests_universal_d_FormattedAddress = FormattedAddress;\n type eventsGuestsV1GuestGuests_universal_d_StandardDetails = StandardDetails;\n type eventsGuestsV1GuestGuests_universal_d_AttendanceStatus = AttendanceStatus;\n const eventsGuestsV1GuestGuests_universal_d_AttendanceStatus: typeof AttendanceStatus;\n type eventsGuestsV1GuestGuests_universal_d_GuestType = GuestType;\n const eventsGuestsV1GuestGuests_universal_d_GuestType: typeof GuestType;\n type eventsGuestsV1GuestGuests_universal_d_GuestCountUpdated = GuestCountUpdated;\n type eventsGuestsV1GuestGuests_universal_d_GuestCountUpdate = GuestCountUpdate;\n type eventsGuestsV1GuestGuests_universal_d_MemberEventStatusUpdated = MemberEventStatusUpdated;\n type eventsGuestsV1GuestGuests_universal_d_MemberEventStatusUpdatedEventType = MemberEventStatusUpdatedEventType;\n const eventsGuestsV1GuestGuests_universal_d_MemberEventStatusUpdatedEventType: typeof MemberEventStatusUpdatedEventType;\n type eventsGuestsV1GuestGuests_universal_d_ContactEventStatusUpdated = ContactEventStatusUpdated;\n type eventsGuestsV1GuestGuests_universal_d_GuestCheckedIn = GuestCheckedIn;\n type eventsGuestsV1GuestGuests_universal_d_EventDetails = EventDetails;\n type eventsGuestsV1GuestGuests_universal_d_NotifyGuestAction = NotifyGuestAction;\n type eventsGuestsV1GuestGuests_universal_d_TaskContext = TaskContext;\n type eventsGuestsV1GuestGuests_universal_d_NotifyActionType = NotifyActionType;\n const eventsGuestsV1GuestGuests_universal_d_NotifyActionType: typeof NotifyActionType;\n type eventsGuestsV1GuestGuests_universal_d_Timing = Timing;\n const eventsGuestsV1GuestGuests_universal_d_Timing: typeof Timing;\n type eventsGuestsV1GuestGuests_universal_d_OrderDetails = OrderDetails;\n type eventsGuestsV1GuestGuests_universal_d_OrderStatus = OrderStatus;\n const eventsGuestsV1GuestGuests_universal_d_OrderStatus: typeof OrderStatus;\n type eventsGuestsV1GuestGuests_universal_d_Invoice = Invoice;\n type eventsGuestsV1GuestGuests_universal_d_Item = Item;\n type eventsGuestsV1GuestGuests_universal_d_Discount = Discount;\n type eventsGuestsV1GuestGuests_universal_d_DiscountItem = DiscountItem;\n type eventsGuestsV1GuestGuests_universal_d_DiscountItemDiscountOneOf = DiscountItemDiscountOneOf;\n type eventsGuestsV1GuestGuests_universal_d_CouponDiscount = CouponDiscount;\n type eventsGuestsV1GuestGuests_universal_d_PaidPlanDiscount = PaidPlanDiscount;\n type eventsGuestsV1GuestGuests_universal_d_PaidPlanDiscountDiscountOneOf = PaidPlanDiscountDiscountOneOf;\n type eventsGuestsV1GuestGuests_universal_d_PercentDiscount = PercentDiscount;\n type eventsGuestsV1GuestGuests_universal_d_Tax = Tax;\n type eventsGuestsV1GuestGuests_universal_d_Fee = Fee;\n type eventsGuestsV1GuestGuests_universal_d_FeeName = FeeName;\n const eventsGuestsV1GuestGuests_universal_d_FeeName: typeof FeeName;\n type eventsGuestsV1GuestGuests_universal_d_GuestEventCanceled = GuestEventCanceled;\n type eventsGuestsV1GuestGuests_universal_d_GuestEventStarts = GuestEventStarts;\n type eventsGuestsV1GuestGuests_universal_d_GuestOrderCanceled = GuestOrderCanceled;\n type eventsGuestsV1GuestGuests_universal_d_QueryEventGuestsRequest = QueryEventGuestsRequest;\n type eventsGuestsV1GuestGuests_universal_d_RequestedFieldsEnumRequestedFields = RequestedFieldsEnumRequestedFields;\n const eventsGuestsV1GuestGuests_universal_d_RequestedFieldsEnumRequestedFields: typeof RequestedFieldsEnumRequestedFields;\n type eventsGuestsV1GuestGuests_universal_d_QueryEventGuestsResponse = QueryEventGuestsResponse;\n type eventsGuestsV1GuestGuests_universal_d_StreamEventGuestsRequest = StreamEventGuestsRequest;\n type eventsGuestsV1GuestGuests_universal_d_SecondaryLanguagesRequest = SecondaryLanguagesRequest;\n type eventsGuestsV1GuestGuests_universal_d_SecondaryLanguagesResponse = SecondaryLanguagesResponse;\n type eventsGuestsV1GuestGuests_universal_d_Language = Language;\n type eventsGuestsV1GuestGuests_universal_d_RsvpCreated = RsvpCreated;\n type eventsGuestsV1GuestGuests_universal_d_RsvpStatus = RsvpStatus;\n const eventsGuestsV1GuestGuests_universal_d_RsvpStatus: typeof RsvpStatus;\n type eventsGuestsV1GuestGuests_universal_d_Guest = Guest;\n type eventsGuestsV1GuestGuests_universal_d_CheckIn = CheckIn;\n type eventsGuestsV1GuestGuests_universal_d_RsvpUpdated = RsvpUpdated;\n type eventsGuestsV1GuestGuests_universal_d_RsvpDeleted = RsvpDeleted;\n type eventsGuestsV1GuestGuests_universal_d_OrderConfirmed = OrderConfirmed;\n type eventsGuestsV1GuestGuests_universal_d_Ticket = Ticket;\n type eventsGuestsV1GuestGuests_universal_d_OrderUpdated = OrderUpdated;\n type eventsGuestsV1GuestGuests_universal_d_OrderDeleted = OrderDeleted;\n type eventsGuestsV1GuestGuests_universal_d_OrderType = OrderType;\n const eventsGuestsV1GuestGuests_universal_d_OrderType: typeof OrderType;\n type eventsGuestsV1GuestGuests_universal_d_Task = Task;\n type eventsGuestsV1GuestGuests_universal_d_TaskKey = TaskKey;\n type eventsGuestsV1GuestGuests_universal_d_ListGuestListPreviewsRequest = ListGuestListPreviewsRequest;\n type eventsGuestsV1GuestGuests_universal_d_ListGuestListPreviewsResponse = ListGuestListPreviewsResponse;\n type eventsGuestsV1GuestGuests_universal_d_GuestListPreview = GuestListPreview;\n type eventsGuestsV1GuestGuests_universal_d_EventGuests = EventGuests;\n type eventsGuestsV1GuestGuests_universal_d_GuestCount = GuestCount;\n type eventsGuestsV1GuestGuests_universal_d_UpdateGuestRequest = UpdateGuestRequest;\n type eventsGuestsV1GuestGuests_universal_d_UpdateGuestResponse = UpdateGuestResponse;\n const eventsGuestsV1GuestGuests_universal_d_queryGuests: typeof queryGuests;\n type eventsGuestsV1GuestGuests_universal_d_QueryEventGuestsOptions = QueryEventGuestsOptions;\n type eventsGuestsV1GuestGuests_universal_d_GuestsQueryResult = GuestsQueryResult;\n type eventsGuestsV1GuestGuests_universal_d_GuestsQueryBuilder = GuestsQueryBuilder;\n type eventsGuestsV1GuestGuests_universal_d_ListGuestListPreviewsOptions = ListGuestListPreviewsOptions;\n namespace eventsGuestsV1GuestGuests_universal_d {\n export { eventsGuestsV1GuestGuests_universal_d_EventGuest as EventGuest, eventsGuestsV1GuestGuests_universal_d_TicketDetails as TicketDetails, eventsGuestsV1GuestGuests_universal_d_TicketGuestDetails as TicketGuestDetails, eventsGuestsV1GuestGuests_universal_d_OnlineConferencingLogin as OnlineConferencingLogin, eventsGuestsV1GuestGuests_universal_d_GuestDetails as GuestDetails, eventsGuestsV1GuestGuests_universal_d_FormResponse as FormResponse, eventsGuestsV1GuestGuests_universal_d_InputValue as InputValue, eventsGuestsV1GuestGuests_universal_d_FormattedAddress as FormattedAddress, Address$3 as Address, AddressStreetOneOf$3 as AddressStreetOneOf, StreetAddress$3 as StreetAddress, AddressLocation$3 as AddressLocation, Subdivision$3 as Subdivision, SubdivisionType$3 as SubdivisionType, eventsGuestsV1GuestGuests_universal_d_StandardDetails as StandardDetails, eventsGuestsV1GuestGuests_universal_d_AttendanceStatus as AttendanceStatus, eventsGuestsV1GuestGuests_universal_d_GuestType as GuestType, eventsGuestsV1GuestGuests_universal_d_GuestCountUpdated as GuestCountUpdated, eventsGuestsV1GuestGuests_universal_d_GuestCountUpdate as GuestCountUpdate, eventsGuestsV1GuestGuests_universal_d_MemberEventStatusUpdated as MemberEventStatusUpdated, eventsGuestsV1GuestGuests_universal_d_MemberEventStatusUpdatedEventType as MemberEventStatusUpdatedEventType, eventsGuestsV1GuestGuests_universal_d_ContactEventStatusUpdated as ContactEventStatusUpdated, EventType$2 as EventType, eventsGuestsV1GuestGuests_universal_d_GuestCheckedIn as GuestCheckedIn, eventsGuestsV1GuestGuests_universal_d_EventDetails as EventDetails, Location$3 as Location, LocationType$3 as LocationType, CommonAddress$1 as CommonAddress, CommonAddressStreetOneOf$1 as CommonAddressStreetOneOf, CommonStreetAddress$1 as CommonStreetAddress, CommonAddressLocation$1 as CommonAddressLocation, CommonSubdivision$1 as CommonSubdivision, SubdivisionSubdivisionType$1 as SubdivisionSubdivisionType, DateAndTimeSettings$1 as DateAndTimeSettings, RecurrenceStatusStatus$1 as RecurrenceStatusStatus, Recurrences$3 as Recurrences, Occurrence$3 as Occurrence, Formatted$1 as Formatted, Status$3 as Status, eventsGuestsV1GuestGuests_universal_d_NotifyGuestAction as NotifyGuestAction, eventsGuestsV1GuestGuests_universal_d_TaskContext as TaskContext, eventsGuestsV1GuestGuests_universal_d_NotifyActionType as NotifyActionType, eventsGuestsV1GuestGuests_universal_d_Timing as Timing, eventsGuestsV1GuestGuests_universal_d_OrderDetails as OrderDetails, eventsGuestsV1GuestGuests_universal_d_OrderStatus as OrderStatus, eventsGuestsV1GuestGuests_universal_d_Invoice as Invoice, eventsGuestsV1GuestGuests_universal_d_Item as Item, Money$3 as Money, eventsGuestsV1GuestGuests_universal_d_Discount as Discount, eventsGuestsV1GuestGuests_universal_d_DiscountItem as DiscountItem, eventsGuestsV1GuestGuests_universal_d_DiscountItemDiscountOneOf as DiscountItemDiscountOneOf, eventsGuestsV1GuestGuests_universal_d_CouponDiscount as CouponDiscount, eventsGuestsV1GuestGuests_universal_d_PaidPlanDiscount as PaidPlanDiscount, eventsGuestsV1GuestGuests_universal_d_PaidPlanDiscountDiscountOneOf as PaidPlanDiscountDiscountOneOf, eventsGuestsV1GuestGuests_universal_d_PercentDiscount as PercentDiscount, eventsGuestsV1GuestGuests_universal_d_Tax as Tax, TaxType$2 as TaxType, eventsGuestsV1GuestGuests_universal_d_Fee as Fee, eventsGuestsV1GuestGuests_universal_d_FeeName as FeeName, FeeType$1 as FeeType, eventsGuestsV1GuestGuests_universal_d_GuestEventCanceled as GuestEventCanceled, eventsGuestsV1GuestGuests_universal_d_GuestEventStarts as GuestEventStarts, eventsGuestsV1GuestGuests_universal_d_GuestOrderCanceled as GuestOrderCanceled, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, MessageEnvelope$4 as MessageEnvelope, IdentificationData$4 as IdentificationData, IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, WebhookIdentityType$4 as WebhookIdentityType, eventsGuestsV1GuestGuests_universal_d_QueryEventGuestsRequest as QueryEventGuestsRequest, QueryV2$4 as QueryV2, QueryV2PagingMethodOneOf$4 as QueryV2PagingMethodOneOf, Sorting$4 as Sorting, SortOrder$4 as SortOrder, Paging$4 as Paging, CursorPaging$3 as CursorPaging, eventsGuestsV1GuestGuests_universal_d_RequestedFieldsEnumRequestedFields as RequestedFieldsEnumRequestedFields, eventsGuestsV1GuestGuests_universal_d_QueryEventGuestsResponse as QueryEventGuestsResponse, PagingMetadataV2$4 as PagingMetadataV2, Cursors$4 as Cursors, eventsGuestsV1GuestGuests_universal_d_StreamEventGuestsRequest as StreamEventGuestsRequest, Empty$2 as Empty, eventsGuestsV1GuestGuests_universal_d_SecondaryLanguagesRequest as SecondaryLanguagesRequest, eventsGuestsV1GuestGuests_universal_d_SecondaryLanguagesResponse as SecondaryLanguagesResponse, eventsGuestsV1GuestGuests_universal_d_Language as Language, eventsGuestsV1GuestGuests_universal_d_RsvpCreated as RsvpCreated, eventsGuestsV1GuestGuests_universal_d_RsvpStatus as RsvpStatus, eventsGuestsV1GuestGuests_universal_d_Guest as Guest, eventsGuestsV1GuestGuests_universal_d_CheckIn as CheckIn, eventsGuestsV1GuestGuests_universal_d_RsvpUpdated as RsvpUpdated, eventsGuestsV1GuestGuests_universal_d_RsvpDeleted as RsvpDeleted, eventsGuestsV1GuestGuests_universal_d_OrderConfirmed as OrderConfirmed, eventsGuestsV1GuestGuests_universal_d_Ticket as Ticket, eventsGuestsV1GuestGuests_universal_d_OrderUpdated as OrderUpdated, eventsGuestsV1GuestGuests_universal_d_OrderDeleted as OrderDeleted, eventsGuestsV1GuestGuests_universal_d_OrderType as OrderType, EventDeleted$1 as EventDeleted, eventsGuestsV1GuestGuests_universal_d_Task as Task, eventsGuestsV1GuestGuests_universal_d_TaskKey as TaskKey, eventsGuestsV1GuestGuests_universal_d_ListGuestListPreviewsRequest as ListGuestListPreviewsRequest, RequestedFields$2 as RequestedFields, eventsGuestsV1GuestGuests_universal_d_ListGuestListPreviewsResponse as ListGuestListPreviewsResponse, eventsGuestsV1GuestGuests_universal_d_GuestListPreview as GuestListPreview, eventsGuestsV1GuestGuests_universal_d_EventGuests as EventGuests, eventsGuestsV1GuestGuests_universal_d_GuestCount as GuestCount, eventsGuestsV1GuestGuests_universal_d_UpdateGuestRequest as UpdateGuestRequest, eventsGuestsV1GuestGuests_universal_d_UpdateGuestResponse as UpdateGuestResponse, eventsGuestsV1GuestGuests_universal_d_queryGuests as queryGuests, eventsGuestsV1GuestGuests_universal_d_QueryEventGuestsOptions as QueryEventGuestsOptions, eventsGuestsV1GuestGuests_universal_d_GuestsQueryResult as GuestsQueryResult, eventsGuestsV1GuestGuests_universal_d_GuestsQueryBuilder as GuestsQueryBuilder, eventsGuestsV1GuestGuests_universal_d_ListGuestListPreviewsOptions as ListGuestListPreviewsOptions, };\n }\n interface TicketDefinition {\n /** Ticket definition ID. */\n _id?: string;\n /** Ticket price. */\n price?: Money$2;\n /** Whether the ticket is free (read only). */\n free?: boolean;\n /** Ticket name. */\n name?: string;\n /** Ticket description. */\n description?: string;\n /**\n * Limit of tickets that can be purchased per checkout.\n * Set to 20 for unlimited ticket definition.\n */\n limitPerCheckout?: number;\n /** Custom sort index. */\n orderIndex?: number;\n /** Policy information plain text block, as printed on the ticket. */\n policy?: string;\n /** Sensitive dashboard data. */\n dashboard?: Dashboard$2;\n /** Event ID associated with the ticket. */\n eventId?: string;\n /**\n * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.\n * @readonly\n */\n wixFeeConfig?: WixFeeConfig;\n /** Ticket sale period. */\n salePeriod?: TicketSalePeriod;\n /**\n * Ticket sale status.\n * @readonly\n */\n saleStatus?: TicketSaleStatus;\n /** Ticket state. */\n state?: TicketDefinitionStateEnumState[];\n /** Ticket pricing. */\n pricing?: TicketPricing;\n }\n interface Money$2 {\n /**\n * Three-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface Dashboard$2 {\n /** Whether ticket is hidden and cannot be sold. */\n hidden?: boolean;\n /** Number of tickets sold and reserved. */\n sold?: number;\n /** Whether the ticket has limited quantity. */\n limited?: boolean;\n /** Ticket limit. `NULL` for unlimited ticket definitions. */\n quantity?: number | null;\n /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */\n unsold?: number | null;\n /** Number of tickets sold. */\n ticketsSold?: number;\n /** Number of tickets reserved. */\n ticketsReserved?: number;\n }\n interface WixFeeConfig {\n /**\n * Fee calculation method.\n *\n * Supported values: `\"FEE_ADDED\"`, `\"FEE_INCLUDED\"`, `\"FEE_ADDED_AT_CHECKOUT\"`\n *\n * Default: `\"FEE_ADDED_AT_CHECKOUT\"`\n */\n type?: FeeType;\n }\n enum FeeType {\n /** Fee is added to the ticket price at checkout */\n FEE_ADDED = \"FEE_ADDED\",\n /** Seller absorbs the fee. It is deducted from the ticket price */\n FEE_INCLUDED = \"FEE_INCLUDED\",\n /** Fee is added to the ticket price at checkout */\n FEE_ADDED_AT_CHECKOUT = \"FEE_ADDED_AT_CHECKOUT\"\n }\n interface TicketSalePeriod {\n /** Ticket sale start timestamp. */\n startDate?: Date;\n /** Ticket sale end timestamp. */\n endDate?: Date;\n /** Whether to hide this ticket if it's not on sale */\n hideNotOnSale?: boolean;\n }\n enum TicketSaleStatus {\n /** Ticket sale is scheduled to start */\n SALE_SCHEDULED = \"SALE_SCHEDULED\",\n /** Ticket sale has started */\n SALE_STARTED = \"SALE_STARTED\",\n /** Ticket sale has ended */\n SALE_ENDED = \"SALE_ENDED\"\n }\n enum TicketDefinitionStateEnumState {\n INCLUDE_HIDDEN_NOT_ON_SALE = \"INCLUDE_HIDDEN_NOT_ON_SALE\"\n }\n interface TicketPricing extends TicketPricingPriceOneOf {\n /** Ticket price which is read only. */\n fixedPrice?: Money$2;\n /** Min price per ticket, customizable. */\n minPrice?: Money$2;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions;\n /**\n * Ticket pricing type.\n * @readonly\n */\n pricingType?: Type$1;\n }\n /** @oneof */\n interface TicketPricingPriceOneOf {\n /** Ticket price which is read only. */\n fixedPrice?: Money$2;\n /** Min price per ticket, customizable. */\n minPrice?: Money$2;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions;\n }\n interface PricingOptions {\n /** Multiple ticket pricing options. */\n options?: PricingOption[];\n }\n interface PricingOption {\n /** Ticket pricing option ID. */\n _id?: string | null;\n /** Ticket pricing option name. */\n name?: string | null;\n /** Ticket pricing option price. */\n price?: Money$2;\n }\n enum Type$1 {\n STANDARD = \"STANDARD\",\n DONATION = \"DONATION\"\n }\n interface QueryTicketDefinitionsRequest {\n /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number;\n /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /** Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset). */\n fieldset?: TicketDefinitionFieldset[];\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions). */\n filter?: Record | null;\n /**\n * Sort order. Defaults to: \"created:asc\".\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).\n */\n sort?: string;\n /**\n * Filter facets to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).\n */\n facet?: string[];\n }\n enum TicketDefinitionFieldset {\n /** Include policy in the response. */\n POLICY = \"POLICY\",\n /** Include dashboard in the response. */\n DASHBOARD = \"DASHBOARD\"\n }\n interface QueryTicketDefinitionsResponse {\n /** Total ticket definitions matching the given filters. */\n total?: number;\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Ticket definitions. */\n definitions?: TicketDefinition[];\n /** Filter facets. */\n facets?: Record;\n }\n interface FacetCounts$2 {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface QueryTicketDefinitionsV2Request {\n /** Query request object. */\n query?: QueryV2$3;\n }\n interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$3;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$3 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$3;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n }\n enum SortOrder$3 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$3 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$2 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryTicketDefinitionsV2Response {\n /** Ticket definitions. */\n definitions?: TicketDefinition[];\n /** Paging metadata definitions. */\n metadata?: PagingMetadataV2$3;\n }\n interface PagingMetadataV2$3 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$3;\n }\n interface Cursors$3 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface ListTicketDefinitionsRequest {\n /** Event ID. */\n eventId?: string[];\n /** Offset. */\n offset?: number;\n /** Paging limit. */\n limit?: number;\n /**\n * Predefined sets of fields to return.\n * - `DASHBOARD`: Returns `dashboard`.\n * - `POLICY`: Returns `policy`.\n *\n * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.\n *\n */\n fieldset?: TicketDefinitionFieldset[];\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Filter by ticket definition state.\n *\n * Supported values: `\"VISIBLE\"`, `\"HIDDEN\"`, `\"FREE\"`, `\"PAID\"`\n */\n state?: State$2[];\n /**\n * Sort order.\n *\n * Default: `\"created\"`:`\"asc\"`\n */\n sort?: string;\n /**\n * Ticket sale status.\n *\n * Supported values: `\"SALE_SCHEDULED\"`, `\"SALE_STARTED\"`, `\"SALE_ENDED\"`\n */\n saleStatus?: TicketSaleStatus[];\n /** Filter facets. */\n facet?: string[];\n }\n enum State$2 {\n /** Ticket is available for purchase. */\n VISIBLE = \"VISIBLE\",\n /** Opposite to VISIBLE. */\n HIDDEN = \"HIDDEN\",\n /** Ticket price is 0. */\n FREE = \"FREE\",\n /** Ticket price is greater than 0. */\n PAID = \"PAID\"\n }\n enum GroupBy {\n /** No grouping. */\n NONE = \"NONE\",\n /** Groups by event created date with descending sorting. */\n EVENT_CREATED_DESC = \"EVENT_CREATED_DESC\",\n /** Groups by event created date with ascending sorting. */\n EVENT_CREATED_ASC = \"EVENT_CREATED_ASC\"\n }\n interface ListTicketDefinitionsResponse {\n /** Meta data. */\n metaData?: ResponseMetaData;\n /** Retrieved ticket definitions. */\n definitions?: TicketDefinition[];\n /** Filter facets. */\n facets?: Record;\n }\n interface ResponseMetaData {\n /** Number of items in the response. */\n count?: number;\n /** Offset of items. */\n offset?: number;\n /** Total number of matching items. */\n total?: number;\n }\n interface GetTicketDefinitionRequest {\n /** Ticket definition ID. */\n definitionId: string;\n /**\n * Predefined sets of fields to return.\n * - `DASHBOARD`: Returns `dashboard`.\n * - `POLICY`: Returns `policy`.\n *\n * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.\n */\n fieldset?: TicketDefinitionFieldset[];\n }\n interface GetTicketDefinitionResponse {\n /** Retrieved ticket definition. */\n definition?: TicketDefinition;\n }\n interface CreateTicketDefinitionRequest {\n /** Event ID. */\n eventId: string;\n /** Ticket definition data. */\n definition: TicketDefinitionData;\n }\n interface TicketDefinitionData {\n /** Ticket name. */\n name?: string | null;\n /** Ticket price. */\n price?: Money$2;\n /** Ticket description. */\n description?: string | null;\n /** Whether this ticket type is limited in quantity. */\n limited?: boolean;\n /**\n * Limit for this ticket type.\n *\n * `NULL` for unlimited.\n */\n quantity?: number | null;\n /** Custom sort index for manual tickets ordering implementation. */\n orderIndex?: number;\n /** Policy information in plain text (as listed on the ticket). */\n policy?: string | null;\n /** Whether this ticket type is hidden to customers and cannot be purchased. */\n hidden?: boolean;\n /** Configuration of the fixed-rate Wix service fee that is applied to each ticket sold. */\n wixFeeConfig?: WixFeeConfig;\n /** Ticket sale period. */\n salePeriod?: TicketSalePeriod;\n /** Ticket pricing. */\n pricing?: TicketPricing;\n }\n interface CreateTicketDefinitionResponse {\n /** Created ticket definition. */\n definition?: TicketDefinition;\n }\n interface TicketDefinitionCreated {\n /** Ticket Definition created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Ticket Definition ID. */\n ticketDefinitionId?: string;\n /** Event ID. */\n eventId?: string;\n /** Originated from. */\n originatedFrom?: OriginatedFrom;\n }\n interface OriginatedFrom {\n /** Instance ID. Indicates the original app instance which current entity originated from. */\n instanceId?: string;\n /** Event ID. Indicates the original event which current entity originated from. */\n eventId?: string;\n /** Event ID. Indicates the original entity which current entity originated from. */\n entityId?: string;\n }\n interface UpdateTicketDefinitionRequest {\n /** Event ID. */\n eventId: string;\n /** Ticket definition ID. */\n definitionId: string;\n /** Ticket definition data. */\n definition?: TicketDefinitionData;\n }\n interface UpdateTicketDefinitionResponse {\n /** Updated ticket definition. */\n definition?: TicketDefinition;\n }\n interface TicketDefinitionUpdated {\n /** Ticket definition updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Event ID. */\n eventId?: string;\n }\n interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {\n /** Ticket definitions to delete. */\n byId?: ById;\n /** Whether to delete all event tickets. */\n all?: boolean;\n /** Event ID. */\n eventId: string;\n }\n /** @oneof */\n interface DeleteTicketDefinitionRequestDeleteOneOf {\n /** Ticket definitions to delete. */\n byId?: ById;\n /** Whether to delete all event tickets. */\n all?: boolean;\n }\n interface ById {\n /** Ticket definition IDs. */\n definitionId?: string[];\n }\n interface DeleteTicketDefinitionResponse {\n }\n interface TicketDefinitionDeleted {\n /** Ticket definition deleted timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Event ID. */\n eventId?: string;\n }\n interface ChangeCurrencyRequest {\n /** Event ID. */\n eventId?: string;\n /** Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */\n currency: string;\n }\n interface ChangeCurrencyResponse {\n }\n interface BulkCopyTicketDefinitionsByEventIdRequest {\n /** Origin instance ID. */\n originInstanceId?: string | null;\n /** Origin Event ID. */\n originEventId?: string;\n /** Target Event ID. */\n targetEventId?: string;\n }\n interface BulkCopyTicketDefinitionsByEventIdResponse {\n /** Copied ticket definitions. */\n definitions?: CopiedTicketDefinition[];\n }\n interface CopiedTicketDefinition {\n /** Origin Ticket definition ID. */\n originTicketDefinitionId?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n }\n interface PaidTicketDefinitionExistsRequest {\n }\n interface PaidTicketDefinitionExistsResponse {\n /** Paid exists. */\n paidExists?: boolean;\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$3;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use [`queryTicketDefinitions()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/queryticketdefinitions) function instead.\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/queryticketdefinitions).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinition()`, and replace it with `ticketDefinitionsV2.queryTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n * Retrieves a list of up to 100 ticket definitions.\n * @public\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): Promise;\n interface QueryTicketDefinitionsOptions {\n /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number;\n /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number;\n /** Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset). */\n fieldset?: TicketDefinitionFieldset[];\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions). */\n filter?: Record | null;\n /**\n * Sort order. Defaults to: \"created:asc\".\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).\n */\n sort?: string;\n /**\n * Filter facets to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).\n */\n facet?: string[];\n }\n interface QueryTicketDefinitionsV2Options {\n }\n interface QueryCursorResult$1 {\n cursors: Cursors$3;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DefinitionsQueryResult extends QueryCursorResult$1 {\n items: TicketDefinition[];\n query: DefinitionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface DefinitionsQueryBuilder {\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => DefinitionsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => DefinitionsQueryBuilder;\n find: () => Promise;\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a substitute is available. Use the [`queryTicketDefinitions()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/queryticketdefinitions) function instead.\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/queryticketdefinitions).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n * Retrieves a list of up to 100 ticket definitions, with basic filter support.\n * @public\n * @param options - Details for the tickets to retrieve.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise;\n interface ListTicketDefinitionsOptions {\n /** Event ID. */\n eventId?: string[];\n /** Offset. */\n offset?: number;\n /** Paging limit. */\n limit?: number;\n /**\n * Predefined sets of fields to return.\n * - `DASHBOARD`: Returns `dashboard`.\n * - `POLICY`: Returns `policy`.\n *\n * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.\n */\n fieldset?: TicketDefinitionFieldset[];\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Filter by ticket definition state.\n *\n * Supported values: `\"VISIBLE\"`, `\"HIDDEN\"`, `\"FREE\"`, `\"PAID\"`\n */\n state?: State$2[];\n /**\n * Sort order.\n *\n * Default: `\"created\"`:`\"asc\"`.\n *\n * See [Ticket Definitions Sort](/wix-events-v2/ticketdefinitions/ticket-definitions-sort) for more information.\n *\n *\n *\n *\n */\n sort?: string;\n /**\n * Ticket sale status.\n *\n * Supported values: `\"SALE_SCHEDULED\"`, `\"SALE_STARTED\"`, `\"SALE_ENDED\"`\n */\n saleStatus?: TicketSaleStatus[];\n /** Filter facets. */\n facet?: string[];\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`getTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/getticketdefinition) function instead.\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`getTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/getticketdefinition).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.getTicketDefinition()`, and replace it with `ticketDefinitionsV2.getTicketDefinition()`. Update your code to work with the new `getTicketDefinition()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n * Retrieves a ticket definition.\n * @param definitionId - Ticket definition ID.\n * @public\n * @requiredField definitionId\n * @param options - Details for the ticket to retrieve.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved ticket definition.\n */\n function getTicketDefinition(definitionId: string, options?: GetTicketDefinitionOptions): Promise;\n interface GetTicketDefinitionOptions {\n /**\n * Predefined sets of fields to return.\n * - `DASHBOARD`: Returns `dashboard`.\n * - `POLICY`: Returns `policy`.\n *\n * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.\n */\n fieldset?: TicketDefinitionFieldset[];\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`createTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/createticketdefinition) function instead.\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`createTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/createticketdefinition).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.createTicketDefinition()`, and replace it with `ticketDefinitionsV2.createTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n * Creates a ticket definition (and enables ticket sales).\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @requiredField options\n * @requiredField options.definition\n * @requiredField options.definition.name\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function createTicketDefinition(eventId: string, options: CreateTicketDefinitionOptions): Promise;\n interface CreateTicketDefinitionOptions {\n /** Ticket definition data. */\n definition: TicketDefinitionData;\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`updateTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/updateticketdefinition) function instead.\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`updateTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/updateticketdefinition).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.updateTicketDefinition()`, and replace it with `ticketDefinitionsV2.updateTicketDefinition()`. Update your code to work with the new `updateTicketDefinition()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n *\n * Updates a ticket definition.\n *\n * See [Partial Updates](/wix-events-v2/partial-updates) for more information.\n * @param definitionId - Ticket definition ID.\n * @param eventId - Event ID.\n * @public\n * @requiredField definitionId\n * @requiredField eventId\n * @requiredField options.definition.pricing\n * @param identifiers - Details of the ticket definition to update.\n * @param options - Ticket definition details to update.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateTicketDefinition(definitionId: string, eventId: string, options?: UpdateTicketDefinitionOptions): Promise;\n interface UpdateTicketDefinitionOptions {\n /** Ticket definition data. */\n definition?: TicketDefinitionData;\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`deleteTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/deleteticketdefinition) function instead.\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`deleteTicketDefinition()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/deleteticketdefinition).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.deleteTicketDefinition()`, and replace it with `ticketDefinitionsV2.deleteTicketDefinition()`. Update your code to work with the new `deleteTicketDefinition()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n * Deletes a ticket definition.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @param options - Details of tickets to delete.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise;\n interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionRequestDeleteOneOf {\n /** Ticket definitions to delete. */\n byId?: ById;\n /** Whether to delete all event tickets. */\n all?: boolean;\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/changecurrency).\n * >**Migration Instructions**.\n * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`changeCurrency()`](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitionsv2/changecurrency).\n * > To migrate to the new function:\n * > 1. Add the new import statement:\n * > ```js\n * > import { ticketDefinitionsV2 } from 'wix-events.v2';\n * > ```\n * > 2. Look for any code that uses `ticketDefinitions.changeCurrency()`, and replace it with `ticketDefinitionsV2.changeCurrency()`. Update your code to work with the new `changeCurrency()` response properties.\n * > 3. Test your changes to make sure your code behaves as expected.\n *\n * Changes the currency for all tickets per event.\n *\n * @public\n * @requiredField options.currency\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Ticket Definitions\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF\n * @applicableIdentity APP\n * @adminMethod\n */\n function changeCurrency(options?: ChangeCurrencyOptions): Promise;\n interface ChangeCurrencyOptions {\n /** Event ID. */\n eventId?: string;\n /** Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */\n currency: string;\n }\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinition = TicketDefinition;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_WixFeeConfig = WixFeeConfig;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_FeeType = FeeType;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_FeeType: typeof FeeType;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketSalePeriod = TicketSalePeriod;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketSaleStatus = TicketSaleStatus;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketSaleStatus: typeof TicketSaleStatus;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionStateEnumState = TicketDefinitionStateEnumState;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionStateEnumState: typeof TicketDefinitionStateEnumState;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketPricing = TicketPricing;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketPricingPriceOneOf = TicketPricingPriceOneOf;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_PricingOptions = PricingOptions;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_PricingOption = PricingOption;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsRequest = QueryTicketDefinitionsRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionFieldset = TicketDefinitionFieldset;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionFieldset: typeof TicketDefinitionFieldset;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsResponse = QueryTicketDefinitionsResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsV2Request = QueryTicketDefinitionsV2Request;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsV2Response = QueryTicketDefinitionsV2Response;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ListTicketDefinitionsRequest = ListTicketDefinitionsRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_GroupBy = GroupBy;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_GroupBy: typeof GroupBy;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ListTicketDefinitionsResponse = ListTicketDefinitionsResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ResponseMetaData = ResponseMetaData;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_GetTicketDefinitionRequest = GetTicketDefinitionRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_GetTicketDefinitionResponse = GetTicketDefinitionResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_CreateTicketDefinitionRequest = CreateTicketDefinitionRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionData = TicketDefinitionData;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_CreateTicketDefinitionResponse = CreateTicketDefinitionResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionCreated = TicketDefinitionCreated;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_OriginatedFrom = OriginatedFrom;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_UpdateTicketDefinitionRequest = UpdateTicketDefinitionRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_UpdateTicketDefinitionResponse = UpdateTicketDefinitionResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionUpdated = TicketDefinitionUpdated;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionRequest = DeleteTicketDefinitionRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionRequestDeleteOneOf = DeleteTicketDefinitionRequestDeleteOneOf;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ById = ById;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionResponse = DeleteTicketDefinitionResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionDeleted = TicketDefinitionDeleted;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ChangeCurrencyRequest = ChangeCurrencyRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ChangeCurrencyResponse = ChangeCurrencyResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_BulkCopyTicketDefinitionsByEventIdRequest = BulkCopyTicketDefinitionsByEventIdRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_BulkCopyTicketDefinitionsByEventIdResponse = BulkCopyTicketDefinitionsByEventIdResponse;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_CopiedTicketDefinition = CopiedTicketDefinition;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_PaidTicketDefinitionExistsRequest = PaidTicketDefinitionExistsRequest;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_PaidTicketDefinitionExistsResponse = PaidTicketDefinitionExistsResponse;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_queryTicketDefinitions: typeof queryTicketDefinitions;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsOptions = QueryTicketDefinitionsOptions;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsV2Options = QueryTicketDefinitionsV2Options;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_DefinitionsQueryResult = DefinitionsQueryResult;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_DefinitionsQueryBuilder = DefinitionsQueryBuilder;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_listTicketDefinitions: typeof listTicketDefinitions;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ListTicketDefinitionsOptions = ListTicketDefinitionsOptions;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_getTicketDefinition: typeof getTicketDefinition;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_GetTicketDefinitionOptions = GetTicketDefinitionOptions;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_createTicketDefinition: typeof createTicketDefinition;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_CreateTicketDefinitionOptions = CreateTicketDefinitionOptions;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_updateTicketDefinition: typeof updateTicketDefinition;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_UpdateTicketDefinitionOptions = UpdateTicketDefinitionOptions;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_deleteTicketDefinition: typeof deleteTicketDefinition;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionOptions = DeleteTicketDefinitionOptions;\n const eventsV1TicketDefinitionTicketDefinitions_universal_d_changeCurrency: typeof changeCurrency;\n type eventsV1TicketDefinitionTicketDefinitions_universal_d_ChangeCurrencyOptions = ChangeCurrencyOptions;\n namespace eventsV1TicketDefinitionTicketDefinitions_universal_d {\n export { eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinition as TicketDefinition, Money$2 as Money, Dashboard$2 as Dashboard, eventsV1TicketDefinitionTicketDefinitions_universal_d_WixFeeConfig as WixFeeConfig, eventsV1TicketDefinitionTicketDefinitions_universal_d_FeeType as FeeType, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketSalePeriod as TicketSalePeriod, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketSaleStatus as TicketSaleStatus, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionStateEnumState as TicketDefinitionStateEnumState, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketPricing as TicketPricing, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketPricingPriceOneOf as TicketPricingPriceOneOf, eventsV1TicketDefinitionTicketDefinitions_universal_d_PricingOptions as PricingOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_PricingOption as PricingOption, Type$1 as Type, eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsRequest as QueryTicketDefinitionsRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionFieldset as TicketDefinitionFieldset, eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsResponse as QueryTicketDefinitionsResponse, FacetCounts$2 as FacetCounts, eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsV2Request as QueryTicketDefinitionsV2Request, QueryV2$3 as QueryV2, QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, Sorting$3 as Sorting, SortOrder$3 as SortOrder, Paging$3 as Paging, CursorPaging$2 as CursorPaging, eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsV2Response as QueryTicketDefinitionsV2Response, PagingMetadataV2$3 as PagingMetadataV2, Cursors$3 as Cursors, eventsV1TicketDefinitionTicketDefinitions_universal_d_ListTicketDefinitionsRequest as ListTicketDefinitionsRequest, State$2 as State, eventsV1TicketDefinitionTicketDefinitions_universal_d_GroupBy as GroupBy, eventsV1TicketDefinitionTicketDefinitions_universal_d_ListTicketDefinitionsResponse as ListTicketDefinitionsResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_ResponseMetaData as ResponseMetaData, eventsV1TicketDefinitionTicketDefinitions_universal_d_GetTicketDefinitionRequest as GetTicketDefinitionRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_GetTicketDefinitionResponse as GetTicketDefinitionResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_CreateTicketDefinitionRequest as CreateTicketDefinitionRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionData as TicketDefinitionData, eventsV1TicketDefinitionTicketDefinitions_universal_d_CreateTicketDefinitionResponse as CreateTicketDefinitionResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionCreated as TicketDefinitionCreated, eventsV1TicketDefinitionTicketDefinitions_universal_d_OriginatedFrom as OriginatedFrom, eventsV1TicketDefinitionTicketDefinitions_universal_d_UpdateTicketDefinitionRequest as UpdateTicketDefinitionRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_UpdateTicketDefinitionResponse as UpdateTicketDefinitionResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionUpdated as TicketDefinitionUpdated, eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionRequest as DeleteTicketDefinitionRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionRequestDeleteOneOf as DeleteTicketDefinitionRequestDeleteOneOf, eventsV1TicketDefinitionTicketDefinitions_universal_d_ById as ById, eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionResponse as DeleteTicketDefinitionResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_TicketDefinitionDeleted as TicketDefinitionDeleted, eventsV1TicketDefinitionTicketDefinitions_universal_d_ChangeCurrencyRequest as ChangeCurrencyRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_ChangeCurrencyResponse as ChangeCurrencyResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_BulkCopyTicketDefinitionsByEventIdRequest as BulkCopyTicketDefinitionsByEventIdRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_BulkCopyTicketDefinitionsByEventIdResponse as BulkCopyTicketDefinitionsByEventIdResponse, eventsV1TicketDefinitionTicketDefinitions_universal_d_CopiedTicketDefinition as CopiedTicketDefinition, eventsV1TicketDefinitionTicketDefinitions_universal_d_PaidTicketDefinitionExistsRequest as PaidTicketDefinitionExistsRequest, eventsV1TicketDefinitionTicketDefinitions_universal_d_PaidTicketDefinitionExistsResponse as PaidTicketDefinitionExistsResponse, MessageEnvelope$3 as MessageEnvelope, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, eventsV1TicketDefinitionTicketDefinitions_universal_d_queryTicketDefinitions as queryTicketDefinitions, eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsOptions as QueryTicketDefinitionsOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_QueryTicketDefinitionsV2Options as QueryTicketDefinitionsV2Options, eventsV1TicketDefinitionTicketDefinitions_universal_d_DefinitionsQueryResult as DefinitionsQueryResult, eventsV1TicketDefinitionTicketDefinitions_universal_d_DefinitionsQueryBuilder as DefinitionsQueryBuilder, eventsV1TicketDefinitionTicketDefinitions_universal_d_listTicketDefinitions as listTicketDefinitions, eventsV1TicketDefinitionTicketDefinitions_universal_d_ListTicketDefinitionsOptions as ListTicketDefinitionsOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_getTicketDefinition as getTicketDefinition, eventsV1TicketDefinitionTicketDefinitions_universal_d_GetTicketDefinitionOptions as GetTicketDefinitionOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_createTicketDefinition as createTicketDefinition, eventsV1TicketDefinitionTicketDefinitions_universal_d_CreateTicketDefinitionOptions as CreateTicketDefinitionOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_updateTicketDefinition as updateTicketDefinition, eventsV1TicketDefinitionTicketDefinitions_universal_d_UpdateTicketDefinitionOptions as UpdateTicketDefinitionOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_deleteTicketDefinition as deleteTicketDefinition, eventsV1TicketDefinitionTicketDefinitions_universal_d_DeleteTicketDefinitionOptions as DeleteTicketDefinitionOptions, eventsV1TicketDefinitionTicketDefinitions_universal_d_changeCurrency as changeCurrency, eventsV1TicketDefinitionTicketDefinitions_universal_d_ChangeCurrencyOptions as ChangeCurrencyOptions, };\n }\n interface Policy {\n /**\n * Policy ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the policy is updated. The existing revision must be used when updating a policy to prevent conflicting changes. You'll get an error if you try to use the previous revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time when the policy was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of the policy's latest update in.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Policy name that is visible in the dashboard and checkout form.\n *\n * Min: 1 character\n *\n * Max: 40 characters\n */\n name?: string;\n /**\n * Policy body, usually containing various terms and conditions.\n *\n * Min: 1 character\n *\n * Max: 50000 characters.\n *\n * **Note**: You can format text using various HTML tags such as `

`, ``, `

    `, etc.\n */\n body?: string;\n /** ID of the event to which the policy belongs. */\n eventId?: string;\n }\n interface CreatePolicyRequest {\n /** Policy info. */\n policy: Policy;\n }\n interface CreatePolicyResponse {\n /** Created policy. */\n policy?: Policy;\n }\n interface UpdatePolicyRequest {\n /** Policy to update. */\n policy: Policy;\n }\n interface UpdatePolicyResponse {\n /** The updated policy. */\n policy?: Policy;\n }\n interface UpdatePolicySortIndexRequest {\n /** Policy's ID */\n policyId?: string;\n /** The revision of the event policy. */\n revision?: string;\n /** The sort index of a policy to set. */\n sortIndex?: number;\n }\n interface UpdatePolicySortIndexResponse {\n /** The updated event policy. */\n policy?: Policy;\n }\n interface DeletePolicyRequest {\n /** ID of the policy to delete. */\n policyId: string;\n }\n interface DeletePolicyResponse {\n }\n interface QueryPoliciesRequest {\n /** Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query: QueryV2$2;\n }\n interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {\n /** Pagination options. */\n paging?: Paging$2;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n /** Filter object in the following format:
    `\"filter\" : { \"fieldName1\": \"value1\", \"fieldName2\":{\"$operator\":\"value2\"} }`.

    **Example:**
    `\"filter\" : { \"id\": \"2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5\", \"revision\": {\"$ne\":\"1\"} }`

    See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information. */\n filter?: Record | null;\n /** Sort object in the following format:
    `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`

    **Example:**
    `[{\"fieldName\":\"createdDate\",\"direction\":\"DESC\"}]`

    See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information. */\n sort?: Sorting$2[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$2 {\n /** Pagination options. */\n paging?: Paging$2;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$2 {\n /** Number of items to load per page. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$1 {\n /** Number of items to load per page. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryPoliciesResponse {\n /** Event policies. */\n policies?: Policy[];\n /** Query result's metadata. */\n metadata?: PagingMetadataV2$2;\n }\n interface PagingMetadataV2$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$2;\n }\n interface Cursors$2 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface ReorderEventPoliciesRequest extends ReorderEventPoliciesRequestReferencePolicyOneOf {\n /** Move the given `policyId` before the specified policy. */\n beforePolicyId?: string;\n /** Move the given `policyId` after the specified policy. */\n afterPolicyId?: string;\n /** Event ID. */\n eventId: string;\n /** Event policy ID. */\n policyId: string;\n }\n /** @oneof */\n interface ReorderEventPoliciesRequestReferencePolicyOneOf {\n /** */\n beforePolicyId?: string;\n /** Move the given `policyId` after the specified policy. */\n afterPolicyId?: string;\n }\n interface ReorderEventPoliciesResponse {\n /** Ordered event policies. */\n policies?: Policy[];\n }\n interface GetPolicyRequest {\n /** Policy ID. */\n policyId: string;\n }\n interface GetPolicyResponse {\n /** The requested policy. */\n policy?: Policy;\n }\n interface EventCopied$1 {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$2;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$2;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus$2;\n /** Instance ID. Indicates the original app instance which current event was derived from. */\n derivedFromInstanceId?: string | null;\n /** Event ID. Indicates the original event which current event was derived from. */\n derivedFromEventId?: string | null;\n /**\n * Map of copied ticket definitions from original event.\n * Key represents ticket def id in the original event.\n * Value represents ticket def id in the newly created event.\n */\n ticketDefinitions?: Record;\n }\n interface Location$2 {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates$2;\n /** Single line address representation. */\n address?: string | null;\n /** Location type. */\n type?: LocationType$2;\n /**\n * Full address derived from formatted single line `address`.\n * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.\n * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.\n *\n * Migration notes:\n * - `full_address.formatted_address` is equivalent to `address`.\n * - `full_address.geocode` is equivalent to `coordinates`.\n */\n fullAddress?: Address$2;\n /**\n * Defines event location as TBD (To Be Determined).\n * When event location is not yet defined, `name` is displayed instead of location address.\n * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.\n */\n tbd?: boolean | null;\n }\n interface MapCoordinates$2 {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationType$2 {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$2 extends AddressStreetOneOf$2 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$2;\n /** Main address line (usually street and number) as free text */\n addressLine1?: string | null;\n /** country code */\n country?: string | null;\n /** subdivision (usually state or region) code according to ISO 3166-2 */\n subdivision?: string | null;\n /** city name */\n city?: string | null;\n /** zip/postal code */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */\n addressLine2?: string | null;\n /** A string containing the human-readable address of this location */\n formatted?: string | null;\n /** coordinates of the physical address */\n location?: AddressLocation$2;\n }\n /** @oneof */\n interface AddressStreetOneOf$2 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$2;\n /** Main address line (usually street and number) as free text */\n addressLine?: string | null;\n }\n interface StreetAddress$2 {\n /** street number */\n number?: string;\n /** street name */\n name?: string;\n }\n interface AddressLocation$2 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$2 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n }\n enum SubdivisionType$2 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface ScheduleConfig$2 {\n /**\n * Defines event as TBD (To Be Determined) schedule.\n * When event time is not yet defined, TBD message is displayed instead of event start and end times.\n * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.\n */\n scheduleTbd?: boolean;\n /** TBD message. */\n scheduleTbdMessage?: string | null;\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether end date is hidden in the formatted schedule. */\n endDateHidden?: boolean;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n /** Event recurrences. */\n recurrences?: Recurrences$2;\n }\n interface Recurrences$2 {\n /** Event occurrences. */\n occurrences?: Occurrence$2[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status$2;\n }\n interface Occurrence$2 {\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n }\n enum Status$2 {\n /** Event occurs only once. */\n ONE_TIME = \"ONE_TIME\",\n /** Event is recurring. */\n RECURRING = \"RECURRING\",\n /** Marks the next upcoming occurrence of the recurring event. */\n RECURRING_NEXT = \"RECURRING_NEXT\",\n /** Marks the most recent ended occurrence of the recurring event. */\n RECURRING_LAST_ENDED = \"RECURRING_LAST_ENDED\",\n /** Marks the most recent canceled occurrence of the recurring event. */\n RECURRING_LAST_CANCELED = \"RECURRING_LAST_CANCELED\"\n }\n enum EventStatus$2 {\n /** Event is public and scheduled to start */\n SCHEDULED = \"SCHEDULED\",\n /** Event has started */\n STARTED = \"STARTED\",\n /** Event has ended */\n ENDED = \"ENDED\",\n /** Event was canceled */\n CANCELED = \"CANCELED\",\n /** Event is not public and needs to be published */\n DRAFT = \"DRAFT\"\n }\n interface Empty$1 {\n }\n interface GetPolicyFromTrashBinRequest {\n /** Policy ID. */\n policyId?: string;\n }\n interface GetPolicyFromTrashBinResponse {\n /** The requested policy. */\n policy?: Policy;\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$2 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$2 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$2 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$2;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$2;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a policy.\n *\n *\n * \n *\n * The `createPolicy()` function returns a Promise that resolves to the newly-created policy.\n *\n * You can create up to 3 policies per event. If you try to create more than 3, you'll get the \"Maximum number of policies for the event has been reached\" error.\n * @public\n * @requiredField policy\n * @requiredField policy.body\n * @requiredField policy.eventId\n * @requiredField policy.name\n * @param policy - Policy info.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Policies\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-POLICIES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created policy.\n */\n function createPolicy(policy: Policy): Promise;\n /**\n * Updates a policy.\n *\n * \n *\n * The `updatePolicy()` function returns a Promise that resolves to the newly-updated policy.\n *\n * Each time the policy is updated, `revision` increments by 1. The existing `revision` must be included when updating the policy. This ensures you're working with the latest policy and prevents unintended overwrites.\n * @public\n * @requiredField _id\n * @requiredField policy\n * @requiredField policy.body\n * @requiredField policy.eventId\n * @requiredField policy.name\n * @requiredField policy.revision\n * @param policy - Policy to update.\n * @param _id - Policy ID.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Policies\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-POLICIES\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated policy.\n */\n function updatePolicy(_id: string | null, policy: UpdatePolicy, options?: UpdatePolicyOptions): Promise;\n interface UpdatePolicy {\n /**\n * Policy ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the policy is updated. The existing revision must be used when updating a policy to prevent conflicting changes. You'll get an error if you try to use the previous revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date policy was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of the policy's latest update in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Policy name that is visible in the dashboard and checkout form.\n *\n * Min: 1 character\n *\n * Max: 40 characters\n */\n name?: string;\n /**\n * Policy body. Here you can enter various terms and conditions.\n *\n * Min: 1 character\n *\n * Max: 50000 characters\n *\n * **Note**: You can format text using various HTML tags such as `

    `, ``, `

      `, etc.\n */\n body?: string;\n /** ID of the event to which the policy belongs. */\n eventId?: string;\n }\n interface UpdatePolicyOptions {\n }\n /**\n * Permanently deletes a policy.\n *\n *\n * \n *\n * The `deletePolicy()` function returns a Promise that resolves when the specified policy is deleted.\n *\n * Deleted policies are not returned by the `getPolicy()` or `queryPolicies()` functions.\n * @public\n * @requiredField policyId\n * @param options - Options for Delete Policy function.\n * @param policyId - ID of the policy to delete.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Policies\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-POLICIES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deletePolicy(policyId: string): Promise;\n /**\n * Creates a query to retrieve a list of policies, given the provided paging and filter.\n *\n *\n * The `queryPolicies()` function builds a query to retrieve a list of policies and returns a [PoliciesQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder) object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/find) function.\n *\n * You can refine the query by chaining `PoliciesQueryBuilder` functions onto the query. `PoliciesQueryBuilder` functions enable you to sort, filter and control the results that `PoliciesQueryBuilder.find()` returns.\n *\n * The query runs with the following `PoliciesQueryBuilder` defaults that you can override:\n *\n * [`limit`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/limit): `50`\n * [`descending`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/descending): `_createdDate`\n *\n * The functions that are chained to `queryPolicies()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the id property in descending order, the results are sorted by the created date and then, if there are multiple results with the same date, the items are sorted by the id.\n *\n * The table below shows which `PoliciesQueryBuilder` functions are supported for `queryPoliciesGuests()`. You can only use one filter function for each property. If a property is used in more than one filter, only the first filter will work.\n * @public\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Policies\n * @permissionScopeId SCOPE.DC-EVENTS.READ-POLICIES\n * @permissionScope Manage Policies\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-POLICIES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryPolicies(): PoliciesQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PoliciesQueryResult extends QueryCursorResult {\n items: Policy[];\n query: PoliciesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface PoliciesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"body\" | \"eventId\", value: any) => PoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"body\" | \"eventId\", value: any) => PoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => PoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => PoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => PoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"revision\" | \"_createdDate\" | \"_updatedDate\", value: any) => PoliciesQueryBuilder;\n in: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"body\" | \"eventId\", value: any) => PoliciesQueryBuilder;\n exists: (propertyName: \"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"body\" | \"eventId\", value: boolean) => PoliciesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"body\" | \"eventId\">) => PoliciesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"revision\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"body\" | \"eventId\">) => PoliciesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => PoliciesQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => PoliciesQueryBuilder;\n find: () => Promise;\n }\n /**\n * Changes policy order in an event dashboard and agreement checkbox on the checkout form.\n * For example, if we have 3 policies in the list, after using this function the 3rd policy will become the 1st, and other policies will move by 1 position. By default, the policies are arranged by the created date in descending order.\n *\n * > **Note**: it is possible to use both `beforePolicyId` and `afterPolicyId` at the same time but only the last one defined will be executed.\n *\n * \n *\n * The `reorderEventPolicies()` function returns a Promise that resolves to the newly-reordered policy.\n * @param policyId - Event policy ID.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @requiredField policyId\n * @param options - Options for Reorder Event Policies function.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Policies\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-POLICIES\n * @applicableIdentity APP\n * @adminMethod\n */\n function reorderEventPolicies(policyId: string, eventId: string, options?: ReorderEventPoliciesOptions): Promise;\n interface ReorderEventPoliciesOptions extends ReorderEventPoliciesRequestReferencePolicyOneOf {\n /** Move the given `policyId` before the specified policy. */\n beforePolicyId?: string;\n /** Move the given `policyId` after the specified policy. */\n afterPolicyId?: string;\n }\n /**\n * Retrieves a policy by ID.\n *\n *\n * The `getPolicy()` function returns a Promise that resolves to a policy whose ID matches the given ID.\n * @public\n * @requiredField policyId\n * @param policyId - Policy ID.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Policies\n * @permissionScopeId SCOPE.DC-EVENTS.READ-POLICIES\n * @permissionScope Manage Policies\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-POLICIES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns The requested policy.\n */\n function getPolicy(policyId: string): Promise;\n type eventsV2PolicyPolicies_universal_d_Policy = Policy;\n type eventsV2PolicyPolicies_universal_d_CreatePolicyRequest = CreatePolicyRequest;\n type eventsV2PolicyPolicies_universal_d_CreatePolicyResponse = CreatePolicyResponse;\n type eventsV2PolicyPolicies_universal_d_UpdatePolicyRequest = UpdatePolicyRequest;\n type eventsV2PolicyPolicies_universal_d_UpdatePolicyResponse = UpdatePolicyResponse;\n type eventsV2PolicyPolicies_universal_d_UpdatePolicySortIndexRequest = UpdatePolicySortIndexRequest;\n type eventsV2PolicyPolicies_universal_d_UpdatePolicySortIndexResponse = UpdatePolicySortIndexResponse;\n type eventsV2PolicyPolicies_universal_d_DeletePolicyRequest = DeletePolicyRequest;\n type eventsV2PolicyPolicies_universal_d_DeletePolicyResponse = DeletePolicyResponse;\n type eventsV2PolicyPolicies_universal_d_QueryPoliciesRequest = QueryPoliciesRequest;\n type eventsV2PolicyPolicies_universal_d_QueryPoliciesResponse = QueryPoliciesResponse;\n type eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesRequest = ReorderEventPoliciesRequest;\n type eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesRequestReferencePolicyOneOf = ReorderEventPoliciesRequestReferencePolicyOneOf;\n type eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesResponse = ReorderEventPoliciesResponse;\n type eventsV2PolicyPolicies_universal_d_GetPolicyRequest = GetPolicyRequest;\n type eventsV2PolicyPolicies_universal_d_GetPolicyResponse = GetPolicyResponse;\n type eventsV2PolicyPolicies_universal_d_GetPolicyFromTrashBinRequest = GetPolicyFromTrashBinRequest;\n type eventsV2PolicyPolicies_universal_d_GetPolicyFromTrashBinResponse = GetPolicyFromTrashBinResponse;\n const eventsV2PolicyPolicies_universal_d_createPolicy: typeof createPolicy;\n const eventsV2PolicyPolicies_universal_d_updatePolicy: typeof updatePolicy;\n type eventsV2PolicyPolicies_universal_d_UpdatePolicy = UpdatePolicy;\n type eventsV2PolicyPolicies_universal_d_UpdatePolicyOptions = UpdatePolicyOptions;\n const eventsV2PolicyPolicies_universal_d_deletePolicy: typeof deletePolicy;\n const eventsV2PolicyPolicies_universal_d_queryPolicies: typeof queryPolicies;\n type eventsV2PolicyPolicies_universal_d_PoliciesQueryResult = PoliciesQueryResult;\n type eventsV2PolicyPolicies_universal_d_PoliciesQueryBuilder = PoliciesQueryBuilder;\n const eventsV2PolicyPolicies_universal_d_reorderEventPolicies: typeof reorderEventPolicies;\n type eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesOptions = ReorderEventPoliciesOptions;\n const eventsV2PolicyPolicies_universal_d_getPolicy: typeof getPolicy;\n namespace eventsV2PolicyPolicies_universal_d {\n export { eventsV2PolicyPolicies_universal_d_Policy as Policy, eventsV2PolicyPolicies_universal_d_CreatePolicyRequest as CreatePolicyRequest, eventsV2PolicyPolicies_universal_d_CreatePolicyResponse as CreatePolicyResponse, eventsV2PolicyPolicies_universal_d_UpdatePolicyRequest as UpdatePolicyRequest, eventsV2PolicyPolicies_universal_d_UpdatePolicyResponse as UpdatePolicyResponse, eventsV2PolicyPolicies_universal_d_UpdatePolicySortIndexRequest as UpdatePolicySortIndexRequest, eventsV2PolicyPolicies_universal_d_UpdatePolicySortIndexResponse as UpdatePolicySortIndexResponse, eventsV2PolicyPolicies_universal_d_DeletePolicyRequest as DeletePolicyRequest, eventsV2PolicyPolicies_universal_d_DeletePolicyResponse as DeletePolicyResponse, eventsV2PolicyPolicies_universal_d_QueryPoliciesRequest as QueryPoliciesRequest, QueryV2$2 as QueryV2, QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf, Sorting$2 as Sorting, SortOrder$2 as SortOrder, Paging$2 as Paging, CursorPaging$1 as CursorPaging, eventsV2PolicyPolicies_universal_d_QueryPoliciesResponse as QueryPoliciesResponse, PagingMetadataV2$2 as PagingMetadataV2, Cursors$2 as Cursors, eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesRequest as ReorderEventPoliciesRequest, eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesRequestReferencePolicyOneOf as ReorderEventPoliciesRequestReferencePolicyOneOf, eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesResponse as ReorderEventPoliciesResponse, eventsV2PolicyPolicies_universal_d_GetPolicyRequest as GetPolicyRequest, eventsV2PolicyPolicies_universal_d_GetPolicyResponse as GetPolicyResponse, EventCopied$1 as EventCopied, Location$2 as Location, MapCoordinates$2 as MapCoordinates, LocationType$2 as LocationType, Address$2 as Address, AddressStreetOneOf$2 as AddressStreetOneOf, StreetAddress$2 as StreetAddress, AddressLocation$2 as AddressLocation, Subdivision$2 as Subdivision, SubdivisionType$2 as SubdivisionType, ScheduleConfig$2 as ScheduleConfig, Recurrences$2 as Recurrences, Occurrence$2 as Occurrence, Status$2 as Status, EventStatus$2 as EventStatus, Empty$1 as Empty, eventsV2PolicyPolicies_universal_d_GetPolicyFromTrashBinRequest as GetPolicyFromTrashBinRequest, eventsV2PolicyPolicies_universal_d_GetPolicyFromTrashBinResponse as GetPolicyFromTrashBinResponse, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, MessageEnvelope$2 as MessageEnvelope, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, eventsV2PolicyPolicies_universal_d_createPolicy as createPolicy, eventsV2PolicyPolicies_universal_d_updatePolicy as updatePolicy, eventsV2PolicyPolicies_universal_d_UpdatePolicy as UpdatePolicy, eventsV2PolicyPolicies_universal_d_UpdatePolicyOptions as UpdatePolicyOptions, eventsV2PolicyPolicies_universal_d_deletePolicy as deletePolicy, eventsV2PolicyPolicies_universal_d_queryPolicies as queryPolicies, eventsV2PolicyPolicies_universal_d_PoliciesQueryResult as PoliciesQueryResult, eventsV2PolicyPolicies_universal_d_PoliciesQueryBuilder as PoliciesQueryBuilder, eventsV2PolicyPolicies_universal_d_reorderEventPolicies as reorderEventPolicies, eventsV2PolicyPolicies_universal_d_ReorderEventPoliciesOptions as ReorderEventPoliciesOptions, eventsV2PolicyPolicies_universal_d_getPolicy as getPolicy, };\n }\n /**\n * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).\n * It also contains customizable messages and labels.\n *\n *\n * A form is an ordered list of controls (blocks), which accept guest information into a field input.\n *\n * Each control contains one or more nested inputs. For example, `Name` control has two inputs:\n * - First Name\n * - Last Name\n *\n * By default, name and email controls are always required and are pinned to the top of the form.\n */\n interface Form$1 {\n /** Nested fields as an ordered list. */\n controls?: InputControl$1[];\n /** Set of configured form messages. */\n messages?: FormMessages$1;\n }\n /**\n * A block of nested fields.\n * Used to aggregate similar inputs like First Name and Last Name.\n */\n interface InputControl$1 {\n /**\n * Field control type. Possible values:\n * - `INPUT`: Single text value field.\n * - `TEXTAREA`: Single text value field with multiple lines.\n * - `DROPDOWN`: Single-choice field with predefined values.\n * - `RADIO`: Single-choice field with predefined values.\n * - `CHECKBOX`: Multiple-choice field with predefined values.\n * - `NAME`: Fields for entering first and last names.\n * - `GUEST_CONTROL`: Fields for additional guests and their respective names.\n * - `ADDRESS_SHORT`: Single-line address field.\n * - `ADDRESS_FULL`: Full address field with multiple lines.\n * - `DATE`: Fields for entering year, month, and day.\n */\n type?: InputControlType$1;\n /**\n * Whether the control is mandatory (such as `name` & `email`).\n * When `true`, only the label can be changed.\n */\n system?: boolean;\n /** Deprecated: Use `id`. */\n name?: string;\n /** Child inputs. */\n inputs?: Input$1[];\n /** Deprecated: use `inputs.label`. */\n label?: string;\n /** Field controls are sorted by this value in ascending order. */\n orderIndex?: number;\n /** Unique control ID. */\n _id?: string;\n /**\n * Whether input control is deleted.\n * @readonly\n */\n deleted?: boolean | null;\n }\n enum InputControlType$1 {\n /** Single text value field. */\n INPUT = \"INPUT\",\n /** Single text value field. */\n TEXTAREA = \"TEXTAREA\",\n /** Single-choice field of predefined values. */\n DROPDOWN = \"DROPDOWN\",\n /** Single-choice field of predefined values. */\n RADIO = \"RADIO\",\n /** Multiple-choice field of predefined values. */\n CHECKBOX = \"CHECKBOX\",\n /** First and last name fields. */\n NAME = \"NAME\",\n /** Additional guests and respective guest names fields. */\n GUEST_CONTROL = \"GUEST_CONTROL\",\n /** Single-line address field. */\n ADDRESS_SHORT = \"ADDRESS_SHORT\",\n /** Full address field. */\n ADDRESS_FULL = \"ADDRESS_FULL\",\n /** Year, month and day fields. */\n DATE = \"DATE\"\n }\n /** An input of one or multiple text values */\n interface Input$1 {\n /** Field name. */\n name?: string;\n /** Deprecated: use `ValueType.TEXT_ARRAY`. */\n array?: boolean;\n /** Main field label */\n label?: string;\n /** Additional labels for multi-valued fields such as address. */\n additionalLabels?: Record;\n /** Predefined choice options for fields, such as dropdown. */\n options?: string[];\n /** Whether field is mandatory. */\n mandatory?: boolean;\n /** Maximum number of accepted characters (relevant for text fields). */\n maxLength?: number;\n /**\n * Type which determines field format.\n * Used to validate submitted response.\n */\n type?: ValueType$1;\n /**\n * The maximum number of accepted values for array input.\n * **Note:** Only applicable for `TEXT_ARRAY` input fields.\n */\n maxSize?: number | null;\n /**\n * Preselected option.\n * Currently only applicable for dropdown.\n */\n defaultOptionSelection?: OptionSelection$1;\n /**\n * Additional labels for multi-valued fields such as address.\n * @readonly\n */\n labels?: Label$1[];\n }\n enum ValueType$1 {\n TEXT = \"TEXT\",\n NUMBER = \"NUMBER\",\n TEXT_ARRAY = \"TEXT_ARRAY\",\n DATE_TIME = \"DATE_TIME\",\n ADDRESS = \"ADDRESS\"\n }\n /**\n * Describes initially selected option when an input has multiple choices.\n * Defaults to first (0th) option if not configured.\n */\n interface OptionSelection$1 extends OptionSelectionSelectedOptionOneOf$1 {\n /** 0-based index from predefined `input.options` which is selected initially. */\n optionIndex?: number;\n /**\n * Placeholder hint describing expected choices (such as \"Please select\").\n * Considered an empty choice.\n */\n placeholderText?: string;\n }\n /** @oneof */\n interface OptionSelectionSelectedOptionOneOf$1 {\n /** 0-based index from predefined `input.options` which is selected initially. */\n optionIndex?: number;\n /**\n * Placeholder hint describing expected choices (such as \"Please select\").\n * Considered an empty choice.\n */\n placeholderText?: string;\n }\n interface Label$1 {\n /** Field name. */\n name?: string;\n /** Field label. */\n label?: string;\n }\n /**\n * Defines form messages shown in UI before, during, and after registration flow.\n * It enables configuration of form titles, response labels, \"thank you\" messages, and call-to-action texts.\n */\n interface FormMessages$1 {\n /** RSVP form messages. */\n rsvp?: RsvpFormMessages$1;\n /** Checkout form messages. */\n checkout?: CheckoutFormMessages$1;\n /** Messages shown when event registration is closed. */\n registrationClosed?: RegistrationClosedMessages$1;\n /** Messages shown when event tickets are unavailable. */\n ticketsUnavailable?: TicketsUnavailableMessages$1;\n }\n interface RsvpFormMessages$1 {\n /** Label text indicating RSVP `YES` response. */\n rsvpYesOption?: string;\n /** Label text indicating RSVP `NO` response. */\n rsvpNoOption?: string;\n /** Messages shown for RSVP = `YES`. */\n positiveMessages?: Positive$1;\n /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */\n waitlistMessages?: Positive$1;\n /** Messages shown for RSVP = `NO`. */\n negativeMessages?: Negative$1;\n /** \"Submit form\" call-to-action label text. */\n submitActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface PositiveResponseConfirmation$1 {\n /** Confirmation message title. */\n title?: string;\n /** Confirmation message text. */\n message?: string;\n /** \"Add to calendar\" call-to-action label text. */\n addToCalendarActionLabel?: string;\n /** \"Share event\" call-to-action label text. */\n shareActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface NegativeResponseConfirmation$1 {\n /** Confirmation message title. */\n title?: string;\n /** \"Share event\" call-to-action label text. */\n shareActionLabel?: string;\n }\n /** Set of messages shown during registration when RSVP response is positive. */\n interface Positive$1 {\n /** Main form title for positive response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: PositiveResponseConfirmation$1;\n }\n /** A set of messages shown during registration with negative response */\n interface Negative$1 {\n /** Main form title for negative response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: NegativeResponseConfirmation$1;\n }\n interface CheckoutFormMessages$1 {\n /** Main form title for response. */\n title?: string;\n /** Submit form call-to-action label text. */\n submitActionLabel?: string;\n /** Confirmation messages shown after checkout. */\n confirmation?: ResponseConfirmation$1;\n }\n /** Confirmation messages shown after checkout. */\n interface ResponseConfirmation$1 {\n /** Confirmation message title. */\n title?: string;\n /** Confirmation message text. */\n message?: string;\n /** \"Download tickets\" call-to-action label text. */\n downloadTicketsLabel?: string;\n /** \"Add to calendar\" call-to-action label text. */\n addToCalendarLabel?: string;\n /** \"Share event\" call-to-action label text. */\n shareEventLabel?: string;\n }\n interface RegistrationClosedMessages$1 {\n /** Message shown when event registration is closed. */\n message?: string;\n /** \"Explore other events\" call-to-action label text. */\n exploreEventsActionLabel?: string;\n }\n interface TicketsUnavailableMessages$1 {\n /** Message shown when event tickets are unavailable. */\n message?: string;\n /** \"Explore other events\" call-to-action label text. */\n exploreEventsActionLabel?: string;\n }\n interface FormInputControlAdded {\n /** Event ID to which the form belongs. */\n eventId?: string;\n /** Input control. */\n inputControl?: InputControl$1;\n }\n interface FormInputControlUpdated {\n /** Event ID to which the form belongs. */\n eventId?: string;\n /** Input control. */\n updatedInputControl?: InputControl$1;\n }\n interface FormInputControlDeleted {\n /** Event ID to which the form belongs. */\n eventId?: string;\n /** Input control. */\n deletedInputControl?: InputControl$1;\n }\n interface GetFormRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n }\n enum RequestedFields$1 {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Include soft deleted input controls in the response. */\n DELETED = \"DELETED\"\n }\n interface GetFormResponse {\n /**\n * Currently published event form.\n * Published form is visible to site visitors.\n */\n form?: Form$1;\n /**\n * Draft event form.\n * Not available to visitors unless published.\n */\n draftForm?: Form$1;\n }\n interface AddControlRequest extends AddControlRequestControlOneOf {\n /** Phone number input control. */\n phone?: PhoneControl;\n /** Single-line or full address input control. */\n address?: AddressControl;\n /** Day, month, year date input control. */\n date?: DateControl;\n /** Additional guests input control. */\n additionalGuests?: AdditionalGuestsControl;\n /** Single-choice dropdown style input control. */\n dropdown?: DropdownControl;\n /** Multiple-choice checkbox style input control. */\n checkbox?: CheckboxControl;\n /** Free-form text input control. */\n text?: TextControl;\n /** Single-choice radio button style input control. */\n radioButton?: RadioButtonControl;\n /** Event ID to which the form belongs. */\n eventId: string;\n }\n /** @oneof */\n interface AddControlRequestControlOneOf {\n /** Phone number input control. */\n phone?: PhoneControl;\n /** Single-line or full address input control. */\n address?: AddressControl;\n /** Day, month, year date input control. */\n date?: DateControl;\n /** Additional guests input control. */\n additionalGuests?: AdditionalGuestsControl;\n /** Single-choice dropdown style input control. */\n dropdown?: DropdownControl;\n /** Multiple-choice checkbox style input control. */\n checkbox?: CheckboxControl;\n /** Free-form text input control. */\n text?: TextControl;\n /** Single-choice radio button style input control. */\n radioButton?: RadioButtonControl;\n }\n interface PhoneControl {\n /** Phone input label. */\n label?: string;\n /** Whether phone input is required. */\n mandatory?: boolean;\n }\n interface AddressControl {\n /** Address control labels for each input. */\n labels?: AddressControlLabels;\n /** Whether address is multi-line (consisting of multiple fields such as country, city, postal code). When false, address is single-line. */\n full?: boolean;\n /** Whether address input is required. */\n mandatory?: boolean;\n }\n interface AddressControlLabels {\n /** Single-line address input label. */\n addressLine?: string;\n /** Country input label. */\n country?: string;\n /** Subdivision input label. */\n subdivision?: string;\n /** City input label. */\n city?: string;\n /** Postal code input label. */\n postalCode?: string;\n /** Street address input label. */\n streetAddress?: string;\n }\n interface DateControl {\n /** Input control label. */\n label?: string;\n /** Whether date input is required */\n mandatory?: boolean;\n }\n interface AdditionalGuestsControl {\n /** Additional guests control labels for each input. */\n labels?: Labels;\n /** Whether individual guest names are required. */\n namesMandatory?: boolean;\n /** Maximum number of additional guests. */\n maxGuests?: number;\n }\n interface Labels {\n /** Input label for a single guest. */\n single?: string;\n /** Input label for multiple guests. */\n multiple?: string;\n }\n interface DropdownControl {\n /** Input control label. */\n label?: string;\n /** Predefined options guests can choose from. */\n options?: string[];\n /** Whether choice is required. */\n mandatory?: boolean;\n /** Preselected option. */\n defaultOptionSelection?: OptionSelection$1;\n }\n interface RadioButtonControl {\n /** Input control label. */\n label?: string;\n /** Predefined options guests can choose from. */\n options?: string[];\n }\n interface CheckboxControl {\n /** Input control label. */\n label?: string;\n /** Whether at least one checkbox is required. */\n mandatory?: boolean;\n /** Predefined options guests can choose from. */\n options?: string[];\n }\n interface TextControl {\n /** Input control label. */\n label?: string;\n /** Whether text input is required. */\n mandatory?: boolean;\n /** Maximum number of characters allowed. */\n maxLength?: number;\n /** Whether input control should allow multiple lines in text. */\n multiLine?: boolean;\n /** Whether input control should be displayed as a comment. */\n comment?: boolean;\n }\n interface AddControlResponse {\n /** Generated unique input control ID. */\n _id?: string;\n /** Modified draft event form. */\n form?: Form$1;\n }\n interface UpdateControlRequest extends UpdateControlRequestControlOneOf {\n /** Phone number input control. */\n phone?: PhoneControl;\n /** Single-line or full address input control. */\n address?: AddressControl;\n /** Day, month, year date input control. */\n date?: DateControl;\n /** Additional guests input control. */\n additionalGuests?: AdditionalGuestsControl;\n /** Single-choice dropdown style input control. */\n dropdown?: DropdownControl;\n /** Multiple-choice checkbox style input control. */\n checkbox?: CheckboxControl;\n /** Free-form text input control. */\n text?: TextControl;\n /** Main guest name input control. */\n name?: NameControl;\n /** Main guest email input control. */\n email?: EmailControl;\n /** Single-choice radio style input control. */\n radioButton?: RadioButtonControl;\n /** Event ID to which the form belongs. */\n eventId: string;\n /** Unique input control ID. */\n _id: string;\n /** Index used to sort input controls in ascending order. */\n orderIndex?: number;\n }\n /** @oneof */\n interface UpdateControlRequestControlOneOf {\n /** Phone number input control. */\n phone?: PhoneControl;\n /** Single-line or full address input control. */\n address?: AddressControl;\n /** Day, month, year date input control. */\n date?: DateControl;\n /** Additional guests input control. */\n additionalGuests?: AdditionalGuestsControl;\n /** Single-choice dropdown style input control. */\n dropdown?: DropdownControl;\n /** Multiple-choice checkbox style input control. */\n checkbox?: CheckboxControl;\n /** Free-form text input control. */\n text?: TextControl;\n /** Main guest name input control. */\n name?: NameControl;\n /** Main guest email input control. */\n email?: EmailControl;\n /** Single-choice radio style input control. */\n radioButton?: RadioButtonControl;\n }\n interface NameControl {\n /** Name control labels of each input */\n labels?: NameControlLabels;\n }\n interface NameControlLabels {\n /** First name input label */\n firstName?: string;\n /** Last name input label */\n lastName?: string;\n }\n interface EmailControl {\n /** Email input label. */\n label?: string;\n }\n interface UpdateControlResponse {\n /** Modified draft event form. */\n form?: Form$1;\n }\n interface DeleteControlRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n /** Unique input control ID. */\n _id: string;\n }\n interface DeleteControlResponse {\n /** Modified draft event form. */\n form?: Form$1;\n }\n interface UpdateMessagesRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n /** Set of configured form messages. */\n messages?: FormMessages$1;\n }\n interface UpdateMessagesResponse {\n /** Modified draft event form. */\n form?: Form$1;\n }\n interface PublishDraftRequest$1 {\n /** Event ID to which the form belongs. */\n eventId: string;\n }\n interface PublishDraftResponse$1 {\n /** Published event form. */\n form?: Form$1;\n }\n interface EventUpdated$1 {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$1;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$1;\n /** Event title. */\n title?: string;\n /** Whether schedule configuration was updated. */\n scheduleConfigUpdated?: boolean;\n /** Updated event */\n event?: Event$1;\n }\n interface Location$1 {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates$1;\n /** Single line address representation. */\n address?: string | null;\n /** Location type. */\n type?: LocationType$1;\n /**\n * Full address derived from formatted single line `address`.\n * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.\n * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.\n *\n * Migration notes:\n * - `full_address.formatted_address` is equivalent to `address`.\n * - `full_address.geocode` is equivalent to `coordinates`.\n */\n fullAddress?: Address$1;\n /**\n * Defines event location as TBD (To Be Determined).\n * When event location is not yet defined, `name` is displayed instead of location address.\n * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.\n */\n tbd?: boolean | null;\n }\n interface MapCoordinates$1 {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationType$1 {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$1 extends AddressStreetOneOf$1 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$1;\n /** Main address line (usually street and number) as free text */\n addressLine1?: string | null;\n /** country code */\n country?: string | null;\n /** subdivision (usually state or region) code according to ISO 3166-2 */\n subdivision?: string | null;\n /** city name */\n city?: string | null;\n /** zip/postal code */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */\n addressLine2?: string | null;\n /** A string containing the human-readable address of this location */\n formatted?: string | null;\n /** coordinates of the physical address */\n location?: AddressLocation$1;\n }\n /** @oneof */\n interface AddressStreetOneOf$1 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$1;\n /** Main address line (usually street and number) as free text */\n addressLine?: string | null;\n }\n interface StreetAddress$1 {\n /** street number */\n number?: string;\n /** street name */\n name?: string;\n }\n interface AddressLocation$1 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$1 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n }\n enum SubdivisionType$1 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface ScheduleConfig$1 {\n /**\n * Defines event as TBD (To Be Determined) schedule.\n * When event time is not yet defined, TBD message is displayed instead of event start and end times.\n * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.\n */\n scheduleTbd?: boolean;\n /** TBD message. */\n scheduleTbdMessage?: string | null;\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether end date is hidden in the formatted schedule. */\n endDateHidden?: boolean;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n /** Event recurrences. */\n recurrences?: Recurrences$1;\n }\n interface Recurrences$1 {\n /** Event occurrences. */\n occurrences?: Occurrence$1[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status$1;\n }\n interface Occurrence$1 {\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n }\n enum Status$1 {\n /** Event occurs only once. */\n ONE_TIME = \"ONE_TIME\",\n /** Event is recurring. */\n RECURRING = \"RECURRING\",\n /** Marks the next upcoming occurrence of the recurring event. */\n RECURRING_NEXT = \"RECURRING_NEXT\",\n /** Marks the most recent ended occurrence of the recurring event. */\n RECURRING_LAST_ENDED = \"RECURRING_LAST_ENDED\",\n /** Marks the most recent canceled occurrence of the recurring event. */\n RECURRING_LAST_CANCELED = \"RECURRING_LAST_CANCELED\"\n }\n interface Event$1 {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location$1;\n /** Event scheduling. */\n scheduling?: Scheduling$1;\n /** Event title. */\n title?: string;\n /** Event description. */\n description?: string;\n /** Rich-text content displayed in Wix UI - \"About Event\" section (HTML). */\n about?: string;\n /** Main event image. */\n mainImage?: string;\n /** Event slug URL (generated from event title). */\n slug?: string;\n /** ISO 639-1 language code of the event (used in content translations). */\n language?: string;\n /** Event creation timestamp. */\n created?: Date;\n /** Event modified timestamp. */\n modified?: Date;\n /** Event status. */\n status?: EventStatus$1;\n /** RSVP or ticketing registration details. */\n registration?: Registration$1;\n /** \"Add to calendar\" URLs. */\n calendarLinks?: CalendarLinks$1;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl$1;\n /** Event registration form. */\n form?: Form$1;\n /** Event dashboard summary of RSVP / ticket sales. */\n dashboard?: Dashboard$1;\n /** Instance ID of the site where event is hosted. */\n instanceId?: string;\n /** Guest list configuration. */\n guestListConfig?: GuestListConfig$1;\n /** Event creator user ID. */\n userId?: string;\n /** Event discussion feed. For internal use. */\n feed?: Feed$1;\n /** Online conferencing details. */\n onlineConferencing?: OnlineConferencing$1;\n /** SEO settings. */\n seoSettings?: SeoSettings$1;\n /** Assigned contacts label key. */\n assignedContactsLabel?: string | null;\n /** Agenda details. */\n agenda?: Agenda$1;\n /** Categories this event is assigned to. */\n categories?: Category$1[];\n /** Visual settings for event. */\n eventDisplaySettings?: EventDisplaySettings$1;\n }\n interface Scheduling$1 {\n /** Schedule configuration. */\n config?: ScheduleConfig$1;\n /** Formatted schedule representation. */\n formatted?: string;\n /** Formatted start date of the event (empty for TBD schedules). */\n startDateFormatted?: string;\n /** Formatted start time of the event (empty for TBD schedules). */\n startTimeFormatted?: string;\n /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */\n endDateFormatted?: string;\n /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */\n endTimeFormatted?: string;\n }\n enum EventStatus$1 {\n /** Event is public and scheduled to start */\n SCHEDULED = \"SCHEDULED\",\n /** Event has started */\n STARTED = \"STARTED\",\n /** Event has ended */\n ENDED = \"ENDED\",\n /** Event was canceled */\n CANCELED = \"CANCELED\",\n /** Event is not public and needs to be published */\n DRAFT = \"DRAFT\"\n }\n interface Registration$1 {\n /** Event type. */\n type?: EventType$1;\n /** Event registration status. */\n status?: RegistrationStatus$1;\n /** RSVP collection details. */\n rsvpCollection?: RsvpCollection$1;\n /** Ticketing details. */\n ticketing?: Ticketing$1;\n /** External registration details. */\n external?: ExternalEvent$1;\n /** Types of users allowed to register. */\n restrictedTo?: VisitorType$1;\n /** Initial event type which was set when creating an event. */\n initialType?: EventType$1;\n }\n enum EventType$1 {\n /** Type not available for this request fieldset */\n NA_EVENT_TYPE = \"NA_EVENT_TYPE\",\n /** Registration via RSVP */\n RSVP = \"RSVP\",\n /** Registration via ticket purchase */\n TICKETS = \"TICKETS\",\n /** External registration */\n EXTERNAL = \"EXTERNAL\",\n /** Registration not available */\n NO_REGISTRATION = \"NO_REGISTRATION\"\n }\n enum RegistrationStatus$1 {\n /** Registration status is not applicable */\n NA_REGISTRATION_STATUS = \"NA_REGISTRATION_STATUS\",\n /** Registration to event is closed */\n CLOSED = \"CLOSED\",\n /** Registration to event is closed manually */\n CLOSED_MANUALLY = \"CLOSED_MANUALLY\",\n /** Registration is open via RSVP */\n OPEN_RSVP = \"OPEN_RSVP\",\n /** Registration to event waitlist is open via RSVP */\n OPEN_RSVP_WAITLIST = \"OPEN_RSVP_WAITLIST\",\n /** Registration is open via ticket purchase */\n OPEN_TICKETS = \"OPEN_TICKETS\",\n /** Registration is open via external URL */\n OPEN_EXTERNAL = \"OPEN_EXTERNAL\",\n /** Registration will be open via RSVP */\n SCHEDULED_RSVP = \"SCHEDULED_RSVP\"\n }\n interface RsvpCollection$1 {\n /** RSVP collection configuration. */\n config?: RsvpCollectionConfig$1;\n }\n interface RsvpCollectionConfig$1 {\n /** Defines the supported RSVP statuses. */\n rsvpStatusOptions?: RsvpStatusOptions$1;\n /**\n * Total guest limit available to register to the event.\n * Additional guests per RSVP are counted towards total guests.\n */\n limit?: number | null;\n /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */\n waitlist?: boolean;\n /** Registration start timestamp. */\n startDate?: Date;\n /** Registration end timestamp. */\n endDate?: Date;\n }\n enum RsvpStatusOptions$1 {\n /** Only YES RSVP status is available for RSVP registration */\n YES_ONLY = \"YES_ONLY\",\n /** YES and NO RSVP status options are available for the registration */\n YES_AND_NO = \"YES_AND_NO\"\n }\n interface Ticketing$1 {\n /** Deprecated. */\n lowestPrice?: string | null;\n /** Deprecated. */\n highestPrice?: string | null;\n /** Currency used in event transactions. */\n currency?: string | null;\n /** Ticketing configuration. */\n config?: TicketingConfig$1;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: Money$1;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: Money$1;\n /**\n * Formatted price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPriceFormatted?: string | null;\n /**\n * Formatted price of highest priced ticket.\n * @readonly\n */\n highestTicketPriceFormatted?: string | null;\n /**\n * Whether all tickets are sold for this event.\n * @readonly\n */\n soldOut?: boolean | null;\n }\n interface TicketingConfig$1 {\n /** Whether the form must be filled out separately for each ticket. */\n guestAssignedTickets?: boolean;\n /** Tax configuration. */\n taxConfig?: TaxConfig$1;\n /** Limit of tickets that can be purchased per order, default 20. */\n ticketLimitPerOrder?: number;\n /** Duration for which the tickets being bought are reserved. */\n reservationDurationInMinutes?: number | null;\n }\n interface TaxConfig$1 {\n /** Tax application settings. */\n type?: TaxType$1;\n /** Tax name. */\n name?: string | null;\n /** Tax rate (e.g.,`21.55`). */\n rate?: string | null;\n /** Applies taxes for donations, default true. */\n appliesToDonations?: boolean | null;\n }\n enum TaxType$1 {\n /** Tax is included in the ticket price */\n INCLUDED = \"INCLUDED\",\n /** Tax is added to the order at the checkout */\n ADDED = \"ADDED\",\n /** Tax is added to the final total at the checkout */\n ADDED_AT_CHECKOUT = \"ADDED_AT_CHECKOUT\"\n }\n interface Money$1 {\n /** *Deprecated:** Use `value` instead. */\n amount?: string;\n /** ISO 4217 format of the currency i.e. `USD`. */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface ExternalEvent$1 {\n /** External event registration URL. */\n registration?: string;\n }\n enum VisitorType$1 {\n /** Site visitor (including member) */\n VISITOR = \"VISITOR\",\n /** Site member */\n MEMBER = \"MEMBER\",\n /** Site visitor or member */\n VISITOR_OR_MEMBER = \"VISITOR_OR_MEMBER\"\n }\n interface CalendarLinks$1 {\n /** \"Add to Google calendar\" URL. */\n google?: string;\n /** \"Download ICS calendar file\" URL. */\n ics?: string;\n }\n /** Site URL components */\n interface SiteUrl$1 {\n /**\n * Base URL. For premium sites, this will be the domain.\n * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)\n */\n base?: string;\n /** The path to that page - e.g `/my-events/weekly-meetup-2` */\n path?: string;\n }\n interface Dashboard$1 {\n /** Guest RSVP summary. */\n rsvpSummary?: RsvpSummary$1;\n /**\n * Summary of revenue and tickets sold.\n * (Archived orders are not included).\n */\n ticketingSummary?: TicketingSummary$1;\n }\n interface RsvpSummary$1 {\n /** Total number of RSVPs. */\n total?: number;\n /** Number of RSVPs with status `YES`. */\n yes?: number;\n /** Number of RSVPs with status `NO`. */\n no?: number;\n /** Number of RSVPs in waitlist. */\n waitlist?: number;\n }\n interface TicketingSummary$1 {\n /** Number of tickets sold. */\n tickets?: number;\n /**\n * Total revenue, excluding fees.\n * (taxes and payment provider fees are not deducted.)\n */\n revenue?: Money$1;\n /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */\n currencyLocked?: boolean;\n /** Number of orders placed. */\n orders?: number;\n /** Total balance of confirmed transactions. */\n totalSales?: Money$1;\n }\n interface GuestListConfig$1 {\n /** Whether members can see other members attending the event (defaults to true). */\n publicGuestList?: boolean;\n }\n interface Feed$1 {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing$1 {\n config?: OnlineConferencingConfig$1;\n session?: OnlineConferencingSession$1;\n }\n interface OnlineConferencingConfig$1 {\n /**\n * Whether online conferencing is enabled (not supported for TBD schedules).\n * When enabled, links to join conferencing are generated and provided to guests.\n */\n enabled?: boolean;\n /** Conferencing provider ID. */\n providerId?: string | null;\n /** Conference type */\n conferenceType?: ConferenceType$1;\n }\n enum ConferenceType$1 {\n /** Everyone in the meeting can publish and subscribe video and audio. */\n MEETING = \"MEETING\",\n /** Guests can only subscribe to video and audio. */\n WEBINAR = \"WEBINAR\"\n }\n interface OnlineConferencingSession$1 {\n /**\n * Link for event host to start the online conference session.\n * @readonly\n */\n hostLink?: string;\n /**\n * Link for guests to join the online conference session.\n * @readonly\n */\n guestLink?: string;\n /**\n * The password required to join online conferencing session (when relevant).\n * @readonly\n */\n password?: string | null;\n /**\n * Indicates that session was created successfully on providers side.\n * @readonly\n */\n sessionCreated?: boolean | null;\n /**\n * Unique session id\n * @readonly\n */\n sessionId?: string | null;\n }\n interface SeoSettings$1 {\n /** URL slug */\n slug?: string;\n /** Advanced SEO data */\n advancedSeoData?: SeoSchema$1;\n /**\n * Hidden from SEO Site Map\n * @readonly\n */\n hidden?: boolean | null;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema$1 {\n /** SEO tag information. */\n tags?: Tag$1[];\n /** SEO general settings. */\n settings?: Settings$1;\n }\n interface Keyword$1 {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n }\n interface Tag$1 {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings$1 {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword$1[];\n }\n interface Agenda$1 {\n /** Whether the schedule is enabled for the event. */\n enabled?: boolean;\n /**\n * Agenda page URL.\n * @readonly\n */\n pageUrl?: SiteUrl$1;\n }\n interface Category$1 {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category name. */\n name?: string;\n /**\n * Category creation timestamp.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Assigned and assigned draft event counts.\n * @readonly\n */\n counts?: CategoryCounts$1;\n /**\n * Category state. Default - MANUAL.\n * WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.\n * Field will be ignored on update requests.\n */\n states?: State$1[];\n }\n interface CategoryCounts$1 {\n /** Assigned events count. Deleted events are excluded. */\n assignedEventsCount?: number | null;\n /** Assigned draft events count. */\n assignedDraftEventsCount?: number | null;\n }\n enum State$1 {\n /** Created manually by the user. */\n MANUAL = \"MANUAL\",\n /** Created automatically. */\n AUTO = \"AUTO\",\n /** Created when publishing recurring events. */\n RECURRING_EVENT = \"RECURRING_EVENT\",\n /** Category is hidden. */\n HIDDEN = \"HIDDEN\",\n /** Category is used to store component events. */\n COMPONENT = \"COMPONENT\"\n }\n interface EventDisplaySettings$1 {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n }\n interface LabellingSettings$1 {\n }\n interface DiscardDraftRequest$1 {\n /** Event ID to which the form belongs. */\n eventId: string;\n }\n interface DiscardDraftResponse$1 {\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves an event registration form (both the draft and published versions).\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the form belongs.\n * @param options - Optional fields.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Events\n * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns Currently published event form.\n * Published form is visible to site visitors.\n */\n function getForm(eventId: string, options?: GetFormOptions): Promise;\n interface GetFormOptions {\n }\n /**\n * Adds an input control to the draft form.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the form belongs.\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function addControl(eventId: string, options?: AddControlOptions): Promise;\n interface AddControlOptions extends AddControlRequestControlOneOf {\n /** Phone number input control. */\n phone?: PhoneControl;\n /** Single-line or full address input control. */\n address?: AddressControl;\n /** Day, month, year date input control. */\n date?: DateControl;\n /** Additional guests input control. */\n additionalGuests?: AdditionalGuestsControl;\n /** Single-choice dropdown style input control. */\n dropdown?: DropdownControl;\n /** Multiple-choice checkbox style input control. */\n checkbox?: CheckboxControl;\n /** Free-form text input control. */\n text?: TextControl;\n /** Single-choice radio button style input control. */\n radioButton?: RadioButtonControl;\n }\n /**\n * Updates an existing input control in the draft form.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.id\n * @param options - Optional fields.\n * @param identifiers - Identifies what form to update.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateControl(identifiers: UpdateControlIdentifiers, options?: UpdateControlOptions): Promise;\n interface UpdateControlIdentifiers extends UpdateControlRequestControlOneOf {\n /** Event ID to which the form belongs. */\n eventId: string;\n /** Unique input control ID. */\n _id: string;\n }\n interface UpdateControlOptions extends UpdateControlRequestControlOneOf {\n /** Index used to sort input controls in ascending order. */\n orderIndex?: number;\n /** Phone number input control. */\n phone?: PhoneControl;\n /** Single-line or full address input control. */\n address?: AddressControl;\n /** Day, month, year date input control. */\n date?: DateControl;\n /** Additional guests input control. */\n additionalGuests?: AdditionalGuestsControl;\n /** Single-choice dropdown style input control. */\n dropdown?: DropdownControl;\n /** Multiple-choice checkbox style input control. */\n checkbox?: CheckboxControl;\n /** Free-form text input control. */\n text?: TextControl;\n /** Main guest name input control. */\n name?: NameControl;\n /** Main guest email input control. */\n email?: EmailControl;\n /** Single-choice radio style input control. */\n radioButton?: RadioButtonControl;\n }\n /**\n * Deletes an input control from the draft form.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.id\n * @param identifiers - Identifies what form to delete.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteControl(identifiers: DeleteControlIdentifiers): Promise;\n interface DeleteControlIdentifiers {\n /** Event ID to which the form belongs. */\n eventId: string;\n /** Unique input control ID. */\n _id: string;\n }\n /**\n * Updates draft form messages, as displayed in the Wix UI before, during, and after the registration flow.\n * Configurable messages include form titles, response labels, \"thank you\" messages, and call-to-action texts.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the form belongs.\n * @param options - Optional fields.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateMessages(eventId: string, options?: UpdateMessagesOptions): Promise;\n interface UpdateMessagesOptions {\n /** Set of configured form messages. */\n messages?: FormMessages$1;\n }\n /**\n * Publishes the draft form.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the form belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function publishDraft(eventId: string): Promise;\n /**\n * Clears all changes to the draft form.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the form belongs.\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function discardDraft(eventId: string): Promise;\n type eventsV1FormForms_universal_d_FormInputControlAdded = FormInputControlAdded;\n type eventsV1FormForms_universal_d_FormInputControlUpdated = FormInputControlUpdated;\n type eventsV1FormForms_universal_d_FormInputControlDeleted = FormInputControlDeleted;\n type eventsV1FormForms_universal_d_GetFormRequest = GetFormRequest;\n type eventsV1FormForms_universal_d_GetFormResponse = GetFormResponse;\n type eventsV1FormForms_universal_d_AddControlRequest = AddControlRequest;\n type eventsV1FormForms_universal_d_AddControlRequestControlOneOf = AddControlRequestControlOneOf;\n type eventsV1FormForms_universal_d_PhoneControl = PhoneControl;\n type eventsV1FormForms_universal_d_AddressControl = AddressControl;\n type eventsV1FormForms_universal_d_AddressControlLabels = AddressControlLabels;\n type eventsV1FormForms_universal_d_DateControl = DateControl;\n type eventsV1FormForms_universal_d_AdditionalGuestsControl = AdditionalGuestsControl;\n type eventsV1FormForms_universal_d_Labels = Labels;\n type eventsV1FormForms_universal_d_DropdownControl = DropdownControl;\n type eventsV1FormForms_universal_d_RadioButtonControl = RadioButtonControl;\n type eventsV1FormForms_universal_d_CheckboxControl = CheckboxControl;\n type eventsV1FormForms_universal_d_TextControl = TextControl;\n type eventsV1FormForms_universal_d_AddControlResponse = AddControlResponse;\n type eventsV1FormForms_universal_d_UpdateControlRequest = UpdateControlRequest;\n type eventsV1FormForms_universal_d_UpdateControlRequestControlOneOf = UpdateControlRequestControlOneOf;\n type eventsV1FormForms_universal_d_NameControl = NameControl;\n type eventsV1FormForms_universal_d_NameControlLabels = NameControlLabels;\n type eventsV1FormForms_universal_d_EmailControl = EmailControl;\n type eventsV1FormForms_universal_d_UpdateControlResponse = UpdateControlResponse;\n type eventsV1FormForms_universal_d_DeleteControlRequest = DeleteControlRequest;\n type eventsV1FormForms_universal_d_DeleteControlResponse = DeleteControlResponse;\n type eventsV1FormForms_universal_d_UpdateMessagesRequest = UpdateMessagesRequest;\n type eventsV1FormForms_universal_d_UpdateMessagesResponse = UpdateMessagesResponse;\n const eventsV1FormForms_universal_d_getForm: typeof getForm;\n type eventsV1FormForms_universal_d_GetFormOptions = GetFormOptions;\n const eventsV1FormForms_universal_d_addControl: typeof addControl;\n type eventsV1FormForms_universal_d_AddControlOptions = AddControlOptions;\n const eventsV1FormForms_universal_d_updateControl: typeof updateControl;\n type eventsV1FormForms_universal_d_UpdateControlIdentifiers = UpdateControlIdentifiers;\n type eventsV1FormForms_universal_d_UpdateControlOptions = UpdateControlOptions;\n const eventsV1FormForms_universal_d_deleteControl: typeof deleteControl;\n type eventsV1FormForms_universal_d_DeleteControlIdentifiers = DeleteControlIdentifiers;\n const eventsV1FormForms_universal_d_updateMessages: typeof updateMessages;\n type eventsV1FormForms_universal_d_UpdateMessagesOptions = UpdateMessagesOptions;\n const eventsV1FormForms_universal_d_publishDraft: typeof publishDraft;\n const eventsV1FormForms_universal_d_discardDraft: typeof discardDraft;\n namespace eventsV1FormForms_universal_d {\n export { Form$1 as Form, InputControl$1 as InputControl, InputControlType$1 as InputControlType, Input$1 as Input, ValueType$1 as ValueType, OptionSelection$1 as OptionSelection, OptionSelectionSelectedOptionOneOf$1 as OptionSelectionSelectedOptionOneOf, Label$1 as Label, FormMessages$1 as FormMessages, RsvpFormMessages$1 as RsvpFormMessages, PositiveResponseConfirmation$1 as PositiveResponseConfirmation, NegativeResponseConfirmation$1 as NegativeResponseConfirmation, Positive$1 as Positive, Negative$1 as Negative, CheckoutFormMessages$1 as CheckoutFormMessages, ResponseConfirmation$1 as ResponseConfirmation, RegistrationClosedMessages$1 as RegistrationClosedMessages, TicketsUnavailableMessages$1 as TicketsUnavailableMessages, eventsV1FormForms_universal_d_FormInputControlAdded as FormInputControlAdded, eventsV1FormForms_universal_d_FormInputControlUpdated as FormInputControlUpdated, eventsV1FormForms_universal_d_FormInputControlDeleted as FormInputControlDeleted, eventsV1FormForms_universal_d_GetFormRequest as GetFormRequest, RequestedFields$1 as RequestedFields, eventsV1FormForms_universal_d_GetFormResponse as GetFormResponse, eventsV1FormForms_universal_d_AddControlRequest as AddControlRequest, eventsV1FormForms_universal_d_AddControlRequestControlOneOf as AddControlRequestControlOneOf, eventsV1FormForms_universal_d_PhoneControl as PhoneControl, eventsV1FormForms_universal_d_AddressControl as AddressControl, eventsV1FormForms_universal_d_AddressControlLabels as AddressControlLabels, eventsV1FormForms_universal_d_DateControl as DateControl, eventsV1FormForms_universal_d_AdditionalGuestsControl as AdditionalGuestsControl, eventsV1FormForms_universal_d_Labels as Labels, eventsV1FormForms_universal_d_DropdownControl as DropdownControl, eventsV1FormForms_universal_d_RadioButtonControl as RadioButtonControl, eventsV1FormForms_universal_d_CheckboxControl as CheckboxControl, eventsV1FormForms_universal_d_TextControl as TextControl, eventsV1FormForms_universal_d_AddControlResponse as AddControlResponse, eventsV1FormForms_universal_d_UpdateControlRequest as UpdateControlRequest, eventsV1FormForms_universal_d_UpdateControlRequestControlOneOf as UpdateControlRequestControlOneOf, eventsV1FormForms_universal_d_NameControl as NameControl, eventsV1FormForms_universal_d_NameControlLabels as NameControlLabels, eventsV1FormForms_universal_d_EmailControl as EmailControl, eventsV1FormForms_universal_d_UpdateControlResponse as UpdateControlResponse, eventsV1FormForms_universal_d_DeleteControlRequest as DeleteControlRequest, eventsV1FormForms_universal_d_DeleteControlResponse as DeleteControlResponse, eventsV1FormForms_universal_d_UpdateMessagesRequest as UpdateMessagesRequest, eventsV1FormForms_universal_d_UpdateMessagesResponse as UpdateMessagesResponse, PublishDraftRequest$1 as PublishDraftRequest, PublishDraftResponse$1 as PublishDraftResponse, EventUpdated$1 as EventUpdated, Location$1 as Location, MapCoordinates$1 as MapCoordinates, LocationType$1 as LocationType, Address$1 as Address, AddressStreetOneOf$1 as AddressStreetOneOf, StreetAddress$1 as StreetAddress, AddressLocation$1 as AddressLocation, Subdivision$1 as Subdivision, SubdivisionType$1 as SubdivisionType, ScheduleConfig$1 as ScheduleConfig, Recurrences$1 as Recurrences, Occurrence$1 as Occurrence, Status$1 as Status, Event$1 as Event, Scheduling$1 as Scheduling, EventStatus$1 as EventStatus, Registration$1 as Registration, EventType$1 as EventType, RegistrationStatus$1 as RegistrationStatus, RsvpCollection$1 as RsvpCollection, RsvpCollectionConfig$1 as RsvpCollectionConfig, RsvpStatusOptions$1 as RsvpStatusOptions, Ticketing$1 as Ticketing, TicketingConfig$1 as TicketingConfig, TaxConfig$1 as TaxConfig, TaxType$1 as TaxType, Money$1 as Money, ExternalEvent$1 as ExternalEvent, VisitorType$1 as VisitorType, CalendarLinks$1 as CalendarLinks, SiteUrl$1 as SiteUrl, Dashboard$1 as Dashboard, RsvpSummary$1 as RsvpSummary, TicketingSummary$1 as TicketingSummary, GuestListConfig$1 as GuestListConfig, Feed$1 as Feed, OnlineConferencing$1 as OnlineConferencing, OnlineConferencingConfig$1 as OnlineConferencingConfig, ConferenceType$1 as ConferenceType, OnlineConferencingSession$1 as OnlineConferencingSession, SeoSettings$1 as SeoSettings, SeoSchema$1 as SeoSchema, Keyword$1 as Keyword, Tag$1 as Tag, Settings$1 as Settings, Agenda$1 as Agenda, Category$1 as Category, CategoryCounts$1 as CategoryCounts, State$1 as State, EventDisplaySettings$1 as EventDisplaySettings, LabellingSettings$1 as LabellingSettings, DiscardDraftRequest$1 as DiscardDraftRequest, DiscardDraftResponse$1 as DiscardDraftResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, eventsV1FormForms_universal_d_getForm as getForm, eventsV1FormForms_universal_d_GetFormOptions as GetFormOptions, eventsV1FormForms_universal_d_addControl as addControl, eventsV1FormForms_universal_d_AddControlOptions as AddControlOptions, eventsV1FormForms_universal_d_updateControl as updateControl, eventsV1FormForms_universal_d_UpdateControlIdentifiers as UpdateControlIdentifiers, eventsV1FormForms_universal_d_UpdateControlOptions as UpdateControlOptions, eventsV1FormForms_universal_d_deleteControl as deleteControl, eventsV1FormForms_universal_d_DeleteControlIdentifiers as DeleteControlIdentifiers, eventsV1FormForms_universal_d_updateMessages as updateMessages, eventsV1FormForms_universal_d_UpdateMessagesOptions as UpdateMessagesOptions, eventsV1FormForms_universal_d_publishDraft as publishDraft, eventsV1FormForms_universal_d_discardDraft as discardDraft, };\n }\n /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */\n interface ScheduleItem {\n /**\n * Schedule item ID.\n * @readonly\n */\n _id?: string;\n /** Whether a schedule item is hidden from guests. */\n hidden?: boolean;\n /** Schedule item name. */\n name?: string;\n /** Time slot of a schedule item. */\n timeSlot?: TimeInterval;\n /** Rich text schedule item description. */\n description?: string;\n /** Stage or room name in which the session takes place. */\n stageName?: string;\n /** Schedule item tags. They're used to organize the items to a theme. */\n tags?: string[];\n /**\n * Schedule item status. Possible values:\n * - `SCHEDULED`: An item is scheduled.\n * - `CANCELED`: An item is canceled.\n */\n status?: ScheduleStatus;\n /**\n * Date and time when the schedule item was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the schedule item was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Event ID to which the schedule belongs.\n * @readonly\n */\n eventId?: string;\n /**\n * Whether the schedule item is draft.\n * @readonly\n */\n draft?: boolean;\n }\n /** Time interval on the timeline between two points in time. */\n interface TimeInterval {\n /** Start of the interval. Inclusive. */\n start?: Date;\n /** End of the interval. Non-inclusive. */\n end?: Date;\n /**\n * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`.\n * Default: `Etc/UTC`.\n */\n timeZoneId?: string | null;\n }\n enum ScheduleStatus {\n /** Item is scheduled for a future date */\n SCHEDULED = \"SCHEDULED\",\n /** Item was canceled */\n CANCELED = \"CANCELED\"\n }\n interface ListScheduleItemsRequest {\n /** Event ID to which the schedule belongs. */\n eventId?: string[];\n /**\n * Schedule item state filter. Possible values:\n * - `PUBLISHED`: The schedule item is published.\n * - `DRAFT`: The schedule item is in the draft. You need the \"WIX_EVENTS.MANAGE_AGENDA\" permissions to change this state.\n * - `VISIBLE`: The schedule item is visible to guests.\n * - `HIDDEN`: The schedule item is hidden from guests. You need the \"WIX_EVENTS.MANAGE_AGENDA\" permissions to change this state.\n * Default: Filters by the `PUBLISHED` and `VISIBLE` states.\n */\n state?: StateFilter[];\n /** Filters schedule items starting on or after specified point in time. Inclusive. */\n startingFrom?: Date;\n /** Filters schedule items starting before specified point in time. Non-inclusive. */\n startingBefore?: Date;\n /**\n * Deprecated, use `paging`.\n * Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n * @deprecated\n */\n offset?: number;\n /**\n * Deprecated, use `paging`.\n * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n * @deprecated\n */\n limit?: number;\n /**\n * Filter facets.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).\n */\n facet?: string[];\n /** Schedule item ID. */\n itemId?: string[];\n /** Schedule item tags. They're used to organize the items to a theme. */\n tag?: string[];\n /** Stage or room name in which the session takes place. */\n stageName?: string[];\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$1;\n }\n enum StateFilter {\n /** Schedule item is published. */\n PUBLISHED = \"PUBLISHED\",\n /** Opposite of `PUBLISHED`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */\n DRAFT = \"DRAFT\",\n /** Schedule item is visible to the public. */\n VISIBLE = \"VISIBLE\",\n /** Opposite of `VISIBLE`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */\n HIDDEN = \"HIDDEN\"\n }\n interface Paging$1 {\n /** Number of items to load per page. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListScheduleItemsResponse {\n /**\n * Deprecated, use `paging_metadata.total`.\n * Total schedule items matching the given filters.\n * @readonly\n * @deprecated\n */\n total?: number;\n /**\n * Deprecated.\n * Limit.\n * @deprecated\n */\n limit?: number;\n /**\n * Deprecated, use `paging_metadata.offset`.\n * Offset.\n * @deprecated\n */\n offset?: number;\n /** Schedule items. */\n items?: ScheduleItem[];\n /**\n * Facets.\n * @readonly\n */\n facets?: Record;\n /**\n * Whether there are draft changes which have not been published yet.\n * Returned only when filtering by single `event_id` with `WIX_EVENTS.MANAGE_AGENDA` permission.\n * @readonly\n */\n draftNotPublished?: boolean | null;\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface FacetCounts$1 {\n /** Facet counts aggregated per value. */\n counts?: Record;\n }\n interface PagingMetadataV2$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryScheduleItemsRequest {\n query?: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$1;\n /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */\n filter?: Record | null;\n /**\n * Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).\n */\n sort?: Sorting$1[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$1 {\n /**\n * Pointer to page of results using offset.\n * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging$1;\n }\n interface Sorting$1 {\n /** Name of the field to sort by */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryScheduleItemsResponse {\n pagingMetadata?: PagingMetadataV2$1;\n /** Schedule items. */\n items?: ScheduleItem[];\n }\n interface GetScheduleItemRequest {\n /** Event ID to which the schedule belongs. */\n eventId?: string;\n /** Schedule item ID. */\n itemId: string;\n /** Whether to include draft schedules in the response. */\n includeDraft?: boolean;\n }\n interface GetScheduleItemResponse {\n /** Schedule item. */\n item?: ScheduleItem;\n /** Draft of the Schedule item. */\n draft?: ScheduleItem;\n }\n interface AddScheduleItemRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item. */\n item?: ScheduleItemData;\n }\n /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */\n interface ScheduleItemData {\n /** Whether a schedule item is hidden from guests. */\n hidden?: boolean;\n /** Schedule item name. */\n name?: string;\n /** Time slot of a schedule item. */\n timeSlot?: TimeInterval;\n /** Rich text schedule item description. */\n description?: string;\n /** Stage or room name in which the session takes place. */\n stageName?: string;\n /** Schedule item tags. They're used to organize the items to a theme. */\n tags?: string[];\n /**\n * Schedule item status. Possible values:\n * - `SCHEDULED`: An item is scheduled.\n * - `CANCELED`: An item is canceled.\n */\n status?: ScheduleStatus;\n }\n interface AddScheduleItemResponse {\n /** Schedule item. */\n item?: ScheduleItem;\n }\n interface UpdateScheduleItemRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item ID. */\n itemId: string;\n /** Schedule item. */\n item?: ScheduleItemData;\n }\n interface UpdateScheduleItemResponse {\n /** Schedule item. */\n item?: ScheduleItem;\n }\n interface DeleteScheduleItemRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule items to delete. */\n itemIds?: string[];\n }\n interface DeleteScheduleItemResponse {\n }\n interface DiscardDraftRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface DiscardDraftResponse {\n }\n interface PublishDraftRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface PublishDraftResponse {\n }\n interface RescheduleDraftRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /**\n * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`.\n * Default: `Etc/UTC`.\n */\n timeZoneId: string;\n /** Offset added or subtracted from the start and end times of schedule items. */\n timeSlotOffset?: GoogleProtoDuration;\n }\n interface RescheduleDraftResponse {\n }\n interface ListBookmarksRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface ListBookmarksResponse {\n /** Schedule items. */\n items?: ScheduleItem[];\n }\n interface CreateBookmarkRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item ID. */\n itemId: string;\n }\n interface CreateBookmarkResponse {\n }\n interface DeleteBookmarkRequest {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n /** Schedule item ID. */\n itemId: string;\n }\n interface DeleteBookmarkResponse {\n }\n type GoogleProtoDuration = any;\n /**\n * Retrieves a list of bookmarked schedule items for a currently logged-in member.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the schedule belongs.\n * @permissionId WIX_EVENTS.READ_AGENDA_BOOKMARKS\n * @applicableIdentity MEMBER\n */\n function listBookmarks(eventId: string): Promise;\n /**\n * Bookmarks a schedule item for a currently logged-in member.\n * @param itemId - Schedule item ID.\n * @public\n * @requiredField eventId\n * @requiredField itemId\n * @param eventId - Event ID to which the schedule belongs.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA_BOOKMARKS\n * @applicableIdentity MEMBER\n */\n function createBookmark(itemId: string, eventId: string): Promise;\n /**\n * Removes a schedule item bookmark for a currently logged-in member.\n * @param itemId - Schedule item ID.\n * @public\n * @requiredField eventId\n * @requiredField itemId\n * @param eventId - Event ID to which the schedule belongs.\n * @permissionId WIX_EVENTS.MANAGE_AGENDA_BOOKMARKS\n * @applicableIdentity MEMBER\n */\n function deleteBookmark(itemId: string, eventId: string): Promise;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleItem = ScheduleItem;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_TimeInterval = TimeInterval;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleStatus = ScheduleStatus;\n const eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleStatus: typeof ScheduleStatus;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListScheduleItemsRequest = ListScheduleItemsRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_StateFilter = StateFilter;\n const eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_StateFilter: typeof StateFilter;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListScheduleItemsResponse = ListScheduleItemsResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_QueryScheduleItemsRequest = QueryScheduleItemsRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_QueryScheduleItemsResponse = QueryScheduleItemsResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_GetScheduleItemRequest = GetScheduleItemRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_GetScheduleItemResponse = GetScheduleItemResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_AddScheduleItemRequest = AddScheduleItemRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleItemData = ScheduleItemData;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_AddScheduleItemResponse = AddScheduleItemResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_UpdateScheduleItemRequest = UpdateScheduleItemRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_UpdateScheduleItemResponse = UpdateScheduleItemResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteScheduleItemRequest = DeleteScheduleItemRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteScheduleItemResponse = DeleteScheduleItemResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DiscardDraftRequest = DiscardDraftRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DiscardDraftResponse = DiscardDraftResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_PublishDraftRequest = PublishDraftRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_PublishDraftResponse = PublishDraftResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_RescheduleDraftRequest = RescheduleDraftRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_RescheduleDraftResponse = RescheduleDraftResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListBookmarksRequest = ListBookmarksRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListBookmarksResponse = ListBookmarksResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_CreateBookmarkRequest = CreateBookmarkRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_CreateBookmarkResponse = CreateBookmarkResponse;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteBookmarkRequest = DeleteBookmarkRequest;\n type eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteBookmarkResponse = DeleteBookmarkResponse;\n const eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_listBookmarks: typeof listBookmarks;\n const eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_createBookmark: typeof createBookmark;\n const eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_deleteBookmark: typeof deleteBookmark;\n namespace eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d {\n export { eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleItem as ScheduleItem, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_TimeInterval as TimeInterval, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleStatus as ScheduleStatus, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListScheduleItemsRequest as ListScheduleItemsRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_StateFilter as StateFilter, Paging$1 as Paging, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListScheduleItemsResponse as ListScheduleItemsResponse, FacetCounts$1 as FacetCounts, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_QueryScheduleItemsRequest as QueryScheduleItemsRequest, QueryV2$1 as QueryV2, QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf, Sorting$1 as Sorting, SortOrder$1 as SortOrder, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_QueryScheduleItemsResponse as QueryScheduleItemsResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_GetScheduleItemRequest as GetScheduleItemRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_GetScheduleItemResponse as GetScheduleItemResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_AddScheduleItemRequest as AddScheduleItemRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ScheduleItemData as ScheduleItemData, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_AddScheduleItemResponse as AddScheduleItemResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_UpdateScheduleItemRequest as UpdateScheduleItemRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_UpdateScheduleItemResponse as UpdateScheduleItemResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteScheduleItemRequest as DeleteScheduleItemRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteScheduleItemResponse as DeleteScheduleItemResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DiscardDraftRequest as DiscardDraftRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DiscardDraftResponse as DiscardDraftResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_PublishDraftRequest as PublishDraftRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_PublishDraftResponse as PublishDraftResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_RescheduleDraftRequest as RescheduleDraftRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_RescheduleDraftResponse as RescheduleDraftResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListBookmarksRequest as ListBookmarksRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_ListBookmarksResponse as ListBookmarksResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_CreateBookmarkRequest as CreateBookmarkRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_CreateBookmarkResponse as CreateBookmarkResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteBookmarkRequest as DeleteBookmarkRequest, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_DeleteBookmarkResponse as DeleteBookmarkResponse, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_listBookmarks as listBookmarks, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_createBookmark as createBookmark, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_deleteBookmark as deleteBookmark, };\n }\n interface V3Event {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings;\n /** Event title. */\n title?: string | null;\n /** Short description that appears under the event title. */\n shortDescription?: string | null;\n /** Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags). */\n detailedDescription?: string | null;\n /**\n * Main event image.
      \n * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.\n */\n mainImage?: string;\n /**\n * Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is \"Leather Crafting 101\", then the slug is \"leather-crafting-101\".\n * @readonly\n */\n slug?: string;\n /**\n * Date and time when the event was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the event was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Event status:\n *\n * - `UPCOMING`: Event is published and scheduled to start.\n * - `STARTED`: Event has started.\n * - `ENDED`: Event has ended.\n * - `CANCELED`: Event is canceled.\n * - `DRAFT`: Event is not published.\n * @readonly\n */\n status?: Status;\n /**\n * RSVP or ticketing registration details.
      \n * **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.\n */\n registration?: Registration;\n /**\n * URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file.
      \n * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.\n * @readonly\n */\n calendarUrls?: CalendarUrls;\n /**\n * Event page URL components.
      \n * **Note:** This field is returned only when the `URLS` fieldset is included in the request.\n */\n eventPageUrl?: string;\n /**\n * Event registration form.
      \n * **Note:** This field is returned only when the `FORM` fieldset is included in the request.\n */\n form?: Form;\n /**\n * Summary of RSVP or ticket sales.
      \n * **Note:** This field is returned only when the `DASHBOARD` fieldset is included in the request and you have the \"WIX_EVENTS.READ_EVENT_DASHBOARD\" permissions.\n */\n summaries?: Summaries;\n /**\n * Instance ID of the site where the event is hosted.\n * @readonly\n */\n instanceId?: string;\n /** Guest list configuration. */\n guestListSettings?: GuestListSettings;\n /**\n * ID of the user who created the event.\n * @readonly\n */\n userId?: string;\n /**\n * Online conferencing details.
      \n * **Note:** This field is returned only when the `ONLINE_CONFERENCING_SESSION` fieldset is included in the request and you have the \"WIX_EVENTS.READ_ONLINE_CONFERENCING\" permissions.\n */\n onlineConferencing?: OnlineConferencing;\n /**\n * SEO settings.
      \n * **Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request.\n */\n seoSettings?: SeoSettings;\n /**\n * Assigned contacts label key.\n * @readonly\n */\n contactLabel?: string | null;\n /**\n * Event schedule details.
      \n * **Note:** This field is returned only when the `AGENDA` fieldset is included in the request.\n */\n agendaSettings?: AgendaSettings;\n /** Visual settings for event. */\n eventDisplaySettings?: V3EventDisplaySettings;\n }\n interface Location {\n /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */\n name?: string | null;\n /**\n * Location type:\n *\n * - `VENUE`: The event is on-site at a specific physical location.\n * - `ONLINE`: The event is online, such as a virtual video conference.\n */\n type?: LocationType;\n /** Exact location address. */\n address?: CommonAddress;\n /** Whether the event location is TBD. */\n locationTbd?: boolean | null;\n }\n enum LocationType {\n /** Default value. This value is unused. */\n UNKNOWN_LOCATION = \"UNKNOWN_LOCATION\",\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface CommonAddress extends CommonAddressStreetOneOf {\n /** Street address. */\n streetAddress?: CommonStreetAddress;\n /** Primary address information (street and building number). */\n addressLine1?: string | null;\n /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip or postal code. */\n postalCode?: string | null;\n /** Secondary address information (suite or apartment number and room number). */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface CommonAddressStreetOneOf {\n /** Street address. */\n streetAddress?: CommonStreetAddress;\n /** Primary address information (street and building number). */\n addressLine?: string | null;\n }\n interface CommonStreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface CommonAddressLocation {\n /** Address latitude coordinates. */\n latitude?: number | null;\n /** Address longitude coordinates. */\n longitude?: number | null;\n }\n interface CommonSubdivision {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n enum SubdivisionSubdivisionType {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface DateAndTimeSettings {\n /** Whether the event date and time are TBD. */\n dateAndTimeTbd?: boolean | null;\n /** Message that is displayed when time and date is TBD. */\n dateAndTimeTbdMessage?: string | null;\n /** Event start date. */\n startDate?: Date;\n /** Event end date. */\n endDate?: Date;\n /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */\n timeZoneId?: string | null;\n /** Whether the end date is hidden in the formatted date and time. */\n hideEndDate?: boolean | null;\n /** Whether the time zone is displayed in the formatted schedule. */\n showTimeZone?: boolean | null;\n /**\n * Repeating event status. Possible values:\n *\n * - `ONE_TIME`: The event happens only once and can last multiple days.\n * - `RECURRING`: A series of events that repeat.\n * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.\n * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.\n * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.\n * @readonly\n */\n recurrenceStatus?: RecurrenceStatusStatus;\n /** Event repetitions. */\n recurringEvents?: Recurrences;\n /** Formatted date and time settings. */\n formatted?: Formatted;\n }\n enum RecurrenceStatusStatus {\n /** Default value. This value is unused. */\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Event happens only once. */\n ONE_TIME = \"ONE_TIME\",\n /** Event is repeating and has a list of scheduled repetitions. */\n RECURRING = \"RECURRING\",\n /** An upcoming event from the list of repetitions. */\n RECURRING_UPCOMING = \"RECURRING_UPCOMING\",\n /** Latest ended event from the list of repetitions. */\n RECURRING_RECENTLY_ENDED = \"RECURRING_RECENTLY_ENDED\",\n /** Latest cancelled event from the list of repetitions. */\n RECURRING_RECENTLY_CANCELED = \"RECURRING_RECENTLY_CANCELED\"\n }\n interface Recurrences {\n /** Individual event dates info. */\n individualEventDates?: Occurrence[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n }\n interface Occurrence {\n /** Event start date. */\n startDate?: Date;\n /** Event end date. */\n endDate?: Date;\n /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */\n timeZoneId?: string | null;\n /** Whether the time zone is displayed in a formatted schedule. */\n showTimeZone?: boolean;\n }\n interface Formatted {\n /**\n * Formatted date and time representation.\n *\n * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.\n * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.\n * @readonly\n */\n dateAndTime?: string | null;\n /**\n * Formatted start date of the event. Empty for TBD schedules.\n * @readonly\n */\n startDate?: string | null;\n /**\n * Formatted start time of the event. Empty for TBD schedules.\n * @readonly\n */\n startTime?: string | null;\n /**\n * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.\n * @readonly\n */\n endDate?: string | null;\n /**\n * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.\n * @readonly\n */\n endTime?: string | null;\n }\n /**\n * A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.\n * For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.\n */\n interface TimeDuration {\n /** Number of days. */\n days?: number;\n /** Number of hours. */\n hours?: number;\n /** Number of minutes. */\n minutes?: number;\n }\n enum Status {\n /** Default value. This value is unused */\n UNKNOWN_EVENT_STATUS = \"UNKNOWN_EVENT_STATUS\",\n /** Event is public and scheduled to start */\n UPCOMING = \"UPCOMING\",\n /** Event has started */\n STARTED = \"STARTED\",\n /** Event has ended */\n ENDED = \"ENDED\",\n /** Event is canceled */\n CANCELED = \"CANCELED\",\n /** Event is not public */\n DRAFT = \"DRAFT\"\n }\n interface Registration {\n /**\n * Current registration type:\n *\n * - `RSVP`: Guests register by RSVPing to the event.\n * - `TICKETING`: Guests register by buying tickets.\n * - `EXTERNAL`: Guests register externally using some other site or platform.\n * - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.\n *\n * The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.\n * @readonly\n */\n type?: RegistrationTypeType;\n /**\n * Registration status. Possible values:\n *\n * - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.\n * - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.\n * - `OPEN_RSVP`: Guests can start RSVPing to the event.\n * - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.\n * - `OPEN_TICKETS`: Guests can buy tickets to the event.\n * - `OPEN_EXTERNAL`: Guests register on a different page or web address.\n * - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.\n * @readonly\n */\n status?: RegistrationStatusStatus;\n /** RSVP registration details. */\n rsvp?: RsvpRegistration;\n /** Ticket registration details. */\n tickets?: TicketsRegistration;\n /** External registration details. */\n external?: ExternalRegistration;\n /**\n * Types of guests allowed to register. Possible values:\n *\n * - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.\n * - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.\n */\n allowedGuestTypes?: GuestTypeType;\n /**\n * Initial event type which is set when creating an event. Possible values:\n *\n * - `RSVP`: Guests register by RSVPing to the event.\n * - `TICKETING`: Guests register by buying tickets.\n *\n * This property value never changes.\n */\n initialType?: InitialRegistrationTypeType;\n /** Whether the registration is paused. */\n registrationPaused?: boolean;\n /** Whether the registration is disabled. */\n registrationDisabled?: boolean;\n }\n enum RegistrationTypeType {\n /** Default value. This value is unused */\n UNKNOWN_REGISTRATION_TYPE = \"UNKNOWN_REGISTRATION_TYPE\",\n /** Registration via RSVP */\n RSVP = \"RSVP\",\n /** Registration via ticket purchase */\n TICKETING = \"TICKETING\",\n /** External registration */\n EXTERNAL = \"EXTERNAL\",\n /** Registration not available */\n NONE = \"NONE\"\n }\n enum RegistrationStatusStatus {\n /** Registration status is not applicable */\n UNKNOWN_REGISTRATION_STATUS = \"UNKNOWN_REGISTRATION_STATUS\",\n /** Registration to event is closed */\n CLOSED_AUTOMATICALLY = \"CLOSED_AUTOMATICALLY\",\n /** Registration to event is closed manually */\n CLOSED_MANUALLY = \"CLOSED_MANUALLY\",\n /** Registration is open via RSVP */\n OPEN_RSVP = \"OPEN_RSVP\",\n /** Registration to event waitlist is open via RSVP */\n OPEN_RSVP_WAITLIST_ONLY = \"OPEN_RSVP_WAITLIST_ONLY\",\n /** Registration is open via ticket purchase */\n OPEN_TICKETS = \"OPEN_TICKETS\",\n /** Registration is open via external URL */\n OPEN_EXTERNAL = \"OPEN_EXTERNAL\",\n /** Registration will be open via RSVP */\n SCHEDULED_RSVP = \"SCHEDULED_RSVP\"\n }\n interface RsvpRegistration {\n /**\n * Available answers for registration to an event. Possible values:\n * - `YES_ONLY`: Only a **Yes** answer is available to select when RSVP'ing to an event.\n * - `YES_AND_NO`: Both **Yes** and **No** answers are available to select when RSVP'ing to an event.\n */\n responseType?: ResponseType;\n /** How many guests can RSVP to an event. */\n limit?: number | null;\n /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */\n waitlistEnabled?: boolean;\n /** Registration start date. */\n startDate?: Date;\n /** Registration end date. */\n endDate?: Date;\n }\n enum ResponseType {\n /** Default value. This value is unused. */\n UNKNOWN_RESPONSE_TYPE = \"UNKNOWN_RESPONSE_TYPE\",\n /** Only a **Yes** answer is available for the registration. */\n YES_ONLY = \"YES_ONLY\",\n /** *Yes** and **No** answers are available for the registration. */\n YES_AND_NO = \"YES_AND_NO\"\n }\n interface TicketsRegistration {\n /** Whether the registration form must be filled out separately for each ticket. */\n guestsAssignedSeparately?: boolean;\n /**\n * Ticket limit per order.\n * Default: 20 tickets.\n */\n ticketLimitPerOrder?: number;\n /** Ticket price currency. */\n currency?: string | null;\n /**\n * Lowest ticket price.\n * @readonly\n */\n lowestPrice?: Money;\n /**\n * Highest ticket price.\n * @readonly\n */\n highestPrice?: Money;\n /**\n * Whether all tickets are sold for the event.\n * @readonly\n */\n soldOut?: boolean | null;\n /** How tax is applied. */\n taxSettings?: TaxSettings;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface Money {\n /** Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`). */\n value?: string;\n /** Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */\n currency?: string;\n /**\n * Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).\n * @readonly\n */\n formattedValue?: string | null;\n }\n interface TaxSettings {\n /**\n * Tax application settings:\n *\n * - `INCLUDED_IN_PRICE`: Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a service fee of $0.25 is deducted from the price and you'll get $9.75.\n * - `ADDED_AT_CHECKOUT`: Show the fee iin addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a service fee of $0.25 and pays $10.25 in total.\n */\n type?: TaxType;\n /** Tax name. */\n name?: string | null;\n /** Tax rate (for example,`21.55`). */\n rate?: string | null;\n /** Apply tax to donations. */\n appliedToDonations?: boolean | null;\n }\n enum TaxType {\n /** Default value. This value is unused. */\n UNKNOWN_TAX_TYPE = \"UNKNOWN_TAX_TYPE\",\n /** Tax is included in the ticket price */\n INCLUDED_IN_PRICE = \"INCLUDED_IN_PRICE\",\n /** Tax is added to the final total at the checkout */\n ADDED_AT_CHECKOUT = \"ADDED_AT_CHECKOUT\"\n }\n interface ExternalRegistration {\n /** External event registration URL. */\n url?: string | null;\n }\n enum GuestTypeType {\n /** Default value. This value is unused */\n UNKNOWN_GUEST_TYPE = \"UNKNOWN_GUEST_TYPE\",\n /** Site visitor or member */\n VISITOR_OR_MEMBER = \"VISITOR_OR_MEMBER\",\n /** Site member */\n MEMBER = \"MEMBER\"\n }\n enum InitialRegistrationTypeType {\n /** Default value. This value is unused */\n UNKNOWN_INITIAL_REGISTRATION_TYPE = \"UNKNOWN_INITIAL_REGISTRATION_TYPE\",\n /** Registration via RSVP */\n RSVP = \"RSVP\",\n /** Registration via ticket purchase */\n TICKETING = \"TICKETING\"\n }\n interface CalendarUrls {\n /**\n * \"Add to Google calendar\" URL.\n * @readonly\n */\n google?: string;\n /**\n * \"Download ICS calendar file\" URL.\n * @readonly\n */\n ics?: string;\n }\n /**\n * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).\n * It also contains customizable messages and labels.\n *\n *\n * A form is an ordered list of controls (blocks), which accept guest information into a field input.\n *\n * Each control contains one or more nested inputs. For example, `Name` control has two inputs:\n * - First Name\n * - Last Name\n *\n * By default, name and email controls are always required and are pinned to the top of the form.\n */\n interface Form {\n /** Nested fields as an ordered list. */\n controls?: InputControl[];\n /** Set of configured form messages. */\n messages?: FormMessages;\n }\n /**\n * A block of nested fields.\n * Used to aggregate similar inputs like First Name and Last Name.\n */\n interface InputControl {\n /** Field control type. */\n type?: InputControlType;\n /** Whether control is mandatory (such as name & email). When true, only label can be changed. */\n system?: boolean;\n /**\n * Deprecated: Use `id`.\n * @deprecated\n */\n name?: string;\n /** Child inputs. */\n inputs?: Input[];\n /**\n * Deprecated: use `inputs.label`.\n * @deprecated\n */\n label?: string;\n /** Field controls are sorted by this value in ascending order. */\n orderIndex?: number;\n /** Unique control ID. */\n _id?: string;\n /**\n * Whether input control is deleted.\n * @readonly\n */\n deleted?: boolean | null;\n }\n enum InputControlType {\n /** Single text value field. */\n INPUT = \"INPUT\",\n /** Single text value field. */\n TEXTAREA = \"TEXTAREA\",\n /** Single-choice field of predefined values. */\n DROPDOWN = \"DROPDOWN\",\n /** Single-choice field of predefined values. */\n RADIO = \"RADIO\",\n /** Multiple-choice field of predefined values. */\n CHECKBOX = \"CHECKBOX\",\n /** First and last name fields. */\n NAME = \"NAME\",\n /** Additional guests and respective guest names fields. */\n GUEST_CONTROL = \"GUEST_CONTROL\",\n /** Single-line address field. */\n ADDRESS_SHORT = \"ADDRESS_SHORT\",\n /** Full address field. */\n ADDRESS_FULL = \"ADDRESS_FULL\",\n /** Year, month and day fields. */\n DATE = \"DATE\"\n }\n /** An input of one or multiple text values */\n interface Input {\n /** Field name. */\n name?: string;\n /**\n * Deprecated: use `ValueType.TEXT_ARRAY`.\n * @deprecated\n */\n array?: boolean;\n /** Main field label */\n label?: string;\n /** Additional labels for multi-valued fields such as address. */\n additionalLabels?: Record;\n /** Predefined choice options for fields, such as dropdown. */\n options?: string[];\n /** Whether field is mandatory. */\n mandatory?: boolean;\n /** Maximum number of accepted characters (relevant for text fields). */\n maxLength?: number;\n /**\n * Type which determines field format.\n * Used to validate submitted response.\n */\n type?: ValueType;\n /**\n * A maximum accepted values for array input.\n * Only applicable for inputs of valueType: TEXT_ARRAY.\n */\n maxSize?: number | null;\n /**\n * Preselected option.\n * Currently only applicable for dropdown.\n */\n defaultOptionSelection?: OptionSelection;\n /**\n * Additional labels for multi-valued fields such as address.\n * @readonly\n */\n labels?: Label[];\n }\n enum ValueType {\n TEXT = \"TEXT\",\n NUMBER = \"NUMBER\",\n TEXT_ARRAY = \"TEXT_ARRAY\",\n DATE_TIME = \"DATE_TIME\",\n ADDRESS = \"ADDRESS\"\n }\n /**\n * Describes initially selected option when an input has multiple choices.\n * Defaults to first (0th) option if not configured.\n */\n interface OptionSelection extends OptionSelectionSelectedOptionOneOf {\n /** 0-based index from predefined `input.options` which is selected initially. */\n optionIndex?: number;\n /**\n * Placeholder hint describing expected choices (such as \"Please select\").\n * Considered an empty choice.\n */\n placeholderText?: string;\n }\n /** @oneof */\n interface OptionSelectionSelectedOptionOneOf {\n /** 0-based index from predefined `input.options` which is selected initially. */\n optionIndex?: number;\n /**\n * Placeholder hint describing expected choices (such as \"Please select\").\n * Considered an empty choice.\n */\n placeholderText?: string;\n }\n interface Label {\n /** Field name. */\n name?: string;\n /** Field label. */\n label?: string;\n }\n /**\n * Defines form messages shown in UI before, during, and after registration flow.\n * It enables configuration of form titles, response labels, \"thank you\" messages, and call-to-action texts.\n */\n interface FormMessages {\n /** RSVP form messages. */\n rsvp?: RsvpFormMessages;\n /** Checkout form messages. */\n checkout?: CheckoutFormMessages;\n /** Messages shown when event registration is closed. */\n registrationClosed?: RegistrationClosedMessages;\n /** Messages shown when event tickets are unavailable. */\n ticketsUnavailable?: TicketsUnavailableMessages;\n }\n interface RsvpFormMessages {\n /** Label text indicating RSVP `YES` response. */\n rsvpYesOption?: string;\n /** Label text indicating RSVP `NO` response. */\n rsvpNoOption?: string;\n /** Messages shown for RSVP = `YES`. */\n positiveMessages?: Positive;\n /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */\n waitlistMessages?: Positive;\n /** Messages shown for RSVP = `NO`. */\n negativeMessages?: Negative;\n /** \"Submit form\" call-to-action label text. */\n submitActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface PositiveResponseConfirmation {\n /** Confirmation message title. */\n title?: string;\n /** Confirmation message text. */\n message?: string;\n /** \"Add to calendar\" call-to-action label text. */\n addToCalendarActionLabel?: string;\n /** \"Share event\" call-to-action label text. */\n shareActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface NegativeResponseConfirmation {\n /** Confirmation message title. */\n title?: string;\n /** \"Share event\" call-to-action label text. */\n shareActionLabel?: string;\n }\n /** Set of messages shown during registration when RSVP response is positive. */\n interface Positive {\n /** Main form title for positive response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: PositiveResponseConfirmation;\n }\n /** A set of messages shown during registration with negative response */\n interface Negative {\n /** Main form title for negative response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: NegativeResponseConfirmation;\n }\n interface CheckoutFormMessages {\n /** Main form title for response. */\n title?: string;\n /** Submit form call-to-action label text. */\n submitActionLabel?: string;\n /** Confirmation messages shown after checkout. */\n confirmation?: ResponseConfirmation;\n }\n /** Confirmation messages shown after checkout. */\n interface ResponseConfirmation {\n /** Confirmation message title. */\n title?: string;\n /** Confirmation message text. */\n message?: string;\n /** \"Download tickets\" call-to-action label text. */\n downloadTicketsLabel?: string;\n /** \"Add to calendar\" call-to-action label text. */\n addToCalendarLabel?: string;\n /** \"Share event\" call-to-action label text. */\n shareEventLabel?: string;\n }\n interface RegistrationClosedMessages {\n /** Message shown when event registration is closed. */\n message?: string;\n /** \"Explore other events\" call-to-action label text. */\n exploreEventsActionLabel?: string;\n }\n interface TicketsUnavailableMessages {\n /** Message shown when event tickets are unavailable. */\n message?: string;\n /** \"Explore other events\" call-to-action label text. */\n exploreEventsActionLabel?: string;\n }\n interface Summaries {\n /** RSVP summary of guests. */\n rsvps?: Rsvps;\n /** Summary of revenue and sold tickets. Archived orders are not included. */\n tickets?: Tickets;\n }\n interface EventsMoney {\n /**\n * *Deprecated:** Use `value` instead.\n * @deprecated\n */\n amount?: string;\n /** ISO 4217 format of the currency e.g., `USD`. */\n currency?: string;\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface Rsvps {\n /**\n * Total number of RSVPs.\n * @readonly\n */\n totalCount?: number;\n /**\n * Number of RSVPs with status `YES`.\n * @readonly\n */\n yesCount?: number;\n /**\n * Number of RSVPs with status `NO`.\n * @readonly\n */\n noCount?: number;\n /**\n * Number of RSVPs in a waitlist.\n * @readonly\n */\n waitlistCount?: number;\n }\n interface Tickets {\n /**\n * Number of sold tickets.\n * @readonly\n */\n ticketsSold?: number;\n /**\n * Total revenue. Taxes and payment provider fees aren't deducted.\n * @readonly\n */\n revenue?: EventsMoney;\n /**\n * Whether the currency is locked and can’t be changed.\n * @readonly\n */\n currencyLocked?: boolean;\n /**\n * Number of orders placed.\n * @readonly\n */\n totalOrders?: number;\n /**\n * Total balance of confirmed transactions.\n * @readonly\n */\n totalSales?: EventsMoney;\n }\n interface GuestListSettings {\n /** Whether the guest list is public for all guests. */\n displayedPublicly?: boolean;\n }\n interface Feed {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing {\n /** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */\n enabled?: boolean;\n /** Conference host ID. */\n providerId?: string | null;\n /**\n * Conference type. Possible values:\n *\n * - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.\n * - `WEBINAR`: Guests can only watch the conference.\n */\n type?: ConferenceTypeType;\n /** Online conferencing session information. */\n session?: OnlineConferencingSession;\n }\n enum ConferenceTypeType {\n /** Default value. This value is unused */\n UNKNOWN_CONFERENCE_TYPE = \"UNKNOWN_CONFERENCE_TYPE\",\n /** Guests can publish and subscribe to video and audio. */\n MEETING = \"MEETING\",\n /** Guests can only subscribe to video and audio. */\n WEBINAR = \"WEBINAR\"\n }\n interface OnlineConferencingSession {\n /**\n * Link for the event host to start the online conference session.\n * @readonly\n */\n hostLink?: string;\n /**\n * Link for guests to join the online conference session.\n * @readonly\n */\n guestLink?: string;\n /**\n * Password required to join the online conferencing session (when relevant).\n * @readonly\n */\n password?: string | null;\n /**\n * Whether the session was created successfully on the event host side.\n * @readonly\n */\n sessionCreated?: boolean | null;\n /**\n * Unique session ID.\n * @readonly\n */\n sessionId?: string | null;\n }\n interface SeoSettings {\n /** URL slug. */\n slug?: string;\n /** Advanced SEO data. */\n advancedSeoData?: SeoSchema;\n /**\n * Whether the slug is hidden from the SEO Site Map.\n * @readonly\n */\n hidden?: boolean | null;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema {\n /** SEO tag information. */\n tags?: Tag[];\n /** SEO general settings. */\n settings?: Settings;\n }\n interface Keyword {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n /** Who added the keyword to the settings */\n origin?: string | null;\n }\n interface Tag {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword[];\n }\n interface AgendaSettings {\n /** Whether the schedule is enabled for the event. */\n enabled?: boolean;\n /**\n * Schedule page URL.\n * @readonly\n */\n pageUrl?: string;\n }\n interface EventCategories {\n /** Event categories. */\n categories?: EventCategory[];\n }\n interface EventCategory {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category name. */\n name?: string;\n /**\n * Category creation timestamp.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Category is hidden.\n * @readonly\n */\n hidden?: boolean;\n /**\n * Category type.\n * @readonly\n */\n type?: Type;\n }\n enum Type {\n /** Created manually by the user. */\n MANUAL = \"MANUAL\",\n /** Created automatically when publishing recurring events. */\n RECURRING_EVENT = \"RECURRING_EVENT\",\n /** Created automatically and used to store component events. */\n COMPONENT = \"COMPONENT\"\n }\n interface V3EventDisplaySettings {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n }\n interface LabellingSettings {\n }\n interface EventEventStarted {\n /** Event schedule configuration. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n }\n interface EventEventEnded {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n }\n interface EventEventReminder {\n /** Reminder timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location;\n /** Event schedule configuration. */\n dateAndTimeSettings?: DateAndTimeSettings;\n /** Event title. */\n title?: string;\n /** ID of the user who created the event. */\n userId?: string | null;\n /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */\n startsIn?: TimeDuration;\n }\n interface EventEventPublished {\n /** Event publishing timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event status. */\n status?: Status;\n /**\n * Event ID. Indicates the original event from which the current event was derived from.\n * Can be used to track the original event and add missing information.\n */\n derivedFromEventId?: string | null;\n /** Event title. */\n title?: string | null;\n /** Short description that appears under the event title. */\n shortDescription?: string | null;\n /** Event location. */\n location?: Location;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings;\n /** Event page URL components. */\n eventPageUrl?: string;\n /** RSVP or ticketing registration details. */\n registration?: Registration;\n }\n interface EventCloned {\n /** Event creation timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings;\n /** Event title. */\n title?: string;\n /** ID of the user who created the event. */\n userId?: string | null;\n /** Event status. */\n status?: Status;\n /** Instance ID. Indicates the original app instance from which current event was derived from. */\n derivedFromInstanceId?: string | null;\n /** Event ID. Indicates the original event from which current event was derived from. */\n derivedFromEventId?: string | null;\n /**\n * Map of copied ticket definitions from the original event.
      \n * Key represents ticket definition ID in the original event.
      \n * Value represents ticket definition ID in the newly event.\n */\n ticketDefinitions?: Record;\n }\n interface EventEventCanceled {\n /** Event cancelation timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event title. */\n title?: string;\n /** ID of the user who created the event. */\n userId?: string | null;\n }\n interface CreateEventRequest {\n /** Event data. */\n event: V3Event;\n /** Whether to create the event as a draft. */\n draft?: boolean;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n enum RequestedFields {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Include `description`, `mainImage` and `calendarLinks` in the response. */\n DETAILS = \"DETAILS\",\n /** Include `about` event rich text in the response. */\n TEXTS = \"TEXTS\",\n /** Include `registration` in the response. */\n REGISTRATION = \"REGISTRATION\",\n /** Include `eventPageUrl` in the response. */\n URLS = \"URLS\",\n /** Include `form` in the response. */\n FORM = \"FORM\",\n /** Include `dashboard` in the response. */\n DASHBOARD = \"DASHBOARD\",\n /** Include `feed` in the response. */\n FEED = \"FEED\",\n /** Include `onlineConferencing` in the response. */\n ONLINE_CONFERENCING_SESSION = \"ONLINE_CONFERENCING_SESSION\",\n /** Include `seoSettings` in the response. */\n SEO_SETTINGS = \"SEO_SETTINGS\",\n /** Include `agendaSettings` in the response. */\n AGENDA = \"AGENDA\",\n /** Include `categories` in the response. */\n CATEGORIES = \"CATEGORIES\",\n CUSTOMIZABLE_TICKETS = \"CUSTOMIZABLE_TICKETS\"\n }\n interface CreateEventResponse {\n /** Created event. */\n event?: V3Event;\n }\n interface CloneEventRequest {\n /** Event ID. */\n eventId: string;\n /** Field values to be changed when cloning the event. */\n event?: V3Event;\n /** Whether to clone the event as a draft. */\n draft?: boolean;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface CloneEventResponse {\n /** Cloned event. */\n event?: V3Event;\n }\n interface UpdateEventRequest {\n /** Field values to be changed. */\n event?: V3Event;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface UpdateEventResponse {\n /** Updated event. */\n event?: V3Event;\n }\n interface PublishDraftEventRequest {\n /** Event ID. */\n eventId: string;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface PublishDraftEventResponse {\n /** Published event. */\n event?: V3Event;\n }\n interface CancelEventRequest {\n /** Event ID. */\n eventId: string;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface CancelEventResponse {\n /** Canceled event. */\n event?: V3Event;\n }\n interface BulkCancelEventsByFilterRequest {\n /** Filter. */\n filter?: CommonQueryV2;\n }\n interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {\n /** Paging options. Can't be used together with `cursorPaging`. */\n paging?: CommonPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: CommonSorting[];\n }\n /** @oneof */\n interface CommonQueryV2PagingMethodOneOf {\n /** Paging options. Can't be used together with `cursorPaging`. */\n paging?: CommonPaging;\n }\n interface CommonSorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /**\n * Sort order.\n * Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Default: `ASC`.\n */\n order?: CommonSortOrder;\n }\n enum CommonSortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CommonPaging {\n /** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface BulkCancelEventsByFilterResponse {\n }\n interface DeleteEventRequest {\n /** Event ID. */\n eventId: string;\n }\n interface DeleteEventResponse {\n /** Deleted event ID. */\n eventId?: string;\n }\n interface BulkDeleteEventsByFilterRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n filter?: CommonQueryV2;\n }\n interface BulkDeleteEventsByFilterResponse {\n }\n interface QueryEventsRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query?: CommonQueryV2;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n /**\n * Whether draft events should be returned in the response.
      \n * **Note:** This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.\n */\n includeDrafts?: boolean;\n }\n interface QueryEventsResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: CommonPagingMetadataV2;\n /** List of events. */\n events?: V3Event[];\n }\n interface CommonPagingMetadataV2 {\n /** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */\n count?: number | null;\n /** Requested offset. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: CommonCursors;\n }\n interface CommonCursors {\n /** Cursor pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface ExportEventsRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query?: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ExportEventsResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2;\n /** List of events. */\n events?: V3Event[];\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface CountEventsByStatusRequest {\n /** Filter object in the following format:
      `\"filter\" : { \"fieldName1\": \"value1\" }`. */\n filter?: Record | null;\n /** Parameters to count events by. */\n facet?: string[];\n /**\n * Whether draft events should be returned in the response.
      \n * **Note:** This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.\n */\n includeDrafts?: boolean;\n }\n interface CountEventsByStatusResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: CommonPagingMetadataV2;\n /** Filter facets. */\n facets?: Record;\n }\n interface FacetCounts {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface ListUserEventsRequest {\n /** Paging options to limit and skip the number of items. */\n paging?: CommonPaging;\n /**\n * Sort order, defaults to `\"created:asc\"`.\n * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).\n */\n sort?: CommonSorting[];\n /** Event status. */\n status?: Status[];\n /**\n * Wix user filter, by default any.\n * Allows to filter events by user relation to the event among all wix sites.\n */\n userFilter?: UserFilter;\n /**\n * Filter facets to include in the response.\n * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).\n */\n facet?: string[];\n }\n interface UserFilter {\n /** User who is related to event */\n userId?: string;\n /** Relation of user to event */\n relation?: Relation[];\n }\n enum Relation {\n /**\n * User is attending the event.\n * User has RSVP with status YES or has ordered tickets.\n */\n ATTENDING = \"ATTENDING\"\n }\n interface ListUserEventsResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: CommonPagingMetadataV2;\n /** List of events. */\n events?: V3Event[];\n /** Filter facets. */\n facets?: Record;\n }\n interface ListEventsByCategoryRequest {\n /** Category ID. */\n categoryId: string;\n /** Paging options to limit and skip the number of items. */\n paging?: CommonPaging;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage`, and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface ListEventsByCategoryResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: CommonPagingMetadataV2;\n /** List of events. */\n events?: V3Event[];\n }\n interface GetEventRequest {\n /** Event ID. */\n eventId: string | null;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface GetEventResponse {\n /** Event. */\n event?: V3Event;\n }\n interface GetEventBySlugRequest {\n /** URL slug. */\n slug: string | null;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface GetEventBySlugResponse {\n /** Event. */\n event?: V3Event;\n }\n interface FindEventRequest extends FindEventRequestFindByOneOf {\n /** Event ID. */\n eventId?: string | null;\n /** URL slug. */\n slug?: string | null;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /** @oneof */\n interface FindEventRequestFindByOneOf {\n /** Event ID. */\n eventId?: string | null;\n /** URL slug. */\n slug?: string | null;\n }\n interface FindEventResponse {\n /** Event. */\n event?: V3Event;\n }\n interface EventCreated {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus;\n /** Instance ID. Indicates the original app instance which current event was derived from. */\n derivedFromInstanceId?: string | null;\n /** Event ID. Indicates the original event which current event was derived from. */\n derivedFromEventId?: string | null;\n /** Event that was created. */\n event?: Event;\n }\n interface EventsLocation {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates;\n /** Single line address representation. */\n address?: string | null;\n /** Location type. */\n type?: LocationLocationType;\n /**\n * Full address derived from formatted single line `address`.\n * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.\n * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.\n *\n * Migration notes:\n * - `full_address.formatted_address` is equivalent to `address`.\n * - `full_address.geocode` is equivalent to `coordinates`.\n */\n fullAddress?: Address;\n /**\n * Defines event location as TBD (To Be Determined).\n * When event location is not yet defined, `name` is displayed instead of location address.\n * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.\n */\n tbd?: boolean | null;\n }\n interface MapCoordinates {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationLocationType {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress;\n /** Main address line (usually street and number) as free text */\n addressLine1?: string | null;\n /** country code */\n country?: string | null;\n /** subdivision (usually state or region) code according to ISO 3166-2 */\n subdivision?: string | null;\n /** city name */\n city?: string | null;\n /** zip/postal code */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */\n addressLine2?: string | null;\n /** A string containing the human-readable address of this location */\n formatted?: string | null;\n /** coordinates of the physical address */\n location?: AddressLocation;\n }\n /** @oneof */\n interface AddressStreetOneOf {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress;\n /** Main address line (usually street and number) as free text */\n addressLine?: string | null;\n }\n interface StreetAddress {\n /** street number */\n number?: string;\n /** street name */\n name?: string;\n }\n interface AddressLocation {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n }\n enum SubdivisionType {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface ScheduleConfig {\n /**\n * Defines event as TBD (To Be Determined) schedule.\n * When event time is not yet defined, TBD message is displayed instead of event start and end times.\n * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.\n */\n scheduleTbd?: boolean;\n /** TBD message. */\n scheduleTbdMessage?: string | null;\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether end date is hidden in the formatted schedule. */\n endDateHidden?: boolean;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n /** Event recurrences. */\n recurrences?: EventsRecurrences;\n }\n interface EventsRecurrences {\n /** Event occurrences. */\n occurrences?: EventsOccurrence[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: EventsRecurrenceStatusStatus;\n }\n interface EventsOccurrence {\n /** Event start timestamp. */\n startDate?: Date;\n /** Event end timestamp. */\n endDate?: Date;\n /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */\n timeZoneId?: string | null;\n /** Whether time zone is displayed in formatted schedule. */\n showTimeZone?: boolean;\n }\n enum EventsRecurrenceStatusStatus {\n /** Event occurs only once. */\n ONE_TIME = \"ONE_TIME\",\n /** Event is recurring. */\n RECURRING = \"RECURRING\",\n /** Marks the next upcoming occurrence of the recurring event. */\n RECURRING_NEXT = \"RECURRING_NEXT\",\n /** Marks the most recent ended occurrence of the recurring event. */\n RECURRING_LAST_ENDED = \"RECURRING_LAST_ENDED\",\n /** Marks the most recent canceled occurrence of the recurring event. */\n RECURRING_LAST_CANCELED = \"RECURRING_LAST_CANCELED\"\n }\n enum EventStatus {\n /** Event is public and scheduled to start */\n SCHEDULED = \"SCHEDULED\",\n /** Event has started */\n STARTED = \"STARTED\",\n /** Event has ended */\n ENDED = \"ENDED\",\n /** Event was canceled */\n CANCELED = \"CANCELED\",\n /** Event is not public and needs to be published */\n DRAFT = \"DRAFT\"\n }\n interface Event {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event scheduling. */\n scheduling?: Scheduling;\n /** Event title. */\n title?: string;\n /** Event description. */\n description?: string;\n /** Rich-text content displayed in Wix UI - \"About Event\" section (HTML). */\n about?: string;\n /** Main event image. */\n mainImage?: string;\n /** Event slug URL (generated from event title). */\n slug?: string;\n /** ISO 639-1 language code of the event (used in content translations). */\n language?: string;\n /** Event creation timestamp. */\n created?: Date;\n /** Event modified timestamp. */\n modified?: Date;\n /** Event status. */\n status?: EventStatus;\n /** RSVP or ticketing registration details. */\n registration?: EventsRegistration;\n /** \"Add to calendar\" URLs. */\n calendarLinks?: CalendarLinks;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl;\n /** Event registration form. */\n form?: Form;\n /** Event dashboard summary of RSVP / ticket sales. */\n dashboard?: Dashboard;\n /** Instance ID of the site where event is hosted. */\n instanceId?: string;\n /** Guest list configuration. */\n guestListConfig?: GuestListConfig;\n /** Event creator user ID. */\n userId?: string;\n /** Event discussion feed. For internal use. */\n feed?: EventsFeed;\n /** Online conferencing details. */\n onlineConferencing?: EventsOnlineConferencing;\n /** SEO settings. */\n seoSettings?: EventsSeoSettings;\n /** Assigned contacts label key. */\n assignedContactsLabel?: string | null;\n /** Agenda details. */\n agenda?: Agenda;\n /** Categories this event is assigned to. */\n categories?: Category[];\n /** Visual settings for event. */\n eventDisplaySettings?: EventDisplaySettings;\n }\n interface Scheduling {\n /** Schedule configuration. */\n config?: ScheduleConfig;\n /** Formatted schedule representation. */\n formatted?: string;\n /** Formatted start date of the event (empty for TBD schedules). */\n startDateFormatted?: string;\n /** Formatted start time of the event (empty for TBD schedules). */\n startTimeFormatted?: string;\n /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */\n endDateFormatted?: string;\n /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */\n endTimeFormatted?: string;\n }\n interface EventsRegistration {\n /** Event type. */\n type?: EventType;\n /** Event registration status. */\n status?: RegistrationStatus;\n /** RSVP collection details. */\n rsvpCollection?: RsvpCollection;\n /** Ticketing details. */\n ticketing?: Ticketing;\n /** External registration details. */\n external?: ExternalEvent;\n /** Types of users allowed to register. */\n restrictedTo?: VisitorType;\n /** Initial event type which was set when creating an event. */\n initialType?: EventType;\n }\n enum EventType {\n /** Type not available for this request fieldset */\n NA_EVENT_TYPE = \"NA_EVENT_TYPE\",\n /** Registration via RSVP */\n RSVP = \"RSVP\",\n /** Registration via ticket purchase */\n TICKETS = \"TICKETS\",\n /** External registration */\n EXTERNAL = \"EXTERNAL\",\n /** Registration not available */\n NO_REGISTRATION = \"NO_REGISTRATION\"\n }\n enum RegistrationStatus {\n /** Registration status is not applicable */\n NA_REGISTRATION_STATUS = \"NA_REGISTRATION_STATUS\",\n /** Registration to event is closed */\n CLOSED = \"CLOSED\",\n /** Registration to event is closed manually */\n CLOSED_MANUALLY = \"CLOSED_MANUALLY\",\n /** Registration is open via RSVP */\n OPEN_RSVP = \"OPEN_RSVP\",\n /** Registration to event waitlist is open via RSVP */\n OPEN_RSVP_WAITLIST = \"OPEN_RSVP_WAITLIST\",\n /** Registration is open via ticket purchase */\n OPEN_TICKETS = \"OPEN_TICKETS\",\n /** Registration is open via external URL */\n OPEN_EXTERNAL = \"OPEN_EXTERNAL\",\n /** Registration will be open via RSVP */\n SCHEDULED_RSVP = \"SCHEDULED_RSVP\"\n }\n interface RsvpCollection {\n /** RSVP collection configuration. */\n config?: RsvpCollectionConfig;\n }\n interface RsvpCollectionConfig {\n /** Defines the supported RSVP statuses. */\n rsvpStatusOptions?: RsvpStatusOptions;\n /**\n * Total guest limit available to register to the event.\n * Additional guests per RSVP are counted towards total guests.\n */\n limit?: number | null;\n /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */\n waitlist?: boolean;\n /** Registration start timestamp. */\n startDate?: Date;\n /** Registration end timestamp. */\n endDate?: Date;\n }\n enum RsvpStatusOptions {\n /** Only YES RSVP status is available for RSVP registration */\n YES_ONLY = \"YES_ONLY\",\n /** YES and NO RSVP status options are available for the registration */\n YES_AND_NO = \"YES_AND_NO\"\n }\n interface Ticketing {\n /**\n * Deprecated.\n * @deprecated\n */\n lowestPrice?: string | null;\n /**\n * Deprecated.\n * @deprecated\n */\n highestPrice?: string | null;\n /** Currency used in event transactions. */\n currency?: string | null;\n /** Ticketing configuration. */\n config?: TicketingConfig;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: EventsMoney;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: EventsMoney;\n /**\n * Formatted price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPriceFormatted?: string | null;\n /**\n * Formatted price of highest priced ticket.\n * @readonly\n */\n highestTicketPriceFormatted?: string | null;\n /**\n * Whether all tickets are sold for this event.\n * @readonly\n */\n soldOut?: boolean | null;\n }\n interface TicketingConfig {\n /** Whether the form must be filled out separately for each ticket. */\n guestAssignedTickets?: boolean;\n /** Tax configuration. */\n taxConfig?: TaxConfig;\n /** Limit of tickets that can be purchased per order, default 20. */\n ticketLimitPerOrder?: number;\n /** Duration for which the tickets being bought are reserved. */\n reservationDurationInMinutes?: number | null;\n }\n interface TaxConfig {\n /** Tax application settings. */\n type?: EventsTaxType;\n /** Tax name. */\n name?: string | null;\n /** Tax rate (e.g.,`21.55`). */\n rate?: string | null;\n /** Applies taxes for donations, default true. */\n appliesToDonations?: boolean | null;\n }\n enum EventsTaxType {\n /** Tax is included in the ticket price. */\n INCLUDED = \"INCLUDED\",\n /** Tax is added to the order at the checkout. */\n ADDED = \"ADDED\",\n /** Tax is added to the final total at the checkout. */\n ADDED_AT_CHECKOUT = \"ADDED_AT_CHECKOUT\"\n }\n interface ExternalEvent {\n /** External event registration URL. */\n registration?: string;\n }\n enum VisitorType {\n /** Site visitor (including member) */\n VISITOR = \"VISITOR\",\n /** Site member */\n MEMBER = \"MEMBER\",\n /** Site visitor or member */\n VISITOR_OR_MEMBER = \"VISITOR_OR_MEMBER\"\n }\n interface CalendarLinks {\n /** \"Add to Google calendar\" URL. */\n google?: string;\n /** \"Download ICS calendar file\" URL. */\n ics?: string;\n }\n /** Site URL components */\n interface SiteUrl {\n /**\n * Base URL. For premium sites, this will be the domain.\n * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)\n */\n base?: string;\n /** The path to that page - e.g `/my-events/weekly-meetup-2` */\n path?: string;\n }\n interface Dashboard {\n /** Guest RSVP summary. */\n rsvpSummary?: RsvpSummary;\n /**\n * Summary of revenue and tickets sold.\n * (Archived orders are not included).\n */\n ticketingSummary?: TicketingSummary;\n }\n interface RsvpSummary {\n /** Total number of RSVPs. */\n total?: number;\n /** Number of RSVPs with status `YES`. */\n yes?: number;\n /** Number of RSVPs with status `NO`. */\n no?: number;\n /** Number of RSVPs in waitlist. */\n waitlist?: number;\n }\n interface TicketingSummary {\n /** Number of tickets sold. */\n tickets?: number;\n /**\n * Total revenue, excluding fees.\n * (taxes and payment provider fees are not deducted.)\n */\n revenue?: EventsMoney;\n /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */\n currencyLocked?: boolean;\n /** Number of orders placed. */\n orders?: number;\n /** Total balance of confirmed transactions. */\n totalSales?: EventsMoney;\n }\n interface GuestListConfig {\n /** Whether members can see other members attending the event (defaults to true). */\n publicGuestList?: boolean;\n }\n interface EventsFeed {\n /** Event discussion feed token. */\n token?: string;\n }\n interface EventsOnlineConferencing {\n config?: OnlineConferencingConfig;\n session?: EventsOnlineConferencingSession;\n }\n interface OnlineConferencingConfig {\n /**\n * Whether online conferencing is enabled (not supported for TBD schedules).\n * When enabled, links to join conferencing are generated and provided to guests.\n */\n enabled?: boolean;\n /** Conferencing provider ID. */\n providerId?: string | null;\n /** Conference type */\n conferenceType?: ConferenceType;\n }\n enum ConferenceType {\n /** Everyone in the meeting can publish and subscribe video and audio. */\n MEETING = \"MEETING\",\n /** Guests can only subscribe to video and audio. */\n WEBINAR = \"WEBINAR\"\n }\n interface EventsOnlineConferencingSession {\n /**\n * Link for event host to start the online conference session.\n * @readonly\n */\n hostLink?: string;\n /**\n * Link for guests to join the online conference session.\n * @readonly\n */\n guestLink?: string;\n /**\n * The password required to join online conferencing session (when relevant).\n * @readonly\n */\n password?: string | null;\n /**\n * Indicates that session was created successfully on providers side.\n * @readonly\n */\n sessionCreated?: boolean | null;\n /**\n * Unique session id\n * @readonly\n */\n sessionId?: string | null;\n }\n interface EventsSeoSettings {\n /** URL slug */\n slug?: string;\n /** Advanced SEO data */\n advancedSeoData?: SeoSchema;\n /**\n * Hidden from SEO Site Map\n * @readonly\n */\n hidden?: boolean | null;\n }\n interface Agenda {\n /** Whether the schedule is enabled for the event. */\n enabled?: boolean;\n /**\n * Agenda page URL.\n * @readonly\n */\n pageUrl?: SiteUrl;\n }\n interface Category {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string;\n /** Category name. */\n name?: string;\n /**\n * Date and time when category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts;\n /**\n * Category state. Possible values:\n *\n * `MANUAL`: Category is created manually by the user.\n * `AUTO`: Category is created automatically.\n * `RECURRING_EVENT`: Category is created automatically when publishing recurring events.\n * `HIDDEN`: Category can't be seen.\n *\n * Default: `MANUAL`.\n *\n * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.\n */\n states?: State[];\n }\n interface CategoryCounts {\n /** Total number of draft events assigned to the category. */\n assignedEventsCount?: number | null;\n /** Total number of published events assigned to the category. Deleted events are excluded. */\n assignedDraftEventsCount?: number | null;\n }\n enum State {\n /** Created manually by the user. */\n MANUAL = \"MANUAL\",\n /** Created automatically. */\n AUTO = \"AUTO\",\n /** Created when publishing recurring events. */\n RECURRING_EVENT = \"RECURRING_EVENT\",\n /** Category is hidden. */\n HIDDEN = \"HIDDEN\",\n /** Category is used to store component events. */\n COMPONENT = \"COMPONENT\"\n }\n interface EventDisplaySettings {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n }\n interface EventsLabellingSettings {\n }\n interface Empty {\n }\n interface EventUpdated {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig;\n /** Event title. */\n title?: string;\n /**\n * Whether schedule configuration was updated.\n * @deprecated\n */\n scheduleConfigUpdated?: boolean;\n /** Updated event */\n event?: Event;\n }\n interface EventDeleted {\n /** Event deleted timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n }\n interface EventCopied {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus;\n /** Instance ID. Indicates the original app instance which current event was derived from. */\n derivedFromInstanceId?: string | null;\n /** Event ID. Indicates the original event which current event was derived from. */\n derivedFromEventId?: string | null;\n /**\n * Map of copied ticket definitions from original event.\n * Key represents ticket def id in the original event.\n * Value represents ticket def id in the newly created event.\n */\n ticketDefinitions?: Record;\n }\n interface EventPublished {\n /** Event publish timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event status. */\n status?: EventStatus;\n /**\n * Event ID. Indicates the original event which current event was derived from.\n * Can be used to track the original event and add missing information.\n */\n derivedFromEventId?: string | null;\n /** Event title. */\n title?: string | null;\n /** Event description. */\n description?: string | null;\n /** Event location. */\n location?: EventsLocation;\n /** Event scheduling. */\n scheduling?: Scheduling;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl;\n /** RSVP or ticketing registration details. */\n registration?: EventsRegistration;\n }\n interface EventCanceled {\n /** Event canceled timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event title */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n }\n interface EventStarted {\n /** Event start timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n }\n interface EventEnded {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n }\n interface EventReminder {\n /** Reminder timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */\n startsIn?: TimeDuration;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates an event.\n *\n *\n * The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) for more information.\n *\n * You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.\n *\n * The event is automatically set up to send daily summary reports of new guests to your business email.\n * @param event - Event data.\n * @public\n * @requiredField event\n * @requiredField event.dateAndTimeSettings\n * @requiredField event.location\n * @requiredField event.registration.initialType\n * @requiredField event.title\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created event.\n */\n function createEvent(event: V3Event, options?: CreateEventOptions): Promise;\n interface CreateEventOptions {\n /** Whether to create the event as a draft. */\n draft?: boolean;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.\n *\n *\n * The new event's date is automatically set to 14 days from the original event date.\n * If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named \"Leather Crafting 101\", the new event's title is \"Leather Crafting 101 (1)\". You can change the required entity field values while cloning an event.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function cloneEvent(eventId: string, options?: CloneEventOptions): Promise;\n interface CloneEventOptions {\n /** Field values to be changed when cloning the event. */\n event?: V3Event;\n /** Whether to clone the event as a draft. */\n draft?: boolean;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Updates an event.\n * @param _id - Event ID.\n * @public\n * @requiredField _id\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated event.\n */\n function updateEvent(_id: string, options?: UpdateEventOptions): Promise;\n interface UpdateEventOptions {\n /** Event to update. */\n event: {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings;\n /** Event title. */\n title?: string | null;\n /** Short description that appears under the event title. */\n shortDescription?: string | null;\n /** Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags). */\n detailedDescription?: string | null;\n /**\n * Main event image.
      \n * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.\n */\n mainImage?: string;\n /**\n * Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is \"Leather Crafting 101\", then the slug is \"leather-crafting-101\".\n * @readonly\n */\n slug?: string;\n /**\n * Date and time when the event was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the event was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Event status. Possible values:\n *\n * - `UPCOMING`: The event is published and scheduled to start.\n * - `STARTED`: The event has started.\n * - `ENDED`: The event has ended.\n * - `CANCELED`: The event is canceled.\n * - `DRAFT`: The event is not published.\n * @readonly\n */\n status?: Status;\n /**\n * RSVP or ticketing registration details.
      \n * **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.\n */\n registration?: Registration;\n /**\n * URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file.
      \n * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.\n * @readonly\n */\n calendarUrls?: CalendarUrls;\n /**\n * Event page URL components.
      \n * **Note:** This field is returned only when the `URLS` fieldset is included in the request.\n */\n eventPageUrl?: string;\n /**\n * Event registration form.
      \n * **Note:** This field is returned only when the `FORM` fieldset is included in the request.\n */\n form?: Form;\n /**\n * Summary of RSVP or ticket sales.
      \n * **Note:** This field is returned only when the `DASHBOARD` fieldset is included in the request and you have the \"WIX_EVENTS.READ_EVENT_DASHBOARD\" permissions.\n */\n summaries?: Summaries;\n /**\n * Instance ID of the site where the event is hosted.\n * @readonly\n */\n instanceId?: string;\n /** Guest list configuration. */\n guestListSettings?: GuestListSettings;\n /**\n * ID of the user who created the event.\n * @readonly\n */\n userId?: string;\n /**\n * Online conferencing details.
      \n * **Note:** This field is returned only when the `ONLINE_CONFERENCING_SESSION` fieldset is included in the request and you have the \"WIX_EVENTS.READ_ONLINE_CONFERENCING\" permissions.\n */\n onlineConferencing?: OnlineConferencing;\n /**\n * SEO settings.
      \n * **Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request.\n */\n seoSettings?: SeoSettings;\n /**\n * Assigned contacts label key.\n * @readonly\n */\n contactLabel?: string | null;\n /**\n * Event schedule details.
      \n * **Note:** This field is returned only when the `AGENDA` fieldset is included in the request.\n */\n agendaSettings?: AgendaSettings;\n /** Visual settings for event. */\n eventDisplaySettings?: V3EventDisplaySettings;\n };\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING.`\n *\n *\n * It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, and then delete the original one.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise;\n interface PublishDraftEventOptions {\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Cancels an event.\n *\n *\n * After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.\n * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function cancelEvent(eventId: string, options?: CancelEventOptions): Promise;\n interface CancelEventOptions {\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Cancels multiple events that meet the given criteria.\n *\n *\n * After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.\n * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.\n * @public\n * @requiredField options.filter.filter\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise;\n interface BulkCancelEventsByFilterOptions {\n /** Filter. */\n filter?: CommonQueryV2;\n }\n /**\n * Permanently deletes an event.

      \n * You can retrieve the deleted event through a GDPR access request.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteEvent(eventId: string): Promise;\n /**\n * Permanently deletes multiple events that meet the given criteria.\n *\n *\n * You can retrieve the deleted events through a GDPR access request.\n * @public\n * @requiredField options.filter.filter\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteEventsByFilter(options?: BulkDeleteEventsByFilterOptions): Promise;\n interface BulkDeleteEventsByFilterOptions {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n filter?: CommonQueryV2;\n }\n /**\n * Creates a query to retrieve a list of events.\n *\n *\n * The `queryEvents()` function builds a query to retrieve a list of events and returns a [`EventsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder) object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/find) function.\n *\n * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results `queryEvents()` returns.\n *\n * `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:\n *\n * - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/skip)\n * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)\n * - [`descending(\"_createdDate\")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)\n *\n * The functions that are chained to `queryEvents()` are applied in the order they're called. For example, if you apply `ascending('title')` and then `descending('status')`, the results are sorted first by the `title`, and then, if there are multiple results with the same `title`, the items are sorted by `status`.\n * @public\n * @param options - Optional fields.\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Events\n * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;\n interface QueryEventsOptions {\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[] | undefined;\n /**\n * Whether draft events should be returned in the response.
      \n * **Note:** This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.\n */\n includeDrafts?: boolean | undefined;\n }\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface EventsQueryResult extends QueryOffsetResult {\n items: V3Event[];\n query: EventsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface EventsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"title\" | \"slug\" | \"_createdDate\" | \"_updatedDate\" | \"status\" | \"registration.initialType\" | \"userId\", value: any) => EventsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"title\" | \"slug\" | \"_createdDate\" | \"_updatedDate\" | \"status\" | \"userId\", value: any) => EventsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => EventsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => EventsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => EventsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => EventsQueryBuilder;\n in: (propertyName: \"_id\" | \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"title\" | \"slug\" | \"_createdDate\" | \"_updatedDate\" | \"status\" | \"userId\", value: any) => EventsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"title\" | \"slug\" | \"_createdDate\" | \"_updatedDate\">) => EventsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"dateAndTimeSettings.startDate\" | \"dateAndTimeSettings.endDate\" | \"title\" | \"slug\" | \"_createdDate\" | \"_updatedDate\">) => EventsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => EventsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => EventsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Counts events by status.\n * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Events\n * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function countEventsByStatus(options?: CountEventsByStatusOptions): Promise;\n interface CountEventsByStatusOptions {\n /** Filter object in the following format:
      `\"filter\" : { \"fieldName1\": \"value1\" }`. */\n filter?: Record | null;\n /** Parameters to count events by. */\n facet?: string[];\n /**\n * Whether draft events should be returned in the response.
      \n * **Note:** This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.\n */\n includeDrafts?: boolean;\n }\n interface ListEventsByCategoryOptions {\n /** Paging options to limit and skip the number of items. */\n paging?: CommonPaging;\n /**\n * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * - `DETAILS`: Returns `shortDescription`, `mainImage`, and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves an event by ID.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Events\n * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Event.\n */\n function getEvent(eventId: string | null, options?: GetEventOptions): Promise;\n interface GetEventOptions {\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves an event by the `slug` URL.\n *\n *\n * The slug is the end of an event URL that refers to a specific event. For example, if an events' URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.\n * @param slug - URL slug.\n * @public\n * @requiredField slug\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @permissionScope Read Events - all read permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Events - all permissions\n * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS\n * @permissionScope Read Events\n * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Guest List\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST\n * @permissionScope Manage Events\n * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise;\n interface GetEventBySlugOptions {\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n interface FindEventOptions extends FindEventRequestFindByOneOf {\n /** Event ID. */\n eventId?: string | null;\n /** URL slug. */\n slug?: string | null;\n /**\n * Predefined sets of fields to return.\n * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.\n * - `TEXTS`: Returns `detailedDescription`.\n * - `REGISTRATION`: Returns `registration`.\n * - `URLS`: Returns `eventPageUrl`.\n * - `FORM`: Returns `form`.\n * - `DASHBOARD`: Returns `summaries`.\n * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.\n * - `SEO_SETTINGS`: Returns `seoSettings`.\n * - `AGENDA`: Returns `agendaSettings`.\n * - `CATEGORIES`: Returns `categories`.\n */\n fields?: RequestedFields[];\n }\n type eventsV3EventWixEventsV2_universal_d_V3Event = V3Event;\n type eventsV3EventWixEventsV2_universal_d_Location = Location;\n type eventsV3EventWixEventsV2_universal_d_LocationType = LocationType;\n const eventsV3EventWixEventsV2_universal_d_LocationType: typeof LocationType;\n type eventsV3EventWixEventsV2_universal_d_CommonAddress = CommonAddress;\n type eventsV3EventWixEventsV2_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type eventsV3EventWixEventsV2_universal_d_CommonStreetAddress = CommonStreetAddress;\n type eventsV3EventWixEventsV2_universal_d_CommonAddressLocation = CommonAddressLocation;\n type eventsV3EventWixEventsV2_universal_d_CommonSubdivision = CommonSubdivision;\n type eventsV3EventWixEventsV2_universal_d_SubdivisionSubdivisionType = SubdivisionSubdivisionType;\n const eventsV3EventWixEventsV2_universal_d_SubdivisionSubdivisionType: typeof SubdivisionSubdivisionType;\n type eventsV3EventWixEventsV2_universal_d_DateAndTimeSettings = DateAndTimeSettings;\n type eventsV3EventWixEventsV2_universal_d_RecurrenceStatusStatus = RecurrenceStatusStatus;\n const eventsV3EventWixEventsV2_universal_d_RecurrenceStatusStatus: typeof RecurrenceStatusStatus;\n type eventsV3EventWixEventsV2_universal_d_Recurrences = Recurrences;\n type eventsV3EventWixEventsV2_universal_d_Occurrence = Occurrence;\n type eventsV3EventWixEventsV2_universal_d_Formatted = Formatted;\n type eventsV3EventWixEventsV2_universal_d_TimeDuration = TimeDuration;\n type eventsV3EventWixEventsV2_universal_d_Status = Status;\n const eventsV3EventWixEventsV2_universal_d_Status: typeof Status;\n type eventsV3EventWixEventsV2_universal_d_Registration = Registration;\n type eventsV3EventWixEventsV2_universal_d_RegistrationTypeType = RegistrationTypeType;\n const eventsV3EventWixEventsV2_universal_d_RegistrationTypeType: typeof RegistrationTypeType;\n type eventsV3EventWixEventsV2_universal_d_RegistrationStatusStatus = RegistrationStatusStatus;\n const eventsV3EventWixEventsV2_universal_d_RegistrationStatusStatus: typeof RegistrationStatusStatus;\n type eventsV3EventWixEventsV2_universal_d_RsvpRegistration = RsvpRegistration;\n type eventsV3EventWixEventsV2_universal_d_ResponseType = ResponseType;\n const eventsV3EventWixEventsV2_universal_d_ResponseType: typeof ResponseType;\n type eventsV3EventWixEventsV2_universal_d_TicketsRegistration = TicketsRegistration;\n type eventsV3EventWixEventsV2_universal_d_Money = Money;\n type eventsV3EventWixEventsV2_universal_d_TaxSettings = TaxSettings;\n type eventsV3EventWixEventsV2_universal_d_TaxType = TaxType;\n const eventsV3EventWixEventsV2_universal_d_TaxType: typeof TaxType;\n type eventsV3EventWixEventsV2_universal_d_ExternalRegistration = ExternalRegistration;\n type eventsV3EventWixEventsV2_universal_d_GuestTypeType = GuestTypeType;\n const eventsV3EventWixEventsV2_universal_d_GuestTypeType: typeof GuestTypeType;\n type eventsV3EventWixEventsV2_universal_d_InitialRegistrationTypeType = InitialRegistrationTypeType;\n const eventsV3EventWixEventsV2_universal_d_InitialRegistrationTypeType: typeof InitialRegistrationTypeType;\n type eventsV3EventWixEventsV2_universal_d_CalendarUrls = CalendarUrls;\n type eventsV3EventWixEventsV2_universal_d_Form = Form;\n type eventsV3EventWixEventsV2_universal_d_InputControl = InputControl;\n type eventsV3EventWixEventsV2_universal_d_InputControlType = InputControlType;\n const eventsV3EventWixEventsV2_universal_d_InputControlType: typeof InputControlType;\n type eventsV3EventWixEventsV2_universal_d_Input = Input;\n type eventsV3EventWixEventsV2_universal_d_ValueType = ValueType;\n const eventsV3EventWixEventsV2_universal_d_ValueType: typeof ValueType;\n type eventsV3EventWixEventsV2_universal_d_OptionSelection = OptionSelection;\n type eventsV3EventWixEventsV2_universal_d_OptionSelectionSelectedOptionOneOf = OptionSelectionSelectedOptionOneOf;\n type eventsV3EventWixEventsV2_universal_d_Label = Label;\n type eventsV3EventWixEventsV2_universal_d_FormMessages = FormMessages;\n type eventsV3EventWixEventsV2_universal_d_RsvpFormMessages = RsvpFormMessages;\n type eventsV3EventWixEventsV2_universal_d_PositiveResponseConfirmation = PositiveResponseConfirmation;\n type eventsV3EventWixEventsV2_universal_d_NegativeResponseConfirmation = NegativeResponseConfirmation;\n type eventsV3EventWixEventsV2_universal_d_Positive = Positive;\n type eventsV3EventWixEventsV2_universal_d_Negative = Negative;\n type eventsV3EventWixEventsV2_universal_d_CheckoutFormMessages = CheckoutFormMessages;\n type eventsV3EventWixEventsV2_universal_d_ResponseConfirmation = ResponseConfirmation;\n type eventsV3EventWixEventsV2_universal_d_RegistrationClosedMessages = RegistrationClosedMessages;\n type eventsV3EventWixEventsV2_universal_d_TicketsUnavailableMessages = TicketsUnavailableMessages;\n type eventsV3EventWixEventsV2_universal_d_Summaries = Summaries;\n type eventsV3EventWixEventsV2_universal_d_EventsMoney = EventsMoney;\n type eventsV3EventWixEventsV2_universal_d_Rsvps = Rsvps;\n type eventsV3EventWixEventsV2_universal_d_Tickets = Tickets;\n type eventsV3EventWixEventsV2_universal_d_GuestListSettings = GuestListSettings;\n type eventsV3EventWixEventsV2_universal_d_Feed = Feed;\n type eventsV3EventWixEventsV2_universal_d_OnlineConferencing = OnlineConferencing;\n type eventsV3EventWixEventsV2_universal_d_ConferenceTypeType = ConferenceTypeType;\n const eventsV3EventWixEventsV2_universal_d_ConferenceTypeType: typeof ConferenceTypeType;\n type eventsV3EventWixEventsV2_universal_d_OnlineConferencingSession = OnlineConferencingSession;\n type eventsV3EventWixEventsV2_universal_d_SeoSettings = SeoSettings;\n type eventsV3EventWixEventsV2_universal_d_SeoSchema = SeoSchema;\n type eventsV3EventWixEventsV2_universal_d_Keyword = Keyword;\n type eventsV3EventWixEventsV2_universal_d_Tag = Tag;\n type eventsV3EventWixEventsV2_universal_d_Settings = Settings;\n type eventsV3EventWixEventsV2_universal_d_AgendaSettings = AgendaSettings;\n type eventsV3EventWixEventsV2_universal_d_EventCategories = EventCategories;\n type eventsV3EventWixEventsV2_universal_d_EventCategory = EventCategory;\n type eventsV3EventWixEventsV2_universal_d_Type = Type;\n const eventsV3EventWixEventsV2_universal_d_Type: typeof Type;\n type eventsV3EventWixEventsV2_universal_d_V3EventDisplaySettings = V3EventDisplaySettings;\n type eventsV3EventWixEventsV2_universal_d_LabellingSettings = LabellingSettings;\n type eventsV3EventWixEventsV2_universal_d_EventEventStarted = EventEventStarted;\n type eventsV3EventWixEventsV2_universal_d_EventEventEnded = EventEventEnded;\n type eventsV3EventWixEventsV2_universal_d_EventEventReminder = EventEventReminder;\n type eventsV3EventWixEventsV2_universal_d_EventEventPublished = EventEventPublished;\n type eventsV3EventWixEventsV2_universal_d_EventCloned = EventCloned;\n type eventsV3EventWixEventsV2_universal_d_EventEventCanceled = EventEventCanceled;\n type eventsV3EventWixEventsV2_universal_d_CreateEventRequest = CreateEventRequest;\n type eventsV3EventWixEventsV2_universal_d_RequestedFields = RequestedFields;\n const eventsV3EventWixEventsV2_universal_d_RequestedFields: typeof RequestedFields;\n type eventsV3EventWixEventsV2_universal_d_CreateEventResponse = CreateEventResponse;\n type eventsV3EventWixEventsV2_universal_d_CloneEventRequest = CloneEventRequest;\n type eventsV3EventWixEventsV2_universal_d_CloneEventResponse = CloneEventResponse;\n type eventsV3EventWixEventsV2_universal_d_UpdateEventRequest = UpdateEventRequest;\n type eventsV3EventWixEventsV2_universal_d_UpdateEventResponse = UpdateEventResponse;\n type eventsV3EventWixEventsV2_universal_d_PublishDraftEventRequest = PublishDraftEventRequest;\n type eventsV3EventWixEventsV2_universal_d_PublishDraftEventResponse = PublishDraftEventResponse;\n type eventsV3EventWixEventsV2_universal_d_CancelEventRequest = CancelEventRequest;\n type eventsV3EventWixEventsV2_universal_d_CancelEventResponse = CancelEventResponse;\n type eventsV3EventWixEventsV2_universal_d_BulkCancelEventsByFilterRequest = BulkCancelEventsByFilterRequest;\n type eventsV3EventWixEventsV2_universal_d_CommonQueryV2 = CommonQueryV2;\n type eventsV3EventWixEventsV2_universal_d_CommonQueryV2PagingMethodOneOf = CommonQueryV2PagingMethodOneOf;\n type eventsV3EventWixEventsV2_universal_d_CommonSorting = CommonSorting;\n type eventsV3EventWixEventsV2_universal_d_CommonSortOrder = CommonSortOrder;\n const eventsV3EventWixEventsV2_universal_d_CommonSortOrder: typeof CommonSortOrder;\n type eventsV3EventWixEventsV2_universal_d_CommonPaging = CommonPaging;\n type eventsV3EventWixEventsV2_universal_d_BulkCancelEventsByFilterResponse = BulkCancelEventsByFilterResponse;\n type eventsV3EventWixEventsV2_universal_d_DeleteEventRequest = DeleteEventRequest;\n type eventsV3EventWixEventsV2_universal_d_DeleteEventResponse = DeleteEventResponse;\n type eventsV3EventWixEventsV2_universal_d_BulkDeleteEventsByFilterRequest = BulkDeleteEventsByFilterRequest;\n type eventsV3EventWixEventsV2_universal_d_BulkDeleteEventsByFilterResponse = BulkDeleteEventsByFilterResponse;\n type eventsV3EventWixEventsV2_universal_d_QueryEventsRequest = QueryEventsRequest;\n type eventsV3EventWixEventsV2_universal_d_QueryEventsResponse = QueryEventsResponse;\n type eventsV3EventWixEventsV2_universal_d_CommonPagingMetadataV2 = CommonPagingMetadataV2;\n type eventsV3EventWixEventsV2_universal_d_CommonCursors = CommonCursors;\n type eventsV3EventWixEventsV2_universal_d_ExportEventsRequest = ExportEventsRequest;\n type eventsV3EventWixEventsV2_universal_d_QueryV2 = QueryV2;\n type eventsV3EventWixEventsV2_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type eventsV3EventWixEventsV2_universal_d_Sorting = Sorting;\n type eventsV3EventWixEventsV2_universal_d_SortOrder = SortOrder;\n const eventsV3EventWixEventsV2_universal_d_SortOrder: typeof SortOrder;\n type eventsV3EventWixEventsV2_universal_d_Paging = Paging;\n type eventsV3EventWixEventsV2_universal_d_CursorPaging = CursorPaging;\n type eventsV3EventWixEventsV2_universal_d_ExportEventsResponse = ExportEventsResponse;\n type eventsV3EventWixEventsV2_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type eventsV3EventWixEventsV2_universal_d_Cursors = Cursors;\n type eventsV3EventWixEventsV2_universal_d_CountEventsByStatusRequest = CountEventsByStatusRequest;\n type eventsV3EventWixEventsV2_universal_d_CountEventsByStatusResponse = CountEventsByStatusResponse;\n type eventsV3EventWixEventsV2_universal_d_FacetCounts = FacetCounts;\n type eventsV3EventWixEventsV2_universal_d_ListUserEventsRequest = ListUserEventsRequest;\n type eventsV3EventWixEventsV2_universal_d_UserFilter = UserFilter;\n type eventsV3EventWixEventsV2_universal_d_Relation = Relation;\n const eventsV3EventWixEventsV2_universal_d_Relation: typeof Relation;\n type eventsV3EventWixEventsV2_universal_d_ListUserEventsResponse = ListUserEventsResponse;\n type eventsV3EventWixEventsV2_universal_d_ListEventsByCategoryRequest = ListEventsByCategoryRequest;\n type eventsV3EventWixEventsV2_universal_d_ListEventsByCategoryResponse = ListEventsByCategoryResponse;\n type eventsV3EventWixEventsV2_universal_d_GetEventRequest = GetEventRequest;\n type eventsV3EventWixEventsV2_universal_d_GetEventResponse = GetEventResponse;\n type eventsV3EventWixEventsV2_universal_d_GetEventBySlugRequest = GetEventBySlugRequest;\n type eventsV3EventWixEventsV2_universal_d_GetEventBySlugResponse = GetEventBySlugResponse;\n type eventsV3EventWixEventsV2_universal_d_FindEventRequest = FindEventRequest;\n type eventsV3EventWixEventsV2_universal_d_FindEventRequestFindByOneOf = FindEventRequestFindByOneOf;\n type eventsV3EventWixEventsV2_universal_d_FindEventResponse = FindEventResponse;\n type eventsV3EventWixEventsV2_universal_d_EventCreated = EventCreated;\n type eventsV3EventWixEventsV2_universal_d_EventsLocation = EventsLocation;\n type eventsV3EventWixEventsV2_universal_d_MapCoordinates = MapCoordinates;\n type eventsV3EventWixEventsV2_universal_d_LocationLocationType = LocationLocationType;\n const eventsV3EventWixEventsV2_universal_d_LocationLocationType: typeof LocationLocationType;\n type eventsV3EventWixEventsV2_universal_d_Address = Address;\n type eventsV3EventWixEventsV2_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type eventsV3EventWixEventsV2_universal_d_StreetAddress = StreetAddress;\n type eventsV3EventWixEventsV2_universal_d_AddressLocation = AddressLocation;\n type eventsV3EventWixEventsV2_universal_d_Subdivision = Subdivision;\n type eventsV3EventWixEventsV2_universal_d_SubdivisionType = SubdivisionType;\n const eventsV3EventWixEventsV2_universal_d_SubdivisionType: typeof SubdivisionType;\n type eventsV3EventWixEventsV2_universal_d_ScheduleConfig = ScheduleConfig;\n type eventsV3EventWixEventsV2_universal_d_EventsRecurrences = EventsRecurrences;\n type eventsV3EventWixEventsV2_universal_d_EventsOccurrence = EventsOccurrence;\n type eventsV3EventWixEventsV2_universal_d_EventsRecurrenceStatusStatus = EventsRecurrenceStatusStatus;\n const eventsV3EventWixEventsV2_universal_d_EventsRecurrenceStatusStatus: typeof EventsRecurrenceStatusStatus;\n type eventsV3EventWixEventsV2_universal_d_EventStatus = EventStatus;\n const eventsV3EventWixEventsV2_universal_d_EventStatus: typeof EventStatus;\n type eventsV3EventWixEventsV2_universal_d_Event = Event;\n type eventsV3EventWixEventsV2_universal_d_Scheduling = Scheduling;\n type eventsV3EventWixEventsV2_universal_d_EventsRegistration = EventsRegistration;\n type eventsV3EventWixEventsV2_universal_d_EventType = EventType;\n const eventsV3EventWixEventsV2_universal_d_EventType: typeof EventType;\n type eventsV3EventWixEventsV2_universal_d_RegistrationStatus = RegistrationStatus;\n const eventsV3EventWixEventsV2_universal_d_RegistrationStatus: typeof RegistrationStatus;\n type eventsV3EventWixEventsV2_universal_d_RsvpCollection = RsvpCollection;\n type eventsV3EventWixEventsV2_universal_d_RsvpCollectionConfig = RsvpCollectionConfig;\n type eventsV3EventWixEventsV2_universal_d_RsvpStatusOptions = RsvpStatusOptions;\n const eventsV3EventWixEventsV2_universal_d_RsvpStatusOptions: typeof RsvpStatusOptions;\n type eventsV3EventWixEventsV2_universal_d_Ticketing = Ticketing;\n type eventsV3EventWixEventsV2_universal_d_TicketingConfig = TicketingConfig;\n type eventsV3EventWixEventsV2_universal_d_TaxConfig = TaxConfig;\n type eventsV3EventWixEventsV2_universal_d_EventsTaxType = EventsTaxType;\n const eventsV3EventWixEventsV2_universal_d_EventsTaxType: typeof EventsTaxType;\n type eventsV3EventWixEventsV2_universal_d_ExternalEvent = ExternalEvent;\n type eventsV3EventWixEventsV2_universal_d_VisitorType = VisitorType;\n const eventsV3EventWixEventsV2_universal_d_VisitorType: typeof VisitorType;\n type eventsV3EventWixEventsV2_universal_d_CalendarLinks = CalendarLinks;\n type eventsV3EventWixEventsV2_universal_d_SiteUrl = SiteUrl;\n type eventsV3EventWixEventsV2_universal_d_Dashboard = Dashboard;\n type eventsV3EventWixEventsV2_universal_d_RsvpSummary = RsvpSummary;\n type eventsV3EventWixEventsV2_universal_d_TicketingSummary = TicketingSummary;\n type eventsV3EventWixEventsV2_universal_d_GuestListConfig = GuestListConfig;\n type eventsV3EventWixEventsV2_universal_d_EventsFeed = EventsFeed;\n type eventsV3EventWixEventsV2_universal_d_EventsOnlineConferencing = EventsOnlineConferencing;\n type eventsV3EventWixEventsV2_universal_d_OnlineConferencingConfig = OnlineConferencingConfig;\n type eventsV3EventWixEventsV2_universal_d_ConferenceType = ConferenceType;\n const eventsV3EventWixEventsV2_universal_d_ConferenceType: typeof ConferenceType;\n type eventsV3EventWixEventsV2_universal_d_EventsOnlineConferencingSession = EventsOnlineConferencingSession;\n type eventsV3EventWixEventsV2_universal_d_EventsSeoSettings = EventsSeoSettings;\n type eventsV3EventWixEventsV2_universal_d_Agenda = Agenda;\n type eventsV3EventWixEventsV2_universal_d_Category = Category;\n type eventsV3EventWixEventsV2_universal_d_CategoryCounts = CategoryCounts;\n type eventsV3EventWixEventsV2_universal_d_State = State;\n const eventsV3EventWixEventsV2_universal_d_State: typeof State;\n type eventsV3EventWixEventsV2_universal_d_EventDisplaySettings = EventDisplaySettings;\n type eventsV3EventWixEventsV2_universal_d_EventsLabellingSettings = EventsLabellingSettings;\n type eventsV3EventWixEventsV2_universal_d_Empty = Empty;\n type eventsV3EventWixEventsV2_universal_d_EventUpdated = EventUpdated;\n type eventsV3EventWixEventsV2_universal_d_EventDeleted = EventDeleted;\n type eventsV3EventWixEventsV2_universal_d_EventCopied = EventCopied;\n type eventsV3EventWixEventsV2_universal_d_EventPublished = EventPublished;\n type eventsV3EventWixEventsV2_universal_d_EventCanceled = EventCanceled;\n type eventsV3EventWixEventsV2_universal_d_EventStarted = EventStarted;\n type eventsV3EventWixEventsV2_universal_d_EventEnded = EventEnded;\n type eventsV3EventWixEventsV2_universal_d_EventReminder = EventReminder;\n type eventsV3EventWixEventsV2_universal_d_DomainEvent = DomainEvent;\n type eventsV3EventWixEventsV2_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type eventsV3EventWixEventsV2_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type eventsV3EventWixEventsV2_universal_d_RestoreInfo = RestoreInfo;\n type eventsV3EventWixEventsV2_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type eventsV3EventWixEventsV2_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type eventsV3EventWixEventsV2_universal_d_ActionEvent = ActionEvent;\n type eventsV3EventWixEventsV2_universal_d_MessageEnvelope = MessageEnvelope;\n type eventsV3EventWixEventsV2_universal_d_IdentificationData = IdentificationData;\n type eventsV3EventWixEventsV2_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type eventsV3EventWixEventsV2_universal_d_WebhookIdentityType = WebhookIdentityType;\n const eventsV3EventWixEventsV2_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const eventsV3EventWixEventsV2_universal_d_createEvent: typeof createEvent;\n type eventsV3EventWixEventsV2_universal_d_CreateEventOptions = CreateEventOptions;\n const eventsV3EventWixEventsV2_universal_d_cloneEvent: typeof cloneEvent;\n type eventsV3EventWixEventsV2_universal_d_CloneEventOptions = CloneEventOptions;\n const eventsV3EventWixEventsV2_universal_d_updateEvent: typeof updateEvent;\n type eventsV3EventWixEventsV2_universal_d_UpdateEventOptions = UpdateEventOptions;\n const eventsV3EventWixEventsV2_universal_d_publishDraftEvent: typeof publishDraftEvent;\n type eventsV3EventWixEventsV2_universal_d_PublishDraftEventOptions = PublishDraftEventOptions;\n const eventsV3EventWixEventsV2_universal_d_cancelEvent: typeof cancelEvent;\n type eventsV3EventWixEventsV2_universal_d_CancelEventOptions = CancelEventOptions;\n const eventsV3EventWixEventsV2_universal_d_bulkCancelEventsByFilter: typeof bulkCancelEventsByFilter;\n type eventsV3EventWixEventsV2_universal_d_BulkCancelEventsByFilterOptions = BulkCancelEventsByFilterOptions;\n const eventsV3EventWixEventsV2_universal_d_deleteEvent: typeof deleteEvent;\n const eventsV3EventWixEventsV2_universal_d_bulkDeleteEventsByFilter: typeof bulkDeleteEventsByFilter;\n type eventsV3EventWixEventsV2_universal_d_BulkDeleteEventsByFilterOptions = BulkDeleteEventsByFilterOptions;\n const eventsV3EventWixEventsV2_universal_d_queryEvents: typeof queryEvents;\n type eventsV3EventWixEventsV2_universal_d_QueryEventsOptions = QueryEventsOptions;\n type eventsV3EventWixEventsV2_universal_d_EventsQueryResult = EventsQueryResult;\n type eventsV3EventWixEventsV2_universal_d_EventsQueryBuilder = EventsQueryBuilder;\n const eventsV3EventWixEventsV2_universal_d_countEventsByStatus: typeof countEventsByStatus;\n type eventsV3EventWixEventsV2_universal_d_CountEventsByStatusOptions = CountEventsByStatusOptions;\n type eventsV3EventWixEventsV2_universal_d_ListEventsByCategoryOptions = ListEventsByCategoryOptions;\n const eventsV3EventWixEventsV2_universal_d_getEvent: typeof getEvent;\n type eventsV3EventWixEventsV2_universal_d_GetEventOptions = GetEventOptions;\n const eventsV3EventWixEventsV2_universal_d_getEventBySlug: typeof getEventBySlug;\n type eventsV3EventWixEventsV2_universal_d_GetEventBySlugOptions = GetEventBySlugOptions;\n type eventsV3EventWixEventsV2_universal_d_FindEventOptions = FindEventOptions;\n namespace eventsV3EventWixEventsV2_universal_d {\n export { eventsV3EventWixEventsV2_universal_d_V3Event as V3Event, eventsV3EventWixEventsV2_universal_d_Location as Location, eventsV3EventWixEventsV2_universal_d_LocationType as LocationType, eventsV3EventWixEventsV2_universal_d_CommonAddress as CommonAddress, eventsV3EventWixEventsV2_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf, eventsV3EventWixEventsV2_universal_d_CommonStreetAddress as CommonStreetAddress, eventsV3EventWixEventsV2_universal_d_CommonAddressLocation as CommonAddressLocation, eventsV3EventWixEventsV2_universal_d_CommonSubdivision as CommonSubdivision, eventsV3EventWixEventsV2_universal_d_SubdivisionSubdivisionType as SubdivisionSubdivisionType, eventsV3EventWixEventsV2_universal_d_DateAndTimeSettings as DateAndTimeSettings, eventsV3EventWixEventsV2_universal_d_RecurrenceStatusStatus as RecurrenceStatusStatus, eventsV3EventWixEventsV2_universal_d_Recurrences as Recurrences, eventsV3EventWixEventsV2_universal_d_Occurrence as Occurrence, eventsV3EventWixEventsV2_universal_d_Formatted as Formatted, eventsV3EventWixEventsV2_universal_d_TimeDuration as TimeDuration, eventsV3EventWixEventsV2_universal_d_Status as Status, eventsV3EventWixEventsV2_universal_d_Registration as Registration, eventsV3EventWixEventsV2_universal_d_RegistrationTypeType as RegistrationTypeType, eventsV3EventWixEventsV2_universal_d_RegistrationStatusStatus as RegistrationStatusStatus, eventsV3EventWixEventsV2_universal_d_RsvpRegistration as RsvpRegistration, eventsV3EventWixEventsV2_universal_d_ResponseType as ResponseType, eventsV3EventWixEventsV2_universal_d_TicketsRegistration as TicketsRegistration, eventsV3EventWixEventsV2_universal_d_Money as Money, eventsV3EventWixEventsV2_universal_d_TaxSettings as TaxSettings, eventsV3EventWixEventsV2_universal_d_TaxType as TaxType, eventsV3EventWixEventsV2_universal_d_ExternalRegistration as ExternalRegistration, eventsV3EventWixEventsV2_universal_d_GuestTypeType as GuestTypeType, eventsV3EventWixEventsV2_universal_d_InitialRegistrationTypeType as InitialRegistrationTypeType, eventsV3EventWixEventsV2_universal_d_CalendarUrls as CalendarUrls, eventsV3EventWixEventsV2_universal_d_Form as Form, eventsV3EventWixEventsV2_universal_d_InputControl as InputControl, eventsV3EventWixEventsV2_universal_d_InputControlType as InputControlType, eventsV3EventWixEventsV2_universal_d_Input as Input, eventsV3EventWixEventsV2_universal_d_ValueType as ValueType, eventsV3EventWixEventsV2_universal_d_OptionSelection as OptionSelection, eventsV3EventWixEventsV2_universal_d_OptionSelectionSelectedOptionOneOf as OptionSelectionSelectedOptionOneOf, eventsV3EventWixEventsV2_universal_d_Label as Label, eventsV3EventWixEventsV2_universal_d_FormMessages as FormMessages, eventsV3EventWixEventsV2_universal_d_RsvpFormMessages as RsvpFormMessages, eventsV3EventWixEventsV2_universal_d_PositiveResponseConfirmation as PositiveResponseConfirmation, eventsV3EventWixEventsV2_universal_d_NegativeResponseConfirmation as NegativeResponseConfirmation, eventsV3EventWixEventsV2_universal_d_Positive as Positive, eventsV3EventWixEventsV2_universal_d_Negative as Negative, eventsV3EventWixEventsV2_universal_d_CheckoutFormMessages as CheckoutFormMessages, eventsV3EventWixEventsV2_universal_d_ResponseConfirmation as ResponseConfirmation, eventsV3EventWixEventsV2_universal_d_RegistrationClosedMessages as RegistrationClosedMessages, eventsV3EventWixEventsV2_universal_d_TicketsUnavailableMessages as TicketsUnavailableMessages, eventsV3EventWixEventsV2_universal_d_Summaries as Summaries, eventsV3EventWixEventsV2_universal_d_EventsMoney as EventsMoney, eventsV3EventWixEventsV2_universal_d_Rsvps as Rsvps, eventsV3EventWixEventsV2_universal_d_Tickets as Tickets, eventsV3EventWixEventsV2_universal_d_GuestListSettings as GuestListSettings, eventsV3EventWixEventsV2_universal_d_Feed as Feed, eventsV3EventWixEventsV2_universal_d_OnlineConferencing as OnlineConferencing, eventsV3EventWixEventsV2_universal_d_ConferenceTypeType as ConferenceTypeType, eventsV3EventWixEventsV2_universal_d_OnlineConferencingSession as OnlineConferencingSession, eventsV3EventWixEventsV2_universal_d_SeoSettings as SeoSettings, eventsV3EventWixEventsV2_universal_d_SeoSchema as SeoSchema, eventsV3EventWixEventsV2_universal_d_Keyword as Keyword, eventsV3EventWixEventsV2_universal_d_Tag as Tag, eventsV3EventWixEventsV2_universal_d_Settings as Settings, eventsV3EventWixEventsV2_universal_d_AgendaSettings as AgendaSettings, eventsV3EventWixEventsV2_universal_d_EventCategories as EventCategories, eventsV3EventWixEventsV2_universal_d_EventCategory as EventCategory, eventsV3EventWixEventsV2_universal_d_Type as Type, eventsV3EventWixEventsV2_universal_d_V3EventDisplaySettings as V3EventDisplaySettings, eventsV3EventWixEventsV2_universal_d_LabellingSettings as LabellingSettings, eventsV3EventWixEventsV2_universal_d_EventEventStarted as EventEventStarted, eventsV3EventWixEventsV2_universal_d_EventEventEnded as EventEventEnded, eventsV3EventWixEventsV2_universal_d_EventEventReminder as EventEventReminder, eventsV3EventWixEventsV2_universal_d_EventEventPublished as EventEventPublished, eventsV3EventWixEventsV2_universal_d_EventCloned as EventCloned, eventsV3EventWixEventsV2_universal_d_EventEventCanceled as EventEventCanceled, eventsV3EventWixEventsV2_universal_d_CreateEventRequest as CreateEventRequest, eventsV3EventWixEventsV2_universal_d_RequestedFields as RequestedFields, eventsV3EventWixEventsV2_universal_d_CreateEventResponse as CreateEventResponse, eventsV3EventWixEventsV2_universal_d_CloneEventRequest as CloneEventRequest, eventsV3EventWixEventsV2_universal_d_CloneEventResponse as CloneEventResponse, eventsV3EventWixEventsV2_universal_d_UpdateEventRequest as UpdateEventRequest, eventsV3EventWixEventsV2_universal_d_UpdateEventResponse as UpdateEventResponse, eventsV3EventWixEventsV2_universal_d_PublishDraftEventRequest as PublishDraftEventRequest, eventsV3EventWixEventsV2_universal_d_PublishDraftEventResponse as PublishDraftEventResponse, eventsV3EventWixEventsV2_universal_d_CancelEventRequest as CancelEventRequest, eventsV3EventWixEventsV2_universal_d_CancelEventResponse as CancelEventResponse, eventsV3EventWixEventsV2_universal_d_BulkCancelEventsByFilterRequest as BulkCancelEventsByFilterRequest, eventsV3EventWixEventsV2_universal_d_CommonQueryV2 as CommonQueryV2, eventsV3EventWixEventsV2_universal_d_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf, eventsV3EventWixEventsV2_universal_d_CommonSorting as CommonSorting, eventsV3EventWixEventsV2_universal_d_CommonSortOrder as CommonSortOrder, eventsV3EventWixEventsV2_universal_d_CommonPaging as CommonPaging, eventsV3EventWixEventsV2_universal_d_BulkCancelEventsByFilterResponse as BulkCancelEventsByFilterResponse, eventsV3EventWixEventsV2_universal_d_DeleteEventRequest as DeleteEventRequest, eventsV3EventWixEventsV2_universal_d_DeleteEventResponse as DeleteEventResponse, eventsV3EventWixEventsV2_universal_d_BulkDeleteEventsByFilterRequest as BulkDeleteEventsByFilterRequest, eventsV3EventWixEventsV2_universal_d_BulkDeleteEventsByFilterResponse as BulkDeleteEventsByFilterResponse, eventsV3EventWixEventsV2_universal_d_QueryEventsRequest as QueryEventsRequest, eventsV3EventWixEventsV2_universal_d_QueryEventsResponse as QueryEventsResponse, eventsV3EventWixEventsV2_universal_d_CommonPagingMetadataV2 as CommonPagingMetadataV2, eventsV3EventWixEventsV2_universal_d_CommonCursors as CommonCursors, eventsV3EventWixEventsV2_universal_d_ExportEventsRequest as ExportEventsRequest, eventsV3EventWixEventsV2_universal_d_QueryV2 as QueryV2, eventsV3EventWixEventsV2_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, eventsV3EventWixEventsV2_universal_d_Sorting as Sorting, eventsV3EventWixEventsV2_universal_d_SortOrder as SortOrder, eventsV3EventWixEventsV2_universal_d_Paging as Paging, eventsV3EventWixEventsV2_universal_d_CursorPaging as CursorPaging, eventsV3EventWixEventsV2_universal_d_ExportEventsResponse as ExportEventsResponse, eventsV3EventWixEventsV2_universal_d_PagingMetadataV2 as PagingMetadataV2, eventsV3EventWixEventsV2_universal_d_Cursors as Cursors, eventsV3EventWixEventsV2_universal_d_CountEventsByStatusRequest as CountEventsByStatusRequest, eventsV3EventWixEventsV2_universal_d_CountEventsByStatusResponse as CountEventsByStatusResponse, eventsV3EventWixEventsV2_universal_d_FacetCounts as FacetCounts, eventsV3EventWixEventsV2_universal_d_ListUserEventsRequest as ListUserEventsRequest, eventsV3EventWixEventsV2_universal_d_UserFilter as UserFilter, eventsV3EventWixEventsV2_universal_d_Relation as Relation, eventsV3EventWixEventsV2_universal_d_ListUserEventsResponse as ListUserEventsResponse, eventsV3EventWixEventsV2_universal_d_ListEventsByCategoryRequest as ListEventsByCategoryRequest, eventsV3EventWixEventsV2_universal_d_ListEventsByCategoryResponse as ListEventsByCategoryResponse, eventsV3EventWixEventsV2_universal_d_GetEventRequest as GetEventRequest, eventsV3EventWixEventsV2_universal_d_GetEventResponse as GetEventResponse, eventsV3EventWixEventsV2_universal_d_GetEventBySlugRequest as GetEventBySlugRequest, eventsV3EventWixEventsV2_universal_d_GetEventBySlugResponse as GetEventBySlugResponse, eventsV3EventWixEventsV2_universal_d_FindEventRequest as FindEventRequest, eventsV3EventWixEventsV2_universal_d_FindEventRequestFindByOneOf as FindEventRequestFindByOneOf, eventsV3EventWixEventsV2_universal_d_FindEventResponse as FindEventResponse, eventsV3EventWixEventsV2_universal_d_EventCreated as EventCreated, eventsV3EventWixEventsV2_universal_d_EventsLocation as EventsLocation, eventsV3EventWixEventsV2_universal_d_MapCoordinates as MapCoordinates, eventsV3EventWixEventsV2_universal_d_LocationLocationType as LocationLocationType, eventsV3EventWixEventsV2_universal_d_Address as Address, eventsV3EventWixEventsV2_universal_d_AddressStreetOneOf as AddressStreetOneOf, eventsV3EventWixEventsV2_universal_d_StreetAddress as StreetAddress, eventsV3EventWixEventsV2_universal_d_AddressLocation as AddressLocation, eventsV3EventWixEventsV2_universal_d_Subdivision as Subdivision, eventsV3EventWixEventsV2_universal_d_SubdivisionType as SubdivisionType, eventsV3EventWixEventsV2_universal_d_ScheduleConfig as ScheduleConfig, eventsV3EventWixEventsV2_universal_d_EventsRecurrences as EventsRecurrences, eventsV3EventWixEventsV2_universal_d_EventsOccurrence as EventsOccurrence, eventsV3EventWixEventsV2_universal_d_EventsRecurrenceStatusStatus as EventsRecurrenceStatusStatus, eventsV3EventWixEventsV2_universal_d_EventStatus as EventStatus, eventsV3EventWixEventsV2_universal_d_Event as Event, eventsV3EventWixEventsV2_universal_d_Scheduling as Scheduling, eventsV3EventWixEventsV2_universal_d_EventsRegistration as EventsRegistration, eventsV3EventWixEventsV2_universal_d_EventType as EventType, eventsV3EventWixEventsV2_universal_d_RegistrationStatus as RegistrationStatus, eventsV3EventWixEventsV2_universal_d_RsvpCollection as RsvpCollection, eventsV3EventWixEventsV2_universal_d_RsvpCollectionConfig as RsvpCollectionConfig, eventsV3EventWixEventsV2_universal_d_RsvpStatusOptions as RsvpStatusOptions, eventsV3EventWixEventsV2_universal_d_Ticketing as Ticketing, eventsV3EventWixEventsV2_universal_d_TicketingConfig as TicketingConfig, eventsV3EventWixEventsV2_universal_d_TaxConfig as TaxConfig, eventsV3EventWixEventsV2_universal_d_EventsTaxType as EventsTaxType, eventsV3EventWixEventsV2_universal_d_ExternalEvent as ExternalEvent, eventsV3EventWixEventsV2_universal_d_VisitorType as VisitorType, eventsV3EventWixEventsV2_universal_d_CalendarLinks as CalendarLinks, eventsV3EventWixEventsV2_universal_d_SiteUrl as SiteUrl, eventsV3EventWixEventsV2_universal_d_Dashboard as Dashboard, eventsV3EventWixEventsV2_universal_d_RsvpSummary as RsvpSummary, eventsV3EventWixEventsV2_universal_d_TicketingSummary as TicketingSummary, eventsV3EventWixEventsV2_universal_d_GuestListConfig as GuestListConfig, eventsV3EventWixEventsV2_universal_d_EventsFeed as EventsFeed, eventsV3EventWixEventsV2_universal_d_EventsOnlineConferencing as EventsOnlineConferencing, eventsV3EventWixEventsV2_universal_d_OnlineConferencingConfig as OnlineConferencingConfig, eventsV3EventWixEventsV2_universal_d_ConferenceType as ConferenceType, eventsV3EventWixEventsV2_universal_d_EventsOnlineConferencingSession as EventsOnlineConferencingSession, eventsV3EventWixEventsV2_universal_d_EventsSeoSettings as EventsSeoSettings, eventsV3EventWixEventsV2_universal_d_Agenda as Agenda, eventsV3EventWixEventsV2_universal_d_Category as Category, eventsV3EventWixEventsV2_universal_d_CategoryCounts as CategoryCounts, eventsV3EventWixEventsV2_universal_d_State as State, eventsV3EventWixEventsV2_universal_d_EventDisplaySettings as EventDisplaySettings, eventsV3EventWixEventsV2_universal_d_EventsLabellingSettings as EventsLabellingSettings, eventsV3EventWixEventsV2_universal_d_Empty as Empty, eventsV3EventWixEventsV2_universal_d_EventUpdated as EventUpdated, eventsV3EventWixEventsV2_universal_d_EventDeleted as EventDeleted, eventsV3EventWixEventsV2_universal_d_EventCopied as EventCopied, eventsV3EventWixEventsV2_universal_d_EventPublished as EventPublished, eventsV3EventWixEventsV2_universal_d_EventCanceled as EventCanceled, eventsV3EventWixEventsV2_universal_d_EventStarted as EventStarted, eventsV3EventWixEventsV2_universal_d_EventEnded as EventEnded, eventsV3EventWixEventsV2_universal_d_EventReminder as EventReminder, eventsV3EventWixEventsV2_universal_d_DomainEvent as DomainEvent, eventsV3EventWixEventsV2_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, eventsV3EventWixEventsV2_universal_d_EntityCreatedEvent as EntityCreatedEvent, eventsV3EventWixEventsV2_universal_d_RestoreInfo as RestoreInfo, eventsV3EventWixEventsV2_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, eventsV3EventWixEventsV2_universal_d_EntityDeletedEvent as EntityDeletedEvent, eventsV3EventWixEventsV2_universal_d_ActionEvent as ActionEvent, eventsV3EventWixEventsV2_universal_d_MessageEnvelope as MessageEnvelope, eventsV3EventWixEventsV2_universal_d_IdentificationData as IdentificationData, eventsV3EventWixEventsV2_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, eventsV3EventWixEventsV2_universal_d_WebhookIdentityType as WebhookIdentityType, eventsV3EventWixEventsV2_universal_d_createEvent as createEvent, eventsV3EventWixEventsV2_universal_d_CreateEventOptions as CreateEventOptions, eventsV3EventWixEventsV2_universal_d_cloneEvent as cloneEvent, eventsV3EventWixEventsV2_universal_d_CloneEventOptions as CloneEventOptions, eventsV3EventWixEventsV2_universal_d_updateEvent as updateEvent, eventsV3EventWixEventsV2_universal_d_UpdateEventOptions as UpdateEventOptions, eventsV3EventWixEventsV2_universal_d_publishDraftEvent as publishDraftEvent, eventsV3EventWixEventsV2_universal_d_PublishDraftEventOptions as PublishDraftEventOptions, eventsV3EventWixEventsV2_universal_d_cancelEvent as cancelEvent, eventsV3EventWixEventsV2_universal_d_CancelEventOptions as CancelEventOptions, eventsV3EventWixEventsV2_universal_d_bulkCancelEventsByFilter as bulkCancelEventsByFilter, eventsV3EventWixEventsV2_universal_d_BulkCancelEventsByFilterOptions as BulkCancelEventsByFilterOptions, eventsV3EventWixEventsV2_universal_d_deleteEvent as deleteEvent, eventsV3EventWixEventsV2_universal_d_bulkDeleteEventsByFilter as bulkDeleteEventsByFilter, eventsV3EventWixEventsV2_universal_d_BulkDeleteEventsByFilterOptions as BulkDeleteEventsByFilterOptions, eventsV3EventWixEventsV2_universal_d_queryEvents as queryEvents, eventsV3EventWixEventsV2_universal_d_QueryEventsOptions as QueryEventsOptions, eventsV3EventWixEventsV2_universal_d_EventsQueryResult as EventsQueryResult, eventsV3EventWixEventsV2_universal_d_EventsQueryBuilder as EventsQueryBuilder, eventsV3EventWixEventsV2_universal_d_countEventsByStatus as countEventsByStatus, eventsV3EventWixEventsV2_universal_d_CountEventsByStatusOptions as CountEventsByStatusOptions, eventsV3EventWixEventsV2_universal_d_ListEventsByCategoryOptions as ListEventsByCategoryOptions, eventsV3EventWixEventsV2_universal_d_getEvent as getEvent, eventsV3EventWixEventsV2_universal_d_GetEventOptions as GetEventOptions, eventsV3EventWixEventsV2_universal_d_getEventBySlug as getEventBySlug, eventsV3EventWixEventsV2_universal_d_GetEventBySlugOptions as GetEventBySlugOptions, eventsV3EventWixEventsV2_universal_d_FindEventOptions as FindEventOptions, };\n }\n export { eventsV1CategoryCategories_universal_d as categories, eventsV1FormForms_universal_d as forms, eventsGuestsV1GuestGuests_universal_d as guests, eventsV1OrderOrders_universal_d as orders, eventsV2PolicyPolicies_universal_d as policies, eventsV1RsvpRsvp_universal_d as rsvp, eventsScheduleV1ScheduleItemSchedule_universal_d as schedule, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d as scheduleBookmarks, eventsV1TicketDefinitionTicketDefinitions_universal_d as ticketDefinitions, eventsV3TicketDefinitionTicketDefinitionsV2_universal_d as ticketDefinitionsV2, eventsV1TicketTickets_universal_d as tickets, eventsV3EventWixEventsV2_universal_d as wixEventsV2 };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-inbox.v2.d.ts", "content": "declare module \"wix-inbox.v2\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Conversation {\n /**\n * Conversation ID.\n * @readonly\n */\n _id?: string;\n /**\n * ID of the visitor, contact, or member who is chatting with the business.\n * @readonly\n */\n participant?: IdentificationData$1;\n /**\n * List of communication channels where the visitor, contact, or member can receive messages.\n * @readonly\n */\n channels?: ChannelType$1[];\n /** Display name and avatar for the business. */\n businessDisplayData?: ConversationDisplayData;\n /** Display name and avatar for the visitor, contact, or member. */\n participantDisplayData?: ConversationDisplayData;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of an anonymous site visitor. */\n anonymousVisitorId?: string;\n /**\n * ID of a site\n * [member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members).\n */\n memberId?: string;\n /**\n * ID of a site\n * [contact](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n * @readonly\n */\n contactId?: string | null;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of an anonymous site visitor. */\n anonymousVisitorId?: string;\n /**\n * ID of a site\n * [member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members).\n */\n memberId?: string;\n }\n enum ChannelType$1 {\n UNKNOWN_CHANNEL_TYPE = \"UNKNOWN_CHANNEL_TYPE\",\n CHAT = \"CHAT\",\n EMAIL = \"EMAIL\",\n SMS = \"SMS\",\n FACEBOOK = \"FACEBOOK\",\n INSTAGRAM = \"INSTAGRAM\",\n WHATSAPP = \"WHATSAPP\"\n }\n interface ConversationDisplayData {\n /**\n * Display name.\n * @readonly\n */\n name?: string;\n /**\n * Avatar image URL.\n * @readonly\n */\n imageUrl?: string | null;\n }\n interface ConversationsMerged {\n /** List of old conversation IDs. */\n oldConversationIds?: string[];\n /** New conversation ID. */\n targetConversationId?: string;\n }\n interface GetConversationRequest {\n /** Conversation ID. */\n conversationId: string;\n }\n interface GetConversationResponse {\n /** Retrieved conversation. */\n conversation?: Conversation;\n }\n interface GetOrCreateConversationRequest {\n /**\n * ID of the visitor, contact, or member chatting with the business.\n *\n * Required for 3rd-party apps.\n */\n participantId?: ParticipantId;\n }\n interface ParticipantId extends ParticipantIdIdOneOf {\n /**\n * ID of a site\n * [contact](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n */\n contactId?: string;\n /** ID of an anonymous site visitor. */\n anonymousVisitorId?: string;\n /**\n * ID of a site\n * [member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members).\n */\n memberId?: string;\n }\n /** @oneof */\n interface ParticipantIdIdOneOf {\n /**\n * ID of a site\n * [contact](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n */\n contactId?: string;\n /** ID of an anonymous site visitor. */\n anonymousVisitorId?: string;\n /**\n * ID of a site\n * [member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members).\n */\n memberId?: string;\n }\n interface GetOrCreateConversationResponse {\n /** Created or retrieved conversation. */\n conversation?: Conversation;\n /**\n * Indicates whether the conversation was just created.\n *\n * If `true`, the conversation was just created.\n * If `false`, the conversation already existed.\n */\n newConversation?: boolean;\n }\n interface ListConversationsRequest {\n paging?: CursorPaging$1;\n /** only message time is supported for field name */\n sorting?: Sorting$1;\n }\n interface CursorPaging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface ListConversationsResponse {\n conversations?: Conversation[];\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface DeleteConversationRequest {\n conversationId: string;\n }\n interface DeleteConversationResponse {\n }\n interface AddConversationChannelsRequest {\n conversationId: string;\n conversationChannels?: ConversationChannel[];\n }\n interface ConversationChannel {\n channel?: ChannelType$1;\n /** TODO rename? - Shalom */\n recipients?: string[];\n }\n interface AddConversationChannelsResponse {\n }\n interface ChatroomsMerged {\n /** old chatroom ids */\n oldChatroomIds?: string[];\n /** new chatroom id */\n targetChatroomId?: string;\n }\n interface Empty$1 {\n }\n /**\n * Retrieves a conversation by conversation ID.\n *\n * If you don't have the conversation ID,\n * use [`getOrCreateConversation()`](#get-or-create-conversation)\n * to retrieve the conversation with the visitor, contact, or member ID.\n *\n *\n * This function is not a universal function and runs only on the backend.\n * @param conversationId - Conversation ID.\n * @public\n * @documentationMaturity preview\n * @requiredField conversationId\n * @adminMethod\n */\n function getConversation(conversationId: string): Promise;\n /**\n * Retrieves a conversation for the specified visitor, contact, or member ID,\n * or creates one if it doesn't exist.\n *\n * This function is not a universal function and runs only on the backend.\n * @param participantId - ID of the visitor, contact, or member chatting with the business.\n *\n * Required for 3rd-party apps.\n * @public\n * @documentationMaturity preview\n * @requiredField participantId\n * @adminMethod\n */\n function getOrCreateConversation(participantId: ParticipantId): Promise;\n interface ListConversationsOptions {\n paging?: CursorPaging$1;\n /** only message time is supported for field name */\n sorting?: Sorting$1;\n }\n interface AddConversationChannelsOptions {\n conversationChannels?: ConversationChannel[];\n }\n type crmInboxV2Conversation_universal_d_Conversation = Conversation;\n type crmInboxV2Conversation_universal_d_ConversationDisplayData = ConversationDisplayData;\n type crmInboxV2Conversation_universal_d_ConversationsMerged = ConversationsMerged;\n type crmInboxV2Conversation_universal_d_GetConversationRequest = GetConversationRequest;\n type crmInboxV2Conversation_universal_d_GetConversationResponse = GetConversationResponse;\n type crmInboxV2Conversation_universal_d_GetOrCreateConversationRequest = GetOrCreateConversationRequest;\n type crmInboxV2Conversation_universal_d_ParticipantId = ParticipantId;\n type crmInboxV2Conversation_universal_d_ParticipantIdIdOneOf = ParticipantIdIdOneOf;\n type crmInboxV2Conversation_universal_d_GetOrCreateConversationResponse = GetOrCreateConversationResponse;\n type crmInboxV2Conversation_universal_d_ListConversationsRequest = ListConversationsRequest;\n type crmInboxV2Conversation_universal_d_ListConversationsResponse = ListConversationsResponse;\n type crmInboxV2Conversation_universal_d_DeleteConversationRequest = DeleteConversationRequest;\n type crmInboxV2Conversation_universal_d_DeleteConversationResponse = DeleteConversationResponse;\n type crmInboxV2Conversation_universal_d_AddConversationChannelsRequest = AddConversationChannelsRequest;\n type crmInboxV2Conversation_universal_d_ConversationChannel = ConversationChannel;\n type crmInboxV2Conversation_universal_d_AddConversationChannelsResponse = AddConversationChannelsResponse;\n type crmInboxV2Conversation_universal_d_ChatroomsMerged = ChatroomsMerged;\n const crmInboxV2Conversation_universal_d_getConversation: typeof getConversation;\n const crmInboxV2Conversation_universal_d_getOrCreateConversation: typeof getOrCreateConversation;\n type crmInboxV2Conversation_universal_d_ListConversationsOptions = ListConversationsOptions;\n type crmInboxV2Conversation_universal_d_AddConversationChannelsOptions = AddConversationChannelsOptions;\n namespace crmInboxV2Conversation_universal_d {\n export { __debug$1 as __debug, crmInboxV2Conversation_universal_d_Conversation as Conversation, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, ChannelType$1 as ChannelType, crmInboxV2Conversation_universal_d_ConversationDisplayData as ConversationDisplayData, crmInboxV2Conversation_universal_d_ConversationsMerged as ConversationsMerged, crmInboxV2Conversation_universal_d_GetConversationRequest as GetConversationRequest, crmInboxV2Conversation_universal_d_GetConversationResponse as GetConversationResponse, crmInboxV2Conversation_universal_d_GetOrCreateConversationRequest as GetOrCreateConversationRequest, crmInboxV2Conversation_universal_d_ParticipantId as ParticipantId, crmInboxV2Conversation_universal_d_ParticipantIdIdOneOf as ParticipantIdIdOneOf, crmInboxV2Conversation_universal_d_GetOrCreateConversationResponse as GetOrCreateConversationResponse, crmInboxV2Conversation_universal_d_ListConversationsRequest as ListConversationsRequest, CursorPaging$1 as CursorPaging, Sorting$1 as Sorting, SortOrder$1 as SortOrder, crmInboxV2Conversation_universal_d_ListConversationsResponse as ListConversationsResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, crmInboxV2Conversation_universal_d_DeleteConversationRequest as DeleteConversationRequest, crmInboxV2Conversation_universal_d_DeleteConversationResponse as DeleteConversationResponse, crmInboxV2Conversation_universal_d_AddConversationChannelsRequest as AddConversationChannelsRequest, crmInboxV2Conversation_universal_d_ConversationChannel as ConversationChannel, crmInboxV2Conversation_universal_d_AddConversationChannelsResponse as AddConversationChannelsResponse, crmInboxV2Conversation_universal_d_ChatroomsMerged as ChatroomsMerged, Empty$1 as Empty, crmInboxV2Conversation_universal_d_getConversation as getConversation, crmInboxV2Conversation_universal_d_getOrCreateConversation as getOrCreateConversation, crmInboxV2Conversation_universal_d_ListConversationsOptions as ListConversationsOptions, crmInboxV2Conversation_universal_d_AddConversationChannelsOptions as AddConversationChannelsOptions, };\n }\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Message {\n /**\n * Message ID.\n * @readonly\n */\n _id?: string | null;\n /** Structured message content. */\n content?: MessageContent;\n /**\n * ID of the message sender.\n *\n * Defaults to the caller's ID\n * using the property that matches their identity type.\n * For 3rd-party apps, defaults to using the app's `appId`.\n *\n * You can override the default behavior when calling\n * [`sendMessage()`](#sendmessage)\n * by using the `sendAs` option.\n *\n * @readonly\n */\n sender?: IdentificationData;\n /**\n * Optional icon and short text\n * that give an additional detail about the message,\n * such as the app the message was sent from\n * or whether the message was an automated response.\n *\n * Currently only 1 badge is supported.\n */\n badges?: Badge[];\n /**\n * Communication channel to send the message to.\n *\n * Currently messages can be sent to 1 channel only.\n */\n targetChannels?: ChannelType[];\n /** Communication channel the message is sent from. */\n sourceChannel?: ChannelType;\n /**\n * ID of the application that sent the message.\n *\n * Omitted if the message was sent with the Chat widget.\n * @readonly\n */\n appId?: string | null;\n /**\n * __Required.__\n * Controls who can see the message.\n *\n * - `BUSINESS_AND_PARTICIPANT`: Visible to the participant and site contributors.\n * - `BUSINESS`: Visible to site contributors only.\n */\n visibility?: MessageVisibility;\n /**\n * Sequential ordering of the message.\n * Ensures more accurate sorting than `createdDate`\n * if two messages are sent at the same time.\n * @readonly\n */\n sequence?: string | null;\n /**\n * __Required.__\n * Message direction.\n *\n * - `BUSINESS_TO_PARTICIPANT`: The message was sent from the business to the participant.\n * - `PARTICIPANT_TO_BUSINESS`: The message was sent from the participant to the business.\n */\n direction?: MessageDirection;\n /** Date and time the message was sent. */\n _createdDate?: Date;\n }\n interface MessageContent extends MessageContentPayloadOneOf {\n /** Plain text, file, or image message. */\n basic?: BasicMessagePayload;\n /**\n * Template containing an image, title, text,\n * and/or up to 10 call-to-action buttons.\n */\n template?: TemplateMessagePayload;\n /**\n * Minimal message containing a single line of text\n * and an optional icon.\n * Often reports an activity that took place.\n */\n minimal?: MinimalMessagePayload;\n /**\n * Message containing submitted form data.\n * Typically sent with a `direction` of `PARTICIPANT_TO_BUSINESS`\n * and message `visibility` of `BUSINESS`.\n */\n form?: FormMessagePayload;\n /**\n * System message.\n * For internal use.\n */\n system?: SystemMessagePayload;\n /**\n * Summary of message contents.\n * Displayed in Inbox in the\n * [Message List](https://support.wix.com/en/article/wix-inbox-getting-started#view-your-messages).\n */\n previewText?: string | null;\n /** Message title. */\n title?: string | null;\n }\n /** @oneof */\n interface MessageContentPayloadOneOf {\n /** Plain text, file, or image message. */\n basic?: BasicMessagePayload;\n /**\n * Template containing an image, title, text,\n * and/or up to 10 call-to-action buttons.\n */\n template?: TemplateMessagePayload;\n /**\n * Minimal message containing a single line of text\n * and an optional icon.\n * Often reports an activity that took place.\n */\n minimal?: MinimalMessagePayload;\n /**\n * Message containing submitted form data.\n * Typically sent with a `direction` of `PARTICIPANT_TO_BUSINESS`\n * and message `visibility` of `BUSINESS`.\n */\n form?: FormMessagePayload;\n /**\n * System message.\n * For internal use.\n */\n system?: SystemMessagePayload;\n }\n interface BasicMessagePayload {\n /**\n * List of plain text messages, images, and/or files.\n * List items are displayed as separate messages\n * in Inbox and the site's chat widget.\n */\n items?: BasicMessageData[];\n }\n interface BasicMessageData extends BasicMessageDataDataOneOf {\n /** Text message. */\n text?: string;\n /**\n * Image message.\n * Can contain an image from Wix Media\n * or from an external provider.\n */\n image?: ImageMessage;\n /**\n * File attachment.\n * Can contain a file from Wix Media or an external provider.\n */\n file?: FileMessage;\n }\n /** @oneof */\n interface BasicMessageDataDataOneOf {\n /** Text message. */\n text?: string;\n /**\n * Image message.\n * Can contain an image from Wix Media\n * or from an external provider.\n */\n image?: ImageMessage;\n /**\n * File attachment.\n * Can contain a file from Wix Media or an external provider.\n */\n file?: FileMessage;\n }\n interface ImageMessage {\n /** Wix Media ID. */\n _id?: string | null;\n /** URL where the image is hosted. */\n url?: string;\n /** File name of the original file. */\n filename?: string | null;\n /** Original image width, in pixels. */\n width?: number;\n /** Original image height, in pixels. */\n height?: number;\n }\n interface FileMessage {\n /** Wix Media ID. */\n _id?: string | null;\n /** URL where the file is hosted. */\n url?: string;\n /** File name of the original file. */\n filename?: string | null;\n /** File [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). */\n mimeType?: string | null;\n }\n interface TemplateMessagePayload {\n /** Title displayed in the message. */\n title?: string | null;\n /**\n * List of buttons to display with the message.\n * Buttons can either open a URL or pass interaction details to the\n * [Button Interacted Webhook](https://dev.wix.com/api/rest/all-apis/inbox/button-interacted-webhook).\n *\n * Maximum: 10 buttons.\n */\n buttons?: Button[];\n /**\n * Controls whether the message is displayed in portrait or landscape layout.\n *\n * Defaults to `PORTRAIT`.\n */\n orientation?: Orientation;\n /**\n * List of lines of text. Each item in the array is displayed on a new line.\n *\n * Maximum: 10 lines, up to 512 characters per line.\n */\n textLines?: string[];\n /** URL where the icon is hosted. */\n imageUrl?: string | null;\n }\n interface Button {\n /** Button label text. */\n label?: string;\n /** If included, the button launches the specified URL. */\n launchUrl?: string | null;\n /**\n * Properties to pass to the\n * [Button Interacted webhook](https://dev.wix.com/api/rest/inbox/messages/button-interacted-webhook)\n * when the button is clicked.\n */\n postbackProperties?: PostbackProperties;\n }\n interface PostbackProperties {\n /**\n * [Your app's](https://dev.wix.com/dc3/my-apps) App ID.\n * @readonly\n */\n appId?: string | null;\n /** ID you define for the interaction, to be handled by your server. */\n interactionId?: string;\n }\n enum Orientation {\n UNKNOWN_ORIENTATION = \"UNKNOWN_ORIENTATION\",\n PORTRAIT = \"PORTRAIT\",\n LANDSCAPE = \"LANDSCAPE\"\n }\n interface MinimalMessagePayload {\n /** Message text. */\n text?: string;\n /** URL where the icon is hosted. */\n iconUrl?: string | null;\n /** If included, URL the user is redirected to when clicking the message. */\n url?: string | null;\n }\n interface FormMessagePayload {\n /** Form title displayed in the message. */\n title?: string | null;\n /** Form description displayed below the title. */\n description?: string | null;\n /** List of form fields and values. */\n fields?: FormField[];\n /**\n * List of files and/or images attached to the form.\n *\n * List items are displayed as separate messages\n * in Inbox and the site's chat widget.\n */\n media?: MediaItem[];\n }\n interface FormField {\n /** Form field display name. */\n name?: string;\n /** Submitted value. */\n value?: string;\n }\n interface MediaItem extends MediaItemMediaOneOf {\n /**\n * Image message.\n * Can contain an image from Wix Media\n * or from an external provider.\n */\n image?: ImageMessage;\n /**\n * File attachment.\n * Can contain a file from Wix Media or an external provider.\n */\n file?: FileMessage;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /**\n * Image message.\n * Can contain an image from Wix Media\n * or from an external provider.\n */\n image?: ImageMessage;\n /**\n * File attachment.\n * Can contain a file from Wix Media or an external provider.\n */\n file?: FileMessage;\n }\n interface SystemMessagePayload {\n /** Text message. `\\n` renders as a line break. */\n text?: string;\n /**\n * List of buttons to display with the message.\n * Buttons can either open a URL or pass interaction details to the\n * [Button Interacted Webhook](https://dev.wix.com/api/rest/all-apis/inbox/button-interacted-webhook).\n *\n * Maximum: 10 buttons.\n */\n buttons?: Button[];\n /** URL where the icon is hosted. */\n imageUrl?: string | null;\n }\n enum ContentType {\n UNKNOWN_CONTENT = \"UNKNOWN_CONTENT\",\n BASIC = \"BASIC\",\n TEMPLATE = \"TEMPLATE\",\n MINIMAL = \"MINIMAL\",\n FORM = \"FORM\",\n SYSTEM = \"SYSTEM\",\n UNSUPPORTED = \"UNSUPPORTED\"\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** Anonymous site visitor ID. */\n anonymousVisitorId?: string;\n /**\n * Site\n * [member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members)\n * ID.\n */\n memberId?: string;\n /** User ID of the site owner or a site contributor. */\n wixUserId?: string;\n /** App ID. */\n appId?: string;\n /**\n * Optional site\n * [contact](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts) ID.\n * @readonly\n */\n contactId?: string | null;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** Anonymous site visitor ID. */\n anonymousVisitorId?: string;\n /**\n * Site\n * [member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members)\n * ID.\n */\n memberId?: string;\n /** User ID of the site owner or a site contributor. */\n wixUserId?: string;\n /** App ID. */\n appId?: string;\n }\n interface Badge {\n /** Display text. */\n text?: string;\n /** URL where the icon is hosted. */\n iconUrl?: string | null;\n /**\n * Controls whether the badge is visible to the participant.\n * Currently not supported in the Chat widget.\n */\n badgeVisibility?: BadgeVisibility;\n }\n enum BadgeVisibility {\n UNKNOWN_BADGE_VISIBILITY = \"UNKNOWN_BADGE_VISIBILITY\",\n BUSINESS_AND_PARTICIPANT = \"BUSINESS_AND_PARTICIPANT\",\n BUSINESS = \"BUSINESS\"\n }\n enum ChannelType {\n UNKNOWN_CHANNEL_TYPE = \"UNKNOWN_CHANNEL_TYPE\",\n CHAT = \"CHAT\",\n EMAIL = \"EMAIL\",\n SMS = \"SMS\",\n FACEBOOK = \"FACEBOOK\",\n INSTAGRAM = \"INSTAGRAM\",\n WHATSAPP = \"WHATSAPP\"\n }\n enum MessageVisibility {\n UNKNOWN_VISIBILITY = \"UNKNOWN_VISIBILITY\",\n BUSINESS_AND_PARTICIPANT = \"BUSINESS_AND_PARTICIPANT\",\n BUSINESS = \"BUSINESS\"\n }\n enum MessageDirection {\n UNKNOWN_DIRECTION = \"UNKNOWN_DIRECTION\",\n BUSINESS_TO_PARTICIPANT = \"BUSINESS_TO_PARTICIPANT\",\n PARTICIPANT_TO_BUSINESS = \"PARTICIPANT_TO_BUSINESS\"\n }\n interface GetMessageIndicationsRequest {\n conversationId: string;\n messageId: string;\n }\n interface GetMessageIndicationsResponse {\n messageIndications?: MessageIndication[];\n }\n interface MessageIndication {\n /** @readonly */\n conversationId?: string | null;\n /**\n * The time when the message was sent\n * @readonly\n */\n messageId?: string | null;\n /** The type of the indication */\n type?: IndicationType;\n /** The channel to which this indication was added */\n channel?: ChannelType;\n /** The time when action happened */\n timestamp?: Date;\n }\n enum IndicationType {\n UNKNOWN_INDICATION_TYPE = \"UNKNOWN_INDICATION_TYPE\",\n SENT = \"SENT\",\n SEEN = \"SEEN\",\n ERROR = \"ERROR\",\n DELIVERED = \"DELIVERED\"\n }\n interface AddMessageIndicationsRequest {\n conversationId: string;\n messageIds: string[];\n /** by whom this action was done, defaults to PARTICIPANT in case of UNKNOWN_PERFORMED_BY */\n performedBy?: PerformedBy;\n indication: MessageIndication;\n }\n enum PerformedBy {\n UNKNOWN_PERFORMED_BY = \"UNKNOWN_PERFORMED_BY\",\n BUSINESS = \"BUSINESS\",\n PARTICIPANT = \"PARTICIPANT\"\n }\n interface AddMessageIndicationsResponse {\n }\n interface MessageSentToParticipant {\n /** Conversation ID. */\n conversationId?: string;\n /** Sent message. */\n message?: Message;\n }\n interface CustomMessageData {\n /** Name of the app this message belong to */\n appName?: string | null;\n /** Data set by the sending application */\n appData?: Record;\n }\n interface MessageSentToBusiness {\n /** Conversation ID. */\n conversationId?: string;\n /** Sent message. */\n message?: Message;\n /** Optional info about interaction with app done by the user */\n interactionInfo?: InteractionInfo;\n }\n /**\n * Source of interaction message, will be available when message originated by interaction with an application.\n * like clicking a button.\n */\n interface InteractionInfo {\n appId?: string | null;\n interactionId?: string | null;\n }\n interface ButtonInteracted {\n /** Conversation ID. */\n conversationId?: string;\n /** [Your app's](https://dev.wix.com/dc3/my-apps) app ID. */\n appId?: string | null;\n /**\n * ID you define for the interaction,\n * to be handled by your server.\n */\n interactionId?: string | null;\n /** ID of the participant who pressed the button. */\n interactedBy?: IdentificationData;\n }\n interface ListMessagesRequest {\n /** ID of the conversation that contains the intended messages. */\n conversationId: string;\n /**\n * __Required.__\n * Filters for messages with the specified visibility setting.\n *\n * - `BUSINESS_AND_PARTICIPANT`: Return messages visible to the business and the participant.\n * - `BUSINESS`: Return all messages.\n */\n visibility?: MessageVisibility;\n /** Paging options. */\n paging?: CursorPaging;\n /** Sorting options. */\n sorting?: Sorting;\n }\n interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface ListMessagesResponse {\n /** List of messages between the specified visitor and the site. */\n messages?: Message[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface SendMessageRequest {\n /** ID of the conversation to add the message to. */\n conversationId: string;\n /** Message to send. */\n message: Message;\n /**\n * Controls whether the message triggers notifications when it's received.\n *\n * Defaults to `false`.\n */\n sendNotifications?: boolean;\n /**\n * Controls whether the unread count and conversation summary\n * are updated in the\n * [Message List](https://support.wix.com/en/article/wix-inbox-getting-started#view-your-messages).\n *\n * If `true`, unread count and conversation summary are not updated.\n *\n * Defaults to `false`.\n */\n silent?: boolean;\n /**\n * Controls which identity to use in the message's `sender` property.\n *\n * - `CALLER`: Uses the identity included in the request header.\n * - `PARTICIPANT`: Uses the `anonymousVisitorId`, `contactId`, or `memberId` of the conversation's participant.\n * - `BUSINESS_USER`: For internal use. Uses the `wixUserId` of the person sending messages on behalf of the business.\n *\n * Defaults to `CALLER`.\n * For 3rd-party apps, the app is the caller.\n */\n sendAs?: OverrideSenderOptions;\n }\n enum OverrideSenderOptions {\n CALLER = \"CALLER\",\n PARTICIPANT = \"PARTICIPANT\",\n BUSINESS_USER = \"BUSINESS_USER\"\n }\n interface SendMessageResponse {\n /** Sent message. */\n message?: Message;\n }\n interface Empty {\n }\n interface AddMessageIndicationsOptions {\n messageIds: string[];\n /** by whom this action was done, defaults to PARTICIPANT in case of UNKNOWN_PERFORMED_BY */\n performedBy?: PerformedBy;\n indication: MessageIndication;\n }\n /**\n * Retrieves messages between the business and participant.\n *\n *\n * Up to 30 messages are returned per request.\n * If the number of messages is larger than the returned page,\n * `pagingMetadata.cursors` is returned in the response,\n * indicating that another page of results is available.\n * To retrieve the next page,\n * pass the `next` cursor value\n * in the next request's `paging.cursor` parameter.\n *\n * To ensure you'll always retrieve the next record,\n * use the same visibility and sorting\n * in the first request and all subsequent requests.\n *\n * By default,\n * 30 messages are retrieved,\n * sorted by `sequence` in descending order\n * (the most recent messages are first in the list).\n *\n * This function is not a universal function and runs only on the backend.\n * @param conversationId - ID of the conversation that contains the intended messages.\n * @param visibility - __Required.__\n * Filters for messages with the specified visibility setting.\n *\n * - `BUSINESS_AND_PARTICIPANT`: Return messages visible to the business and the participant.\n * - `BUSINESS`: Return all messages.\n * @public\n * @documentationMaturity preview\n * @requiredField conversationId\n * @requiredField visibility\n * @param options - Additional options for listing messages.\n * @adminMethod\n */\n function listMessages(conversationId: string, visibility: MessageVisibility, options?: ListMessagesOptions): Promise;\n interface ListMessagesOptions {\n /** Paging options. */\n paging?: CursorPaging;\n /** Sorting options. */\n sorting?: Sorting;\n }\n /**\n * Sends a message to the business or participant.\n *\n *\n * Specify the message type in `message.content`\n * by including the appropriate object: `basic`, `template`, `minimal`, or `form`.\n * For more information on message types\n * and how each type renders in Inbox and the Chat widget,\n * see [Message Types](#message-types).\n *\n * This function is not a universal function and runs only on the backend.\n * @param conversationId - ID of the conversation to add the message to.\n * @param message - Message to send.\n * @public\n * @documentationMaturity preview\n * @requiredField conversationId\n * @requiredField message\n * @requiredField message.content\n * @param options - Additional options for sending a message.\n * @adminMethod\n */\n function sendMessage(conversationId: string, message: Message, options?: SendMessageOptions): Promise;\n interface SendMessageOptions {\n /**\n * Controls whether the message triggers notifications when it's received.\n *\n * Defaults to `false`.\n */\n sendNotifications?: boolean;\n /**\n * Controls whether the unread count and conversation summary\n * are updated in the\n * [Message List](https://support.wix.com/en/article/wix-inbox-getting-started#view-your-messages).\n *\n * If `true`, unread count and conversation summary are not updated.\n *\n * Defaults to `false`.\n */\n silent?: boolean;\n /**\n * Controls which identity to use in the message's `sender` property.\n *\n * - `CALLER`: Uses the identity included in the request header.\n * - `PARTICIPANT`: Uses the `anonymousVisitorId`, `contactId`, or `memberId` of the conversation's participant.\n * - `BUSINESS_USER`: For internal use. Uses the `wixUserId` of the person sending messages on behalf of the business.\n *\n * Defaults to `CALLER`.\n * For 3rd-party apps, the app is the caller.\n */\n sendAs?: OverrideSenderOptions;\n }\n const crmInboxV2Message_universal_d___debug: typeof __debug;\n type crmInboxV2Message_universal_d_Message = Message;\n type crmInboxV2Message_universal_d_MessageContent = MessageContent;\n type crmInboxV2Message_universal_d_MessageContentPayloadOneOf = MessageContentPayloadOneOf;\n type crmInboxV2Message_universal_d_BasicMessagePayload = BasicMessagePayload;\n type crmInboxV2Message_universal_d_BasicMessageData = BasicMessageData;\n type crmInboxV2Message_universal_d_BasicMessageDataDataOneOf = BasicMessageDataDataOneOf;\n type crmInboxV2Message_universal_d_ImageMessage = ImageMessage;\n type crmInboxV2Message_universal_d_FileMessage = FileMessage;\n type crmInboxV2Message_universal_d_TemplateMessagePayload = TemplateMessagePayload;\n type crmInboxV2Message_universal_d_Button = Button;\n type crmInboxV2Message_universal_d_PostbackProperties = PostbackProperties;\n type crmInboxV2Message_universal_d_Orientation = Orientation;\n const crmInboxV2Message_universal_d_Orientation: typeof Orientation;\n type crmInboxV2Message_universal_d_MinimalMessagePayload = MinimalMessagePayload;\n type crmInboxV2Message_universal_d_FormMessagePayload = FormMessagePayload;\n type crmInboxV2Message_universal_d_FormField = FormField;\n type crmInboxV2Message_universal_d_MediaItem = MediaItem;\n type crmInboxV2Message_universal_d_MediaItemMediaOneOf = MediaItemMediaOneOf;\n type crmInboxV2Message_universal_d_SystemMessagePayload = SystemMessagePayload;\n type crmInboxV2Message_universal_d_ContentType = ContentType;\n const crmInboxV2Message_universal_d_ContentType: typeof ContentType;\n type crmInboxV2Message_universal_d_IdentificationData = IdentificationData;\n type crmInboxV2Message_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type crmInboxV2Message_universal_d_Badge = Badge;\n type crmInboxV2Message_universal_d_BadgeVisibility = BadgeVisibility;\n const crmInboxV2Message_universal_d_BadgeVisibility: typeof BadgeVisibility;\n type crmInboxV2Message_universal_d_ChannelType = ChannelType;\n const crmInboxV2Message_universal_d_ChannelType: typeof ChannelType;\n type crmInboxV2Message_universal_d_MessageVisibility = MessageVisibility;\n const crmInboxV2Message_universal_d_MessageVisibility: typeof MessageVisibility;\n type crmInboxV2Message_universal_d_MessageDirection = MessageDirection;\n const crmInboxV2Message_universal_d_MessageDirection: typeof MessageDirection;\n type crmInboxV2Message_universal_d_GetMessageIndicationsRequest = GetMessageIndicationsRequest;\n type crmInboxV2Message_universal_d_GetMessageIndicationsResponse = GetMessageIndicationsResponse;\n type crmInboxV2Message_universal_d_MessageIndication = MessageIndication;\n type crmInboxV2Message_universal_d_IndicationType = IndicationType;\n const crmInboxV2Message_universal_d_IndicationType: typeof IndicationType;\n type crmInboxV2Message_universal_d_AddMessageIndicationsRequest = AddMessageIndicationsRequest;\n type crmInboxV2Message_universal_d_PerformedBy = PerformedBy;\n const crmInboxV2Message_universal_d_PerformedBy: typeof PerformedBy;\n type crmInboxV2Message_universal_d_AddMessageIndicationsResponse = AddMessageIndicationsResponse;\n type crmInboxV2Message_universal_d_MessageSentToParticipant = MessageSentToParticipant;\n type crmInboxV2Message_universal_d_CustomMessageData = CustomMessageData;\n type crmInboxV2Message_universal_d_MessageSentToBusiness = MessageSentToBusiness;\n type crmInboxV2Message_universal_d_InteractionInfo = InteractionInfo;\n type crmInboxV2Message_universal_d_ButtonInteracted = ButtonInteracted;\n type crmInboxV2Message_universal_d_ListMessagesRequest = ListMessagesRequest;\n type crmInboxV2Message_universal_d_CursorPaging = CursorPaging;\n type crmInboxV2Message_universal_d_Sorting = Sorting;\n type crmInboxV2Message_universal_d_SortOrder = SortOrder;\n const crmInboxV2Message_universal_d_SortOrder: typeof SortOrder;\n type crmInboxV2Message_universal_d_ListMessagesResponse = ListMessagesResponse;\n type crmInboxV2Message_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type crmInboxV2Message_universal_d_Cursors = Cursors;\n type crmInboxV2Message_universal_d_SendMessageRequest = SendMessageRequest;\n type crmInboxV2Message_universal_d_OverrideSenderOptions = OverrideSenderOptions;\n const crmInboxV2Message_universal_d_OverrideSenderOptions: typeof OverrideSenderOptions;\n type crmInboxV2Message_universal_d_SendMessageResponse = SendMessageResponse;\n type crmInboxV2Message_universal_d_Empty = Empty;\n type crmInboxV2Message_universal_d_AddMessageIndicationsOptions = AddMessageIndicationsOptions;\n const crmInboxV2Message_universal_d_listMessages: typeof listMessages;\n type crmInboxV2Message_universal_d_ListMessagesOptions = ListMessagesOptions;\n const crmInboxV2Message_universal_d_sendMessage: typeof sendMessage;\n type crmInboxV2Message_universal_d_SendMessageOptions = SendMessageOptions;\n namespace crmInboxV2Message_universal_d {\n export { crmInboxV2Message_universal_d___debug as __debug, crmInboxV2Message_universal_d_Message as Message, crmInboxV2Message_universal_d_MessageContent as MessageContent, crmInboxV2Message_universal_d_MessageContentPayloadOneOf as MessageContentPayloadOneOf, crmInboxV2Message_universal_d_BasicMessagePayload as BasicMessagePayload, crmInboxV2Message_universal_d_BasicMessageData as BasicMessageData, crmInboxV2Message_universal_d_BasicMessageDataDataOneOf as BasicMessageDataDataOneOf, crmInboxV2Message_universal_d_ImageMessage as ImageMessage, crmInboxV2Message_universal_d_FileMessage as FileMessage, crmInboxV2Message_universal_d_TemplateMessagePayload as TemplateMessagePayload, crmInboxV2Message_universal_d_Button as Button, crmInboxV2Message_universal_d_PostbackProperties as PostbackProperties, crmInboxV2Message_universal_d_Orientation as Orientation, crmInboxV2Message_universal_d_MinimalMessagePayload as MinimalMessagePayload, crmInboxV2Message_universal_d_FormMessagePayload as FormMessagePayload, crmInboxV2Message_universal_d_FormField as FormField, crmInboxV2Message_universal_d_MediaItem as MediaItem, crmInboxV2Message_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf, crmInboxV2Message_universal_d_SystemMessagePayload as SystemMessagePayload, crmInboxV2Message_universal_d_ContentType as ContentType, crmInboxV2Message_universal_d_IdentificationData as IdentificationData, crmInboxV2Message_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, crmInboxV2Message_universal_d_Badge as Badge, crmInboxV2Message_universal_d_BadgeVisibility as BadgeVisibility, crmInboxV2Message_universal_d_ChannelType as ChannelType, crmInboxV2Message_universal_d_MessageVisibility as MessageVisibility, crmInboxV2Message_universal_d_MessageDirection as MessageDirection, crmInboxV2Message_universal_d_GetMessageIndicationsRequest as GetMessageIndicationsRequest, crmInboxV2Message_universal_d_GetMessageIndicationsResponse as GetMessageIndicationsResponse, crmInboxV2Message_universal_d_MessageIndication as MessageIndication, crmInboxV2Message_universal_d_IndicationType as IndicationType, crmInboxV2Message_universal_d_AddMessageIndicationsRequest as AddMessageIndicationsRequest, crmInboxV2Message_universal_d_PerformedBy as PerformedBy, crmInboxV2Message_universal_d_AddMessageIndicationsResponse as AddMessageIndicationsResponse, crmInboxV2Message_universal_d_MessageSentToParticipant as MessageSentToParticipant, crmInboxV2Message_universal_d_CustomMessageData as CustomMessageData, crmInboxV2Message_universal_d_MessageSentToBusiness as MessageSentToBusiness, crmInboxV2Message_universal_d_InteractionInfo as InteractionInfo, crmInboxV2Message_universal_d_ButtonInteracted as ButtonInteracted, crmInboxV2Message_universal_d_ListMessagesRequest as ListMessagesRequest, crmInboxV2Message_universal_d_CursorPaging as CursorPaging, crmInboxV2Message_universal_d_Sorting as Sorting, crmInboxV2Message_universal_d_SortOrder as SortOrder, crmInboxV2Message_universal_d_ListMessagesResponse as ListMessagesResponse, crmInboxV2Message_universal_d_PagingMetadataV2 as PagingMetadataV2, crmInboxV2Message_universal_d_Cursors as Cursors, crmInboxV2Message_universal_d_SendMessageRequest as SendMessageRequest, crmInboxV2Message_universal_d_OverrideSenderOptions as OverrideSenderOptions, crmInboxV2Message_universal_d_SendMessageResponse as SendMessageResponse, crmInboxV2Message_universal_d_Empty as Empty, crmInboxV2Message_universal_d_AddMessageIndicationsOptions as AddMessageIndicationsOptions, crmInboxV2Message_universal_d_listMessages as listMessages, crmInboxV2Message_universal_d_ListMessagesOptions as ListMessagesOptions, crmInboxV2Message_universal_d_sendMessage as sendMessage, crmInboxV2Message_universal_d_SendMessageOptions as SendMessageOptions, };\n }\n export { crmInboxV2Conversation_universal_d as conversations, crmInboxV2Message_universal_d as messages };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-email-marketing.v2.d.ts", "content": "declare module \"wix-email-marketing.v2\" {\n /**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\n interface AccountDetails {\n /**\n * Account status. One of:\n * + `'ACTIVE'`\n * + `'WARNED'`\n * + `'SUSPENDED'`\n * + `'BANNED'`\n */\n status?: Enum$1;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n }\n enum Enum$1 {\n UNKNOWN = \"UNKNOWN\",\n /** Able to use email marketing normally. */\n ACTIVE = \"ACTIVE\",\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = \"WARNED\",\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = \"SUSPENDED\",\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = \"BANNED\",\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = \"SUSPENDED_AUTOLIFT\"\n }\n interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n }\n interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n }\n interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n }\n interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n }\n interface GetAccountDetailsRequest {\n }\n interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n }\n interface GetComplianceDetailsRequest {\n }\n interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n }\n interface ComplianceDetails {\n /** Account status. */\n status?: Enum$1;\n /** Suspension reasons. */\n suspensionReasons?: string[];\n /** Suspension description. */\n note?: string | null;\n /** Support ticket id. */\n supportTicketId?: string | null;\n }\n interface RespondRequest {\n action: Action;\n supportTicketData?: SupportTicketData;\n }\n enum Action {\n UNKNOWN_ACTION = \"UNKNOWN_ACTION\",\n AGREE_TO_TERMS = \"AGREE_TO_TERMS\",\n OPEN_TICKET = \"OPEN_TICKET\",\n FILL_FORM = \"FILL_FORM\",\n ANSWER_QUESTIONS = \"ANSWER_QUESTIONS\",\n FILL_AUTOLIFT_FORM = \"FILL_AUTOLIFT_FORM\"\n }\n interface RespondResponse {\n /** ID of the support ticket created (optional). */\n supportTicketId?: string | null;\n }\n interface SupportTicketData {\n subject?: string;\n body?: string;\n agentReplyBody?: string | null;\n }\n /**\n * Retrieves email marketing account details.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function getAccountDetails(): Promise;\n interface RespondOptions {\n supportTicketData?: SupportTicketData;\n }\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_AccountDetails = AccountDetails;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_Package = Package;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_Quota = Quota;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_QuotaPeriod = QuotaPeriod;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_Features = Features;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_GetAccountDetailsRequest = GetAccountDetailsRequest;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_GetAccountDetailsResponse = GetAccountDetailsResponse;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_GetComplianceDetailsRequest = GetComplianceDetailsRequest;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_GetComplianceDetailsResponse = GetComplianceDetailsResponse;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_ComplianceDetails = ComplianceDetails;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_RespondRequest = RespondRequest;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_Action = Action;\n const emailMarketingV1AccountDetailsAccountDetails_universal_d_Action: typeof Action;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_RespondResponse = RespondResponse;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_SupportTicketData = SupportTicketData;\n const emailMarketingV1AccountDetailsAccountDetails_universal_d_getAccountDetails: typeof getAccountDetails;\n type emailMarketingV1AccountDetailsAccountDetails_universal_d_RespondOptions = RespondOptions;\n namespace emailMarketingV1AccountDetailsAccountDetails_universal_d {\n export { emailMarketingV1AccountDetailsAccountDetails_universal_d_AccountDetails as AccountDetails, Enum$1 as Enum, emailMarketingV1AccountDetailsAccountDetails_universal_d_Package as Package, emailMarketingV1AccountDetailsAccountDetails_universal_d_Quota as Quota, emailMarketingV1AccountDetailsAccountDetails_universal_d_QuotaPeriod as QuotaPeriod, emailMarketingV1AccountDetailsAccountDetails_universal_d_Features as Features, emailMarketingV1AccountDetailsAccountDetails_universal_d_GetAccountDetailsRequest as GetAccountDetailsRequest, emailMarketingV1AccountDetailsAccountDetails_universal_d_GetAccountDetailsResponse as GetAccountDetailsResponse, emailMarketingV1AccountDetailsAccountDetails_universal_d_GetComplianceDetailsRequest as GetComplianceDetailsRequest, emailMarketingV1AccountDetailsAccountDetails_universal_d_GetComplianceDetailsResponse as GetComplianceDetailsResponse, emailMarketingV1AccountDetailsAccountDetails_universal_d_ComplianceDetails as ComplianceDetails, emailMarketingV1AccountDetailsAccountDetails_universal_d_RespondRequest as RespondRequest, emailMarketingV1AccountDetailsAccountDetails_universal_d_Action as Action, emailMarketingV1AccountDetailsAccountDetails_universal_d_RespondResponse as RespondResponse, emailMarketingV1AccountDetailsAccountDetails_universal_d_SupportTicketData as SupportTicketData, emailMarketingV1AccountDetailsAccountDetails_universal_d_getAccountDetails as getAccountDetails, emailMarketingV1AccountDetailsAccountDetails_universal_d_RespondOptions as RespondOptions, };\n }\n interface Campaign {\n /** Campaign ID. */\n campaignId?: string;\n /**\n * Marketing campaign title. For sent campaigns this will match the email subject if subject was not explicitly provided on sending.\n * For published campaigns - the title will be the first line of text.\n */\n title?: string | null;\n /** URL of first image after the logo. */\n firstImageUrl?: string | null;\n /**\n * URL of the landing page snapshot.\n * Attention: this field is deprecated and snapshot images will no longer be supported! Use \"firstImageUrl\" instead.\n * This field will soon start to return \"firstImageUrl\" value too.\n * @deprecated URL of the landing page snapshot.\n * Attention: this field is deprecated and snapshot images will no longer be supported! Use \"firstImageUrl\" instead.\n * This field will soon start to return \"firstImageUrl\" value too.\n * @replacedBy firstImageUrl\n * @targetRemovalDate 2024-12-01\n */\n snapshotImageUrl?: string | null;\n /**\n * Editor type. Either web app, or mobile app. One of:\n * + `'WEB'`\n * + `'MOBILE'`\n */\n editorType?: CampaignEditorTypeEnum;\n /**\n * Campaign status. One of:\n * + `'ACTIVE'`\n * + `'ARCHIVED'`\n * + `'DELETED'`\n */\n status?: CampaignStatusEnum;\n /**\n * Campaign visibility status. One of:\n * + `'DRAFT'`\n * + `'PUBLISHED'`\n * + `'TEMPLATE'`\n */\n visibilityStatus?: CampaignVisibilityStatusEnum;\n /**\n * Campaign distribution status. One of:\n * + `'NOT_STARTED'`\n * + `'SCHEDULED'`\n * + `'IN_DETECTION'`\n * + `'IN_MODERATION'`\n * + `'SAMPLING'`\n * + `'SENDING'`\n * + `'REJECTED'`\n * + `'TERMINATED'`\n * + `'DISTRIBUTED'`\n * + `'PAUSED'`\n */\n distributionStatus?: Enum;\n /** Publishing data (present only if campaign is published). */\n publishingData?: PublishingData;\n /** Campaign creation date. */\n dateCreated?: Date;\n /** Campaign last update date. */\n dateUpdated?: Date;\n /**\n * Email subject of the campaign (initially copied from the template).\n * TODO: Deprecated (moved to \"GetComposerResponse\").\n * @deprecated\n */\n emailSubject?: string;\n }\n enum CampaignEditorTypeEnum {\n UNKNOWN = \"UNKNOWN\",\n WEB = \"WEB\",\n MOBILE = \"MOBILE\"\n }\n enum CampaignStatusEnum {\n UNKNOWN = \"UNKNOWN\",\n /** Campaign is active. */\n ACTIVE = \"ACTIVE\",\n /** Campaign is archived. */\n ARCHIVED = \"ARCHIVED\",\n /** Campaign is deleted. */\n DELETED = \"DELETED\"\n }\n enum CampaignVisibilityStatusEnum {\n UNKNOWN = \"UNKNOWN\",\n /** Campaign not yet published. */\n DRAFT = \"DRAFT\",\n /** Campaign published. */\n PUBLISHED = \"PUBLISHED\",\n /** Campaign is a template. */\n TEMPLATE = \"TEMPLATE\"\n }\n enum Enum {\n UNKNOWN = \"UNKNOWN\",\n /** Campaign not yet distributed via emails. */\n NOT_STARTED = \"NOT_STARTED\",\n /** Campaign scheduled for distribution. */\n SCHEDULED = \"SCHEDULED\",\n /** Campaign is being automatically screened for malicious content. */\n IN_DETECTION = \"IN_DETECTION\",\n /** Campaign is being manually reviewed by moderators. */\n IN_MODERATION = \"IN_MODERATION\",\n /** A fraction of recipients is selected as a sample and its performance will be assessed to determine further action. */\n SAMPLING = \"SAMPLING\",\n /** Campaign is being distributed to all recipients. */\n SENDING = \"SENDING\",\n /** Campaign was rejected. */\n REJECTED = \"REJECTED\",\n /** Campaign was terminated after unsuccessful sampling. */\n TERMINATED = \"TERMINATED\",\n /** Campaign fully distributed to recipients. */\n DISTRIBUTED = \"DISTRIBUTED\",\n /** Scheduled campaign has been paused. */\n PAUSED = \"PAUSED\"\n }\n interface PublishingData {\n /** Landing page URL. */\n landingPageUrl?: string;\n /** Marketing campaign statistics. */\n statistics?: CampaignStatistics;\n /** Marketing campaign publish date. */\n datePublished?: Date;\n }\n interface CampaignStatistics {\n /** Marketing campaign's landing page statistics. */\n landingPage?: LandingPageStatistics;\n /** Marketing campaign's email distribution statistics. */\n emailCampaign?: DistributionStatistics;\n /** Combined landing page and email distribution statistics. */\n total?: TotalStatistics;\n }\n interface LandingPageStatistics {\n /** Number of times landing page was loaded or viewed. */\n opened?: number;\n /** Number of times a link was clicked in landing page. */\n clicked?: number;\n }\n interface DistributionStatistics {\n /** Number of emails delivered. */\n delivered?: number;\n /**\n * Number of recipients who opened an email.\n *\n * If a single recipient opens an email twice, it is counted as one unique open.\n */\n opened?: number;\n /**\n * Number of recipients who clicked a link in the email.\n *\n * If a single recipient clicks a link in an email twice, it is counted as one unique click.\n * If a single recipient clicks different links in an email, it is counted as one unique click.\n */\n clicked?: number;\n /** Number of emails that bounced. */\n bounced?: number;\n /** Number of recipients who reported email as spam. */\n complained?: number;\n /** Number of emails not sent because the campaign was terminated. */\n notSent?: number;\n }\n interface TotalStatistics {\n /** Total number of emails sent. */\n mailsSent?: number;\n /** Number of landing page views + emails opened. */\n opened?: number;\n /** Number of landing page link clicks + email link clicks. */\n clicked?: number;\n }\n interface RejectionData {\n rejectionReasons?: RejectionReasonEnum[];\n }\n enum RejectionReasonEnum {\n UNKNOWN = \"UNKNOWN\",\n LOW_ENGAGEMENT = \"LOW_ENGAGEMENT\",\n SENDER_DETAILS = \"SENDER_DETAILS\",\n SPAM_TRAPS = \"SPAM_TRAPS\",\n OTHER = \"OTHER\",\n ADULT_SEXUAL_CONTENT = \"ADULT_SEXUAL_CONTENT\",\n AFFILIATE_MARKETING = \"AFFILIATE_MARKETING\",\n BETTING_OR_GAMBLING = \"BETTING_OR_GAMBLING\",\n CREDIT_REPAIR_OR_DEBT_RELIEF = \"CREDIT_REPAIR_OR_DEBT_RELIEF\",\n GET_RICH_QUICK_SCHEME = \"GET_RICH_QUICK_SCHEME\",\n ILLEGAL_SUBSTANCES_OR_WEAPONS = \"ILLEGAL_SUBSTANCES_OR_WEAPONS\",\n MISLEADING_SUBJECT_LINE = \"MISLEADING_SUBJECT_LINE\",\n TRADING_OR_CRYPTOCURRENCIES = \"TRADING_OR_CRYPTOCURRENCIES\",\n UNSOLICITED_CONTENT = \"UNSOLICITED_CONTENT\"\n }\n enum CampaignSendingStateEnum {\n /** Campaign not yet published. */\n DRAFT = \"DRAFT\",\n /** Campaign is being reviewed. */\n REVIEW = \"REVIEW\",\n /** Campaign was rejected. */\n REJECTED = \"REJECTED\",\n /** Campaign is scheduled. */\n SCHEDULED = \"SCHEDULED\",\n /** Scheduled campaign was paused. */\n PAUSED = \"PAUSED\",\n /** Campaign is published. */\n PUBLISHED = \"PUBLISHED\",\n /** Campaign is being send. */\n SENDING = \"SENDING\",\n /**\n * Campaign was partially sent.\n * Happens when too many recipients bounce.\n */\n PARTIALLY_SENT = \"PARTIALLY_SENT\",\n /** Campaign was sent. */\n SENT = \"SENT\"\n }\n enum CampaignTypeEnum {\n UNKNOWN = \"UNKNOWN\",\n /** Regular email marketing campaign. */\n EMAIL_MARKETING = \"EMAIL_MARKETING\",\n /** mobile place invitation email */\n INVITATION = \"INVITATION\",\n /** automation */\n AUTOMATION = \"AUTOMATION\",\n /** triggered email */\n TRIGGERED = \"TRIGGERED\"\n }\n interface EstimateFilterSizeRequest {\n /** Contacts filter expression. */\n filter: Record | null;\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n /** Contacts plain text search expression (searches in name, phone and email fields). */\n search?: string | null;\n }\n interface EstimateFilterSizeResponse {\n /** Mailing list size estimation. */\n estimation?: number;\n }\n interface EstimateAudienceSizeRequest {\n /** Contact IDs of a campaign audience. */\n contactIds?: string[];\n /** Label IDs of a campaign audience. */\n labelIds?: string[];\n /** Contacts filter expression (json). */\n contactsFilter?: Record | null;\n /** Contacts plain text search expression (searches in name, phone and email fields). */\n search?: string | null;\n /** Segment ids of a campaign audience. */\n segmentIds?: string[];\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n /** Id of a campaign that is to be resent. */\n resendCampaignId?: string | null;\n /** Should total number of contacts in provided audience be returned or not (default value \"false\"). */\n withTotal?: boolean;\n }\n interface EstimateAudienceSizeResponse {\n /** Audience size (estimated number of emails to be sent). */\n estimation?: number;\n /** Total number of contacts in provided audience (optional). */\n total?: number | null;\n }\n interface ReconcileContactRequest {\n /** Email address of the contact. */\n emailAddress: string;\n }\n interface ReconcileContactResponse {\n /** Created or retrieved contact. */\n contact?: Contact;\n }\n interface Contact {\n /** Unique ID of the contact entity. */\n _id?: string;\n /** Primary email address of the contact. */\n emailAddress?: string;\n /** Full name of the contact (optional). */\n fullName?: string | null;\n /** Profile picture of the contact (optional). */\n pictureUrl?: string | null;\n }\n interface SearchContactsRequest {\n /** Text to search contacts by - can search by name or email address. */\n searchTerm: string;\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n /** Page size (default 50, max 1000). */\n pageSize?: number | null;\n }\n interface SearchContactsResponse {\n /** Search results. */\n contacts?: Contact[];\n }\n interface GetLabelsRequest {\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n }\n interface GetLabelsResponse {\n /** Returned labels with contact counts. */\n labels?: Label[];\n }\n interface Label {\n /** Unique ID of the label entity. */\n _id?: string;\n /** Name of the label. */\n name?: string;\n /** Amount of contacts assigned to the label. */\n contactsCount?: number;\n }\n interface SubscribeFromLandingPageRequest {\n /** Campaign ID that the subscription is happening from. */\n campaignId: string;\n /** Email address that is entered into subscription field. */\n emailAddress: string;\n /** Did UoU explicitly consent to terms of use or not (optional, default value \"false\") */\n consent?: boolean;\n }\n interface SubscribeFromLandingPageResponse {\n contactId?: string;\n }\n interface GetPlaceholderKeysRequest {\n /** Campaign ID. */\n campaignId: string;\n }\n interface GetPlaceholderKeysResponse {\n /** Keys of placeholders used in the campaign. */\n placeholderKeys?: string[];\n }\n interface GetDefaultComponentsRequest {\n }\n interface GetDefaultComponentsResponse {\n footer?: Record | null;\n logo?: Record | null;\n follow?: Record | null;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface ValidateLinkRequest {\n /** web URL */\n url: string;\n }\n interface ValidateLinkResponse {\n /** Whether link is valid */\n valid?: boolean;\n }\n interface ValidateHtmlLinksRequest {\n /** string containing HTML */\n html: string;\n }\n interface ValidateHtmlLinksResponse {\n /** array of blacklisted links */\n blacklistedLinks?: string[];\n }\n interface ListStatisticsRequest {\n /** IDs of the campaigns to retrieve (max 100 campaigns). */\n campaignIds: string[];\n }\n interface ListStatisticsResponse {\n /** List of statistics. */\n statistics?: CampaignStatisticsContainer[];\n }\n interface CampaignStatisticsContainer {\n /** Campaign ID. */\n campaignId?: string;\n /** Landing page statistics. */\n landingPage?: LandingPageStatistics;\n /** Email campaign statistics. */\n email?: DistributionStatistics;\n }\n interface ListRecipientsRequest {\n /** Campaign ID. */\n campaignId: string;\n /**\n * __Required.__ Email activity to filter for. One of:\n * + `'DELIVERED'`\n * + `'OPENED'`\n * + `'CLICKED'`\n * + `'BOUNCED'`\n * + `'NOT_SENT'`\n */\n activity: RecipientsActivityEnum;\n /** Pagination options. */\n paging?: CursorPaging;\n }\n enum RecipientsActivityEnum {\n UNKNOWN = \"UNKNOWN\",\n DELIVERED = \"DELIVERED\",\n OPENED = \"OPENED\",\n CLICKED = \"CLICKED\",\n BOUNCED = \"BOUNCED\",\n NOT_SENT = \"NOT_SENT\",\n SENT = \"SENT\",\n NOT_OPENED = \"NOT_OPENED\"\n }\n interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListRecipientsResponse {\n /** List of recipients. */\n recipients?: CampaignRecipientDetails[];\n /** Details on the paged set of returned results. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface CampaignRecipientDetails {\n /** Contact ID. */\n contactId?: string;\n /** Date and time of the last activity. */\n lastActivityDate?: Date;\n /** Primary email address of the contact. */\n emailAddress?: string;\n /** Full name of the contact (optional). */\n fullName?: string | null;\n /** Is this contact currently deleted from the site or not. */\n contactDeleted?: boolean;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface UnprocessedTargetEvent {\n /** The target that was not marked as processed */\n target?: Target;\n }\n interface Target {\n /** Unique identifier of the target with pattern `id_tag_value[type]`, for example 'com.wixpress.myproto[wix_proto_bundle_export]`` */\n _id?: string | null;\n /** The unique location of the target in Bazel notation i.e @repo//path/to/target:target_name */\n location?: string | null;\n /** The combined digest of all files within the target */\n combinedDigest?: string | null;\n /** The vcs commit timestamp of the target in milliseconds */\n commitTimestamp?: string | null;\n /** The type of the target */\n type?: TargetType;\n /**\n * The target's id tag value in Bazel, uniquness is not guaranteed\n * i.e for a tag \"businessSchemaIndexerId=com.wixpress.myproto\" the value is \"com.wixpress.myproto\"\n */\n idTagValue?: string | null;\n files?: File[];\n }\n enum TargetType {\n NONE = \"NONE\",\n WIX_PROTO_BUNDLE_EXPORT = \"WIX_PROTO_BUNDLE_EXPORT\",\n WIX_APPENDIX_BUNDLE_EXPORT = \"WIX_APPENDIX_BUNDLE_EXPORT\",\n WIX_API_REGISTRY_INFO_EXPORT = \"WIX_API_REGISTRY_INFO_EXPORT\"\n }\n interface File {\n /** The name of the file including path relative to its source repo, i.e src/main/java/com/wixpress/MyClass.java */\n name?: string | null;\n /** The URI of the file */\n uri?: string | null;\n /** The digest of the file */\n digest?: string | null;\n /** The size of the file in bytes */\n sizeInBytes?: string | null;\n }\n interface GetCampaignMappingRequest {\n /** rule ID in automations */\n automationRuleId: string;\n /** template ID configured for the automation */\n templateId: string;\n }\n interface GetCampaignMappingResponse {\n campaignId?: string;\n }\n interface GetPingCampaignMappingRequest {\n /** ping stream ID. */\n streamId: string;\n /** template ID configured for the ping automation. */\n templateId: string;\n /** ID of the initiating vertical. */\n appDefId: string;\n /** Ping template ID. */\n pingTemplateId?: string | null;\n /** Preferred language. */\n language: string;\n /** rule ID in automations */\n automationRuleId: string;\n }\n interface GetPingCampaignMappingResponse {\n campaignId?: string;\n }\n interface QueryAutomationTemplatesRequest {\n /** https://github.com/wix-private/p13n/blob/master/protos/query/src/main/proto/wix/common/query.proto */\n query?: Query;\n }\n interface Query {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryAutomationTemplatesResponse {\n entries?: AutomationTemplateContainer[];\n metaData?: QueryMetadata;\n total?: number;\n }\n interface AutomationTemplateContainer {\n automationTemplate?: AutomationTemplate;\n enrichmentData?: AutomationTemplateEnrichmentData;\n }\n interface AutomationTemplate {\n /**\n * Automation template ID (unique)\n * @readonly\n */\n _id?: string | null;\n /**\n * Automation template current revision\n * @readonly\n */\n revision?: number | null;\n /** Automation template name */\n name?: string | null;\n /** Automation template description */\n description?: string | null;\n /** Automation template rule configuration */\n rule?: RuleConfiguration;\n /** Automation template correlation id - TODO: rename */\n correlationId?: string | null;\n /** Automation template type */\n templateType?: TemplateType;\n /** Automation template preconditions */\n preconditions?: Precondition[];\n /** used to determine which users will see the Automation template while in internal state */\n groupIds?: string[];\n /**\n * Automation template state\n * @readonly\n */\n templateState?: TemplateState;\n /**\n * Automation template created date\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Automation template updated date\n * @readonly\n */\n _updatedDate?: Date;\n /** @readonly */\n translation?: Translation;\n /**\n * key -> english value, we will include those keys in the translator json and send them for translations.\n * in the \"search rules\" api they will be resolved with their translation\n */\n additionalTranslations?: Record;\n }\n interface RuleConfiguration {\n /** Rule configuration name */\n name?: string;\n /** Rule configuration description */\n description?: string;\n /** Trigger configuration */\n trigger?: TriggerConfiguration;\n /** Actions configuration */\n actions?: ActionConfiguration[];\n /** Rule status */\n ruleStatus?: RuleStatus;\n /** Activation cycle */\n activationCycle?: ActivationCycle;\n metadata?: RuleMetadata;\n }\n interface ConditionConfiguration {\n /** Condition schema key */\n schemaKey?: string;\n /** Condition operator */\n operator?: Operator;\n /** Condition values */\n values?: string[];\n }\n enum Operator {\n UNDEFINED = \"UNDEFINED\",\n IN = \"IN\"\n }\n interface TriggerConfiguration {\n /** Trigger source app def id */\n appDefId?: string;\n /** Trigger name */\n triggerName?: string;\n /** Trigger schema */\n triggerSchema?: string;\n /** Condition configuration */\n conditions?: ConditionConfiguration[];\n /** TODO - might need to replace the entire object */\n triggerConfigurationId?: string | null;\n /** Trigger Reengagement delay internal in sec */\n reengagementDelaySec?: number | null;\n }\n interface ActionConfiguration {\n _id?: string | null;\n /** Action source app def id */\n appDefId?: string;\n /** Action name */\n actionName?: string;\n /** Action configuration */\n configuration?: string;\n /** Delay interval in seconds */\n delayIntervalSec?: number;\n }\n enum RuleStatus {\n UnknownStatus = \"UnknownStatus\",\n Active = \"Active\",\n Suspended = \"Suspended\"\n }\n interface ActivationCycle {\n /** set a time frame in minutes for the once_per_user attribute, use 0 for infinite */\n timeFrame?: number;\n /** number of activations allowed in the given time_frame */\n activations?: number;\n rateLimitingJsonata?: string | null;\n }\n interface RuleMetadata {\n /** default value is 'true', when this is set to 'false' user wont be able to toggle off the rule */\n canBeSuspended?: boolean | null;\n /** additional notes to describe the rule */\n notes?: string | null;\n /** will be used to indicate to user how urgent is this change during \"version\" changes */\n versionType?: VersionType;\n }\n enum VersionType {\n UNKNOWN_VERSION_TYPE = \"UNKNOWN_VERSION_TYPE\",\n MINOR = \"MINOR\",\n MAJOR = \"MAJOR\"\n }\n /** Type */\n enum TemplateType {\n UNKNOWN_TEMPLATE_TYPE = \"UNKNOWN_TEMPLATE_TYPE\",\n PREINSTALLED = \"PREINSTALLED\",\n RECIPE = \"RECIPE\"\n }\n /**\n * {\n * State message examples:\n * precondition_type: PreconditionType.Petri,\n * key: ‘specs.crm.InvoicesSendViaAutomationsABC’,\n * value: ‘C’\n * },\n * {\n * precondition_type: PreconditionType.STATE,\n * key: ‘:double_opt_in’,\n * value: ‘true’\n * },\n * {\n * precondition_type: PreconditionType.APP_DEPENDENCY,\n * key: ‘’,\n * value: ‘true’\n * }\n */\n interface Precondition {\n /** Precondition type */\n preconditionType?: PreconditionType;\n /** Precondition unique key */\n key?: string;\n /** Precondition value */\n value?: string;\n /** Precondition fallback */\n fallback?: boolean | null;\n }\n enum PreconditionType {\n UNKNOWN_PRECONDITION_TYPE = \"UNKNOWN_PRECONDITION_TYPE\",\n PETRI = \"PETRI\",\n STATE = \"STATE\",\n APP_DEPENDENCY = \"APP_DEPENDENCY\",\n DEALER_OFFERING = \"DEALER_OFFERING\"\n }\n enum TemplateState {\n UNKNOWN_TEMPLATE_STATUS = \"UNKNOWN_TEMPLATE_STATUS\",\n INTERNAL = \"INTERNAL\",\n PUBLIC = \"PUBLIC\",\n ARCHIVED = \"ARCHIVED\",\n LIVE = \"LIVE\"\n }\n interface Translation {\n state?: TranslationState;\n }\n enum TranslationState {\n UNKNOWN_TRANSLATION_STATE = \"UNKNOWN_TRANSLATION_STATE\",\n NOT_REQUESTED = \"NOT_REQUESTED\",\n PENDING = \"PENDING\",\n PARTIAL = \"PARTIAL\",\n TRANSLATED = \"TRANSLATED\"\n }\n interface AutomationTemplateEnrichmentData {\n campaignId?: string;\n metaSiteId?: string;\n }\n interface QueryMetadata {\n /** Number of returned items */\n items?: number;\n /** Offset that was applied to the request */\n offset?: number;\n }\n interface QueryAppTemplatesRequest {\n queryType?: TemplateQueryType;\n }\n enum TemplateQueryType {\n TRIGGERED_EMAILS = \"TRIGGERED_EMAILS\",\n PING = \"PING\"\n }\n interface QueryAppTemplatesResponse {\n template?: TemplateData[];\n }\n interface TemplateData {\n templateName?: string;\n templateId?: string;\n }\n interface CampaignLookupRequest {\n campaignId: string;\n }\n interface CampaignLookupResponse {\n campaignId?: string;\n instanceId?: string;\n metasiteId?: string;\n }\n interface CampaignLookupBatchRequest {\n campaignIds?: string[];\n }\n interface CampaignLookupBatchResponse {\n responses?: CampaignLookupResponse[];\n }\n interface UpsertTranslationRequest {\n /** Campaign ID. */\n campaignId: string;\n /** Composer data. */\n composer: Composer;\n /** Translation language (optional, default value \"EN\"). */\n language?: string | null;\n /** For BI event [36:1031] only (optional, default value \"n/a\"). */\n automationRuleId?: string | null;\n /** Should campaign also be published or not (default value \"false\"). */\n publish?: boolean;\n /** Campaign subject (optional). */\n emailSubject?: string | null;\n /** Campaign preheader (optional). */\n emailPreheader?: string | null;\n }\n interface Composer {\n /** Internal data structure for editor/viewer to render the campaign. */\n composerDataJson?: string;\n /** Default values of existing placeholders. */\n defaultValues?: DefaultValues;\n }\n interface DefaultValues {\n map?: Record;\n }\n interface UpsertTranslationResponse {\n }\n interface GetUsedPlaceholderKeysRequest {\n /** Campaign ID. */\n campaignId: string;\n }\n interface GetUsedPlaceholderKeysResponse {\n /** Keys of placeholders used in the automation. */\n placeholderKeys?: string[];\n }\n interface GetCampaignRequest {\n /** Campaign ID. */\n campaignId: string;\n /**\n * Whether a returned campaign object should include `publishingData.statistics`.\n * Default: `false`\n */\n optionIncludeStatistics?: boolean;\n }\n interface GetCampaignResponse {\n /** Campaign information. */\n campaign?: Campaign;\n }\n interface ListCampaignsRequest {\n /** Paging parameters. */\n paging?: Paging;\n /**\n * Whether to include `publishingData.statistics` in the returned campaign object.\n * Default: `false`\n */\n optionIncludeStatistics?: boolean;\n /**\n * Include campaigns with the following statuses (no filtering by default). One of:\n * + `'ACTIVE'`\n * + `'ARCHIVED'`\n * + `'DELETED'`\n */\n statuses?: CampaignStatusEnum[];\n /**\n * Include campaigns with the following visibility statuses (no filtering by default). One of:\n * + `'DRAFT'`\n * + `'PUBLISHED'`\n * + `'TEMPLATE'`\n */\n visibilityStatuses?: CampaignVisibilityStatusEnum[];\n /**\n * Filter by the following campaign types. One of:\n * + `'EMAIL_MARKETING'`\n * + `INVITATION'`\n * + `'AUTOMATION'`\n * + `'TRIGGERED'`\n */\n campaignType?: CampaignTypeEnum;\n }\n interface ListCampaignsResponse {\n /** Paging parameters. */\n paging?: Paging;\n /** List of campaigns. */\n campaigns?: Campaign[];\n }\n interface CountCampaignsRequest {\n /** Since when should we start counting (optional, default value \"1970-01-01T00:00:00.000Z\") */\n dateFrom?: Date;\n }\n interface CountCampaignsResponse {\n /** \"drafts\" + \"scheduled\" + \"published\" (excluding \"archived\"). */\n total?: number;\n /** Non published (draft) campaigns. */\n drafts?: number;\n /** Campaigns scheduled for publishing in the future. */\n scheduled?: number;\n /** Campaigns published or sent. */\n published?: number;\n /** Campaigns moved to archive (regardless of the status). */\n archived?: number;\n }\n interface CreateFromTemplateRequest {\n /** ID of the template to fork. */\n templateId: string;\n /** Values to replace template placeholders with (unique for each template). */\n variables?: Record;\n /** Campaign type. */\n campaignType?: CampaignTypeEnum;\n /** Campaign editor type. Either web app or mobile app. */\n campaignEditorType?: CampaignEditorTypeEnum;\n }\n interface CreateFromTemplateResponse {\n /** Campaign information. */\n campaign?: Campaign;\n }\n interface CreateUserTemplateRequest {\n /** ID of campaign to create template from. */\n campaignId: string;\n /** Title of template. */\n title?: string | null;\n }\n interface CreateUserTemplateResponse {\n /** Created user template information. */\n campaign?: Campaign;\n }\n interface CreateFromUserTemplateRequest {\n /** ID of the user template campaign to use. */\n campaignId: string;\n }\n interface CreateFromUserTemplateResponse {\n /** Campaign created from user template. */\n campaign?: Campaign;\n }\n interface PublishCampaignRequest {\n /** Campaign ID */\n campaignId: string;\n /** Email distribution options - provided only if marketing campaign is intended to be distributed via email. */\n emailDistributionOptions?: EmailDistributionOptions;\n }\n interface EmailDistributionOptions {\n /** Subject of an email sent to recipient. */\n emailSubject?: string | null;\n /** Label IDs to send campaign to. */\n labelIds?: string[];\n /** Contact IDs to send campaign to. */\n contactIds?: string[];\n /**\n * Filter ids to send campaign to (unsupported).\n * @deprecated Filter ids to send campaign to (unsupported).\n * @replacedBy contacts_filter\n * @targetRemovalDate 2023-10-10\n */\n filterIds?: string[];\n /** For scheduling (at least one hour in the future, for premium users only). */\n sendAt?: Date;\n }\n interface PublishCampaignResponse {\n /** `publishingData.statistics` will be empty. */\n publishingData?: PublishingData;\n }\n interface CampaignRejectedEvent {\n /** ID of the campaign that was rejected. */\n campaignId?: string;\n }\n interface CampaignPublishedEvent {\n /** ID of the campaign that was published. */\n campaignId?: string;\n /** Campaign landing page URL. */\n landingPageUrl?: string;\n /** Estimation of recipient list size (optional). */\n mailingListSizeEstimate?: number | null;\n }\n interface CampaignTerminatedEvent {\n /** ID of the campaign that was terminated. */\n campaignId?: string;\n }\n interface CampaignDistributedEvent {\n /** ID of the campaign that was distributed. */\n campaignId?: string;\n }\n interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf {\n click?: Click;\n /** Recipient opened an email. */\n open?: Open;\n /**\n * Email soft bounced when sent to a recipient.\n *\n * Indicates a temporary issue sending your email. For example, the email server receiving the email is under a heavy load.\n * For soft bounces, you should wait and try again at a later time.\n */\n softBounce?: SoftBounce;\n /**\n * Email hard bounced when sent to a recipient.\n *\n * Indicates a permanent error sending your email. For example, the email address does not exist.\n */\n hardBounce?: HardBounce;\n /** Campaign ID. */\n campaignId?: string;\n /** [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of recipient. */\n contactId?: string;\n /** Email address of recipient. */\n recipientEmailAddress?: string;\n /** Date and time of the event. */\n timestamp?: Date;\n activityType?: ActivityType;\n /** email metadata */\n metadata?: Record;\n }\n /** @oneof */\n interface EmailActivityUpdatedEventTypeOneOf {\n click?: Click;\n /** Recipient opened an email. */\n open?: Open;\n /**\n * Email soft bounced when sent to a recipient.\n *\n * Indicates a temporary issue sending your email. For example, the email server receiving the email is under a heavy load.\n * For soft bounces, you should wait and try again at a later time.\n */\n softBounce?: SoftBounce;\n /**\n * Email hard bounced when sent to a recipient.\n *\n * Indicates a permanent error sending your email. For example, the email address does not exist.\n */\n hardBounce?: HardBounce;\n }\n /** The type of email activity that triggered the webhook. */\n enum ActivityType {\n /** Triggered when email is delivered to the recipient. */\n DELIVERY = \"DELIVERY\",\n /** Triggered when the recipient clicks on an url inside of the email. */\n CLICK = \"CLICK\",\n /** Triggered when the email is opened by the recipient. */\n OPEN = \"OPEN\",\n /** Triggered when the email is bounced softly. */\n SOFT_BOUNCE = \"SOFT_BOUNCE\",\n /** Triggered when the email bounces. */\n HARD_BOUNCED = \"HARD_BOUNCED\"\n }\n interface Click {\n /** URL that was clicked. */\n url?: string;\n /** Browser user agent of the recipient. */\n userAgent?: string;\n }\n interface Open {\n /** Browser user agent of the recipient. */\n userAgent?: string;\n }\n interface SoftBounce {\n /** Reason the email soft bounced. */\n reason?: string;\n }\n interface HardBounce {\n /** Reason the email hard bounced. */\n reason?: string;\n }\n interface CampaignScheduledEvent {\n /** ID of the campaign that was scheduled. */\n campaignId?: string;\n /** The timestamp campaign is scheduled for. */\n sendAt?: Date;\n }\n interface SendTestRequest {\n /** Campaign ID. */\n campaignId: string;\n /** Subject of an email sent to recipient. */\n emailSubject?: string | null;\n /** Recipient's email address. */\n toEmailAddress: string;\n }\n interface PlaceholderContent extends PlaceholderContentValueOneOf {\n text?: PlainText;\n html?: Html;\n money?: Money;\n dateTime?: DateTime;\n map?: Map;\n array?: _Array;\n enum?: PlaceholderContentEnum;\n attachment?: Attachment;\n integer?: Integer;\n decimal?: Decimal;\n }\n /** @oneof */\n interface PlaceholderContentValueOneOf {\n text?: PlainText;\n html?: Html;\n money?: Money;\n dateTime?: DateTime;\n map?: Map;\n array?: _Array;\n enum?: PlaceholderContentEnum;\n attachment?: Attachment;\n integer?: Integer;\n decimal?: Decimal;\n }\n interface PlainText {\n text?: string;\n }\n interface Html {\n html?: string;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface Money {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n formattedValue?: string | null;\n }\n interface DateTime {\n timestamp?: Date;\n /** optional time zone is the full name. example: \"Asia/Jerusalem\" */\n timeZone?: string | null;\n }\n interface Map {\n variables?: Record;\n }\n interface _Array {\n items?: PlaceholderContent[];\n }\n interface PlaceholderContentEnum {\n value?: string;\n translation?: string;\n }\n interface Attachment {\n fileName?: string;\n downloadUrl?: string;\n }\n interface Integer {\n /** min value: -2147483648, max value: 2147483647 */\n value?: number;\n }\n interface Decimal {\n /**\n * when converted from Double, has a limitation of max 16 digits (including fractional part)\n * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)\n */\n value?: string;\n }\n interface SendTestResponse {\n }\n interface PauseSchedulingRequest {\n /** Campaign ID. */\n campaignId: string;\n }\n interface PauseSchedulingResponse {\n }\n interface CampaignPausedEvent {\n /** ID of the campaign that was paused. */\n campaignId?: string;\n }\n interface RescheduleRequest {\n /** ID of the campaign to reschedule. */\n campaignId: string;\n /** New time that this email marketing campaign should be sent at. */\n sendAt: Date;\n }\n interface RescheduleResponse {\n }\n interface ArchiveCampaignRequest {\n /** ID of the campaign to archive. */\n campaignId: string;\n }\n interface ArchiveCampaignResponse {\n }\n /** Sent when status of the campaign is changed from \"Active\" to \"Archived\" */\n interface CampaignArchivedEvent {\n /** ID of the campaign that was archived. */\n campaignId?: string;\n }\n interface UnarchiveCampaignRequest {\n /** ID of the campaign to unarchive. */\n campaignId: string;\n }\n interface UnarchiveCampaignResponse {\n }\n /** Sent when status of the campaign is changed from \"Archived\" to \"Active\" */\n interface CampaignUnarchivedEvent {\n /** ID of the campaign whose status was changed to active. */\n campaignId?: string;\n }\n interface UpdateTitleRequest {\n /** ID of the campaign to change title of. */\n campaignId: string;\n title: string;\n }\n interface UpdateTitleResponse {\n }\n interface DeleteCampaignRequest {\n /** Campaign ID. */\n campaignId: string;\n }\n interface DeleteCampaignResponse {\n }\n interface ReuseCampaignRequest {\n /** ID of the message to be duplicated. */\n campaignId: string;\n }\n interface ReuseCampaignResponse {\n /** Campaign information. */\n campaign?: Campaign;\n }\n interface PreviewCampaignRequest {\n /** ID of the campaign to preview. */\n campaignId: string;\n /** Preferred language for campaign content (optional). */\n language?: string | null;\n /** Values to replace campaign placeholders with (unique for each campaign). */\n placeholders?: Record;\n /** Whether to hide the ad (default value \"false\"). */\n forceHideAd?: boolean;\n }\n interface PreviewCampaignResponse {\n /** Preview HTML. */\n html?: string;\n }\n interface GetComposerRequest {\n /** Campaign ID. */\n campaignId: string;\n /** Preferred language for campaign content (optional). */\n language?: string | null;\n }\n interface GetComposerResponse {\n /** Composer. */\n composer?: Composer;\n /** Campaign subject. */\n emailSubject?: string;\n /** Campaign preheader (optional). */\n emailPreheader?: string | null;\n }\n interface UpdateComposerRequest {\n /** Campaign ID. */\n campaignId: string;\n /** Campaign composer. */\n composer: Composer;\n /** Campaign editor type. Either web app or mobile app (optional, default \"Web\"). */\n campaignEditorType?: CampaignEditorType;\n /** Campaign subject (optional). */\n emailSubject?: string | null;\n /** Campaign preheader (optional). */\n emailPreheader?: string | null;\n }\n /** specifies if campaign is being created and edited in web or mobile app */\n interface CampaignEditorType {\n value?: CampaignEditorTypeEnum;\n }\n interface UpdateComposerResponse {\n }\n interface CreateCampaignRequest {\n /** Campaign composer. */\n composer: Composer;\n /** Campaign editor type. Either web app or mobile app (optional, default \"Web\"). */\n campaignEditorType?: CampaignEditorType;\n }\n interface CreateCampaignResponse {\n /** Campaign information. */\n campaign?: Campaign;\n }\n interface ResendToNonOpenersRequest {\n /** ID of the campaign to resend. */\n campaignId: string;\n /** Subject line to use with the resent copy of campaign. */\n emailSubject?: string | null;\n }\n interface ResendToNonOpenersResponse {\n /** ID of the newly created and resent campaign. */\n campaignId?: string;\n }\n interface EstimateFilterSizeOptions {\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n /** Contacts plain text search expression (searches in name, phone and email fields). */\n search?: string | null;\n }\n interface EstimateAudienceSizeOptions {\n /** Contact IDs of a campaign audience. */\n contactIds?: string[];\n /** Label IDs of a campaign audience. */\n labelIds?: string[];\n /** Contacts filter expression (json). */\n contactsFilter?: Record | null;\n /** Contacts plain text search expression (searches in name, phone and email fields). */\n search?: string | null;\n /** Segment ids of a campaign audience. */\n segmentIds?: string[];\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n /** Id of a campaign that is to be resent. */\n resendCampaignId?: string | null;\n /** Should total number of contacts in provided audience be returned or not (default value \"false\"). */\n withTotal?: boolean;\n }\n interface SearchContactsOptions {\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n /** Page size (default 50, max 1000). */\n pageSize?: number | null;\n }\n interface GetLabelsOptions {\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n }\n interface SubscribeFromLandingPageOptions {\n /** Email address that is entered into subscription field. */\n emailAddress: string;\n /** Did UoU explicitly consent to terms of use or not (optional, default value \"false\") */\n consent?: boolean;\n }\n /**\n * Retrieves a list of statistics for up to 100 selected campaigns.\n *\n * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total\n * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.\n *\n * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.\n * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.\n * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).\n * @public\n * @documentationMaturity preview\n * @requiredField campaignIds\n * @permissionScope Read Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function listStatistics(campaignIds: string[]): Promise;\n /**\n * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.\n *\n * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.\n *\n * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.\n * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.\n *\n * If no `activity` is included, this endpoint returns an error.\n *\n * @param campaignId - Campaign ID.\n * @param activity - __Required.__ Email activity to filter for. One of:\n * + `'DELIVERED'`\n * + `'OPENED'`\n * + `'CLICKED'`\n * + `'BOUNCED'`\n * + `'NOT_SENT'`\n * @public\n * @documentationMaturity preview\n * @requiredField activity\n * @requiredField campaignId\n * @param options - Options to use when getting the list of recipients.\n * @permissionScope Read Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise;\n interface ListRecipientsOptions {\n /** Pagination options. */\n paging?: CursorPaging;\n }\n interface GetCampaignMappingIdentifiers {\n /** rule ID in automations */\n automationRuleId: string;\n /** template ID configured for the automation */\n templateId: string;\n }\n interface GetPingCampaignMappingIdentifiers {\n /** rule ID in automations */\n automationRuleId: string;\n /** template ID configured for the ping automation. */\n templateId: string;\n }\n interface GetPingCampaignMappingOptions {\n /** ID of the initiating vertical. */\n appDefId: string;\n /** Ping template ID. */\n pingTemplateId?: string | null;\n /** Preferred language. */\n language: string;\n }\n interface QueryAutomationTemplatesOptions {\n /** https://github.com/wix-private/p13n/blob/master/protos/query/src/main/proto/wix/common/query.proto */\n query?: Query;\n }\n interface QueryAppTemplatesOptions {\n queryType?: TemplateQueryType;\n }\n interface CampaignLookupBatchOptions {\n campaignIds?: string[];\n }\n interface UpsertTranslationOptions {\n /** Translation language (optional, default value \"EN\"). */\n language?: string | null;\n /** For BI event [36:1031] only (optional, default value \"n/a\"). */\n automationRuleId?: string | null;\n /** Should campaign also be published or not (default value \"false\"). */\n publish?: boolean;\n /** Campaign subject (optional). */\n emailSubject?: string | null;\n /** Campaign preheader (optional). */\n emailPreheader?: string | null;\n }\n /**\n * Retrieves information about an email campaign by the specified ID.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @param options - Options to use when getting a campaign.\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n * @returns Campaign information.\n */\n function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise;\n interface GetCampaignOptions {\n /**\n * Whether a returned campaign object should include `publishingData.statistics`.\n * Default: `false`\n */\n optionIncludeStatistics?: boolean;\n }\n /**\n * Returns a list of email campaigns.\n *\n * Default sort by `date_updated` in `desc` order.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when getting the list of campaigns.\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function listCampaigns(options?: ListCampaignsOptions): Promise;\n interface ListCampaignsOptions {\n /** Paging parameters. */\n paging?: Paging;\n /**\n * Whether to include `publishingData.statistics` in the returned campaign object.\n * Default: `false`\n */\n optionIncludeStatistics?: boolean;\n /**\n * Include campaigns with the following statuses (no filtering by default). One of:\n * + `'ACTIVE'`\n * + `'ARCHIVED'`\n * + `'DELETED'`\n */\n statuses?: CampaignStatusEnum[];\n /**\n * Include campaigns with the following visibility statuses (no filtering by default). One of:\n * + `'ACTIVE'`\n * + `'ARCHIVED'`\n * + `'DELETED'`\n */\n visibilityStatuses?: CampaignVisibilityStatusEnum[];\n /**\n * Filter by the following campaign types. One of:\n * + `'EMAIL_MARKETING'`\n * + `INVITATION'`\n * + `'AUTOMATION'`\n * + `'TRIGGERED'`\n */\n campaignType?: CampaignTypeEnum;\n }\n interface CountOptions {\n /** Since when should we start counting (optional, default value \"1970-01-01T00:00:00.000Z\") */\n dateFrom?: Date;\n }\n interface CreateFromTemplateOptions {\n /** Values to replace template placeholders with (unique for each template). */\n variables?: Record;\n /** Campaign type. */\n campaignType?: CampaignTypeEnum;\n /** Campaign editor type. Either web app or mobile app. */\n campaignEditorType?: CampaignEditorTypeEnum;\n }\n interface CreateUserTemplateOptions {\n /** Title of template. */\n title?: string | null;\n }\n /**\n * Publishes/sends a specified campaign.\n *\n * If no `emailDistributionOptions` parameters are specified, the campaign is only published as a landing page.\n * @param campaignId - Campaign ID\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @param options - Options to use when publishing a campaign.\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise;\n interface PublishCampaignOptions {\n /** Email distribution options - provided only if marketing campaign is intended to be distributed via email. */\n emailDistributionOptions?: EmailDistributionOptions;\n }\n /**\n * Sends a test email for preview purposes.\n *\n * It is heavily throttled, so don't use this for regular campaign sending.\n *\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField options.toEmailAddress\n * @param options - Options for sending a test email.\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function sendTest(campaignId: string, options?: SendTestOptions): Promise;\n interface SendTestOptions {\n /** Subject of an email sent to recipient. */\n emailSubject?: string | null;\n /** Recipient's email address. */\n toEmailAddress: string;\n }\n /**\n * Pauses a scheduled campaign.\n *\n * Learn more about [market campaign scheduling](https://support.wix.com/en/article/managing-your-scheduled-email-marketing-campaign).\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function pauseScheduling(campaignId: string): Promise;\n /**\n * Change sending time for already scheduled campaign.\n * @param campaignId - ID of the campaign to reschedule.\n * @param sendAt - New time that this email marketing campaign should be sent at.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField sendAt\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function reschedule(campaignId: string, sendAt: Date): Promise;\n /**\n * Permanently deletes a campaign.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteCampaign(campaignId: string): Promise;\n /**\n * Creates a (draft) copy of an existing campaign.\n *\n * @param campaignId - ID of the message to be duplicated.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function reuseCampaign(campaignId: string): Promise;\n interface PreviewOptions {\n /** Preferred language for campaign content (optional). */\n language?: string | null;\n /** Values to replace campaign placeholders with (unique for each campaign). */\n placeholders?: Record;\n /** Whether to hide the ad (default value \"false\"). */\n forceHideAd?: boolean;\n }\n interface GetComposerOptions {\n /** Preferred language for campaign content (optional). */\n language?: string | null;\n }\n interface UpdateComposerOptions {\n /** Campaign editor type. Either web app or mobile app (optional, default \"Web\"). */\n campaignEditorType?: CampaignEditorType;\n /** Campaign subject (optional). */\n emailSubject?: string | null;\n /** Campaign preheader (optional). */\n emailPreheader?: string | null;\n }\n interface CreateOptions {\n /** Campaign editor type. Either web app or mobile app (optional, default \"Web\"). */\n campaignEditorType?: CampaignEditorType;\n }\n interface ResendToNonOpenersOptions {\n /** Subject line to use with the resent copy of campaign. */\n emailSubject?: string | null;\n }\n type emailMarketingV1CampaignCampaigns_universal_d_Campaign = Campaign;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignEditorTypeEnum = CampaignEditorTypeEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_CampaignEditorTypeEnum: typeof CampaignEditorTypeEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignStatusEnum = CampaignStatusEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_CampaignStatusEnum: typeof CampaignStatusEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignVisibilityStatusEnum = CampaignVisibilityStatusEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_CampaignVisibilityStatusEnum: typeof CampaignVisibilityStatusEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_Enum = Enum;\n const emailMarketingV1CampaignCampaigns_universal_d_Enum: typeof Enum;\n type emailMarketingV1CampaignCampaigns_universal_d_PublishingData = PublishingData;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignStatistics = CampaignStatistics;\n type emailMarketingV1CampaignCampaigns_universal_d_LandingPageStatistics = LandingPageStatistics;\n type emailMarketingV1CampaignCampaigns_universal_d_DistributionStatistics = DistributionStatistics;\n type emailMarketingV1CampaignCampaigns_universal_d_TotalStatistics = TotalStatistics;\n type emailMarketingV1CampaignCampaigns_universal_d_RejectionData = RejectionData;\n type emailMarketingV1CampaignCampaigns_universal_d_RejectionReasonEnum = RejectionReasonEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_RejectionReasonEnum: typeof RejectionReasonEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignSendingStateEnum = CampaignSendingStateEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_CampaignSendingStateEnum: typeof CampaignSendingStateEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignTypeEnum = CampaignTypeEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_CampaignTypeEnum: typeof CampaignTypeEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_EstimateFilterSizeRequest = EstimateFilterSizeRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_EstimateFilterSizeResponse = EstimateFilterSizeResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_EstimateAudienceSizeRequest = EstimateAudienceSizeRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_EstimateAudienceSizeResponse = EstimateAudienceSizeResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ReconcileContactRequest = ReconcileContactRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ReconcileContactResponse = ReconcileContactResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_Contact = Contact;\n type emailMarketingV1CampaignCampaigns_universal_d_SearchContactsRequest = SearchContactsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_SearchContactsResponse = SearchContactsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetLabelsRequest = GetLabelsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetLabelsResponse = GetLabelsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_Label = Label;\n type emailMarketingV1CampaignCampaigns_universal_d_SubscribeFromLandingPageRequest = SubscribeFromLandingPageRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_SubscribeFromLandingPageResponse = SubscribeFromLandingPageResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetPlaceholderKeysRequest = GetPlaceholderKeysRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetPlaceholderKeysResponse = GetPlaceholderKeysResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetDefaultComponentsRequest = GetDefaultComponentsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetDefaultComponentsResponse = GetDefaultComponentsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_RestoreInfo = RestoreInfo;\n type emailMarketingV1CampaignCampaigns_universal_d_ValidateLinkRequest = ValidateLinkRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ValidateLinkResponse = ValidateLinkResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ValidateHtmlLinksRequest = ValidateHtmlLinksRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ValidateHtmlLinksResponse = ValidateHtmlLinksResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ListStatisticsRequest = ListStatisticsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ListStatisticsResponse = ListStatisticsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignStatisticsContainer = CampaignStatisticsContainer;\n type emailMarketingV1CampaignCampaigns_universal_d_ListRecipientsRequest = ListRecipientsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_RecipientsActivityEnum = RecipientsActivityEnum;\n const emailMarketingV1CampaignCampaigns_universal_d_RecipientsActivityEnum: typeof RecipientsActivityEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_CursorPaging = CursorPaging;\n type emailMarketingV1CampaignCampaigns_universal_d_ListRecipientsResponse = ListRecipientsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignRecipientDetails = CampaignRecipientDetails;\n type emailMarketingV1CampaignCampaigns_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type emailMarketingV1CampaignCampaigns_universal_d_Cursors = Cursors;\n type emailMarketingV1CampaignCampaigns_universal_d_UnprocessedTargetEvent = UnprocessedTargetEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_Target = Target;\n type emailMarketingV1CampaignCampaigns_universal_d_TargetType = TargetType;\n const emailMarketingV1CampaignCampaigns_universal_d_TargetType: typeof TargetType;\n type emailMarketingV1CampaignCampaigns_universal_d_File = File;\n type emailMarketingV1CampaignCampaigns_universal_d_GetCampaignMappingRequest = GetCampaignMappingRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetCampaignMappingResponse = GetCampaignMappingResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingRequest = GetPingCampaignMappingRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingResponse = GetPingCampaignMappingResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryAutomationTemplatesRequest = QueryAutomationTemplatesRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_Query = Query;\n type emailMarketingV1CampaignCampaigns_universal_d_Sorting = Sorting;\n type emailMarketingV1CampaignCampaigns_universal_d_SortOrder = SortOrder;\n const emailMarketingV1CampaignCampaigns_universal_d_SortOrder: typeof SortOrder;\n type emailMarketingV1CampaignCampaigns_universal_d_Paging = Paging;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryAutomationTemplatesResponse = QueryAutomationTemplatesResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_AutomationTemplateContainer = AutomationTemplateContainer;\n type emailMarketingV1CampaignCampaigns_universal_d_AutomationTemplate = AutomationTemplate;\n type emailMarketingV1CampaignCampaigns_universal_d_RuleConfiguration = RuleConfiguration;\n type emailMarketingV1CampaignCampaigns_universal_d_ConditionConfiguration = ConditionConfiguration;\n type emailMarketingV1CampaignCampaigns_universal_d_Operator = Operator;\n const emailMarketingV1CampaignCampaigns_universal_d_Operator: typeof Operator;\n type emailMarketingV1CampaignCampaigns_universal_d_TriggerConfiguration = TriggerConfiguration;\n type emailMarketingV1CampaignCampaigns_universal_d_ActionConfiguration = ActionConfiguration;\n type emailMarketingV1CampaignCampaigns_universal_d_RuleStatus = RuleStatus;\n const emailMarketingV1CampaignCampaigns_universal_d_RuleStatus: typeof RuleStatus;\n type emailMarketingV1CampaignCampaigns_universal_d_ActivationCycle = ActivationCycle;\n type emailMarketingV1CampaignCampaigns_universal_d_RuleMetadata = RuleMetadata;\n type emailMarketingV1CampaignCampaigns_universal_d_VersionType = VersionType;\n const emailMarketingV1CampaignCampaigns_universal_d_VersionType: typeof VersionType;\n type emailMarketingV1CampaignCampaigns_universal_d_TemplateType = TemplateType;\n const emailMarketingV1CampaignCampaigns_universal_d_TemplateType: typeof TemplateType;\n type emailMarketingV1CampaignCampaigns_universal_d_Precondition = Precondition;\n type emailMarketingV1CampaignCampaigns_universal_d_PreconditionType = PreconditionType;\n const emailMarketingV1CampaignCampaigns_universal_d_PreconditionType: typeof PreconditionType;\n type emailMarketingV1CampaignCampaigns_universal_d_TemplateState = TemplateState;\n const emailMarketingV1CampaignCampaigns_universal_d_TemplateState: typeof TemplateState;\n type emailMarketingV1CampaignCampaigns_universal_d_Translation = Translation;\n type emailMarketingV1CampaignCampaigns_universal_d_TranslationState = TranslationState;\n const emailMarketingV1CampaignCampaigns_universal_d_TranslationState: typeof TranslationState;\n type emailMarketingV1CampaignCampaigns_universal_d_AutomationTemplateEnrichmentData = AutomationTemplateEnrichmentData;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryMetadata = QueryMetadata;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryAppTemplatesRequest = QueryAppTemplatesRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_TemplateQueryType = TemplateQueryType;\n const emailMarketingV1CampaignCampaigns_universal_d_TemplateQueryType: typeof TemplateQueryType;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryAppTemplatesResponse = QueryAppTemplatesResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_TemplateData = TemplateData;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupRequest = CampaignLookupRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupResponse = CampaignLookupResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupBatchRequest = CampaignLookupBatchRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupBatchResponse = CampaignLookupBatchResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_UpsertTranslationRequest = UpsertTranslationRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_Composer = Composer;\n type emailMarketingV1CampaignCampaigns_universal_d_DefaultValues = DefaultValues;\n type emailMarketingV1CampaignCampaigns_universal_d_UpsertTranslationResponse = UpsertTranslationResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetUsedPlaceholderKeysRequest = GetUsedPlaceholderKeysRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetUsedPlaceholderKeysResponse = GetUsedPlaceholderKeysResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetCampaignRequest = GetCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetCampaignResponse = GetCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ListCampaignsRequest = ListCampaignsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ListCampaignsResponse = ListCampaignsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CountCampaignsRequest = CountCampaignsRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CountCampaignsResponse = CountCampaignsResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateFromTemplateRequest = CreateFromTemplateRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateFromTemplateResponse = CreateFromTemplateResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateUserTemplateRequest = CreateUserTemplateRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateUserTemplateResponse = CreateUserTemplateResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateFromUserTemplateRequest = CreateFromUserTemplateRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateFromUserTemplateResponse = CreateFromUserTemplateResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_PublishCampaignRequest = PublishCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_EmailDistributionOptions = EmailDistributionOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_PublishCampaignResponse = PublishCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignRejectedEvent = CampaignRejectedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignPublishedEvent = CampaignPublishedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignTerminatedEvent = CampaignTerminatedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignDistributedEvent = CampaignDistributedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_EmailActivityUpdated = EmailActivityUpdated;\n type emailMarketingV1CampaignCampaigns_universal_d_EmailActivityUpdatedEventTypeOneOf = EmailActivityUpdatedEventTypeOneOf;\n type emailMarketingV1CampaignCampaigns_universal_d_ActivityType = ActivityType;\n const emailMarketingV1CampaignCampaigns_universal_d_ActivityType: typeof ActivityType;\n type emailMarketingV1CampaignCampaigns_universal_d_Click = Click;\n type emailMarketingV1CampaignCampaigns_universal_d_Open = Open;\n type emailMarketingV1CampaignCampaigns_universal_d_SoftBounce = SoftBounce;\n type emailMarketingV1CampaignCampaigns_universal_d_HardBounce = HardBounce;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignScheduledEvent = CampaignScheduledEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_SendTestRequest = SendTestRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_PlaceholderContent = PlaceholderContent;\n type emailMarketingV1CampaignCampaigns_universal_d_PlaceholderContentValueOneOf = PlaceholderContentValueOneOf;\n type emailMarketingV1CampaignCampaigns_universal_d_PlainText = PlainText;\n type emailMarketingV1CampaignCampaigns_universal_d_Html = Html;\n type emailMarketingV1CampaignCampaigns_universal_d_Money = Money;\n type emailMarketingV1CampaignCampaigns_universal_d_DateTime = DateTime;\n type emailMarketingV1CampaignCampaigns_universal_d_Map = Map;\n type emailMarketingV1CampaignCampaigns_universal_d__Array = _Array;\n type emailMarketingV1CampaignCampaigns_universal_d_PlaceholderContentEnum = PlaceholderContentEnum;\n type emailMarketingV1CampaignCampaigns_universal_d_Attachment = Attachment;\n type emailMarketingV1CampaignCampaigns_universal_d_Integer = Integer;\n type emailMarketingV1CampaignCampaigns_universal_d_Decimal = Decimal;\n type emailMarketingV1CampaignCampaigns_universal_d_SendTestResponse = SendTestResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_PauseSchedulingRequest = PauseSchedulingRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_PauseSchedulingResponse = PauseSchedulingResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignPausedEvent = CampaignPausedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_RescheduleRequest = RescheduleRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_RescheduleResponse = RescheduleResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ArchiveCampaignRequest = ArchiveCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ArchiveCampaignResponse = ArchiveCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignArchivedEvent = CampaignArchivedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_UnarchiveCampaignRequest = UnarchiveCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_UnarchiveCampaignResponse = UnarchiveCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignUnarchivedEvent = CampaignUnarchivedEvent;\n type emailMarketingV1CampaignCampaigns_universal_d_UpdateTitleRequest = UpdateTitleRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_UpdateTitleResponse = UpdateTitleResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_DeleteCampaignRequest = DeleteCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_DeleteCampaignResponse = DeleteCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ReuseCampaignRequest = ReuseCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ReuseCampaignResponse = ReuseCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_PreviewCampaignRequest = PreviewCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_PreviewCampaignResponse = PreviewCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_GetComposerRequest = GetComposerRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_GetComposerResponse = GetComposerResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_UpdateComposerRequest = UpdateComposerRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignEditorType = CampaignEditorType;\n type emailMarketingV1CampaignCampaigns_universal_d_UpdateComposerResponse = UpdateComposerResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateCampaignRequest = CreateCampaignRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateCampaignResponse = CreateCampaignResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_ResendToNonOpenersRequest = ResendToNonOpenersRequest;\n type emailMarketingV1CampaignCampaigns_universal_d_ResendToNonOpenersResponse = ResendToNonOpenersResponse;\n type emailMarketingV1CampaignCampaigns_universal_d_EstimateFilterSizeOptions = EstimateFilterSizeOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_EstimateAudienceSizeOptions = EstimateAudienceSizeOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_SearchContactsOptions = SearchContactsOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_GetLabelsOptions = GetLabelsOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_SubscribeFromLandingPageOptions = SubscribeFromLandingPageOptions;\n const emailMarketingV1CampaignCampaigns_universal_d_listStatistics: typeof listStatistics;\n const emailMarketingV1CampaignCampaigns_universal_d_listRecipients: typeof listRecipients;\n type emailMarketingV1CampaignCampaigns_universal_d_ListRecipientsOptions = ListRecipientsOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_GetCampaignMappingIdentifiers = GetCampaignMappingIdentifiers;\n type emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingIdentifiers = GetPingCampaignMappingIdentifiers;\n type emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingOptions = GetPingCampaignMappingOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryAutomationTemplatesOptions = QueryAutomationTemplatesOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_QueryAppTemplatesOptions = QueryAppTemplatesOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupBatchOptions = CampaignLookupBatchOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_UpsertTranslationOptions = UpsertTranslationOptions;\n const emailMarketingV1CampaignCampaigns_universal_d_getCampaign: typeof getCampaign;\n type emailMarketingV1CampaignCampaigns_universal_d_GetCampaignOptions = GetCampaignOptions;\n const emailMarketingV1CampaignCampaigns_universal_d_listCampaigns: typeof listCampaigns;\n type emailMarketingV1CampaignCampaigns_universal_d_ListCampaignsOptions = ListCampaignsOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_CountOptions = CountOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateFromTemplateOptions = CreateFromTemplateOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateUserTemplateOptions = CreateUserTemplateOptions;\n const emailMarketingV1CampaignCampaigns_universal_d_publishCampaign: typeof publishCampaign;\n type emailMarketingV1CampaignCampaigns_universal_d_PublishCampaignOptions = PublishCampaignOptions;\n const emailMarketingV1CampaignCampaigns_universal_d_sendTest: typeof sendTest;\n type emailMarketingV1CampaignCampaigns_universal_d_SendTestOptions = SendTestOptions;\n const emailMarketingV1CampaignCampaigns_universal_d_pauseScheduling: typeof pauseScheduling;\n const emailMarketingV1CampaignCampaigns_universal_d_reschedule: typeof reschedule;\n const emailMarketingV1CampaignCampaigns_universal_d_deleteCampaign: typeof deleteCampaign;\n const emailMarketingV1CampaignCampaigns_universal_d_reuseCampaign: typeof reuseCampaign;\n type emailMarketingV1CampaignCampaigns_universal_d_PreviewOptions = PreviewOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_GetComposerOptions = GetComposerOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_UpdateComposerOptions = UpdateComposerOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_CreateOptions = CreateOptions;\n type emailMarketingV1CampaignCampaigns_universal_d_ResendToNonOpenersOptions = ResendToNonOpenersOptions;\n namespace emailMarketingV1CampaignCampaigns_universal_d {\n export { emailMarketingV1CampaignCampaigns_universal_d_Campaign as Campaign, emailMarketingV1CampaignCampaigns_universal_d_CampaignEditorTypeEnum as CampaignEditorTypeEnum, emailMarketingV1CampaignCampaigns_universal_d_CampaignStatusEnum as CampaignStatusEnum, emailMarketingV1CampaignCampaigns_universal_d_CampaignVisibilityStatusEnum as CampaignVisibilityStatusEnum, emailMarketingV1CampaignCampaigns_universal_d_Enum as Enum, emailMarketingV1CampaignCampaigns_universal_d_PublishingData as PublishingData, emailMarketingV1CampaignCampaigns_universal_d_CampaignStatistics as CampaignStatistics, emailMarketingV1CampaignCampaigns_universal_d_LandingPageStatistics as LandingPageStatistics, emailMarketingV1CampaignCampaigns_universal_d_DistributionStatistics as DistributionStatistics, emailMarketingV1CampaignCampaigns_universal_d_TotalStatistics as TotalStatistics, emailMarketingV1CampaignCampaigns_universal_d_RejectionData as RejectionData, emailMarketingV1CampaignCampaigns_universal_d_RejectionReasonEnum as RejectionReasonEnum, emailMarketingV1CampaignCampaigns_universal_d_CampaignSendingStateEnum as CampaignSendingStateEnum, emailMarketingV1CampaignCampaigns_universal_d_CampaignTypeEnum as CampaignTypeEnum, emailMarketingV1CampaignCampaigns_universal_d_EstimateFilterSizeRequest as EstimateFilterSizeRequest, emailMarketingV1CampaignCampaigns_universal_d_EstimateFilterSizeResponse as EstimateFilterSizeResponse, emailMarketingV1CampaignCampaigns_universal_d_EstimateAudienceSizeRequest as EstimateAudienceSizeRequest, emailMarketingV1CampaignCampaigns_universal_d_EstimateAudienceSizeResponse as EstimateAudienceSizeResponse, emailMarketingV1CampaignCampaigns_universal_d_ReconcileContactRequest as ReconcileContactRequest, emailMarketingV1CampaignCampaigns_universal_d_ReconcileContactResponse as ReconcileContactResponse, emailMarketingV1CampaignCampaigns_universal_d_Contact as Contact, emailMarketingV1CampaignCampaigns_universal_d_SearchContactsRequest as SearchContactsRequest, emailMarketingV1CampaignCampaigns_universal_d_SearchContactsResponse as SearchContactsResponse, emailMarketingV1CampaignCampaigns_universal_d_GetLabelsRequest as GetLabelsRequest, emailMarketingV1CampaignCampaigns_universal_d_GetLabelsResponse as GetLabelsResponse, emailMarketingV1CampaignCampaigns_universal_d_Label as Label, emailMarketingV1CampaignCampaigns_universal_d_SubscribeFromLandingPageRequest as SubscribeFromLandingPageRequest, emailMarketingV1CampaignCampaigns_universal_d_SubscribeFromLandingPageResponse as SubscribeFromLandingPageResponse, emailMarketingV1CampaignCampaigns_universal_d_GetPlaceholderKeysRequest as GetPlaceholderKeysRequest, emailMarketingV1CampaignCampaigns_universal_d_GetPlaceholderKeysResponse as GetPlaceholderKeysResponse, emailMarketingV1CampaignCampaigns_universal_d_GetDefaultComponentsRequest as GetDefaultComponentsRequest, emailMarketingV1CampaignCampaigns_universal_d_GetDefaultComponentsResponse as GetDefaultComponentsResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, emailMarketingV1CampaignCampaigns_universal_d_RestoreInfo as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, emailMarketingV1CampaignCampaigns_universal_d_ValidateLinkRequest as ValidateLinkRequest, emailMarketingV1CampaignCampaigns_universal_d_ValidateLinkResponse as ValidateLinkResponse, emailMarketingV1CampaignCampaigns_universal_d_ValidateHtmlLinksRequest as ValidateHtmlLinksRequest, emailMarketingV1CampaignCampaigns_universal_d_ValidateHtmlLinksResponse as ValidateHtmlLinksResponse, emailMarketingV1CampaignCampaigns_universal_d_ListStatisticsRequest as ListStatisticsRequest, emailMarketingV1CampaignCampaigns_universal_d_ListStatisticsResponse as ListStatisticsResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignStatisticsContainer as CampaignStatisticsContainer, emailMarketingV1CampaignCampaigns_universal_d_ListRecipientsRequest as ListRecipientsRequest, emailMarketingV1CampaignCampaigns_universal_d_RecipientsActivityEnum as RecipientsActivityEnum, emailMarketingV1CampaignCampaigns_universal_d_CursorPaging as CursorPaging, emailMarketingV1CampaignCampaigns_universal_d_ListRecipientsResponse as ListRecipientsResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignRecipientDetails as CampaignRecipientDetails, emailMarketingV1CampaignCampaigns_universal_d_PagingMetadataV2 as PagingMetadataV2, emailMarketingV1CampaignCampaigns_universal_d_Cursors as Cursors, emailMarketingV1CampaignCampaigns_universal_d_UnprocessedTargetEvent as UnprocessedTargetEvent, emailMarketingV1CampaignCampaigns_universal_d_Target as Target, emailMarketingV1CampaignCampaigns_universal_d_TargetType as TargetType, emailMarketingV1CampaignCampaigns_universal_d_File as File, emailMarketingV1CampaignCampaigns_universal_d_GetCampaignMappingRequest as GetCampaignMappingRequest, emailMarketingV1CampaignCampaigns_universal_d_GetCampaignMappingResponse as GetCampaignMappingResponse, emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingRequest as GetPingCampaignMappingRequest, emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingResponse as GetPingCampaignMappingResponse, emailMarketingV1CampaignCampaigns_universal_d_QueryAutomationTemplatesRequest as QueryAutomationTemplatesRequest, emailMarketingV1CampaignCampaigns_universal_d_Query as Query, emailMarketingV1CampaignCampaigns_universal_d_Sorting as Sorting, emailMarketingV1CampaignCampaigns_universal_d_SortOrder as SortOrder, emailMarketingV1CampaignCampaigns_universal_d_Paging as Paging, emailMarketingV1CampaignCampaigns_universal_d_QueryAutomationTemplatesResponse as QueryAutomationTemplatesResponse, emailMarketingV1CampaignCampaigns_universal_d_AutomationTemplateContainer as AutomationTemplateContainer, emailMarketingV1CampaignCampaigns_universal_d_AutomationTemplate as AutomationTemplate, emailMarketingV1CampaignCampaigns_universal_d_RuleConfiguration as RuleConfiguration, emailMarketingV1CampaignCampaigns_universal_d_ConditionConfiguration as ConditionConfiguration, emailMarketingV1CampaignCampaigns_universal_d_Operator as Operator, emailMarketingV1CampaignCampaigns_universal_d_TriggerConfiguration as TriggerConfiguration, emailMarketingV1CampaignCampaigns_universal_d_ActionConfiguration as ActionConfiguration, emailMarketingV1CampaignCampaigns_universal_d_RuleStatus as RuleStatus, emailMarketingV1CampaignCampaigns_universal_d_ActivationCycle as ActivationCycle, emailMarketingV1CampaignCampaigns_universal_d_RuleMetadata as RuleMetadata, emailMarketingV1CampaignCampaigns_universal_d_VersionType as VersionType, emailMarketingV1CampaignCampaigns_universal_d_TemplateType as TemplateType, emailMarketingV1CampaignCampaigns_universal_d_Precondition as Precondition, emailMarketingV1CampaignCampaigns_universal_d_PreconditionType as PreconditionType, emailMarketingV1CampaignCampaigns_universal_d_TemplateState as TemplateState, emailMarketingV1CampaignCampaigns_universal_d_Translation as Translation, emailMarketingV1CampaignCampaigns_universal_d_TranslationState as TranslationState, emailMarketingV1CampaignCampaigns_universal_d_AutomationTemplateEnrichmentData as AutomationTemplateEnrichmentData, emailMarketingV1CampaignCampaigns_universal_d_QueryMetadata as QueryMetadata, emailMarketingV1CampaignCampaigns_universal_d_QueryAppTemplatesRequest as QueryAppTemplatesRequest, emailMarketingV1CampaignCampaigns_universal_d_TemplateQueryType as TemplateQueryType, emailMarketingV1CampaignCampaigns_universal_d_QueryAppTemplatesResponse as QueryAppTemplatesResponse, emailMarketingV1CampaignCampaigns_universal_d_TemplateData as TemplateData, emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupRequest as CampaignLookupRequest, emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupResponse as CampaignLookupResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupBatchRequest as CampaignLookupBatchRequest, emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupBatchResponse as CampaignLookupBatchResponse, emailMarketingV1CampaignCampaigns_universal_d_UpsertTranslationRequest as UpsertTranslationRequest, emailMarketingV1CampaignCampaigns_universal_d_Composer as Composer, emailMarketingV1CampaignCampaigns_universal_d_DefaultValues as DefaultValues, emailMarketingV1CampaignCampaigns_universal_d_UpsertTranslationResponse as UpsertTranslationResponse, emailMarketingV1CampaignCampaigns_universal_d_GetUsedPlaceholderKeysRequest as GetUsedPlaceholderKeysRequest, emailMarketingV1CampaignCampaigns_universal_d_GetUsedPlaceholderKeysResponse as GetUsedPlaceholderKeysResponse, emailMarketingV1CampaignCampaigns_universal_d_GetCampaignRequest as GetCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_GetCampaignResponse as GetCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_ListCampaignsRequest as ListCampaignsRequest, emailMarketingV1CampaignCampaigns_universal_d_ListCampaignsResponse as ListCampaignsResponse, emailMarketingV1CampaignCampaigns_universal_d_CountCampaignsRequest as CountCampaignsRequest, emailMarketingV1CampaignCampaigns_universal_d_CountCampaignsResponse as CountCampaignsResponse, emailMarketingV1CampaignCampaigns_universal_d_CreateFromTemplateRequest as CreateFromTemplateRequest, emailMarketingV1CampaignCampaigns_universal_d_CreateFromTemplateResponse as CreateFromTemplateResponse, emailMarketingV1CampaignCampaigns_universal_d_CreateUserTemplateRequest as CreateUserTemplateRequest, emailMarketingV1CampaignCampaigns_universal_d_CreateUserTemplateResponse as CreateUserTemplateResponse, emailMarketingV1CampaignCampaigns_universal_d_CreateFromUserTemplateRequest as CreateFromUserTemplateRequest, emailMarketingV1CampaignCampaigns_universal_d_CreateFromUserTemplateResponse as CreateFromUserTemplateResponse, emailMarketingV1CampaignCampaigns_universal_d_PublishCampaignRequest as PublishCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_EmailDistributionOptions as EmailDistributionOptions, emailMarketingV1CampaignCampaigns_universal_d_PublishCampaignResponse as PublishCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignRejectedEvent as CampaignRejectedEvent, emailMarketingV1CampaignCampaigns_universal_d_CampaignPublishedEvent as CampaignPublishedEvent, emailMarketingV1CampaignCampaigns_universal_d_CampaignTerminatedEvent as CampaignTerminatedEvent, emailMarketingV1CampaignCampaigns_universal_d_CampaignDistributedEvent as CampaignDistributedEvent, emailMarketingV1CampaignCampaigns_universal_d_EmailActivityUpdated as EmailActivityUpdated, emailMarketingV1CampaignCampaigns_universal_d_EmailActivityUpdatedEventTypeOneOf as EmailActivityUpdatedEventTypeOneOf, emailMarketingV1CampaignCampaigns_universal_d_ActivityType as ActivityType, emailMarketingV1CampaignCampaigns_universal_d_Click as Click, emailMarketingV1CampaignCampaigns_universal_d_Open as Open, emailMarketingV1CampaignCampaigns_universal_d_SoftBounce as SoftBounce, emailMarketingV1CampaignCampaigns_universal_d_HardBounce as HardBounce, emailMarketingV1CampaignCampaigns_universal_d_CampaignScheduledEvent as CampaignScheduledEvent, emailMarketingV1CampaignCampaigns_universal_d_SendTestRequest as SendTestRequest, emailMarketingV1CampaignCampaigns_universal_d_PlaceholderContent as PlaceholderContent, emailMarketingV1CampaignCampaigns_universal_d_PlaceholderContentValueOneOf as PlaceholderContentValueOneOf, emailMarketingV1CampaignCampaigns_universal_d_PlainText as PlainText, emailMarketingV1CampaignCampaigns_universal_d_Html as Html, emailMarketingV1CampaignCampaigns_universal_d_Money as Money, emailMarketingV1CampaignCampaigns_universal_d_DateTime as DateTime, emailMarketingV1CampaignCampaigns_universal_d_Map as Map, emailMarketingV1CampaignCampaigns_universal_d__Array as _Array, emailMarketingV1CampaignCampaigns_universal_d_PlaceholderContentEnum as PlaceholderContentEnum, emailMarketingV1CampaignCampaigns_universal_d_Attachment as Attachment, emailMarketingV1CampaignCampaigns_universal_d_Integer as Integer, emailMarketingV1CampaignCampaigns_universal_d_Decimal as Decimal, emailMarketingV1CampaignCampaigns_universal_d_SendTestResponse as SendTestResponse, emailMarketingV1CampaignCampaigns_universal_d_PauseSchedulingRequest as PauseSchedulingRequest, emailMarketingV1CampaignCampaigns_universal_d_PauseSchedulingResponse as PauseSchedulingResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignPausedEvent as CampaignPausedEvent, emailMarketingV1CampaignCampaigns_universal_d_RescheduleRequest as RescheduleRequest, emailMarketingV1CampaignCampaigns_universal_d_RescheduleResponse as RescheduleResponse, emailMarketingV1CampaignCampaigns_universal_d_ArchiveCampaignRequest as ArchiveCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_ArchiveCampaignResponse as ArchiveCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignArchivedEvent as CampaignArchivedEvent, emailMarketingV1CampaignCampaigns_universal_d_UnarchiveCampaignRequest as UnarchiveCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_UnarchiveCampaignResponse as UnarchiveCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_CampaignUnarchivedEvent as CampaignUnarchivedEvent, emailMarketingV1CampaignCampaigns_universal_d_UpdateTitleRequest as UpdateTitleRequest, emailMarketingV1CampaignCampaigns_universal_d_UpdateTitleResponse as UpdateTitleResponse, emailMarketingV1CampaignCampaigns_universal_d_DeleteCampaignRequest as DeleteCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_DeleteCampaignResponse as DeleteCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_ReuseCampaignRequest as ReuseCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_ReuseCampaignResponse as ReuseCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_PreviewCampaignRequest as PreviewCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_PreviewCampaignResponse as PreviewCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_GetComposerRequest as GetComposerRequest, emailMarketingV1CampaignCampaigns_universal_d_GetComposerResponse as GetComposerResponse, emailMarketingV1CampaignCampaigns_universal_d_UpdateComposerRequest as UpdateComposerRequest, emailMarketingV1CampaignCampaigns_universal_d_CampaignEditorType as CampaignEditorType, emailMarketingV1CampaignCampaigns_universal_d_UpdateComposerResponse as UpdateComposerResponse, emailMarketingV1CampaignCampaigns_universal_d_CreateCampaignRequest as CreateCampaignRequest, emailMarketingV1CampaignCampaigns_universal_d_CreateCampaignResponse as CreateCampaignResponse, emailMarketingV1CampaignCampaigns_universal_d_ResendToNonOpenersRequest as ResendToNonOpenersRequest, emailMarketingV1CampaignCampaigns_universal_d_ResendToNonOpenersResponse as ResendToNonOpenersResponse, emailMarketingV1CampaignCampaigns_universal_d_EstimateFilterSizeOptions as EstimateFilterSizeOptions, emailMarketingV1CampaignCampaigns_universal_d_EstimateAudienceSizeOptions as EstimateAudienceSizeOptions, emailMarketingV1CampaignCampaigns_universal_d_SearchContactsOptions as SearchContactsOptions, emailMarketingV1CampaignCampaigns_universal_d_GetLabelsOptions as GetLabelsOptions, emailMarketingV1CampaignCampaigns_universal_d_SubscribeFromLandingPageOptions as SubscribeFromLandingPageOptions, emailMarketingV1CampaignCampaigns_universal_d_listStatistics as listStatistics, emailMarketingV1CampaignCampaigns_universal_d_listRecipients as listRecipients, emailMarketingV1CampaignCampaigns_universal_d_ListRecipientsOptions as ListRecipientsOptions, emailMarketingV1CampaignCampaigns_universal_d_GetCampaignMappingIdentifiers as GetCampaignMappingIdentifiers, emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingIdentifiers as GetPingCampaignMappingIdentifiers, emailMarketingV1CampaignCampaigns_universal_d_GetPingCampaignMappingOptions as GetPingCampaignMappingOptions, emailMarketingV1CampaignCampaigns_universal_d_QueryAutomationTemplatesOptions as QueryAutomationTemplatesOptions, emailMarketingV1CampaignCampaigns_universal_d_QueryAppTemplatesOptions as QueryAppTemplatesOptions, emailMarketingV1CampaignCampaigns_universal_d_CampaignLookupBatchOptions as CampaignLookupBatchOptions, emailMarketingV1CampaignCampaigns_universal_d_UpsertTranslationOptions as UpsertTranslationOptions, emailMarketingV1CampaignCampaigns_universal_d_getCampaign as getCampaign, emailMarketingV1CampaignCampaigns_universal_d_GetCampaignOptions as GetCampaignOptions, emailMarketingV1CampaignCampaigns_universal_d_listCampaigns as listCampaigns, emailMarketingV1CampaignCampaigns_universal_d_ListCampaignsOptions as ListCampaignsOptions, emailMarketingV1CampaignCampaigns_universal_d_CountOptions as CountOptions, emailMarketingV1CampaignCampaigns_universal_d_CreateFromTemplateOptions as CreateFromTemplateOptions, emailMarketingV1CampaignCampaigns_universal_d_CreateUserTemplateOptions as CreateUserTemplateOptions, emailMarketingV1CampaignCampaigns_universal_d_publishCampaign as publishCampaign, emailMarketingV1CampaignCampaigns_universal_d_PublishCampaignOptions as PublishCampaignOptions, emailMarketingV1CampaignCampaigns_universal_d_sendTest as sendTest, emailMarketingV1CampaignCampaigns_universal_d_SendTestOptions as SendTestOptions, emailMarketingV1CampaignCampaigns_universal_d_pauseScheduling as pauseScheduling, emailMarketingV1CampaignCampaigns_universal_d_reschedule as reschedule, emailMarketingV1CampaignCampaigns_universal_d_deleteCampaign as deleteCampaign, emailMarketingV1CampaignCampaigns_universal_d_reuseCampaign as reuseCampaign, emailMarketingV1CampaignCampaigns_universal_d_PreviewOptions as PreviewOptions, emailMarketingV1CampaignCampaigns_universal_d_GetComposerOptions as GetComposerOptions, emailMarketingV1CampaignCampaigns_universal_d_UpdateComposerOptions as UpdateComposerOptions, emailMarketingV1CampaignCampaigns_universal_d_CreateOptions as CreateOptions, emailMarketingV1CampaignCampaigns_universal_d_ResendToNonOpenersOptions as ResendToNonOpenersOptions, };\n }\n /**\n * A sender details object contains the information that is displayed as the email sender's name and email address.\n * If sending email campaigns with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not\n * be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users),\n * and the sender's email is placed in the 'reply-to' header.\n *\n * If sending email campaigns with an email from a Wix managed domain, that email will be displayed in the 'from' header.\n * If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the\n * email was sent via wixemails.com.\n */\n interface SenderDetails {\n /** Display name of sender. */\n fromName?: string;\n /** Email address of sender. */\n fromEmail?: string;\n /**\n * Date and time the sender's email address was verified.\n * @readonly\n */\n dateVerified?: Date;\n }\n interface GetSenderDetailsRequest {\n }\n interface GetSenderDetailsResponse {\n /** Current sender details. */\n senderDetails?: SenderDetails;\n }\n interface UpdateSenderDetailsRequest {\n /** New sender details. */\n senderDetails: SenderDetails;\n }\n interface UpdateSenderDetailsResponse {\n /** Whether email address needs verification. */\n verificationNeeded?: boolean;\n }\n interface VerifySenderEmailRequest {\n /** Verification code. */\n verificationCode: string;\n }\n interface VerifySenderEmailResponse {\n }\n interface ResolveActualFromAddressRequest {\n /** User's provided address from which to send email marketing campaign. */\n fromAddress: string;\n }\n interface ResolveActualFromAddressResponse {\n /** Actual from-address that will be used for email distribution. */\n actualFromAddress?: string;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves sender details.\n *\n * The sender details include the information displayed as the email sender's name and email address.\n *\n * + If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.\n *\n * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.\n *\n * + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function getSenderDetails(): Promise;\n /**\n * Updates sender details.\n *\n * If the `fromEmail` is changed, a verification code will be sent to the new email address.\n *\n * If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.\n *\n * @param senderDetails - New sender details.\n * @public\n * @documentationMaturity preview\n * @requiredField senderDetails\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateSenderDetails(senderDetails: SenderDetails): Promise;\n /**\n * Verifies the sender's email using a verification code sent to the user's email address upon update.\n * @param verificationCode - Verification code.\n * @public\n * @documentationMaturity preview\n * @requiredField verificationCode\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function verifyEmail(verificationCode: string): Promise;\n /**\n * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).\n * @param fromAddress - User's provided address from which to send email marketing campaign.\n * @public\n * @documentationMaturity preview\n * @requiredField fromAddress\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @applicableIdentity APP\n * @adminMethod\n */\n function resolveActualFromAddress(fromAddress: string): Promise;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_SenderDetails = SenderDetails;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_GetSenderDetailsRequest = GetSenderDetailsRequest;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_GetSenderDetailsResponse = GetSenderDetailsResponse;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_UpdateSenderDetailsRequest = UpdateSenderDetailsRequest;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_UpdateSenderDetailsResponse = UpdateSenderDetailsResponse;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_VerifySenderEmailRequest = VerifySenderEmailRequest;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_VerifySenderEmailResponse = VerifySenderEmailResponse;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_ResolveActualFromAddressRequest = ResolveActualFromAddressRequest;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_ResolveActualFromAddressResponse = ResolveActualFromAddressResponse;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_DomainEvent = DomainEvent;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_ActionEvent = ActionEvent;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_MessageEnvelope = MessageEnvelope;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_IdentificationData = IdentificationData;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type emailMarketingV1SenderDetailsSenderDetails_universal_d_WebhookIdentityType = WebhookIdentityType;\n const emailMarketingV1SenderDetailsSenderDetails_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const emailMarketingV1SenderDetailsSenderDetails_universal_d_getSenderDetails: typeof getSenderDetails;\n const emailMarketingV1SenderDetailsSenderDetails_universal_d_updateSenderDetails: typeof updateSenderDetails;\n const emailMarketingV1SenderDetailsSenderDetails_universal_d_verifyEmail: typeof verifyEmail;\n const emailMarketingV1SenderDetailsSenderDetails_universal_d_resolveActualFromAddress: typeof resolveActualFromAddress;\n namespace emailMarketingV1SenderDetailsSenderDetails_universal_d {\n export { emailMarketingV1SenderDetailsSenderDetails_universal_d_SenderDetails as SenderDetails, emailMarketingV1SenderDetailsSenderDetails_universal_d_GetSenderDetailsRequest as GetSenderDetailsRequest, emailMarketingV1SenderDetailsSenderDetails_universal_d_GetSenderDetailsResponse as GetSenderDetailsResponse, emailMarketingV1SenderDetailsSenderDetails_universal_d_UpdateSenderDetailsRequest as UpdateSenderDetailsRequest, emailMarketingV1SenderDetailsSenderDetails_universal_d_UpdateSenderDetailsResponse as UpdateSenderDetailsResponse, emailMarketingV1SenderDetailsSenderDetails_universal_d_VerifySenderEmailRequest as VerifySenderEmailRequest, emailMarketingV1SenderDetailsSenderDetails_universal_d_VerifySenderEmailResponse as VerifySenderEmailResponse, emailMarketingV1SenderDetailsSenderDetails_universal_d_ResolveActualFromAddressRequest as ResolveActualFromAddressRequest, emailMarketingV1SenderDetailsSenderDetails_universal_d_ResolveActualFromAddressResponse as ResolveActualFromAddressResponse, emailMarketingV1SenderDetailsSenderDetails_universal_d_DomainEvent as DomainEvent, emailMarketingV1SenderDetailsSenderDetails_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, emailMarketingV1SenderDetailsSenderDetails_universal_d_EntityCreatedEvent as EntityCreatedEvent, emailMarketingV1SenderDetailsSenderDetails_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, emailMarketingV1SenderDetailsSenderDetails_universal_d_EntityDeletedEvent as EntityDeletedEvent, emailMarketingV1SenderDetailsSenderDetails_universal_d_ActionEvent as ActionEvent, emailMarketingV1SenderDetailsSenderDetails_universal_d_MessageEnvelope as MessageEnvelope, emailMarketingV1SenderDetailsSenderDetails_universal_d_IdentificationData as IdentificationData, emailMarketingV1SenderDetailsSenderDetails_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, emailMarketingV1SenderDetailsSenderDetails_universal_d_WebhookIdentityType as WebhookIdentityType, emailMarketingV1SenderDetailsSenderDetails_universal_d_getSenderDetails as getSenderDetails, emailMarketingV1SenderDetailsSenderDetails_universal_d_updateSenderDetails as updateSenderDetails, emailMarketingV1SenderDetailsSenderDetails_universal_d_verifyEmail as verifyEmail, emailMarketingV1SenderDetailsSenderDetails_universal_d_resolveActualFromAddress as resolveActualFromAddress, };\n }\n export { emailMarketingV1AccountDetailsAccountDetails_universal_d as accountDetails, emailMarketingV1CampaignCampaigns_universal_d as campaigns, emailMarketingV1SenderDetailsSenderDetails_universal_d as senderDetails };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-bookings.v2.d.ts", "content": "declare module \"wix-bookings.v2\" {\n /**\n * The `Attendance` object represents the attendance information\n * for a booked session, such as:\n *\n * + Did anyone attend the session?\n * + How many people attended the session?\n *\n * The number of session `Attendance` objects available depends on the booking type:\n * + Appointment bookings have 1 `Attendance` object per appointment session.\n * + Class bookings have 1 `Attendance` object for each session of the class. The number of sessions for a class is defined in Schedule and Sessions [`schedule.capacity`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.\n * + Course bookings have an `Attendance` object for each session of the course. For example, if there are 12 sessions in a course, there are 12 `Attendance` objects. The number of sessions for a class is defined in Schedule and Sessions [`schedule.capacity`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.\n */\n interface Attendance$1 {\n /**\n * ID of the `Attendance` object.\n * @readonly\n */\n _id?: string | null;\n /** Corresponding booking ID. */\n bookingId?: string | null;\n /** Corresponding session ID. */\n sessionId?: string | null;\n /**\n * Status indicating if any participants attended the session:\n *\n * + `NOT_SET`: There is no available attendance information.\n * + `ATTENDED`: At least a single participant attended the session.\n * + `NOT_ATTENDED`: No participants attended the session.\n */\n status?: AttendanceStatus$1;\n /**\n * Total number of participants that attended the session. By default, the number\n * of attendees is set to `1`, but you can set a number to greater than `1` if multiple\n * participants attended.\n *\n * Do not set to `0` to indicate that no one attended the session. Instead, set the `status` field to `NOT_ATTENDED`.\n *\n * Default: 1\n */\n numberOfAttendees?: number;\n }\n enum AttendanceStatus$1 {\n NOT_SET = \"NOT_SET\",\n ATTENDED = \"ATTENDED\",\n NOT_ATTENDED = \"NOT_ATTENDED\"\n }\n interface GetAttendanceRequest {\n /** ID of the object that contains the attendance information that you want to retrieve. */\n attendanceId: string;\n }\n interface GetAttendanceResponse {\n /** The retrieved attendance information for the booked session. */\n attendance?: Attendance$1;\n }\n interface SetAttendanceRequest {\n /** The attendance information for a booked session that you want to create or update. */\n attendance: Attendance$1;\n }\n interface SetAttendanceResponse {\n /** The created or updated attendance information for the booked session. */\n attendance?: Attendance$1;\n }\n interface BulkSetAttendanceRequest {\n /** The attendance information for a booked sessions that you want to create or update. */\n attendanceList: Attendance$1[];\n returnFullEntity?: boolean;\n }\n interface BulkSetAttendanceResponse {\n /** The created or updated attendance information for the booked sessions. */\n results?: BulkAttendanceResult[];\n /** Total successes and failures of the bulk set attendance action. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkAttendanceResult {\n item?: Attendance$1;\n itemMetadata?: ItemMetadata$2;\n }\n interface ItemMetadata$2 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$2;\n }\n interface ApplicationError$2 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$2 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface QueryAttendanceRequest {\n /** Query options. */\n query: QueryV2$6;\n }\n interface QueryV2$6 extends QueryV2PagingMethodOneOf$6 {\n /** Cursors to navigate through the result pages using `next` and `prev`. */\n cursorPaging?: CursorPaging$7;\n /**\n * Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.\n *\n * For a detailed list of supported fields and operators, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).\n *\n * Max: 1 filter\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[ {\"fieldName\":\"sortField1\",\"order\":\"ASC\"}, {\"fieldName\":\"sortField2\",\"order\":\"DESC\"} ]`\n *\n * For details about sorting, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).\n */\n sort?: Sorting$5[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$6 {\n /** Cursors to navigate through the result pages using `next` and `prev`. */\n cursorPaging?: CursorPaging$7;\n }\n interface Sorting$5 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$5;\n }\n /**\n * Sort order. Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Default: `ASC`.\n */\n enum SortOrder$5 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$4 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$7 {\n /**\n * Number of `Attendance` objects to return.\n *\n * Default: `50`\n * Maximum: `1000`\n */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n *\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n /** List of objects that contain attendance information. */\n interface QueryAttendanceResponse {\n /** List of objects that contain attendance information for a booked session. */\n attendances?: Attendance$1[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: CursorPagingMetadata$4;\n }\n /** This is the preferred message for cursor-paging enabled services */\n interface CursorPagingMetadata$4 {\n /** Use these cursors to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */\n cursors?: Cursors$7;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$7 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface DomainEvent$4 extends DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n }\n interface EntityCreatedEvent$4 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$4 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$4 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$5;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves attendance information by ID.\n * @param attendanceId - ID of the object that contains the attendance information that you want to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField attendanceId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns The retrieved attendance information for the booked session.\n */\n function getAttendance(attendanceId: string): Promise;\n /**\n * Sets information about whether a booking's session was attended. This information\n * is saved in an `Attendance` object.\n *\n *\n * If attendance was already set, meaning the `Attendance` object already exists, the\n * existing attendance information is updated. Otherwise, a new `Attendance` object\n * is created.\n *\n * By default, the number\n * of attendees is set to `1`, but you can set a number to greater than `1` if multiple\n * participants attended. Do not set to `0` to indicate that no one attended the session.\n * Instead, set the `status` field to `NOT_ATTENDED`.\n *\n * > __Note:__ Make sure your code validates that:\n * > + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.\n * > + The attendance's `numberOfAttendees` and the booking's `numberOfParticipants` correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).\n * @param attendance - The attendance information for a booked session that you want to create or update.\n * @public\n * @documentationMaturity preview\n * @requiredField attendance\n * @requiredField attendance.bookingId\n * @requiredField attendance.status\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function setAttendance(attendance: Attendance$1): Promise;\n interface BulkSetAttendanceOptions {\n returnFullEntity?: boolean;\n }\n /**\n * Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.\n *\n *\n * When querying attendance information, you can query from the perspective of:\n * + **A booking.** Specify a booking ID to retrieve attendance information\n * for all sessions related to that booking.\n * + **A session.** Specify a session ID to retrieve attendance information\n * for all bookings related to that session.\n *\n * For example, query by a course's `bookingId` and `status = \"NOT_ATTENDED\"` to\n * retrieve the attendance of a given participant in a course. For example, this query\n * helps you determine if a participant booked the course\n * but did not attend most of its sessions, taking away spots for other potential participants.\n *\n * Query Attendance runs with the following defaults, which you can override:\n *\n * - `id` sorted in `ASC` order\n * - `cursorPaging.limit` is `50`\n *\n * For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).\n *\n * > __Notes__:\n * > + Another way to retrieve attendance information is to call Bookings Reader V2's [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) with `withBookingAttendanceInfo` as `true`.\n * > + Up to 100 results can be returned per request.\n * > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.\n *\n * To learn about working with query endpoints, see\n * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryAttendance(): AttendancesQueryBuilder;\n interface QueryCursorResult$2 {\n cursors: Cursors$7;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface AttendancesQueryResult extends QueryCursorResult$2 {\n items: Attendance$1[];\n query: AttendancesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface AttendancesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"bookingId\" | \"sessionId\" | \"status\" | \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"bookingId\" | \"sessionId\" | \"status\" | \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"bookingId\" | \"sessionId\" | \"status\" | \"numberOfAttendees\", value: any) => AttendancesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"bookingId\" | \"sessionId\" | \"status\" | \"numberOfAttendees\">) => AttendancesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"numberOfAttendees\">) => AttendancesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => AttendancesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => AttendancesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n type bookingsV2AttendanceAttendance_universal_d_GetAttendanceRequest = GetAttendanceRequest;\n type bookingsV2AttendanceAttendance_universal_d_GetAttendanceResponse = GetAttendanceResponse;\n type bookingsV2AttendanceAttendance_universal_d_SetAttendanceRequest = SetAttendanceRequest;\n type bookingsV2AttendanceAttendance_universal_d_SetAttendanceResponse = SetAttendanceResponse;\n type bookingsV2AttendanceAttendance_universal_d_BulkSetAttendanceRequest = BulkSetAttendanceRequest;\n type bookingsV2AttendanceAttendance_universal_d_BulkSetAttendanceResponse = BulkSetAttendanceResponse;\n type bookingsV2AttendanceAttendance_universal_d_BulkAttendanceResult = BulkAttendanceResult;\n type bookingsV2AttendanceAttendance_universal_d_QueryAttendanceRequest = QueryAttendanceRequest;\n type bookingsV2AttendanceAttendance_universal_d_QueryAttendanceResponse = QueryAttendanceResponse;\n const bookingsV2AttendanceAttendance_universal_d_getAttendance: typeof getAttendance;\n const bookingsV2AttendanceAttendance_universal_d_setAttendance: typeof setAttendance;\n type bookingsV2AttendanceAttendance_universal_d_BulkSetAttendanceOptions = BulkSetAttendanceOptions;\n const bookingsV2AttendanceAttendance_universal_d_queryAttendance: typeof queryAttendance;\n type bookingsV2AttendanceAttendance_universal_d_AttendancesQueryResult = AttendancesQueryResult;\n type bookingsV2AttendanceAttendance_universal_d_AttendancesQueryBuilder = AttendancesQueryBuilder;\n namespace bookingsV2AttendanceAttendance_universal_d {\n export { Attendance$1 as Attendance, AttendanceStatus$1 as AttendanceStatus, bookingsV2AttendanceAttendance_universal_d_GetAttendanceRequest as GetAttendanceRequest, bookingsV2AttendanceAttendance_universal_d_GetAttendanceResponse as GetAttendanceResponse, bookingsV2AttendanceAttendance_universal_d_SetAttendanceRequest as SetAttendanceRequest, bookingsV2AttendanceAttendance_universal_d_SetAttendanceResponse as SetAttendanceResponse, bookingsV2AttendanceAttendance_universal_d_BulkSetAttendanceRequest as BulkSetAttendanceRequest, bookingsV2AttendanceAttendance_universal_d_BulkSetAttendanceResponse as BulkSetAttendanceResponse, bookingsV2AttendanceAttendance_universal_d_BulkAttendanceResult as BulkAttendanceResult, ItemMetadata$2 as ItemMetadata, ApplicationError$2 as ApplicationError, BulkActionMetadata$2 as BulkActionMetadata, bookingsV2AttendanceAttendance_universal_d_QueryAttendanceRequest as QueryAttendanceRequest, QueryV2$6 as QueryV2, QueryV2PagingMethodOneOf$6 as QueryV2PagingMethodOneOf, Sorting$5 as Sorting, SortOrder$5 as SortOrder, Paging$4 as Paging, CursorPaging$7 as CursorPaging, bookingsV2AttendanceAttendance_universal_d_QueryAttendanceResponse as QueryAttendanceResponse, CursorPagingMetadata$4 as CursorPagingMetadata, Cursors$7 as Cursors, DomainEvent$4 as DomainEvent, DomainEventBodyOneOf$4 as DomainEventBodyOneOf, EntityCreatedEvent$4 as EntityCreatedEvent, EntityUpdatedEvent$4 as EntityUpdatedEvent, EntityDeletedEvent$4 as EntityDeletedEvent, ActionEvent$4 as ActionEvent, MessageEnvelope$3 as MessageEnvelope, IdentificationData$5 as IdentificationData, IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, bookingsV2AttendanceAttendance_universal_d_getAttendance as getAttendance, bookingsV2AttendanceAttendance_universal_d_setAttendance as setAttendance, bookingsV2AttendanceAttendance_universal_d_BulkSetAttendanceOptions as BulkSetAttendanceOptions, bookingsV2AttendanceAttendance_universal_d_queryAttendance as queryAttendance, bookingsV2AttendanceAttendance_universal_d_AttendancesQueryResult as AttendancesQueryResult, bookingsV2AttendanceAttendance_universal_d_AttendancesQueryBuilder as AttendancesQueryBuilder, };\n }\n /** extended bookings */\n interface ExtendedBooking {\n /** Booking. */\n booking?: Booking$2;\n /**\n * Information about which actions the customer can perform for the\n * booking. Available only when passing `withBookingAllowedActions` as `true`.\n */\n allowedActions?: AllowedActions$1;\n /**\n * Information about attendance. Available only when passing\n * `withBookingAttendanceInfo` as `true`.\n */\n attendance?: Attendance;\n }\n enum AttendanceStatus {\n NOT_SET = \"NOT_SET\",\n ATTENDED = \"ATTENDED\",\n NOT_ATTENDED = \"NOT_ATTENDED\"\n }\n /** The booking object, version 2. */\n interface Booking$2 extends BookingParticipantsInfoOneOf$2 {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices$2;\n /**\n * Booking ID.\n * @readonly\n */\n _id?: string | null;\n /** An object describing the slot or schedule that was booked. */\n bookedEntity?: BookedEntity$2;\n /** Contact details of the site visitor or member making the booking. */\n contactDetails?: ContactDetails$2;\n /** Additional custom fields submitted with the booking form. */\n additionalFields?: CustomFormField$2[];\n /**\n * Booking status.\n * One of:\n * - `\"CREATED\"` - The booking was created.\n * - `\"UPDATED\"` - The booking was updated.\n * - `\"CONFIRMED\"` - The booking was confirmed and appears on the bookings calendar.\n * A booking can be manually confirmed using the [`Confirm Or Decline API`](www.example.com).\n * A booking can be automatically confirmed when the following requirements are met:\n * + The service is configured as automatically confirmed.\n * + The system invoked the eCommerce checkout API and created an order.\n * - `\"CANCELED\"` - The booking has been canceled and synced to the bookings calendar.\n * The booking can be canceled using [`Cancel Booking API`](www.example.com).\n * - `\"PENDING\"` - The booking is waiting to be confirmed or declined by the owner and the booking is synced to the bookings calendar.\n * Bookings can be manually set as `PENDING` using the [`setAsPending` API](www.example.com), by those with Manage Booking Status permissions scopes.\n * Bookings can be automatically set as `PENDING` when the following requirements are met:\n * + The service is configured as manually confirmed.\n * + Invoking the eCommerce checkout API and an order has been created.\n * - `\"WAITING_LIST\"` - The booking is on a waiting list.\n * - `\"DECLINED\"` - The booking was declined by the owner and synced to the Bookings calendar.\n * Bookings can be manually declined using the [`Decline Booking` API](www.example.com) by those with Manage Booking Status permissions scopes.\n * Booking can be automatically declined when one of the following requirements are met:\n * + Invoking the `eCommerce checkout` API and the order declined event has been sent.\n * + Invoking the `eCommerce checkout` API and order approved event has been sent, but the booking is offline and the booking causes a double booking.\n */\n status?: BookingStatus$2;\n /**\n * Payment status.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n * @readonly\n */\n paymentStatus?: PaymentStatus$2;\n /**\n * Selected payment option.\n * One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.\n * When undefined, the payment option is resolved by the service configuration on checkout.\n */\n selectedPaymentOption?: SelectedPaymentOption$2;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */\n revision?: string | null;\n /**\n * ID of the creator of the Booking.\n * If `appId` and another ID are present, the other ID takes precedence.\n * @readonly\n */\n createdBy?: IdentificationData$4;\n /**\n * The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.\n * @readonly\n */\n startDate?: Date;\n /**\n * The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.\n * @readonly\n */\n endDate?: Date;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls. */\n extendedFields?: ExtendedFields$3;\n /**\n * Whether this booking overlaps another existing confirmed booking. Returned when: `true`\n * @readonly\n */\n doubleBooked?: boolean | null;\n }\n /** @oneof */\n interface BookingParticipantsInfoOneOf$2 {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices$2;\n }\n enum MultiServiceBookingType$2 {\n /**\n * Multi service booking will be considered available if its bookings are\n * available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url\n */\n SEQUENTIAL_BOOKINGS = \"SEQUENTIAL_BOOKINGS\",\n /**\n * Multi service booking will be considered available if each of its bookings is available separately.\n * Not supported yet\n */\n SEPARATE_BOOKINGS = \"SEPARATE_BOOKINGS\",\n /** Not supported yet */\n PARALLEL_BOOKINGS = \"PARALLEL_BOOKINGS\"\n }\n interface BookedEntity$2 extends BookedEntityItemOneOf$2 {\n /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */\n slot?: BookedSlot$2;\n /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */\n schedule?: BookedSchedule$2;\n /**\n * Session title at the time of booking.\n * If session doesn't exist at the time of the booking, service name is used.\n * @readonly\n */\n title?: string | null;\n /**\n * List of tags for the booking.\n * System-assigned tags for sessions and schedules are:\n * + \"INDIVIDUAL\" Appointments, including appointments with more than 1 participant.\n * + \"GROUP\" Individual classes.\n * + \"COURSE\" Courses.\n */\n tags?: string[] | null;\n }\n /** @oneof */\n interface BookedEntityItemOneOf$2 {\n /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */\n slot?: BookedSlot$2;\n /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */\n schedule?: BookedSchedule$2;\n }\n interface BookedSlot$2 {\n /**\n * ID of the underlying session when session is a single session or generated from a recurring session.\n * If `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information.\n */\n sessionId?: string | null;\n /** Service ID. */\n serviceId?: string;\n /** Schedule ID. Required. */\n scheduleId?: string;\n /**\n * Calendar 3 event ID\n * If not empty, on all write flows (create / update) gets priority over session_id.\n * so if both session_id and event_id are provided, the session_id that will be set on the booking will be based on the event_id.\n * Otherwise, if event_id is empty on write flow,\n */\n eventId?: string | null;\n /**\n * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n */\n startDate?: string | null;\n /**\n * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n */\n endDate?: string | null;\n /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */\n timezone?: string | null;\n /**\n * The enriched resource assigned to the slot, can be either the requested resource or the resource chosen by the system.\n * When populated, the given resource will be booked according to it's availability.\n * When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,\n * otherwise one of the service resources will be assigned to the slot randomly upon confirmation.\n * This resource is the slot primary resource.\n */\n resource?: BookedResource$2;\n /** Location where the slot's session takes place. */\n location?: Location$8;\n }\n interface BookedResource$2 {\n /** Booked resource ID. */\n _id?: string;\n /** Resource's name at the time of booking. */\n name?: string | null;\n /** Resource's email at the time of booking. */\n email?: string | null;\n /** Resource's schedule ID. */\n scheduleId?: string | null;\n }\n interface Location$8 {\n /**\n * Business location ID. Available only for locations that are business locations,\n * meaning the `location_type` is `\"OWNER_BUSINESS\"`.\n */\n _id?: string | null;\n /** Location name. */\n name?: string | null;\n /** The full address of this location. */\n formattedAddress?: string | null;\n /**\n * Location type.\n *\n * - `\"OWNER_BUSINESS\"`: The business address, as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"`: The address as set when creating the service.\n * - `\"CUSTOM\"`: The address as set for the individual session.\n */\n locationType?: LocationType$8;\n }\n enum LocationType$8 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface BookedSchedule$2 {\n /** Schedule ID. */\n scheduleId?: string;\n /** Booked service ID. */\n serviceId?: string | null;\n /**\n * Location where the schedule's sessions take place. Read only.\n * @readonly\n */\n location?: Location$8;\n /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */\n timezone?: string | null;\n /**\n * The start time of the first session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format. Required.\n * @readonly\n */\n firstSessionStart?: string | null;\n /**\n * The end time of the last session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format. Required.\n * @readonly\n */\n lastSessionEnd?: string | null;\n }\n interface ContactDetails$2 {\n /** Contact's ID. */\n contactId?: string | null;\n /** Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /** Contact's email, used to create a new contact or get existing one from the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). */\n email?: string | null;\n /** Contact's phone number. */\n phone?: string | null;\n /** Contact's full address. */\n fullAddress?: Address$7;\n /** Contact's time zone. */\n timeZone?: string | null;\n /** Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n countryCode?: string | null;\n }\n /** Physical address */\n interface Address$7 extends AddressStreetOneOf$7 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$7;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$7;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$7[];\n }\n /** @oneof */\n interface AddressStreetOneOf$7 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$7;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$7 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$7 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$7 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface CustomFormField$2 {\n /** ID of the form field as defined in the form. */\n _id?: string;\n /** Value that was submitted for this field. */\n value?: string | null;\n /**\n * Form field's label at the time of submission.\n * @readonly\n */\n label?: string | null;\n /**\n * \n */\n valueType?: ValueType$2;\n }\n enum ValueType$2 {\n /** Short text. This is the default value type. */\n SHORT_TEXT = \"SHORT_TEXT\",\n /** Long text */\n LONG_TEXT = \"LONG_TEXT\",\n /** a text that represent the check box value: if selected the value is \"true\", otherwise \"false\". */\n CHECK_BOX = \"CHECK_BOX\"\n }\n /** Booking status. */\n enum BookingStatus$2 {\n CREATED = \"CREATED\",\n CONFIRMED = \"CONFIRMED\",\n CANCELED = \"CANCELED\",\n PENDING = \"PENDING\",\n DECLINED = \"DECLINED\",\n WAITING_LIST = \"WAITING_LIST\"\n }\n /**\n * Payment status.\n * Automatically updated when using eCom checkout APIs.\n */\n enum PaymentStatus$2 {\n UNDEFINED = \"UNDEFINED\",\n NOT_PAID = \"NOT_PAID\",\n PAID = \"PAID\",\n /** not supported yet. */\n PARTIALLY_PAID = \"PARTIALLY_PAID\",\n /** not supported yet */\n REFUNDED = \"REFUNDED\",\n EXEMPT = \"EXEMPT\"\n }\n /**\n * The selected payment option.\n * One of the payment options offered by the service.\n * This field is be set when the user selects an option during booking.\n * If left undefined, the payment option is resolved by the service configuration on checkout.\n */\n enum SelectedPaymentOption$2 {\n UNDEFINED = \"UNDEFINED\",\n OFFLINE = \"OFFLINE\",\n ONLINE = \"ONLINE\",\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface BookingSource$2 {\n /**\n * Platform from which a booking was created\n * \n */\n platform?: Platform$2;\n /**\n * Actor that created this booking.\n * \n */\n actor?: Actor$2;\n /**\n * Wix site ID of the application that created the booking.\n * @readonly\n */\n appDefId?: string | null;\n /**\n * Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.\n * @readonly\n */\n appName?: string | null;\n }\n enum Platform$2 {\n UNDEFINED_PLATFORM = \"UNDEFINED_PLATFORM\",\n WEB = \"WEB\",\n MOBILE_APP = \"MOBILE_APP\"\n }\n enum Actor$2 {\n UNDEFINED_ACTOR = \"UNDEFINED_ACTOR\",\n BUSINESS = \"BUSINESS\",\n CUSTOMER = \"CUSTOMER\"\n }\n interface ParticipantNotification$7 {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */\n contactId?: string | null;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum IdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface FlowControlSettings$2 {\n /**\n * When true, skips availability checking and allows booking.\n * Requires BOOKINGS.OVERRIDE_AVAILABILITY permissions.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * When true, allows booking a confirmation-required service without requiring confirmation.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n */\n skipBusinessConfirmation?: boolean;\n /**\n * When true, skips selected payment option checking as defined in `selectedPaymentOption` field\n * and allows booking.\n * Requires BOOKINGS.MANAGE_PAYMENTS permissions.\n */\n skipSelectedPaymentOptionValidation?: boolean;\n /** When true, refunds the booking's payment when the booking is canceled. */\n withRefund?: boolean | null;\n }\n interface ExtendedFields$3 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface ParticipantChoices$2 {\n /** Information about the booked service choices. Includes the number of participants. */\n serviceChoices?: ServiceChoices$2[];\n }\n interface ServiceChoices$2 {\n /** Number of participants for this variant. */\n numberOfParticipants?: number | null;\n /** Service choices for these participants. */\n choices?: ServiceChoice$3[];\n }\n interface ServiceChoice$3 extends ServiceChoiceChoiceOneOf$3 {\n /**\n * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.\n * Choices are specific values for an option the customer can choose to book. For example,\n * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n custom?: string;\n /**\n * ID of the corresponding option for the choice. For example, the choice `child`\n * could correspond to the option `ageGroup`. In this case, `optionId` is the ID\n * for the `ageGroup` option.\n */\n optionId?: string;\n }\n /** @oneof */\n interface ServiceChoiceChoiceOneOf$3 {\n /**\n * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.\n * Choices are specific values for an option the customer can choose to book. For example,\n * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n custom?: string;\n }\n interface MultiServiceBookingInfo$2 {\n /**\n * Multi service booking ID.\n * @readonly\n */\n _id?: string | null;\n /** Multi service booking type. */\n type?: MultiServiceBookingType$2;\n }\n /** Possible allowed actions for a Booking */\n interface AllowedActions$1 {\n /** Whether the customer is allowed to cancel the booking. */\n cancel?: boolean;\n /** Whether the customer is allowed to reschedule the booking. */\n reschedule?: boolean;\n /**\n * Deprecated.\n * Whether the customer is entitled to a refund when canceling the booking.\n */\n refund?: boolean | null;\n }\n interface Attendance {\n /**\n * ID of the attendance object.\n * @readonly\n */\n _id?: string | null;\n /**\n * General Information about the booking's attendance.\n *\n * + `NOT_SET`: There is no available attendance information.\n * + `ATTENDED`: At least 1 participant attended the session.\n * + `NOT_ATTENDED`: No participant attended the session.\n */\n status?: AttendanceStatus;\n /** Total number of participants that attended the session. */\n numberOfAttendees?: number;\n }\n interface ConferencingDetails {\n /** URL used by a guest to join the conference. */\n guestUrl?: string | null;\n /** Optional conference password. */\n password?: string | null;\n }\n interface CancellationFeeDetails {\n /** Specifies whether this booking require cancellation fee */\n required?: boolean | null;\n /** the amount of the cancellation fee */\n amount?: Money$2;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface Money$2 {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n formattedValue?: string | null;\n }\n interface QueryExtendedBookingRequest {\n /** Information about filters, paging, and sorting. */\n query: QueryV2$5;\n /**\n * Whether information about which actions the customer can perform\n * for the bookings is returned.\n */\n withBookingAllowedActions?: boolean;\n /** Whether information about the attendance for the bookings is returned. */\n withBookingAttendanceInfo?: boolean;\n /**\n * Filters the retrieved bookings by the booking ID that corresponds to\n * specified `sessionId`. The `booking.id` is calculated by calling\n * [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)\n * and saving the returned values for `participants.Id`.\n * These participant IDs are then used as `booking.id`.\n * This filter overrides the `booking.id` filter inside the query object.\n *\n * __Note__: Bookings for courses don't include a `sessionId`. For these\n * bookings, you must use this field to filter by session ID.\n */\n sessionId?: string | null;\n }\n interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$3;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$6;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$4[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$5 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$3;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$6;\n }\n interface Sorting$4 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$4;\n }\n enum SortOrder$4 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$3 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$6 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryExtendedBookingResponse {\n /**\n * Retrieved bookings and additional information about attendance or actions\n * the customer can perform\n */\n extendedBookings?: ExtendedBooking[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2$5;\n }\n interface PagingMetadataV2$5 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$6;\n }\n interface Cursors$6 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryExtendedBookingsRequest {\n /** Information about filters, paging, and sorting. */\n query: CommonQueryV2$1;\n /**\n * Whether information about which actions the customer can perform\n * for the bookings is returned.\n */\n withBookingAllowedActions?: boolean;\n /** Whether information about the attendance for the bookings is returned. */\n withBookingAttendanceInfo?: boolean;\n }\n interface CommonQueryV2$1 extends CommonQueryV2PagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: CommonPaging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$6;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n *\n * See [Supported Filters](https://www.wix.com/velo/reference/wix-bookings-v2/extendedbookings/supported-filters)\n * for a full list.\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$4[];\n }\n /** @oneof */\n interface CommonQueryV2PagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: CommonPaging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$6;\n }\n interface CommonPaging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryExtendedBookingsResponse {\n /**\n * Retrieved bookings and additional information, such as information about about the attendance or actions\n * the customer can perform.\n */\n extendedBookings?: ExtendedBooking[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2$5;\n }\n interface QueryOptions$1 {\n /**\n * Whether information about which actions the customer can perform\n * for the bookings is returned.\n */\n withBookingAllowedActions?: boolean;\n /** Whether information about the attendance for the bookings is returned. */\n withBookingAttendanceInfo?: boolean;\n /**\n * Filters the retrieved bookings by the booking ID that corresponds to\n * specified `sessionId`. The `booking.id` is calculated by calling\n * [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)\n * and saving the returned values for `participants.Id`.\n * These participant IDs are then used as `booking.id`.\n * This filter overrides the `booking.id` filter inside the query object.\n *\n * __Note__: Bookings for courses don't include a `sessionId`. For these\n * bookings, you must use this field to filter by session ID.\n */\n sessionId?: string | null;\n }\n /**\n * Retrieves a list of bookings, including additional extended information, given the provided paging, filtering, and sorting.\n *\n * Up to 100 extended bookings can be returned per request.\n *\n * `queryExtendedBookings()` runs with these defaults, which you can override:\n *\n * - `createdDate` sorted in `DESC` order\n * - `cursorPaging.limit` is `50`\n *\n *\n * You can retrieve information about which actions the customer can perform\n * for the bookings. To do so, pass `withBookingAllowedActions` as `true`.\n *\n *\n * For field support, see\n * [supported filters](https://www.wix.com/velo/reference/wix-bookings-v2/extendedbookings/supported-filters)\n * for more information.\n *\n * You can specify a filter only once per query. If you specify a filter\n * more than once, only the first filter determines the extended bookings that are returned.\n *\n * When filtering by date, you must use [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n *\n * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @param query - Information about filters, paging, and sorting.\n * @param options - Additional options for performing the query.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryExtendedBookings(query: CommonQueryV2$1, options?: QueryExtendedBookingsOptions): Promise;\n interface QueryExtendedBookingsOptions {\n /**\n * Whether information about which actions the customer can perform\n * for the bookings is returned.\n */\n withBookingAllowedActions?: boolean;\n /** Whether information about the attendance for the bookings is returned. */\n withBookingAttendanceInfo?: boolean;\n }\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_ExtendedBooking = ExtendedBooking;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_AttendanceStatus = AttendanceStatus;\n const bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_AttendanceStatus: typeof AttendanceStatus;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_Attendance = Attendance;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_ConferencingDetails = ConferencingDetails;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_CancellationFeeDetails = CancellationFeeDetails;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingRequest = QueryExtendedBookingRequest;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingResponse = QueryExtendedBookingResponse;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingsRequest = QueryExtendedBookingsRequest;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_CommonPaging = CommonPaging;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingsResponse = QueryExtendedBookingsResponse;\n const bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_queryExtendedBookings: typeof queryExtendedBookings;\n type bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingsOptions = QueryExtendedBookingsOptions;\n namespace bookingsReaderV2ExtendedBookingExtendedBookings_universal_d {\n export { bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_ExtendedBooking as ExtendedBooking, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_AttendanceStatus as AttendanceStatus, Booking$2 as Booking, BookingParticipantsInfoOneOf$2 as BookingParticipantsInfoOneOf, MultiServiceBookingType$2 as MultiServiceBookingType, BookedEntity$2 as BookedEntity, BookedEntityItemOneOf$2 as BookedEntityItemOneOf, BookedSlot$2 as BookedSlot, BookedResource$2 as BookedResource, Location$8 as Location, LocationType$8 as LocationType, BookedSchedule$2 as BookedSchedule, ContactDetails$2 as ContactDetails, Address$7 as Address, AddressStreetOneOf$7 as AddressStreetOneOf, StreetAddress$7 as StreetAddress, AddressLocation$7 as AddressLocation, Subdivision$7 as Subdivision, CustomFormField$2 as CustomFormField, ValueType$2 as ValueType, BookingStatus$2 as BookingStatus, PaymentStatus$2 as PaymentStatus, SelectedPaymentOption$2 as SelectedPaymentOption, BookingSource$2 as BookingSource, Platform$2 as Platform, Actor$2 as Actor, ParticipantNotification$7 as ParticipantNotification, IdentificationData$4 as IdentificationData, IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$2 as IdentityType, FlowControlSettings$2 as FlowControlSettings, ExtendedFields$3 as ExtendedFields, ParticipantChoices$2 as ParticipantChoices, ServiceChoices$2 as ServiceChoices, ServiceChoice$3 as ServiceChoice, ServiceChoiceChoiceOneOf$3 as ServiceChoiceChoiceOneOf, MultiServiceBookingInfo$2 as MultiServiceBookingInfo, AllowedActions$1 as AllowedActions, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_Attendance as Attendance, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_ConferencingDetails as ConferencingDetails, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_CancellationFeeDetails as CancellationFeeDetails, Money$2 as Money, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingRequest as QueryExtendedBookingRequest, QueryV2$5 as QueryV2, QueryV2PagingMethodOneOf$5 as QueryV2PagingMethodOneOf, Sorting$4 as Sorting, SortOrder$4 as SortOrder, Paging$3 as Paging, CursorPaging$6 as CursorPaging, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingResponse as QueryExtendedBookingResponse, PagingMetadataV2$5 as PagingMetadataV2, Cursors$6 as Cursors, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingsRequest as QueryExtendedBookingsRequest, CommonQueryV2$1 as CommonQueryV2, CommonQueryV2PagingMethodOneOf$1 as CommonQueryV2PagingMethodOneOf, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_CommonPaging as CommonPaging, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingsResponse as QueryExtendedBookingsResponse, QueryOptions$1 as QueryOptions, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_queryExtendedBookings as queryExtendedBookings, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d_QueryExtendedBookingsOptions as QueryExtendedBookingsOptions, };\n }\n interface PriceInfo extends PriceInfoTotalPriceOneOf {\n /**\n * Calculated total price. Available only when the\n * service's\n * price has been set up as a numerical value in the\n * `schedule.rate.labeledPriceOptions` object.\n */\n calculatedPrice?: number;\n /**\n * Description of the total price. Available only when the\n * service's\n * price has been set up as a text value in the\n * `schedule.rate.priceText` property.\n */\n priceDescription?: string;\n /** List of line items, including the number of participants and the price per participant. */\n bookingLineItems?: BookingLineItem[];\n /**\n * Total deposit the customer must pay when booking the service.\n *\n * Available when: The service includes a deposit.\n */\n deposit?: number | null;\n }\n /** @oneof */\n interface PriceInfoTotalPriceOneOf {\n /**\n * Calculated total price. Available only when the\n * [service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)'s\n * price has been set up as a numerical value in the\n * [`schedule.rate.labeledPriceOptions`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) object.\n */\n calculatedPrice?: number;\n /**\n * Description of the total price. Available only when the\n * [service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)'s\n * price has been set up as a text value in the\n * [`schedule.rate.priceText`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.\n */\n priceDescription?: string;\n }\n interface BookingLineItem {\n /**\n * Service ID.\n *\n * Required when not using Wix Booking's default pricing logic.\n */\n serviceId?: string | null;\n /** Resource ID. Required for services of type appointment or class. */\n resourceId?: string | null;\n /**\n * Custom choices. Choices are specific values for an option the customer can choose to book.\n * For example, the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n choices?: ServiceChoice$2[];\n /** Number of participants for the line item. */\n numberOfParticipants?: number | null;\n /**\n * Price per participant for the line item.\n * @readonly\n */\n pricePerParticipant?: number | null;\n }\n interface ServiceChoice$2 extends ServiceChoiceChoiceOneOf$2 {\n /**\n * Value for one of the choices in the `CustomServiceOption.choices` list.\n * Choices are specific values for an option the customer can choose to book. For example,\n * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n custom?: string;\n /**\n * ID of the corresponding option for the choice. For example, the choice `child`\n * could correspond to the option `ageGroup`. In this case, `optionId` is the ID\n * for the `ageGroup` option.\n */\n optionId?: string;\n }\n /** @oneof */\n interface ServiceChoiceChoiceOneOf$2 {\n /**\n * Value for one of the choices in the `CustomServiceOption.choices` list.\n * Choices are specific values for an option the customer can choose to book. For example,\n * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n custom?: string;\n }\n interface PreviewPriceRequest {\n /** List of line items to preview the price for. */\n bookingLineItems: BookingLineItem[];\n }\n interface PreviewPriceResponse {\n /** Information about each line item's price and the estimated total price based on the line items. */\n priceInfo?: PriceInfo;\n }\n interface CalculatePriceRequest {\n /** Booking to calculate the price for. */\n booking: Booking$1;\n }\n /** The booking object, version 2. */\n interface Booking$1 extends BookingParticipantsInfoOneOf$1 {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices$1;\n /**\n * Booking ID.\n * @readonly\n */\n _id?: string | null;\n /** An object describing the slot or schedule that was booked. */\n bookedEntity?: BookedEntity$1;\n /** Contact details of the site visitor or member making the booking. */\n contactDetails?: ContactDetails$1;\n /** Additional custom fields submitted with the booking form. */\n additionalFields?: CustomFormField$1[];\n /**\n * Booking status.\n * One of:\n * - `\"CREATED\"` - The booking was created.\n * - `\"UPDATED\"` - The booking was updated.\n * - `\"CONFIRMED\"` - The booking was confirmed and appears on the bookings calendar. A booking can be manually confirmed using the [`confirmOrDecline()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/confirmordeclinebooking) API. A booking can be automatically confirmed when the following requirements are met:\n * + The service is configured as automatically confirmed.\n * + The system invoked the eCommerce checkout API and created an order.\n * - `\"CANCELED\"` - The booking has been canceled and synced to the bookings calendar.\n * The booking can be canceled using [`cancelBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/cancelbooking) API.\n * - `\"PENDING\"` - The booking is waiting to be confirmed or declined by the owner and the booking is synced to the bookings calendar.\n * Bookings can be manually set as `PENDING` using the `setAsPending()` API, by those with Manage Booking Status permissions scopes.\n * Bookings can be automatically set as `PENDING` when the following requirements are met:\n * + The service is configured as manually confirmed.\n * + Invoking the eCommerce checkout API and an order has been created.\n * - `\"WAITING_LIST\"` - The booking is on a waiting list.\n * - `\"DECLINED\"` - The booking was declined by the owner and synced to the Bookings calendar. Bookings can be manually declined using the [`declineBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/declinebooking) API by those with Manage Booking Status permission scopes. Bookings can be automatically declined when one of the following requirements are met:\n * + Invoking the `eCommerce checkout` API and the order declined event has been sent.\n * + Invoking the `eCommerce checkout` API and order approved event has been sent, but the booking is offline and the booking causes a double booking.\n */\n status?: BookingStatus$1;\n /**\n * Payment status.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n * @readonly\n */\n paymentStatus?: PaymentStatus$1;\n /**\n * Selected payment option.\n *\n * Supported values: `\"OFFLINE\"`, `\"ONLINE\"`, `\"MEMBERSHIP\"`, `\"MEMBERSHIP_OFFLINE\"`.\n *\n * One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.\n * When undefined, the payment option is resolved by the service configuration on checkout.\n */\n selectedPaymentOption?: SelectedPaymentOption$1;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */\n revision?: string | null;\n /**\n * ID of the creator of the Booking.\n * If `appId` and another ID are present, the other ID takes precedence.\n * @readonly\n */\n createdBy?: IdentificationData$3;\n /**\n * The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.\n * @readonly\n */\n startDate?: Date;\n /**\n * The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.\n * @readonly\n */\n endDate?: Date;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls. */\n extendedFields?: ExtendedFields$2;\n /**\n * Whether this booking overlaps another existing confirmed booking. Returned when: `true`\n * @readonly\n */\n doubleBooked?: boolean | null;\n }\n /** @oneof */\n interface BookingParticipantsInfoOneOf$1 {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices$1;\n }\n enum MultiServiceBookingType$1 {\n /**\n * Multi service booking will be considered available if its bookings are\n * available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url\n */\n SEQUENTIAL_BOOKINGS = \"SEQUENTIAL_BOOKINGS\",\n /**\n * Multi service booking will be considered available if each of its bookings is available separately.\n * Not supported yet\n */\n SEPARATE_BOOKINGS = \"SEPARATE_BOOKINGS\",\n /** Not supported yet */\n PARALLEL_BOOKINGS = \"PARALLEL_BOOKINGS\"\n }\n interface BookedEntity$1 extends BookedEntityItemOneOf$1 {\n /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */\n slot?: BookedSlot$1;\n /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */\n schedule?: BookedSchedule$1;\n /**\n * Session title at the time of booking.\n * If session doesn't exist at the time of the booking, service name is used.\n * @readonly\n */\n title?: string | null;\n /**\n * List of tags for the booking.\n * System-assigned tags for sessions and schedules are:\n * + \"INDIVIDUAL\" Appointments, including appointments with more than 1 participant.\n * + \"GROUP\" Individual classes.\n * + \"COURSE\" Courses.\n */\n tags?: string[] | null;\n }\n /** @oneof */\n interface BookedEntityItemOneOf$1 {\n /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */\n slot?: BookedSlot$1;\n /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */\n schedule?: BookedSchedule$1;\n }\n interface BookedSlot$1 {\n /**\n * ID of the underlying session when session is a single session or generated from a recurring session.\n * If `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information.\n */\n sessionId?: string | null;\n /** Service ID. */\n serviceId?: string;\n /** Schedule ID. Required. */\n scheduleId?: string;\n /**\n * Calendar 3 event ID\n * If not empty, on all write flows (create / update) gets priority over session_id.\n * so if both session_id and event_id are provided, the session_id that will be set on the booking will be based on the event_id.\n * Otherwise, if event_id is empty on write flow,\n */\n eventId?: string | null;\n /**\n * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n */\n startDate?: string | null;\n /**\n * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n */\n endDate?: string | null;\n /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */\n timezone?: string | null;\n /**\n * The enriched resource assigned to the slot, can be either the requested resource or the resource chosen by the system.\n * When populated, the given resource will be booked according to it's availability.\n * When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,\n * otherwise one of the service resources will be assigned to the slot randomly upon confirmation.\n * This resource is the slot primary resource.\n */\n resource?: BookedResource$1;\n /** Location where the slot's session takes place. */\n location?: Location$7;\n }\n interface BookedResource$1 {\n /** Booked resource ID. */\n _id?: string;\n /** Resource's name at the time of booking. */\n name?: string | null;\n /** Resource's email at the time of booking. */\n email?: string | null;\n /** Resource's schedule ID. */\n scheduleId?: string | null;\n }\n interface Location$7 {\n /**\n * Business location ID. Available only for locations that are business locations,\n * meaning the `location_type` is `\"OWNER_BUSINESS\"`.\n */\n _id?: string | null;\n /** Location name. */\n name?: string | null;\n /** The full address of this location. */\n formattedAddress?: string | null;\n /**\n * Location type.\n *\n * - `\"OWNER_BUSINESS\"`: The business address, as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"`: The address as set when creating the service.\n * - `\"CUSTOM\"`: The address as set for the individual session.\n */\n locationType?: LocationType$7;\n }\n enum LocationType$7 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface BookedSchedule$1 {\n /** Schedule ID. */\n scheduleId?: string;\n /** Booked service ID. */\n serviceId?: string | null;\n /**\n * Location where the schedule's sessions take place. Read only.\n * @readonly\n */\n location?: Location$7;\n /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */\n timezone?: string | null;\n /**\n * The start time of the first session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format. Required.\n * @readonly\n */\n firstSessionStart?: string | null;\n /**\n * The end time of the last session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format. Required.\n * @readonly\n */\n lastSessionEnd?: string | null;\n }\n interface ContactDetails$1 {\n /** Contact's ID. */\n contactId?: string | null;\n /** Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /** Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). */\n email?: string | null;\n /** Contact's phone number. */\n phone?: string | null;\n /** Contact's full address. */\n fullAddress?: Address$6;\n /** Contact's time zone. */\n timeZone?: string | null;\n /** Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n countryCode?: string | null;\n }\n /** Physical address */\n interface Address$6 extends AddressStreetOneOf$6 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$6;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$6;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$6[];\n }\n /** @oneof */\n interface AddressStreetOneOf$6 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$6;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$6 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$6 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$6 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface CustomFormField$1 {\n /** ID of the form field as defined in the form. */\n _id?: string;\n /** Value that was submitted for this field. */\n value?: string | null;\n /**\n * Form field's label at the time of submission.\n * @readonly\n */\n label?: string | null;\n /**\n * Form field value's type at the time of submission.\n *\n * Supported values: `\"SHORT_TEXT\"`, `\"LONG_TEXT\"`, `\"CHECK_BOX\"`\n */\n valueType?: ValueType$1;\n }\n enum ValueType$1 {\n /** Short text. This is the default value type. */\n SHORT_TEXT = \"SHORT_TEXT\",\n /** Long text */\n LONG_TEXT = \"LONG_TEXT\",\n /** a text that represent the check box value: if selected the value is \"true\", otherwise \"false\". */\n CHECK_BOX = \"CHECK_BOX\"\n }\n /** Booking status. */\n enum BookingStatus$1 {\n CREATED = \"CREATED\",\n CONFIRMED = \"CONFIRMED\",\n CANCELED = \"CANCELED\",\n PENDING = \"PENDING\",\n DECLINED = \"DECLINED\",\n WAITING_LIST = \"WAITING_LIST\"\n }\n /**\n * Payment status.\n * Automatically updated when using eCom checkout APIs.\n */\n enum PaymentStatus$1 {\n UNDEFINED = \"UNDEFINED\",\n NOT_PAID = \"NOT_PAID\",\n PAID = \"PAID\",\n /** not supported yet. */\n PARTIALLY_PAID = \"PARTIALLY_PAID\",\n /** not supported yet */\n REFUNDED = \"REFUNDED\",\n EXEMPT = \"EXEMPT\"\n }\n /**\n * The selected payment option.\n * One of the payment options offered by the service.\n * This field is be set when the user selects an option during booking.\n * If left undefined, the payment option is resolved by the service configuration on checkout.\n */\n enum SelectedPaymentOption$1 {\n UNDEFINED = \"UNDEFINED\",\n OFFLINE = \"OFFLINE\",\n ONLINE = \"ONLINE\",\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface BookingSource$1 {\n /**\n * Platform from which a booking was created\n * \n */\n platform?: Platform$1;\n /**\n * Actor that created this booking.\n * \n */\n actor?: Actor$1;\n /**\n * Wix site ID of the application that created the booking.\n * @readonly\n */\n appDefId?: string | null;\n /**\n * Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.\n * @readonly\n */\n appName?: string | null;\n }\n enum Platform$1 {\n UNDEFINED_PLATFORM = \"UNDEFINED_PLATFORM\",\n WEB = \"WEB\",\n MOBILE_APP = \"MOBILE_APP\"\n }\n enum Actor$1 {\n UNDEFINED_ACTOR = \"UNDEFINED_ACTOR\",\n BUSINESS = \"BUSINESS\",\n CUSTOMER = \"CUSTOMER\"\n }\n interface ParticipantNotification$6 {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */\n contactId?: string | null;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum IdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface FlowControlSettings$1 {\n /**\n * When true, skips availability checking and allows booking.\n * Requires BOOKINGS.OVERRIDE_AVAILABILITY permissions.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * When true, allows booking a confirmation-required service without requiring confirmation.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n */\n skipBusinessConfirmation?: boolean;\n /**\n * When true, skips selected payment option checking as defined in `selectedPaymentOption` field\n * and allows booking.\n * Requires BOOKINGS.MANAGE_PAYMENTS permissions.\n */\n skipSelectedPaymentOptionValidation?: boolean;\n /** When true, refunds the booking's payment when the booking is canceled. */\n withRefund?: boolean | null;\n }\n interface ExtendedFields$2 {\n /**\n * Data Extensions extended fields expressed as a set of key-value pairs:\n *\n * `key:value`\n *\n * + `key` is the namespace, type `string`.\n * + `value` is the data of the extended fields data, type `struct`.\n */\n namespaces?: Record>;\n }\n interface ParticipantChoices$1 {\n /** Information about the booked service choices. Includes the number of participants. */\n serviceChoices?: ServiceChoices$1[];\n }\n interface ServiceChoices$1 {\n /** Number of participants for this variant. */\n numberOfParticipants?: number | null;\n /** Service choices for these participants. */\n choices?: ServiceChoice$2[];\n }\n interface MultiServiceBookingInfo$1 {\n /**\n * Multi service booking ID.\n * @readonly\n */\n _id?: string | null;\n /** Multi service booking type. */\n type?: MultiServiceBookingType$1;\n }\n interface CalculatePriceResponse {\n /** Information about each line item's price and the actual total base price. */\n priceInfo?: PriceInfo;\n }\n /**\n * Previews the base price for a set of line items belonging to the same service\n * before a potential booking is actually created.\n *\n *\n *\n * The returned price preview information about each line\n * item's price and sums up each line item's price.\n *\n * The previewed price is not the actual price that will be used to charge the customer.\n * `Preview Price` only estimates the base price by adding up the price\n * of each line item before\n * the booking is actually created.\n *\n * Use [`Calculate Price`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice) to get the base price\n * after the booking is created.\n *\n * Passing line items that belong to different services results in an error.\n *\n * ## Calculating the previewed price\n *\n * Wix Bookings has its own default pricing logic for previewing the price. You must\n * pass the `serviceId` in the `slot`\n * or `schedule` object to [`previewPrice()`].\n *\n * You cannot call `previewPrice()` if you have customized Bookings pricing logic using the\n * [Bookings Pricing Integration REST SPI](https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi). Calling `previewPrice` if custom pricing\n * logic has been implemented for the site results in an error.\n * @param bookingLineItems - List of line items to preview the price for.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingLineItems\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function previewPrice(bookingLineItems: BookingLineItem[]): Promise;\n /**\n * Calculates the base price of a booking.\n *\n *\n *\n * You can call [`calculatePrice()`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice) after a booking is created. The returned calculated price includes information about each line\n * item's price and the booking's total price.\n *\n * You can use [`previewPrice()`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/previewprice) to get the base price\n * before a booking is created.\n *\n * The calculated price is the base price that will be used as a basis for charging the customer.\n * During checkout, additional taxes\n * and fees might be added to this base price.\n *\n * ## Calculating the price\n *\n * Wix Bookings has its own default pricing logic for calculating the price. When\n * using Wix Bookings' default pricing logic, you must pass the `serviceId` in the `slot`\n * or `schedule` object to [`calculatePrice()`](https://www.wix.com/velo/reference/wix-bookings-v2/pricing/calculateprice).\n *\n * Alternatively you can customize the pricing logic using the\n * [Bookings Pricing Integration REST SPI](https://dev.wix.com/api/rest/wix-bookings/pricing-integration-spi).\n * If you integrate with a pricing provider, the customized pricing logic becomes\n * the default logic. This means that, if the Pricing Integration SPI is implemented,\n * when calling `calculatePrice()`,\n * the customized logic is used instead.\n * @param booking - Booking to calculate the price for.\n * @public\n * @documentationMaturity preview\n * @requiredField booking\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function calculatePrice(booking: Booking$1): Promise;\n type bookingsV2PriceInfoPricing_universal_d_PriceInfo = PriceInfo;\n type bookingsV2PriceInfoPricing_universal_d_PriceInfoTotalPriceOneOf = PriceInfoTotalPriceOneOf;\n type bookingsV2PriceInfoPricing_universal_d_BookingLineItem = BookingLineItem;\n type bookingsV2PriceInfoPricing_universal_d_PreviewPriceRequest = PreviewPriceRequest;\n type bookingsV2PriceInfoPricing_universal_d_PreviewPriceResponse = PreviewPriceResponse;\n type bookingsV2PriceInfoPricing_universal_d_CalculatePriceRequest = CalculatePriceRequest;\n type bookingsV2PriceInfoPricing_universal_d_CalculatePriceResponse = CalculatePriceResponse;\n const bookingsV2PriceInfoPricing_universal_d_previewPrice: typeof previewPrice;\n const bookingsV2PriceInfoPricing_universal_d_calculatePrice: typeof calculatePrice;\n namespace bookingsV2PriceInfoPricing_universal_d {\n export { bookingsV2PriceInfoPricing_universal_d_PriceInfo as PriceInfo, bookingsV2PriceInfoPricing_universal_d_PriceInfoTotalPriceOneOf as PriceInfoTotalPriceOneOf, bookingsV2PriceInfoPricing_universal_d_BookingLineItem as BookingLineItem, ServiceChoice$2 as ServiceChoice, ServiceChoiceChoiceOneOf$2 as ServiceChoiceChoiceOneOf, bookingsV2PriceInfoPricing_universal_d_PreviewPriceRequest as PreviewPriceRequest, bookingsV2PriceInfoPricing_universal_d_PreviewPriceResponse as PreviewPriceResponse, bookingsV2PriceInfoPricing_universal_d_CalculatePriceRequest as CalculatePriceRequest, Booking$1 as Booking, BookingParticipantsInfoOneOf$1 as BookingParticipantsInfoOneOf, MultiServiceBookingType$1 as MultiServiceBookingType, BookedEntity$1 as BookedEntity, BookedEntityItemOneOf$1 as BookedEntityItemOneOf, BookedSlot$1 as BookedSlot, BookedResource$1 as BookedResource, Location$7 as Location, LocationType$7 as LocationType, BookedSchedule$1 as BookedSchedule, ContactDetails$1 as ContactDetails, Address$6 as Address, AddressStreetOneOf$6 as AddressStreetOneOf, StreetAddress$6 as StreetAddress, AddressLocation$6 as AddressLocation, Subdivision$6 as Subdivision, CustomFormField$1 as CustomFormField, ValueType$1 as ValueType, BookingStatus$1 as BookingStatus, PaymentStatus$1 as PaymentStatus, SelectedPaymentOption$1 as SelectedPaymentOption, BookingSource$1 as BookingSource, Platform$1 as Platform, Actor$1 as Actor, ParticipantNotification$6 as ParticipantNotification, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, IdentityType$1 as IdentityType, FlowControlSettings$1 as FlowControlSettings, ExtendedFields$2 as ExtendedFields, ParticipantChoices$1 as ParticipantChoices, ServiceChoices$1 as ServiceChoices, MultiServiceBookingInfo$1 as MultiServiceBookingInfo, bookingsV2PriceInfoPricing_universal_d_CalculatePriceResponse as CalculatePriceResponse, bookingsV2PriceInfoPricing_universal_d_previewPrice as previewPrice, bookingsV2PriceInfoPricing_universal_d_calculatePrice as calculatePrice, };\n }\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Session$4 {\n /**\n * Session ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the schedule that the session belongs to. */\n scheduleId?: string;\n /**\n * ID of the resource or service that the session's schedule belongs to.\n * @readonly\n */\n scheduleOwnerId?: string | null;\n /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */\n originalStart?: Date;\n /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */\n start?: CalendarDateTime$4;\n /**\n * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.\n * If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end?: CalendarDateTime$4;\n /**\n * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.\n * The array is inherited from the schedule and can be overridden even if the session is a recurring session.\n */\n affectedSchedules?: LinkedSchedule$4[];\n /**\n * Session title.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags?: string[] | null;\n /**\n * An object describing the location where the session takes place.\n * Defaults to the schedule location.\n * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.\n */\n location?: Location$6;\n /**\n * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate$4;\n /**\n * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.\n * If the session is a recurring session, this field must be empty.\n */\n timeReservedAfter?: number | null;\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * The number of participants booked for the session. Read-only.\n * Calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** list of participants booked for the session.\n * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.\n * If the session is a recurring session, this field must be empty.\n * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n */\n participants?: Participant$4[];\n /**\n * A list of properties for which values were inherited from the schedule.\n * This does not include participants that were inherited from the schedule.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides$4;\n /**\n * Session status.\n *\n * Supported values:\n * - `CONFIRMED`: Default value.\n * - `CANCELLED`: The session was deleted.\n * @readonly\n */\n status?: Status$4;\n /**\n * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.\n * For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.\n * This field is omitted for single sessions or instances of recurring sessions.\n * Specified when the session was originally generated from a schedule recurring interval.\n * Deprecated. Use `recurringSessionId`.\n * @readonly\n */\n recurringIntervalId?: string | null;\n /**\n * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.\n * @readonly\n */\n recurringSessionId?: string | null;\n /**\n * Session type.\n *\n * Supported values:\n * - `EVENT`: Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n * - `WORKING_HOURS`: Placeholder for available time on a resource’s schedule.\n */\n type?: SessionType$4;\n /**\n * A conference created for the session according to the details set in the schedule's conference provider information.\n * If the session is a recurring session, this field is inherited from the schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference$4;\n /**\n * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n * \n */\n recurrence?: string | null;\n /**\n * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\n * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.\n * @readonly\n */\n instanceOfRecurrence?: string | null;\n /**\n * The session version.\n * Composed by the schedule, session and participants versions.\n * @readonly\n */\n version?: Version$4;\n }\n interface CalendarDateTime$4 {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.\n */\n timestamp?: Date;\n /** An object containing the local date and time for the business's time zone. */\n localDateTime?: LocalDateTime$4;\n /**\n * The time zone. Optional. Derived from the schedule's time zone.\n * In case this field is associated with recurring session, this field is empty.\n * @readonly\n */\n timeZone?: string | null;\n }\n interface LocalDateTime$4 {\n /** Year. 4-digit format. */\n year?: number | null;\n /** Month number, from 1-12. */\n monthOfYear?: number | null;\n /** Day of the month, from 1-31. */\n dayOfMonth?: number | null;\n /** Hour of the day in 24-hour format, from 0-23. */\n hourOfDay?: number | null;\n /** Minute, from 0-59. */\n minutesOfHour?: number | null;\n }\n interface LinkedSchedule$4 {\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * Sets this schedule's availability for the duration of the linked schedule's sessions.\n *\n * Supported values:\n * - `FREE`: This schedule can have available slots during the linked schedule's sessions.\n * - `BUSY`: This schedule cannot have any available slots during the linked schedule's sessions.\n *\n * Default: `BUSY`\n */\n transparency?: Transparency$4;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n }\n enum Transparency$4 {\n UNDEFINED = \"UNDEFINED\",\n /** The schedule can have available slots during the session. */\n FREE = \"FREE\",\n /** The schedule cannot have available slots during the session. Default value. */\n BUSY = \"BUSY\"\n }\n interface Location$6 {\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: LocationType$6;\n /** Free text address used when locationType is `OWNER_CUSTOM`. */\n address?: string | null;\n /** Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default. */\n customAddress?: Address$5;\n }\n enum LocationType$6 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface Address$5 extends AddressStreetOneOf$5 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$5;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$5;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$5[];\n }\n /** @oneof */\n interface AddressStreetOneOf$5 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$5;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$5 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$5 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$5 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface LocationsLocation$4 {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status. `INACTIVE` is currently not supported.\n */\n status?: LocationStatus$4;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n */\n locationType?: LocationsLocationType$4;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: LocationsAddress$4;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$4;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationsLocationType$4[];\n }\n /** For future use */\n enum LocationStatus$4 {\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n /** For future use */\n enum LocationsLocationType$4 {\n UNKNOWN = \"UNKNOWN\",\n BRANCH = \"BRANCH\",\n OFFICES = \"OFFICES\",\n RECEPTION = \"RECEPTION\",\n HEADQUARTERS = \"HEADQUARTERS\",\n INVENTORY = \"INVENTORY\"\n }\n interface LocationsAddress$4 {\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n streetAddress?: LocationsStreetAddress$4;\n /** Full address of the location. */\n formatted?: string | null;\n /** Geographic coordinates of location. */\n location?: LocationsAddressLocation$4;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface LocationsStreetAddress$4 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n /** Address Geolocation */\n interface LocationsAddressLocation$4 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number | null;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number | null;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$4 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$4[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$4[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$4 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$4;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$4;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$4 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$4 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Rate$4 {\n /**\n * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n labeledPriceOptions?: Record;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n priceText?: string | null;\n }\n interface Price$4 {\n /** Required payment amount. */\n amount?: string;\n /** Currency in which the amount is quoted. */\n currency?: string;\n /** Amount of a down payment or deposit as part of the transaction. */\n downPayAmount?: string;\n }\n interface Participant$4 {\n /** Participant ID. Currently represents the booking.id. */\n _id?: string;\n /** Contact ID. */\n contactId?: string | null;\n /** Participant's name. */\n name?: string | null;\n /** Participant's phone number. */\n phone?: string | null;\n /** Participant's email address. */\n email?: string | null;\n /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */\n partySize?: number;\n /**\n * Approval status for the participant.\n *\n * Supported values:\n * - `PENDING`: Pending business approval.\n * - `APPROVED`: Approved by the business.\n * - `DECLINED`: Declined by the business.\n */\n approvalStatus?: ApprovalStatus$4;\n /**\n * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.\n * @readonly\n */\n inherited?: boolean;\n }\n enum ApprovalStatus$4 {\n /** Default. */\n UNDEFINED = \"UNDEFINED\",\n /** Pending business approval. */\n PENDING = \"PENDING\",\n /** Approved by the business. */\n APPROVED = \"APPROVED\",\n /** Declined by the business. */\n DECLINED = \"DECLINED\"\n }\n interface ExternalCalendarInfo$4 {\n /** The external calendar type (e.g. Google Calendar, iCal, etc). */\n calendarType?: CalendarType$4;\n }\n enum CalendarType$4 {\n UNDEFINED = \"UNDEFINED\",\n GOOGLE = \"GOOGLE\",\n I_CAL = \"I_CAL\",\n /** Use `MICROSOFT` instead. */\n OUTLOOK = \"OUTLOOK\",\n /** Use `MICROSOFT` instead. */\n OFFICE_365 = \"OFFICE_365\",\n MICROSOFT = \"MICROSOFT\",\n OTHER = \"OTHER\"\n }\n interface ExternalCalendarOverrides$4 {\n /** Synced title of the external calendar event. */\n title?: string | null;\n /** Synced description of the external calendar event. */\n description?: string | null;\n }\n enum Status$4 {\n UNDEFINED = \"UNDEFINED\",\n /** The session is confirmed. Default status. */\n CONFIRMED = \"CONFIRMED\",\n /**\n * The session is cancelled.\n * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.\n * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.\n */\n CANCELLED = \"CANCELLED\"\n }\n enum SessionType$4 {\n UNDEFINED = \"UNDEFINED\",\n /**\n * The session creates an event on the calendar for the owner of the schedule that the session belongs to.\n * Default type.\n */\n EVENT = \"EVENT\",\n /** The session represents a resource's available working hours. */\n WORKING_HOURS = \"WORKING_HOURS\",\n /** Deprecated. please use WORKING_HOURS */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface CalendarConference$4 {\n /** Wix Calendar conference ID. */\n _id?: string;\n /** Conference meeting ID in the provider's conferencing system. */\n externalId?: string;\n /** Conference provider ID. */\n providerId?: string;\n /** URL used by the host to start the conference. */\n hostUrl?: string;\n /** URL used by a guest to join the conference. */\n guestUrl?: string;\n /** Password to join the conference. */\n password?: string | null;\n /** Conference description. */\n description?: string | null;\n /**\n * Conference type.\n *\n * Supported values:\n * - `ONLINE_MEETING_PROVIDER`: API-generated online meeting.\n * - `CUSTOM`: User-defined meeting.\n */\n conferenceType?: ConferenceType$4;\n /** ID of the account owner in the video conferencing service. */\n accountOwnerId?: string | null;\n }\n enum ConferenceType$4 {\n UNDEFINED = \"UNDEFINED\",\n /** API-generated online meeting. */\n ONLINE_MEETING_PROVIDER = \"ONLINE_MEETING_PROVIDER\",\n /** User-defined meeting. */\n CUSTOM = \"CUSTOM\"\n }\n interface Version$4 {\n /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */\n number?: string | null;\n }\n interface CreateSessionRequest {\n /** The session to create. */\n session?: Session$4;\n }\n interface CreateSessionResponse {\n /** The created session. */\n session?: Session$4;\n }\n interface UpdateSessionRequest {\n /** The session to update. */\n session?: Session$4;\n /** Whether to notify participants about the change, and an optional custom message. */\n participantNotification?: ParticipantNotification$5;\n }\n interface ParticipantNotification$5 {\n /**\n * Whether to notify participants about the change.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface UpdateSessionResponse {\n /** The updated session. */\n session?: Session$4;\n }\n interface DeleteSessionRequest {\n /** The ID of the session to delete. */\n sessionId?: string | null;\n /** Whether to notify participants about the change, and an optional custom message. */\n participantNotification?: ParticipantNotification$5;\n }\n interface DeleteSessionResponse {\n }\n interface QuerySessionsRequest {\n /**\n * Start of the time range for which sessions are returned, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n *\n * Sessions that begin before the `fromDate` but end after it are included in the results. For recurring session definitions, this means the `start` value is before the `fromDate` and the `UNTIL` value in the `recurrence` property is after the `fromDate`.\n *\n * Required, unless `query.cursorPaging` is provided.\n */\n fromDate?: Date;\n /**\n * End of the time range for which sessions are returned, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n *\n * Sessions that begin before the `toDate` but end after it are included in the results. For recurring session definitions, this means the `start` value is before the `toDate` and the `UNTIL` value in the `recurrence` property is after the `toDate`.\n *\n * Required, unless `query.cursorPaging` is provided.\n *\n * Max: 1 year after `fromDate` for session instance queries. This limit doesn't apply to recurring session definition queries.\n */\n toDate?: Date;\n /** Query options. */\n query?: QueryV2$4;\n /**\n * Type of sessions to return.\n *\n * - `EVENT`: Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n * - `WORKING_HOURS`: Placeholder for available time on a resource’s schedule.\n *\n * Default: `UNDEFINED`. This returns sessions of all types.\n */\n type?: SessionTypeFilter;\n /**\n * Whether to return only single session instances and instances of recurring sessions.\n *\n * If `true`, only single session instances and instances of recurring sessions are returned.\n *\n * If `false`, only recurring session definitions are returned. **Note:** Cursor pagination is not supported for recurring session definition queries.\n *\n * Default: `true`.\n */\n instances?: boolean | null;\n /**\n * Whether to include sessions imported from connected external calendars in the results.\n *\n * Default: `false`.\n */\n includeExternal?: boolean | null;\n }\n interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {\n /**\n * Cursor token pointing to a page of results.\n * Not used in the first request.\n * Following requests use the cursor token and not `filter`.\n */\n cursorPaging?: CursorPaging$5;\n /**\n * Filter object. For field support for filters, see\n * [Sessions: Supported Filters](./filtering).\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information about querying with filters.\n */\n filter?: Record | null;\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns session objects without personal information.\n * - `ALL_PI`: Returns complete session objects, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$4 {\n /**\n * Cursor token pointing to a page of results.\n * Not used in the first request.\n * Following requests use the cursor token and not `filter`.\n */\n cursorPaging?: CursorPaging$5;\n }\n interface CursorPaging$5 {\n /**\n * Number of sessions to return.\n *\n * Default: `100`\n * Max: `1000`\n */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n enum SessionTypeFilter {\n UNKNOWN_SESSION_TYPE = \"UNKNOWN_SESSION_TYPE\",\n /** Filter sessions of type `EVENT`. This is the default. */\n EVENT = \"EVENT\",\n /** Filter sessions of type `WORKING_HOURS`. */\n WORKING_HOURS = \"WORKING_HOURS\",\n /** Return sessions of any type. */\n ALL = \"ALL\"\n }\n interface QuerySessionsResponse {\n /** List of sessions matching the query. */\n sessions?: Session$4[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$3;\n }\n /** This is the preferred message for cursor-paging enabled services */\n interface CursorPagingMetadata$3 {\n /** Number of sessions returned in the response. */\n count?: number | null;\n /** Cursors to navigate through the result pages. */\n cursors?: Cursors$5;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$5 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n }\n interface GetSessionRequest {\n /** ID of the session to retrieve. */\n _id: string | null;\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns a session object without personal information.\n * - `ALL_PI`: Returns a complete session object, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n }\n interface GetSessionResponse {\n /** Retrieved session. */\n session?: Session$4;\n }\n interface ListSessionsRequest {\n /** IDs of the sessions to retrieve. */\n ids: string[] | null;\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns session objects without personal information.\n * - `ALL_PI`: Returns complete session objects, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n }\n interface ListSessionsResponse {\n /** Retrieved sessions. */\n sessions?: Session$4[];\n }\n interface QueryEventSessionInstancesRequest {\n /**\n * Start of the time range for which sessions are returned\n * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n * Required, if `query.cursorPaging` is omitted.\n * `end.timestamp` of all returned sessions is greater than or equal to `fromDate`.\n */\n fromDate?: Date;\n /**\n * End of the time range for which sessions are returned\n * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n * Required, if `query.cursorPaging` is omitted.\n * `start.timestamp` of all returned sessions is less than or equal to `toDate`.\n */\n toDate?: Date;\n /** Information about filters, paging, and returned fields. */\n query?: CommonQueryV2;\n }\n interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `query.filter`. */\n cursorPaging?: CommonCursorPaging;\n /**\n * Filter object.\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * for more information.\n *\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n *\n * For a detailed list of supported filters, see\n * [Supported Filters](https://dev.wix.com/api/rest/wix-bookings/calendar-v2/filters).\n */\n filter?: Record | null;\n /**\n * Supported values: `ALL_PI`.\n *\n * Predefined sets of fields to return.\n *\n * - `ALL_PI`: Returns complete session objects.\n *\n * If you don't pass a value in the `fieldsets` array, session objects without\n * personal information are returned by default. This means without `participants`,\n * `location`, `calendarConference`, and `externalCalendarOverrides`.\n */\n fieldsets?: string[];\n }\n /** @oneof */\n interface CommonQueryV2PagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `query.filter`. */\n cursorPaging?: CommonCursorPaging;\n }\n interface CommonCursorPaging {\n /**\n * Number of sessions to return.\n * Defaults to `50`. Maximum `1000`.\n */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryEventSessionInstancesResponse {\n /** Retrieved sessions. */\n sessions?: Session$4[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2$4;\n }\n interface PagingMetadataV2$4 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: CommonCursors;\n }\n interface CommonCursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface CacheRequest {\n fromDate?: Date;\n }\n interface CacheResponse {\n cacheInfo?: CacheInfo;\n }\n interface CacheInfo {\n status?: CacheInfoStatus;\n fromDate?: Date;\n toDate?: Date;\n feedReplayId?: string | null;\n sessionCount?: number | null;\n cachedDate?: Date;\n }\n enum CacheInfoStatus {\n UNDEFINED = \"UNDEFINED\",\n INACTIVE = \"INACTIVE\",\n IN_PROGRESS = \"IN_PROGRESS\",\n ACTIVE = \"ACTIVE\"\n }\n interface UncacheRequest {\n }\n interface UncacheResponse {\n }\n interface ShortenCacheRequest {\n /**\n * The new cache from date to set.\n * Must be after than the current from date.\n */\n fromDate?: Date;\n }\n interface ShortenCacheResponse {\n /** The updated cache. */\n cacheInfo?: CacheInfo;\n }\n interface GetCacheInfoRequest {\n includeSessionCount?: boolean | null;\n }\n interface GetCacheInfoResponse {\n cacheInfo?: CacheInfo;\n }\n interface FeedEvent$1 extends FeedEventTypeOneOf$1 {\n /** Session has been added or updated within the feed window. */\n sessionAddedOrUpdated?: SessionAddedOrUpdated$1;\n /** Session has been removed from the feed. */\n sessionRemoved?: SessionRemoved$1;\n /** The feed window has been extended. */\n windowExtended?: WindowExtended$1;\n }\n /** @oneof */\n interface FeedEventTypeOneOf$1 {\n /** Session has been added or updated within the feed window. */\n sessionAddedOrUpdated?: SessionAddedOrUpdated$1;\n /** Session has been removed from the feed. */\n sessionRemoved?: SessionRemoved$1;\n /** The feed window has been extended. */\n windowExtended?: WindowExtended$1;\n }\n interface SessionAddedOrUpdated$1 {\n /** The session which was added or updated within the view. */\n session?: Session$4;\n /** Optionally, the previous session. */\n previousSession?: Session$4;\n }\n interface SessionRemoved$1 {\n /** The updated session which was removed from the view. */\n session?: Session$4;\n /** Optionally, the previous session. */\n previousSession?: Session$4;\n }\n interface WindowExtended$1 {\n /** The updated window end date. */\n windowEndDate?: Date;\n }\n /** Deprecated. Please use `window_extended` instead. */\n interface WindowMoved$1 {\n /** The updated window edge. */\n edge?: Date;\n /** The window version. */\n windowVersion?: number | null;\n }\n interface Empty$4 {\n }\n interface FeedReplayEvent$1 extends FeedReplayEventTypeOneOf$1 {\n /** Session has been added within the feed window. */\n sessionAdded?: SessionAdded$1;\n /** Sessions replay completed. */\n replayCompleted?: ReplayCompleted$1;\n replayId?: string | null;\n }\n /** @oneof */\n interface FeedReplayEventTypeOneOf$1 {\n /** Session has been added within the feed window. */\n sessionAdded?: SessionAdded$1;\n /** Sessions replay completed. */\n replayCompleted?: ReplayCompleted$1;\n }\n interface SessionAdded$1 {\n /** The session which was added within the feed window. */\n session?: Session$4;\n }\n interface ReplayCompleted$1 {\n /** The (minimum) number of sessions that were replayed. */\n totalSessions?: number | null;\n }\n interface QuerySessionsResponseNonNullableFields {\n sessions: {\n scheduleId: string;\n affectedSchedules: {\n scheduleId: string;\n transparency: Transparency$4;\n scheduleOwnerId: string;\n }[];\n location?: {\n locationType: LocationType$6;\n customAddress?: {\n streetAddress?: {\n number: string;\n name: string;\n apt: string;\n };\n subdivisions: {\n code: string;\n name: string;\n }[];\n };\n };\n rate?: {\n labeledPriceOptions?: {\n amount: string;\n currency: string;\n downPayAmount: string;\n };\n };\n notes: string;\n totalNumberOfParticipants: number;\n participants: {\n _id: string;\n partySize: number;\n approvalStatus: ApprovalStatus$4;\n inherited: boolean;\n }[];\n inheritedFields: string[];\n status: Status$4;\n type: SessionType$4;\n calendarConference?: {\n _id: string;\n externalId: string;\n providerId: string;\n hostUrl: string;\n guestUrl: string;\n conferenceType: ConferenceType$4;\n };\n }[];\n }\n interface GetSessionResponseNonNullableFields {\n session?: {\n scheduleId: string;\n affectedSchedules: {\n scheduleId: string;\n transparency: Transparency$4;\n scheduleOwnerId: string;\n }[];\n location?: {\n locationType: LocationType$6;\n customAddress?: {\n streetAddress?: {\n number: string;\n name: string;\n apt: string;\n };\n subdivisions: {\n code: string;\n name: string;\n }[];\n };\n };\n rate?: {\n labeledPriceOptions?: {\n amount: string;\n currency: string;\n downPayAmount: string;\n };\n };\n notes: string;\n totalNumberOfParticipants: number;\n participants: {\n _id: string;\n partySize: number;\n approvalStatus: ApprovalStatus$4;\n inherited: boolean;\n }[];\n inheritedFields: string[];\n status: Status$4;\n type: SessionType$4;\n calendarConference?: {\n _id: string;\n externalId: string;\n providerId: string;\n hostUrl: string;\n guestUrl: string;\n conferenceType: ConferenceType$4;\n };\n };\n }\n interface ListSessionsResponseNonNullableFields {\n sessions: {\n scheduleId: string;\n affectedSchedules: {\n scheduleId: string;\n transparency: Transparency$4;\n scheduleOwnerId: string;\n }[];\n location?: {\n locationType: LocationType$6;\n customAddress?: {\n streetAddress?: {\n number: string;\n name: string;\n apt: string;\n };\n subdivisions: {\n code: string;\n name: string;\n }[];\n };\n };\n rate?: {\n labeledPriceOptions?: {\n amount: string;\n currency: string;\n downPayAmount: string;\n };\n };\n notes: string;\n totalNumberOfParticipants: number;\n participants: {\n _id: string;\n partySize: number;\n approvalStatus: ApprovalStatus$4;\n inherited: boolean;\n }[];\n inheritedFields: string[];\n status: Status$4;\n type: SessionType$4;\n calendarConference?: {\n _id: string;\n externalId: string;\n providerId: string;\n hostUrl: string;\n guestUrl: string;\n conferenceType: ConferenceType$4;\n };\n }[];\n }\n /**\n * Retrieves a list of sessions, given the provided time range, filtering, and paging.\n *\n *\n * The `querySessions()` function builds a query to retrieve a list of sessions, and returns a `SessionQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the `find()` function.\n *\n * To query all event instances within a specified time range of up to 1 year, set `options.type` to `EVENT` and specify the time range in `options.startDate` and `options.endDate`.\n *\n * You can refine the query by chaining `SessionQueryBuilder` functions to the query, before chaining `find()`. These enable you to filter and control the results a query returns.\n *\n * The `querySessions()` function runs with these defaults, which you can override:\n * - All session types are returned.\n * - `options.instances` is true. This means only single sessions and instances of recurring sessions are returned.\n * - Session objects are returned with the fields specified in the `NO_PI` fieldset. This means they don't contain personal information.\n *\n * Note the following limitations, which you can't override:\n * - Sessions are always sorted by `start.timestamp` in `ASC` order.\n * - The maximum time range you can query is 1 year.\n *\n * To query only for events, set `options.type` to `EVENT`. An event is a single or recurring session that appears in a calendar, for example an appointment or a class.\n *\n * To query for recurring session pattern definitions, set `options.instances` to `false`. In this case, you don't need to specify a time range.\n *\n * To return session objects including personal information, use the `ALL_PI` fieldset. This requires elevating permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n *\n * For details on fieldsets, see [Sessions: Supported Fieldsets](https://www.wix.com/velo/reference/wix-bookings-v2/sessions/fieldsets).\n * For details on supported filters, see [Sessions: Supported Filters](https://www.wix.com/velo/reference/wix-bookings-v2/sessions/supported-filters).\n * @public\n * @documentationMaturity preview\n * @requiredField fromDate\n * @requiredField toDate\n * @param options - Options for customizing a query.\n *\n * To query all event instances within a specific time range of up to 1 year, set `options.type` to `EVENT` and specify the time range in `options.startDate` and `options.endDate`.\n * @param fromDate - Start of the time range for which sessions are returned, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n *\n * Sessions that begin before the `fromDate` but end after it are included in the results. For recurring session definitions, this means the `start` value is before the `fromDate` and the `UNTIL` value in the `recurrence` property is after the `fromDate`.\n *\n * Required, unless `query.cursorPaging` is provided.\n * @param toDate - End of the time range for which sessions are returned, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\n *\n * Sessions that begin before the `toDate` but end after it are included in the results. For recurring session definitions, this means the `start` value is before the `toDate` and the `UNTIL` value in the `recurrence` property is after the `toDate`.\n *\n * Required, unless `query.cursorPaging` is provided.\n *\n * Max: 1 year after `fromDate` for session instance queries. This limit doesn't apply to recurring session definition queries.\n * @permissionScope Read Bookings - Public Data\n * @permissionScope Manage Bookings\n * @permissionScope Read Bookings - Including Participants\n * @permissionScope Read Bookings - all read permissions\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScope Manage Bookings - all permissions\n * @permissionScope Read bookings calendar - including participants\n * @permissionScope Read Bookings Calendar\n * @permissionScope Manage Bookings Services and Settings\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function querySessions(fromDate: Date, toDate: Date, options?: QuerySessionsOptions): SessionsQueryBuilder;\n interface QuerySessionsOptions {\n /**\n * Type of sessions to return.\n *\n * - `EVENT`: Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.\n * - `WORKING_HOURS`: Placeholder for available time on a resource’s schedule.\n *\n * Default: `UNDEFINED`. This returns sessions of all types.\n */\n type?: SessionTypeFilter | undefined;\n /**\n * Whether to return only single session instances and instances of recurring sessions.\n *\n * If `true`, only single session instances and instances of recurring sessions are returned.\n *\n * If `false`, only recurring session definitions are returned. **Note:** Cursor pagination is not supported for recurring session definition queries.\n *\n * Default: `true`.\n */\n instances?: boolean | null | undefined;\n /**\n * Whether to include sessions imported from connected external calendars in the results.\n *\n * Default: `false`.\n */\n includeExternal?: boolean | null | undefined;\n }\n interface QueryCursorResult$1 {\n cursors: Cursors$5;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface SessionsQueryResult extends QueryCursorResult$1 {\n items: Session$4[];\n query: SessionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface SessionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"scheduleId\" | \"scheduleOwnerId\" | \"affectedSchedules.scheduleId\" | \"title\" | \"tags\" | \"location.locationType\" | \"location.customAddress.formattedAddress\" | \"location.businessLocation.id\" | \"location.businessLocation.name\" | \"location.businessLocation.address.formattedAddress\" | \"capacity\" | \"participants.contactId\" | \"recurringSessionId\" | \"calendarConference.id\" | \"calendarConference.externalId\" | \"calendarConference.providerId\" | \"instanceOfRecurrence\", value: any) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"scheduleId\" | \"scheduleOwnerId\" | \"title\" | \"location.locationType\" | \"location.customAddress.formattedAddress\" | \"location.businessLocation.id\" | \"location.businessLocation.name\" | \"location.businessLocation.address.formattedAddress\" | \"capacity\" | \"recurringSessionId\" | \"calendarConference.id\" | \"calendarConference.externalId\" | \"calendarConference.providerId\" | \"instanceOfRecurrence\", value: any) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"capacity\", value: any) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"capacity\", value: any) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"capacity\", value: any) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"capacity\", value: any) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"title\" | \"location.customAddress.formattedAddress\" | \"location.businessLocation.name\" | \"location.businessLocation.address.formattedAddress\", value: string) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"scheduleId\" | \"scheduleOwnerId\" | \"affectedSchedules.scheduleId\" | \"affectedSchedules.transparency\" | \"affectedSchedules.scheduleOwnerId\" | \"title\" | \"tags\" | \"location.locationType\" | \"location.customAddress.formattedAddress\" | \"location.businessLocation.id\" | \"location.businessLocation.name\" | \"location.businessLocation.address.formattedAddress\" | \"participants.id\" | \"participants.contactId\" | \"participants.approvalStatus\" | \"inheritedFields\" | \"recurringSessionId\" | \"calendarConference.id\" | \"calendarConference.externalId\" | \"calendarConference.providerId\" | \"instanceOfRecurrence\", value: any[]) => SessionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasAll: (propertyName: \"tags\" | \"inheritedFields\", value: any[]) => SessionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"location\" | \"location.customAddress\" | \"recurringSessionId\" | \"calendarConference\" | \"instanceOfRecurrence\", value: boolean) => SessionsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => SessionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => SessionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves a session by ID.\n *\n *\n * The `getSession()` function returns a Promise that resolves to a session with the specified session ID.\n *\n * By default, a session object is returned with the fields specified in the `NO_PI` fieldset. This means it doesn't contain personal information.\n *\n * To retrieve a full session object including all personal information, use the `ALL_PI` fieldset. This requires elevating permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @param _id - ID of the session to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @param options - Options to use when retrieving a session.\n * @permissionScope Read Bookings - Public Data\n * @permissionScope Manage Bookings\n * @permissionScope Read Bookings - Including Participants\n * @permissionScope Read Bookings - all read permissions\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScope Manage Bookings - all permissions\n * @permissionScope Read bookings calendar - including participants\n * @permissionScope Read Bookings Calendar\n * @permissionScope Manage Bookings Services and Settings\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns Retrieved session.\n */\n function getSession(_id: string | null, options?: GetSessionOptions): Promise[\"session\"]>;\n interface GetSessionOptions {\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns a session object without personal information.\n * - `ALL_PI`: Returns a complete session object, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n }\n /**\n * Retrieves a list of sessions by their IDs.\n *\n *\n * The `listSessions()` function returns a Promise that resolves to the sessions with the specified IDs.\n *\n * By default, session objects are returned with the fields specified in the `NO_PI` fieldset. This means they don't contain personal information.\n *\n * To retrieve full session objects including all personal information, use the `ALL_PI` fieldset. This requires elevating permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @param ids - IDs of the sessions to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @param options - Options to use when retrieving a list of sessions.\n * @permissionScope Read Bookings - Public Data\n * @permissionScope Manage Bookings\n * @permissionScope Read Bookings - Including Participants\n * @permissionScope Read Bookings - all read permissions\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScope Manage Bookings - all permissions\n * @permissionScope Read bookings calendar - including participants\n * @permissionScope Read Bookings Calendar\n * @permissionScope Manage Bookings Services and Settings\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function listSessions(ids: string[] | null, options?: ListSessionsOptions): Promise;\n interface ListSessionsOptions {\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns session objects without personal information.\n * - `ALL_PI`: Returns complete session objects, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n }\n type bookingsCalendarV1SessionSessions_universal_d_CreateSessionRequest = CreateSessionRequest;\n type bookingsCalendarV1SessionSessions_universal_d_CreateSessionResponse = CreateSessionResponse;\n type bookingsCalendarV1SessionSessions_universal_d_UpdateSessionRequest = UpdateSessionRequest;\n type bookingsCalendarV1SessionSessions_universal_d_UpdateSessionResponse = UpdateSessionResponse;\n type bookingsCalendarV1SessionSessions_universal_d_DeleteSessionRequest = DeleteSessionRequest;\n type bookingsCalendarV1SessionSessions_universal_d_DeleteSessionResponse = DeleteSessionResponse;\n type bookingsCalendarV1SessionSessions_universal_d_QuerySessionsRequest = QuerySessionsRequest;\n type bookingsCalendarV1SessionSessions_universal_d_SessionTypeFilter = SessionTypeFilter;\n const bookingsCalendarV1SessionSessions_universal_d_SessionTypeFilter: typeof SessionTypeFilter;\n type bookingsCalendarV1SessionSessions_universal_d_QuerySessionsResponse = QuerySessionsResponse;\n type bookingsCalendarV1SessionSessions_universal_d_GetSessionRequest = GetSessionRequest;\n type bookingsCalendarV1SessionSessions_universal_d_GetSessionResponse = GetSessionResponse;\n type bookingsCalendarV1SessionSessions_universal_d_ListSessionsRequest = ListSessionsRequest;\n type bookingsCalendarV1SessionSessions_universal_d_ListSessionsResponse = ListSessionsResponse;\n type bookingsCalendarV1SessionSessions_universal_d_QueryEventSessionInstancesRequest = QueryEventSessionInstancesRequest;\n type bookingsCalendarV1SessionSessions_universal_d_CommonQueryV2 = CommonQueryV2;\n type bookingsCalendarV1SessionSessions_universal_d_CommonQueryV2PagingMethodOneOf = CommonQueryV2PagingMethodOneOf;\n type bookingsCalendarV1SessionSessions_universal_d_CommonCursorPaging = CommonCursorPaging;\n type bookingsCalendarV1SessionSessions_universal_d_QueryEventSessionInstancesResponse = QueryEventSessionInstancesResponse;\n type bookingsCalendarV1SessionSessions_universal_d_CommonCursors = CommonCursors;\n type bookingsCalendarV1SessionSessions_universal_d_CacheRequest = CacheRequest;\n type bookingsCalendarV1SessionSessions_universal_d_CacheResponse = CacheResponse;\n type bookingsCalendarV1SessionSessions_universal_d_CacheInfo = CacheInfo;\n type bookingsCalendarV1SessionSessions_universal_d_CacheInfoStatus = CacheInfoStatus;\n const bookingsCalendarV1SessionSessions_universal_d_CacheInfoStatus: typeof CacheInfoStatus;\n type bookingsCalendarV1SessionSessions_universal_d_UncacheRequest = UncacheRequest;\n type bookingsCalendarV1SessionSessions_universal_d_UncacheResponse = UncacheResponse;\n type bookingsCalendarV1SessionSessions_universal_d_ShortenCacheRequest = ShortenCacheRequest;\n type bookingsCalendarV1SessionSessions_universal_d_ShortenCacheResponse = ShortenCacheResponse;\n type bookingsCalendarV1SessionSessions_universal_d_GetCacheInfoRequest = GetCacheInfoRequest;\n type bookingsCalendarV1SessionSessions_universal_d_GetCacheInfoResponse = GetCacheInfoResponse;\n type bookingsCalendarV1SessionSessions_universal_d_QuerySessionsResponseNonNullableFields = QuerySessionsResponseNonNullableFields;\n type bookingsCalendarV1SessionSessions_universal_d_GetSessionResponseNonNullableFields = GetSessionResponseNonNullableFields;\n type bookingsCalendarV1SessionSessions_universal_d_ListSessionsResponseNonNullableFields = ListSessionsResponseNonNullableFields;\n const bookingsCalendarV1SessionSessions_universal_d_querySessions: typeof querySessions;\n type bookingsCalendarV1SessionSessions_universal_d_QuerySessionsOptions = QuerySessionsOptions;\n type bookingsCalendarV1SessionSessions_universal_d_SessionsQueryResult = SessionsQueryResult;\n type bookingsCalendarV1SessionSessions_universal_d_SessionsQueryBuilder = SessionsQueryBuilder;\n const bookingsCalendarV1SessionSessions_universal_d_getSession: typeof getSession;\n type bookingsCalendarV1SessionSessions_universal_d_GetSessionOptions = GetSessionOptions;\n const bookingsCalendarV1SessionSessions_universal_d_listSessions: typeof listSessions;\n type bookingsCalendarV1SessionSessions_universal_d_ListSessionsOptions = ListSessionsOptions;\n namespace bookingsCalendarV1SessionSessions_universal_d {\n export { __debug$1 as __debug, Session$4 as Session, CalendarDateTime$4 as CalendarDateTime, LocalDateTime$4 as LocalDateTime, LinkedSchedule$4 as LinkedSchedule, Transparency$4 as Transparency, Location$6 as Location, LocationType$6 as LocationType, Address$5 as Address, AddressStreetOneOf$5 as AddressStreetOneOf, StreetAddress$5 as StreetAddress, AddressLocation$5 as AddressLocation, Subdivision$5 as Subdivision, LocationsLocation$4 as LocationsLocation, LocationStatus$4 as LocationStatus, LocationsLocationType$4 as LocationsLocationType, LocationsAddress$4 as LocationsAddress, LocationsStreetAddress$4 as LocationsStreetAddress, LocationsAddressLocation$4 as LocationsAddressLocation, BusinessSchedule$4 as BusinessSchedule, TimePeriod$4 as TimePeriod, DayOfWeek$4 as DayOfWeek, SpecialHourPeriod$4 as SpecialHourPeriod, Rate$4 as Rate, Price$4 as Price, Participant$4 as Participant, ApprovalStatus$4 as ApprovalStatus, ExternalCalendarInfo$4 as ExternalCalendarInfo, CalendarType$4 as CalendarType, ExternalCalendarOverrides$4 as ExternalCalendarOverrides, Status$4 as Status, SessionType$4 as SessionType, CalendarConference$4 as CalendarConference, ConferenceType$4 as ConferenceType, Version$4 as Version, bookingsCalendarV1SessionSessions_universal_d_CreateSessionRequest as CreateSessionRequest, bookingsCalendarV1SessionSessions_universal_d_CreateSessionResponse as CreateSessionResponse, bookingsCalendarV1SessionSessions_universal_d_UpdateSessionRequest as UpdateSessionRequest, ParticipantNotification$5 as ParticipantNotification, bookingsCalendarV1SessionSessions_universal_d_UpdateSessionResponse as UpdateSessionResponse, bookingsCalendarV1SessionSessions_universal_d_DeleteSessionRequest as DeleteSessionRequest, bookingsCalendarV1SessionSessions_universal_d_DeleteSessionResponse as DeleteSessionResponse, bookingsCalendarV1SessionSessions_universal_d_QuerySessionsRequest as QuerySessionsRequest, QueryV2$4 as QueryV2, QueryV2PagingMethodOneOf$4 as QueryV2PagingMethodOneOf, CursorPaging$5 as CursorPaging, bookingsCalendarV1SessionSessions_universal_d_SessionTypeFilter as SessionTypeFilter, bookingsCalendarV1SessionSessions_universal_d_QuerySessionsResponse as QuerySessionsResponse, CursorPagingMetadata$3 as CursorPagingMetadata, Cursors$5 as Cursors, bookingsCalendarV1SessionSessions_universal_d_GetSessionRequest as GetSessionRequest, bookingsCalendarV1SessionSessions_universal_d_GetSessionResponse as GetSessionResponse, bookingsCalendarV1SessionSessions_universal_d_ListSessionsRequest as ListSessionsRequest, bookingsCalendarV1SessionSessions_universal_d_ListSessionsResponse as ListSessionsResponse, bookingsCalendarV1SessionSessions_universal_d_QueryEventSessionInstancesRequest as QueryEventSessionInstancesRequest, bookingsCalendarV1SessionSessions_universal_d_CommonQueryV2 as CommonQueryV2, bookingsCalendarV1SessionSessions_universal_d_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf, bookingsCalendarV1SessionSessions_universal_d_CommonCursorPaging as CommonCursorPaging, bookingsCalendarV1SessionSessions_universal_d_QueryEventSessionInstancesResponse as QueryEventSessionInstancesResponse, PagingMetadataV2$4 as PagingMetadataV2, bookingsCalendarV1SessionSessions_universal_d_CommonCursors as CommonCursors, bookingsCalendarV1SessionSessions_universal_d_CacheRequest as CacheRequest, bookingsCalendarV1SessionSessions_universal_d_CacheResponse as CacheResponse, bookingsCalendarV1SessionSessions_universal_d_CacheInfo as CacheInfo, bookingsCalendarV1SessionSessions_universal_d_CacheInfoStatus as CacheInfoStatus, bookingsCalendarV1SessionSessions_universal_d_UncacheRequest as UncacheRequest, bookingsCalendarV1SessionSessions_universal_d_UncacheResponse as UncacheResponse, bookingsCalendarV1SessionSessions_universal_d_ShortenCacheRequest as ShortenCacheRequest, bookingsCalendarV1SessionSessions_universal_d_ShortenCacheResponse as ShortenCacheResponse, bookingsCalendarV1SessionSessions_universal_d_GetCacheInfoRequest as GetCacheInfoRequest, bookingsCalendarV1SessionSessions_universal_d_GetCacheInfoResponse as GetCacheInfoResponse, FeedEvent$1 as FeedEvent, FeedEventTypeOneOf$1 as FeedEventTypeOneOf, SessionAddedOrUpdated$1 as SessionAddedOrUpdated, SessionRemoved$1 as SessionRemoved, WindowExtended$1 as WindowExtended, WindowMoved$1 as WindowMoved, Empty$4 as Empty, FeedReplayEvent$1 as FeedReplayEvent, FeedReplayEventTypeOneOf$1 as FeedReplayEventTypeOneOf, SessionAdded$1 as SessionAdded, ReplayCompleted$1 as ReplayCompleted, bookingsCalendarV1SessionSessions_universal_d_QuerySessionsResponseNonNullableFields as QuerySessionsResponseNonNullableFields, bookingsCalendarV1SessionSessions_universal_d_GetSessionResponseNonNullableFields as GetSessionResponseNonNullableFields, bookingsCalendarV1SessionSessions_universal_d_ListSessionsResponseNonNullableFields as ListSessionsResponseNonNullableFields, bookingsCalendarV1SessionSessions_universal_d_querySessions as querySessions, bookingsCalendarV1SessionSessions_universal_d_QuerySessionsOptions as QuerySessionsOptions, bookingsCalendarV1SessionSessions_universal_d_SessionsQueryResult as SessionsQueryResult, bookingsCalendarV1SessionSessions_universal_d_SessionsQueryBuilder as SessionsQueryBuilder, bookingsCalendarV1SessionSessions_universal_d_getSession as getSession, bookingsCalendarV1SessionSessions_universal_d_GetSessionOptions as GetSessionOptions, bookingsCalendarV1SessionSessions_universal_d_listSessions as listSessions, bookingsCalendarV1SessionSessions_universal_d_ListSessionsOptions as ListSessionsOptions, };\n }\n /** The booking object, version 2. */\n interface Booking extends BookingParticipantsInfoOneOf {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices;\n /**\n * Booking ID.\n * @readonly\n */\n _id?: string | null;\n /** An object describing the slot or schedule that was booked. */\n bookedEntity?: BookedEntity;\n /** Contact details of the site visitor or member making the booking. */\n contactDetails?: ContactDetails;\n /** Additional custom fields submitted with the booking form. */\n additionalFields?: CustomFormField[];\n /**\n * Booking status.\n * Supported values:\n * - `CREATED`: The booking was created.\n * - `UPDATED`: The booking was updated.\n * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business owner confirmation and an eCommerce order was created.\n * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an eCommerce order was created. If the service isn't configured to automatically confirm bookings, you can use `confirmOrDeclineBooking()`.\n * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an eCommerce order was created that resulted in a double booking.\n * - `CANCELED`: The booking was canceled.\n * - `WAITING_LIST`: The booking is on a wait list.\n */\n status?: BookingStatus;\n /**\n * Payment status.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n * @readonly\n */\n paymentStatus?: PaymentStatus;\n /**\n * Selected payment option.\n * One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.\n * When undefined, the payment option is resolved by the service configuration on checkout.\n */\n selectedPaymentOption?: SelectedPaymentOption;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */\n revision?: string | null;\n /**\n * ID of the creator of the Booking.\n * If `appId` and another ID are present, the other ID takes precedence.\n * @readonly\n */\n createdBy?: CommonIdentificationData;\n /**\n * The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.\n * @readonly\n */\n startDate?: Date;\n /**\n * The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.\n * @readonly\n */\n endDate?: Date;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls. */\n extendedFields?: ExtendedFields$1;\n /**\n * Whether this booking overlaps another existing confirmed booking. Returned when: `true`\n * @readonly\n */\n doubleBooked?: boolean | null;\n }\n /** @oneof */\n interface BookingParticipantsInfoOneOf {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices;\n }\n enum MultiServiceBookingType {\n /**\n * Multi service booking will be considered available if its bookings are\n * available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url\n */\n SEQUENTIAL_BOOKINGS = \"SEQUENTIAL_BOOKINGS\",\n /**\n * Multi service booking will be considered available if each of its bookings is available separately.\n * Not supported yet\n */\n SEPARATE_BOOKINGS = \"SEPARATE_BOOKINGS\",\n /** Not supported yet */\n PARALLEL_BOOKINGS = \"PARALLEL_BOOKINGS\"\n }\n interface BookedEntity extends BookedEntityItemOneOf {\n /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */\n slot?: BookedSlot;\n /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */\n schedule?: BookedSchedule;\n /**\n * Session title at the time of booking.\n * If session doesn't exist at the time of the booking, service name is used.\n * @readonly\n */\n title?: string | null;\n /**\n * List of tags for the booking.\n * System-assigned tags for sessions and schedules are:\n * + \"INDIVIDUAL\" Appointments, including appointments with more than 1 participant.\n * + \"GROUP\" Individual classes.\n * + \"COURSE\" Courses.\n */\n tags?: string[] | null;\n }\n /** @oneof */\n interface BookedEntityItemOneOf {\n /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */\n slot?: BookedSlot;\n /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */\n schedule?: BookedSchedule;\n }\n interface BookedSlot {\n /**\n * ID of the underlying session when session is a single session or generated from a recurring session.\n * If `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information.\n */\n sessionId?: string | null;\n /** Service ID. */\n serviceId?: string;\n /** Schedule ID. Required. */\n scheduleId?: string;\n /**\n * Calendar 3 event ID\n * If not empty, on all write flows (create / update) gets priority over session_id.\n * so if both session_id and event_id are provided, the session_id that will be set on the booking will be based on the event_id.\n * Otherwise, if event_id is empty on write flow,\n */\n eventId?: string | null;\n /**\n * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n */\n startDate?: string | null;\n /**\n * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n */\n endDate?: string | null;\n /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */\n timezone?: string | null;\n /**\n * The enriched resource assigned to the slot, can be either the requested resource or the resource chosen by the system.\n * When populated, the given resource will be booked according to it's availability.\n * When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,\n * otherwise one of the service resources will be assigned to the slot randomly upon confirmation.\n * This resource is the slot primary resource.\n */\n resource?: BookedResource;\n /** Location where the slot's session takes place. */\n location?: Location$5;\n }\n interface BookedResource {\n /** Booked resource ID. */\n _id?: string;\n /** Resource's name at the time of booking. */\n name?: string | null;\n /** Resource's email at the time of booking. */\n email?: string | null;\n /** Resource's schedule ID. */\n scheduleId?: string | null;\n }\n interface Location$5 {\n /**\n * Business location ID. Available only for locations that are business locations,\n * meaning the `location_type` is `\"OWNER_BUSINESS\"`.\n */\n _id?: string | null;\n /** Location name. */\n name?: string | null;\n /** The full address of this location. */\n formattedAddress?: string | null;\n /**\n * Location type.\n *\n * - `\"OWNER_BUSINESS\"`: The business address, as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"`: The address as set when creating the service.\n * - `\"CUSTOM\"`: The address as set for the individual session.\n */\n locationType?: LocationType$5;\n }\n enum LocationType$5 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface BookedSchedule {\n /** Schedule ID. */\n scheduleId?: string;\n /** Booked service ID. */\n serviceId?: string | null;\n /**\n * Location where the schedule's sessions take place. Read only.\n * @readonly\n */\n location?: Location$5;\n /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */\n timezone?: string | null;\n /**\n * The start time of the first session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format. Required.\n * @readonly\n */\n firstSessionStart?: string | null;\n /**\n * The end time of the last session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format. Required.\n * @readonly\n */\n lastSessionEnd?: string | null;\n }\n interface ContactDetails {\n /** Contact's ID. */\n contactId?: string | null;\n /** Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /** Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts/introduction). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). */\n email?: string | null;\n /** Contact's phone number. */\n phone?: string | null;\n /** Contact's full address. */\n fullAddress?: Address$4;\n /**\n * Contact's time zone.\n * @deprecated\n */\n timeZone?: string | null;\n /** Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n countryCode?: string | null;\n }\n /** Physical address */\n interface Address$4 extends AddressStreetOneOf$4 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$4;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$4;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$4[];\n }\n /** @oneof */\n interface AddressStreetOneOf$4 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$4;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$4 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$4 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$4 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface CustomFormField {\n /** ID of the form field as defined in the form. */\n _id?: string;\n /** Value that was submitted for this field. */\n value?: string | null;\n /**\n * Form field's label at the time of submission.\n * @readonly\n */\n label?: string | null;\n valueType?: ValueType;\n }\n enum ValueType {\n /** Short text. This is the default value type. */\n SHORT_TEXT = \"SHORT_TEXT\",\n /** Long text */\n LONG_TEXT = \"LONG_TEXT\",\n /** a text that represent the check box value: if selected the value is \"true\", otherwise \"false\". */\n CHECK_BOX = \"CHECK_BOX\"\n }\n /** Booking status. */\n enum BookingStatus {\n CREATED = \"CREATED\",\n CONFIRMED = \"CONFIRMED\",\n CANCELED = \"CANCELED\",\n PENDING = \"PENDING\",\n DECLINED = \"DECLINED\",\n WAITING_LIST = \"WAITING_LIST\"\n }\n /**\n * Payment status.\n * Automatically updated when using eCom checkout APIs.\n */\n enum PaymentStatus {\n UNDEFINED = \"UNDEFINED\",\n NOT_PAID = \"NOT_PAID\",\n PAID = \"PAID\",\n /** not supported yet. */\n PARTIALLY_PAID = \"PARTIALLY_PAID\",\n /** not supported yet */\n REFUNDED = \"REFUNDED\",\n EXEMPT = \"EXEMPT\"\n }\n /**\n * The selected payment option.\n * One of the payment options offered by the service.\n * This field is be set when the user selects an option during booking.\n * If left undefined, the payment option is resolved by the service configuration on checkout.\n */\n enum SelectedPaymentOption {\n UNDEFINED = \"UNDEFINED\",\n OFFLINE = \"OFFLINE\",\n ONLINE = \"ONLINE\",\n MEMBERSHIP = \"MEMBERSHIP\",\n /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */\n MEMBERSHIP_OFFLINE = \"MEMBERSHIP_OFFLINE\"\n }\n interface BookingSource {\n /** Platform from which a booking was created */\n platform?: Platform;\n /** Actor that created this booking. */\n actor?: Actor;\n /**\n * Wix site ID of the application that created the booking.\n * @readonly\n */\n appDefId?: string | null;\n /**\n * Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.\n * @readonly\n */\n appName?: string | null;\n }\n enum Platform {\n UNDEFINED_PLATFORM = \"UNDEFINED_PLATFORM\",\n WEB = \"WEB\",\n MOBILE_APP = \"MOBILE_APP\"\n }\n enum Actor {\n UNDEFINED_ACTOR = \"UNDEFINED_ACTOR\",\n BUSINESS = \"BUSINESS\",\n CUSTOMER = \"CUSTOMER\"\n }\n interface ParticipantNotification$4 {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */\n contactId?: string | null;\n }\n /** @oneof */\n interface CommonIdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum IdentificationDataIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface FlowControlSettings {\n /**\n * When true, skips availability checking and allows booking.\n * Requires BOOKINGS.OVERRIDE_AVAILABILITY permissions.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * When true, allows booking a confirmation-required service without requiring confirmation.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n */\n skipBusinessConfirmation?: boolean;\n /**\n * When true, skips selected payment option checking as defined in `selectedPaymentOption` field\n * and allows booking.\n * Requires BOOKINGS.MANAGE_PAYMENTS permissions.\n */\n skipSelectedPaymentOptionValidation?: boolean;\n /** When true, refunds the booking's payment when the booking is canceled. */\n withRefund?: boolean | null;\n }\n interface ExtendedFields$1 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface ParticipantChoices {\n /** Information about the booked service choices. Includes the number of participants. */\n serviceChoices?: ServiceChoices[];\n }\n interface ServiceChoices {\n /** Number of participants for this variant. */\n numberOfParticipants?: number | null;\n /** Service choices for these participants. */\n choices?: ServiceChoice$1[];\n }\n interface ServiceChoice$1 extends ServiceChoiceChoiceOneOf$1 {\n /**\n * Value for one of the choices in the `CustomServiceOption.choices` list.\n * Choices are specific values for an option the customer can choose to book. For example,\n * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n custom?: string;\n /**\n * ID of the corresponding option for the choice. For example, the choice `child`\n * could correspond to the option `ageGroup`. In this case, `optionId` is the ID\n * for the `ageGroup` option.\n */\n optionId?: string;\n }\n /** @oneof */\n interface ServiceChoiceChoiceOneOf$1 {\n /**\n * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.\n * Choices are specific values for an option the customer can choose to book. For example,\n * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.\n * Each choice may have a different price.\n */\n custom?: string;\n }\n interface MultiServiceBookingInfo {\n /**\n * Multi service booking ID.\n * @readonly\n */\n _id?: string | null;\n /** Multi service booking type. */\n type?: MultiServiceBookingType;\n }\n interface CreateMultiServiceBookingRequest {\n /** The bookings to create as multi service booking. */\n bookings: Booking[];\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingFlowControlSettings;\n /** Whether to return the created bookings entities. */\n returnFullEntity?: boolean;\n /**\n * Multi service booking type.\n * One of:\n * - `\"SEQUENTIAL_BOOKINGS\"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * - `\"SEPARATE_BOOKINGS\"` Not supported yet.\n * - `\"PARALLEL_BOOKINGS\"` Not supported yet.\n */\n multiServiceBookingType?: MultiServiceBookingType;\n }\n interface CreateBookingFlowControlSettings {\n /**\n * Whether the availability is checked before creating the booking. When\n * passing `false` a booking is only created when the slot or schedule is\n * available.\n * Default: `false`.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * Whether `PENDING` bookings are automatically set to `CONFIRMED` for\n * services that normally require the owner's manual confirmation. Your\n * app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission scope\n * when passing `true`.\n * Default: `false`.\n */\n skipBusinessConfirmation?: boolean;\n /**\n * Whether customers can pay using a payment method that isn't supported\n * for the service, but that's supported for other services. Your app\n * must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing\n * `true`.\n * Default: `false`.\n */\n skipSelectedPaymentOptionValidation?: boolean;\n }\n interface CreateMultiServiceBookingResponse {\n /**\n * Created multi service booking.\n * Contains the booking results on the same order as passed on the request.\n */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface MultiServiceBooking {\n /** Multi service booking ID. */\n _id?: string | null;\n /** The created bookings which are part of the multi service booking */\n bookings?: BookingResult[];\n }\n interface BookingResult {\n /** Booking ID. */\n bookingId?: string | null;\n /** Booking entity. */\n booking?: Booking;\n }\n interface RescheduleMultiServiceBookingRequest {\n /** ID of the multi service booking to reschedule it's related bookings. */\n multiServiceBookingId: string | null;\n /** Bookings to reschedule. */\n rescheduleBookingsInfo: RescheduleBookingInfo[];\n /** Information about whether to notify the customer about the rescheduling and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * rescheduling flow are changed. For example, whether the availability of\n * the new slot is checked before rescheduling the booking or if you can\n * reschedule the booking even though the rescheduling policy doesn't allow it.\n */\n flowControlSettings?: RescheduleBookingFlowControlSettings;\n /** Whether to return the rescheduled bookings entities. */\n returnFullEntity?: boolean;\n }\n interface V2Slot {\n /** Identifier for underlying session when session is a single session or generated from a recurring session. */\n sessionId?: string | null;\n /** Service identifier. Required. */\n serviceId?: string;\n /** Schedule identifier. Required. */\n scheduleId?: string;\n /** The start time of this Slot (formatted according to RFC3339). */\n startDate?: string | null;\n /** The end time of this Slot (formatted according to RFC3339). */\n endDate?: string | null;\n /** The timezone according to which the slot is calculated presented. */\n timezone?: string | null;\n /**\n * The resource required for this slot.\n * When populated, the given resource will be assigned to the slot upon confirmation according to it's availability.\n * When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,\n * otherwise one of the service resources will be assigned to the slot randomly upon confirmation.\n */\n resource?: SlotSlotResource;\n /** Geographic location of the slot. */\n location?: SlotLocation;\n }\n enum LocationLocationType {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface SlotSlotResource {\n /**\n * Resource ID\n * @readonly\n */\n _id?: string | null;\n /** Read only. Resource name. */\n name?: string | null;\n }\n interface SlotLocation {\n /** Business Location ID. Present if the location is a business location. */\n _id?: string | null;\n /** Location name. */\n name?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: LocationLocationType;\n }\n interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n /** ID of the booking to reschedule. */\n bookingId?: string | null;\n /** Information about the new slot. */\n slot?: V2Slot;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision?: string | null;\n }\n /** @oneof */\n interface RescheduleBookingInfoParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n }\n interface RescheduleBookingFlowControlSettings {\n /**\n * Whether the rescheduling policy applies when rescheduling the booking.\n * When passing `false` you can only cancel a booking if the rescheduling\n * policy allows it.\n * Default: `false`.\n */\n ignoreReschedulePolicy?: boolean;\n /**\n * Whether the availability is checked before rescheduling the booking.\n * When passing `false` a booking is only created when the slot or\n * schedule is available.\n * Default: `false`.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * Whether the rescheduled booking's status is automatically set to\n * `CONFIRMED` for services that normally require the owner's manual\n * confirmation.\n * Default: `false`.\n */\n skipBusinessConfirmation?: boolean;\n }\n interface RescheduleMultiServiceBookingResponse {\n /** Rescheduled multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {\n /** The previous total number of participants. Available only when the booking includes a single service variant. */\n previousTotalParticipants?: number;\n /**\n * Information about the previous booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n previousParticipantsChoices?: ParticipantChoices;\n /** The rescheduled booking object. */\n booking?: Booking;\n /** Information about whether to notify the customer about the rescheduling and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * rescheduling flow are changed. For example, whether the availability of\n * the new slot is checked before rescheduling the booking or if you can\n * reschedule the booking even though the rescheduling policy doesn't allow it.\n */\n flowControlSettings?: RescheduleBookingFlowControlSettings;\n /** ID of the rescheduling initiator. */\n initiatedBy?: IdentificationData$2;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus;\n /** An object describing the previous slot or schedule of the booking. */\n previousBookedEntity?: BookedEntity;\n /** The previous start date of the booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session. */\n previousStartDate?: Date;\n /** The previous end date of the booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session. */\n previousEndDate?: Date;\n }\n /** @oneof */\n interface BookingRescheduledPreviousParticipantsInfoOneOf {\n /** The previous total number of participants. Available only when the booking includes a single service variant. */\n previousTotalParticipants?: number;\n /**\n * Information about the previous booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n previousParticipantsChoices?: ParticipantChoices;\n }\n interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /**\n * ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.\n * @readonly\n */\n contactId?: string | null;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface GetMultiServiceBookingAvailabilityRequest {\n multiServiceBookingId: string | null;\n }\n interface GetMultiServiceBookingAvailabilityResponse {\n /** Whether these bookings are bookable. */\n bookable?: boolean;\n /** Total number of spots for this availability. */\n totalCapacity?: number | null;\n /** Number of open spots for this availability. */\n remainingCapacity?: number | null;\n /** Indicators for policy violations of the multi service booking. */\n policyViolations?: BookingPolicyViolations$1;\n /** Multi service booking policy settings */\n policySettings?: BookingPolicySettings$1;\n /** Info of the bookings this availability was calculated for. */\n multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];\n }\n interface BookingPolicyViolations$1 {\n /** Bookings policy violation. Too early to book this slot. */\n tooEarlyToBook?: boolean | null;\n /** Bookings policy violation. Too late to book this slot. */\n tooLateToBook?: boolean | null;\n /** Bookings policy violation. Online booking is disabled for this slot. */\n bookOnlineDisabled?: boolean | null;\n }\n interface BookingPolicySettings$1 {\n /** Booking policy settings for a given Slot/Schedule */\n maxParticipantsPerBooking?: number | null;\n }\n interface GetMultiServiceBookingAvailabilityResponseBookingInfo {\n /** Booking id */\n bookingId?: string | null;\n }\n interface CancelMultiServiceBookingRequest {\n /** ID of the multi service booking to cancel it's related bookings. */\n multiServiceBookingId: string | null;\n /** Information about whether to notify the customer about the cancelation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * cancelation flow are changed. For example, whether the you can cancel\n * a booking even though the cancelation policy doesn't allow it or whether\n * to issue a refund.\n */\n flowControlSettings?: CancelBookingFlowControlSettings;\n /** Whether to return the canceled bookings entities. */\n returnFullEntity?: boolean;\n }\n interface CancelBookingFlowControlSettings {\n /**\n * Whether the cancelation policy applies when canceling the booking. When\n * passing `false` you can only cancel a booking if the cancelation policy\n * allows it.\n * Default: `false`.\n */\n ignoreCancellationPolicy?: boolean | null;\n /**\n * Whether to issue a refund when canceling the booking.\n * The refund will be issued only if the booking is refundable.\n * Currently, booking is considered refundable when it was paid by membership.\n * If passing `true`, the booking flow control settings will be set with refund,\n * otherwise, either if `false` is passed or the field remains empty,\n * the booking flow control settings will be set with no refund.\n * Default: `false`.\n */\n withRefund?: boolean | null;\n }\n interface CancelMultiServiceBookingResponse {\n /** Canceled multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface BookingCanceled {\n /** The canceled booking object. */\n booking?: Booking;\n /** Information about whether to notify the customer about the cancelation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * cancelation flow are changed. For example, whether you can cancel\n * a booking even though the cancelation policy doesn't allow it or whether\n * to issue a refund.\n */\n flowControlSettings?: CancelBookingFlowControlSettings;\n /** ID of the cancelation initiator. */\n initiatedBy?: IdentificationData$2;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus;\n }\n interface MarkMultiServiceBookingAsPendingRequest {\n /** ID of the multi service booking to mark as pending it's related bookings. */\n multiServiceBookingId: string | null;\n /** Bookings to mark as pending. */\n markAsPendingBookingsInfo?: BookingInfo[];\n /** Information about whether to notify the customer upon manual confirmation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** Whether to return the pending bookings entities. */\n returnFullEntity?: boolean;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before updating the booking.\n */\n flowControlSettings?: MarkBookingAsPendingFlowControlSettings;\n }\n interface BookingInfo {\n /** ID of the booking. */\n bookingId?: string | null;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision?: string | null;\n /**\n * Payment status to set for the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n }\n interface MarkBookingAsPendingFlowControlSettings {\n /**\n * Whether should check for double bookings before updating the booking as pending.\n * When passing `false` a booking is only being updated with status PENDING\n * Default: `false`.\n */\n checkAvailabilityValidation?: boolean;\n /**\n * Whether should validate that the given booking to be marked as pending, has a booking.slot.serviceId\n * of a pending approval service.\n * Default: `false`.\n */\n skipPendingApprovalServiceValidation?: boolean;\n }\n interface MarkMultiServiceBookingAsPendingResponse {\n /** Pending multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface ConfirmMultiServiceBookingRequest {\n /** ID of the multi service booking to confirm it's related bookings. */\n multiServiceBookingId: string | null;\n /** Bookings to confirm. */\n confirmBookingsInfo?: BookingInfo[];\n /** Information about whether to notify the customer about the confirmation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** Whether to return the confirmed bookings entities. */\n returnFullEntity?: boolean;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * confirmation flow are changed. For example, whether the availability is\n * checked before confirming the booking.\n */\n flowControlSettings?: ConfirmBookingFlowControlSettings;\n }\n interface ConfirmBookingFlowControlSettings {\n /**\n * todo: docs any-resource flow behavior\n * Whether the availability is checked before confirming the booking.\n * When passing `false` a booking is only being updated with status CONFIRMED\n * Default: `false`.\n */\n checkAvailabilityValidation?: boolean;\n }\n interface ConfirmMultiServiceBookingResponse {\n /** Confirmed multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface BookingConfirmed {\n /** The confirmed booking object. */\n booking?: Booking;\n /** Information about whether to notify the customer about the confirmation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** ID of the confirmation initiator. */\n initiatedBy?: IdentificationData$2;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus;\n /** The previous payment status of the booking. */\n previousPaymentStatus?: PaymentStatus;\n }\n interface DeclineMultiServiceBookingRequest {\n /** ID of the multi service booking to decline it's related bookings. */\n multiServiceBookingId: string | null;\n /** Bookings to decline. */\n declineBookingsInfo?: BookingInfo[];\n /** Information about whether to notify the customer about the decline and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** Whether to return the declined bookings entities. */\n returnFullEntity?: boolean;\n }\n interface DeclineMultiServiceBookingResponse {\n /** Declined multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface BookingDeclined {\n /** The declined booking object. */\n booking?: Booking;\n /** Information about whether to notify the customer about the decline and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** ID of the decline initiator. */\n initiatedBy?: IdentificationData$2;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus;\n /** The previous payment status of the booking. */\n previousPaymentStatus?: PaymentStatus;\n }\n interface BulkGetMultiServiceBookingAllowedActionsRequest {\n /** The multi service booking ids to get the allowedActions for. */\n multiServiceBookingIds: string[] | null;\n }\n interface BulkGetMultiServiceBookingAllowedActionsResponse {\n results?: BulkCalculateAllowedActionsResult[];\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkCalculateAllowedActionsResult {\n /** (id, indexInGivenSeq, isSuccessful, error) */\n itemMetadata?: ItemMetadata$1;\n item?: AllowedActions;\n }\n interface ItemMetadata$1 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$1;\n }\n interface ApplicationError$1 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n /** Possible allowed actions for a Booking */\n interface AllowedActions {\n /** Is cancel booking allowed */\n cancel?: boolean;\n /** Is reschedule booking allowed */\n reschedule?: boolean;\n }\n interface BulkActionMetadata$1 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface MarkAsMultiServiceBookingRequest {\n /** IDs of the bookings to mark as multi service booking. */\n bookingIds: string[] | null;\n /**\n * Multi service booking type.\n * One of:\n * - `\"SEQUENTIAL_BOOKINGS\"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * - `\"SEPARATE_BOOKINGS\"` Not supported yet.\n * - `\"PARALLEL_BOOKINGS\"` Not supported yet.\n */\n multiServiceBookingType?: MultiServiceBookingType;\n }\n interface MarkAsMultiServiceBookingResponse {\n /** Multi service booking ID. */\n multiServiceBookingId?: string | null;\n }\n interface GetMultiServiceBookingRequest {\n /** Multi service booking ID. */\n multiServiceBookingId: string | null;\n }\n interface GetMultiServiceBookingResponse {\n /** Multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n metadata?: MultiServiceBookingMetadata;\n }\n interface MultiServiceBookingMetadata {\n /**\n * Total number of the scheduled bookings within the multi service booking, including bookings which were not retrieved due to lack of read permissions.\n * Scheduled bookings are bookings with status CONFIRMED or PENDING.\n */\n totalNumberOfScheduledBookings?: number | null;\n }\n interface AddBookingsToMultiServiceBookingRequest {\n /** ID of the multi service booking. */\n multiServiceBookingId: string | null;\n /** List of bookings ids and their revisions to add to the multi service booking. */\n bookings: BookingIdAndRevision[];\n /** Whether to return the bookings entities. */\n returnFullEntity?: boolean;\n }\n interface BookingIdAndRevision {\n /** ID of the booking. */\n bookingId?: string | null;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision?: string | null;\n }\n interface AddBookingsToMultiServiceBookingResponse {\n /** The bookings that were added to the multi service booking. */\n bookings?: BookingResult[];\n }\n interface RemoveBookingsFromMultiServiceBookingRequest {\n /** ID of the multi service booking. */\n multiServiceBookingId: string | null;\n /** List of bookings ids and their revisions to remove from the multi service booking. */\n bookings?: BookingIdAndRevision[];\n /** Whether to return the bookings entities. */\n returnFullEntity?: boolean;\n }\n interface RemoveBookingsFromMultiServiceBookingResponse {\n /** The bookings that were removed from the multi service booking. */\n bookings?: BookingResult[];\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$2 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: WebhooksIdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$2;\n }\n /** @oneof */\n interface WebhooksIdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface BookingChanged {\n /** The booking before the changes. */\n previousBooking?: Booking;\n /** The booking after the changes. */\n currentBooking?: Booking;\n }\n interface CreateBookingRequest {\n /** The booking to create. */\n booking: Booking;\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingFlowControlSettings;\n }\n interface CreateBookingResponse {\n /** Created booking. */\n booking?: Booking;\n }\n /**\n * The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results\n * in an error. `participantsInfo` is preferred over `numberOfParticipants`.\n */\n interface UpdateBookingRequest {\n booking: Booking;\n }\n interface UpdateBookingResponse {\n booking?: Booking;\n }\n interface LegacyCreateBookingRequest {\n booking: Booking;\n }\n interface LegacyCreateBookingResponse {\n booking?: Booking;\n }\n /**\n * The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results\n * in an error. `participantsInfo` is preferred over `numberOfParticipants`.\n */\n interface BulkUpdateBookingRequest {\n bookings: MaskedBooking[];\n }\n interface MaskedBooking {\n booking?: Booking;\n }\n interface BulkUpdateBookingResponse {\n results?: ItemMetadata$1[];\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkCreateBookingRequest {\n /**\n * Bookings to create.\n * Max: 8 bookings.\n */\n createBookingsInfo: CreateBookingInfo[];\n /** Whether to return the created bookings entities. */\n returnFullEntity?: boolean;\n }\n interface CreateBookingInfo {\n /** The booking to create */\n booking?: Booking;\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingFlowControlSettings;\n }\n interface BulkCreateBookingResponse {\n /**\n * Bulk create booking results.\n * Whether it successfully created each booking, providing the corresponding error message if a failure occurred, and includes the created booking entity if the `returnFullEntity` is `true`.\n */\n results?: BulkBookingResult[];\n /** Total successes and failures of the bulk create booking action. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkBookingResult {\n itemMetadata?: ItemMetadata$1;\n item?: Booking;\n }\n interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n /** ID of the booking to reschedule. */\n bookingId: string;\n /** Information about the new slot. */\n slot: V2Slot;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the rescheduling and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * rescheduling flow are changed. For example, whether the availability of\n * the new slot is checked before rescheduling the booking or if you can\n * reschedule the booking even though the rescheduling policy doesn't allow it.\n */\n flowControlSettings?: RescheduleBookingFlowControlSettings;\n }\n /** @oneof */\n interface RescheduleBookingRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n }\n interface RescheduleBookingResponse {\n /** Rescheduled booking. */\n booking?: Booking;\n }\n interface BulkRescheduleBookingRequest {\n /** Reschedule multiple bookings to multiple slots. */\n slotsBookings: SlotBookings[];\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$4;\n }\n interface BulkRescheduleBookingRequestBooking {\n /** ID of the bookings to be rescheduled. */\n _id?: string;\n revision?: string | null;\n }\n /** Bookings to be rescheduled to the given slot. */\n interface SlotBookings {\n /** The bookings details. */\n bookings?: BulkRescheduleBookingRequestBooking[];\n /**\n * The slot to which the bookings were rescheduled.\n * This bookings are automatically assigned to the session, if given. Otherwise, a new session is created.\n */\n slot?: BookedSlot;\n }\n interface BulkRescheduleBookingResponse {\n /** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */\n results?: ItemMetadata$1[];\n /** Total successes and failures of the bulk reschedule action. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n /** Update the booked schedule of multiple bookings to the given schedule. */\n interface BulkUpdateBookedScheduleRequest {\n /** The bookings whose booked schedule is to be updated to the given schedule. */\n bookings: BookingDetails[];\n /** The ID of the schedule to be updated. */\n scheduleId: string;\n /** Whether to notify participants about the change and an optional custom message. */\n participantNotification?: ParticipantNotification$4;\n }\n interface BookingDetails {\n /** ID of the bookings to be updated. */\n _id?: string;\n revision?: string | null;\n }\n interface BulkUpdateBookedScheduleResponse {\n /** The bulk update results. For each booking, the results contain the metadata of the update action. */\n results?: ItemMetadata$1[];\n /** Total successes and failures of the bulk update action. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface QueryBookingsRequest {\n query: QueryV2$3;\n }\n interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$4;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$3 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$4;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n }\n enum SortOrder$3 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$4 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryBookingsResponse {\n bookings?: Booking[];\n pagingMetadata?: PagingMetadataV2$3;\n }\n interface PagingMetadataV2$3 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$4;\n }\n interface Cursors$4 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface ConfirmRequest {\n /** ID of the booking to be confirmed. */\n _id?: string;\n /** Whether to notify the participants about the booking confirmation, and an optional custom message. */\n participantNotification?: ParticipantNotification$4;\n }\n interface ConfirmResponse {\n /** Confirmed booking. */\n booking?: Booking;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n }\n interface ConfirmBookingRequest {\n /** ID of the booking to confirm. */\n bookingId: string;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the confirmation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Payment status to set for the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before confirming the booking.\n */\n flowControlSettings?: ConfirmBookingFlowControlSettings;\n }\n interface ConfirmBookingResponse {\n booking?: Booking;\n }\n interface PartySizeRequest extends PartySizeRequestPartySizeForOneOf {\n sessionId?: string | null;\n scheduleId?: string | null;\n }\n /** @oneof */\n interface PartySizeRequestPartySizeForOneOf {\n sessionId?: string | null;\n scheduleId?: string | null;\n }\n interface PartySizeResponse {\n partySize?: number | null;\n }\n interface ConsistentQueryBookingsRequest {\n query?: QueryV2$3;\n }\n interface ConsistentQueryBookingsResponse {\n bookings?: Booking[];\n pagingMetadata?: PagingMetadataV2$3;\n }\n interface SetBookingSessionIdRequest {\n /** ID of the booking to set its sessionId. */\n _id: string;\n /** The sessionId to be set. */\n sessionId?: string;\n }\n interface SetBookingSessionIdResponse {\n /** The updated booking. */\n booking?: Booking;\n }\n interface UpdateExtendedFieldsRequest {\n /** ID of the booking for which to update extended fields. */\n _id: string;\n /** [Namespace](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-reading-and-writing-schema-plugin-fields#namespaces) of the app for which to update extended fields. */\n namespace: string;\n /** Data of the extended field to update. Must be structured according to the [schema](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions#json-schema-for-extended-fields) defined during the configuration of the extended fields. */\n namespaceData: Record | null;\n }\n interface UpdateExtendedFieldsResponse {\n /** [Namespace](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-reading-and-writing-schema-plugin-fields#namespaces) of the app for which the extended fields were updated. */\n namespace?: string;\n /** Updated data of the extended fields. */\n namespaceData?: Record | null;\n }\n interface DeclineBookingRequest {\n /** ID of the booking to decline. */\n bookingId: string;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the decline and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Payment status to set on the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n }\n interface DeclineBookingResponse {\n /** eclined booking */\n booking?: Booking;\n }\n interface CancelBookingRequest {\n /** ID of the booking to cancel. */\n bookingId: string;\n /**\n * Information about whether to notify the customer about the cancelation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * cancelation flow are changed. For example, whether the you can cancel\n * a booking even though the cancelation policy doesn't allow it or whether\n * to issue a refund.\n */\n flowControlSettings?: CancelBookingFlowControlSettings;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when managing the booking.\n */\n revision: string | null;\n }\n interface CancelBookingResponse {\n /** Canceled booking. */\n booking?: Booking;\n }\n interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n /** ID of the booking to update the number of participants for. */\n bookingId: string;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n }\n /** @oneof */\n interface UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n }\n interface UpdateNumberOfParticipantsResponse {\n /** Booking with updated number of participants. */\n booking?: Booking;\n }\n interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {\n /** The previous total number of participants. Available only when the booking includes a single service variant. */\n previousTotalParticipants?: number;\n /**\n * Information about the previous booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n previousParticipantsChoices?: ParticipantChoices;\n /** The updated booking object. */\n booking?: Booking;\n /** ID of the participant number update initiator. */\n initiatedBy?: IdentificationData$2;\n }\n /** @oneof */\n interface NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf {\n /** The previous total number of participants. Available only when the booking includes a single service variant. */\n previousTotalParticipants?: number;\n /**\n * Information about the previous booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n previousParticipantsChoices?: ParticipantChoices;\n }\n interface CalculateAllowedActionsRequest {\n /** The booking id that we want to calculate the allowedActions for */\n bookingId: string | null;\n }\n interface CalculateAllowedActionsResponse {\n allowedActions?: AllowedActions;\n }\n interface BulkCalculateAllowedActionsRequest {\n /** The booking id's that we want to calculate the allowedActions for */\n bookingIds: string[] | null;\n }\n interface BulkCalculateAllowedActionsResponse {\n results?: BulkCalculateAllowedActionsResult[];\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface GetSlotAvailabilityRequest$1 {\n /** The slot for which the availability is checked. */\n slot?: V2Slot;\n /** The timezone for which availability is to be calculated. */\n timezone?: string | null;\n }\n interface GetSlotAvailabilityResponse$1 {\n availability?: SlotAvailability$1;\n bookingPolicySettings?: BookingPolicySettings$1;\n }\n interface SlotAvailability$1 {\n /** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */\n slot?: V2Slot;\n /** Whether this available slot is bookable. */\n bookable?: boolean;\n /**\n * Total number of spots for this availability.\n * For example, for a class of 10 spots with 3 spots booked, `spotsTotal` is 10, `openSpots` is 7.\n */\n totalSpots?: number | null;\n /**\n * Number of open spots for this availability.\n * For appointment if there are existing bookings with overlapping time, service & resource, `openSpots` is 0, otherwise `openSpots` is 1.\n */\n openSpots?: number | null;\n /** An object describing the slot's waiting-list and its occupancy. */\n waitingList?: WaitingList$1;\n /** Indicators for booking policy violations for the slot. */\n bookingPolicyViolations?: BookingPolicyViolations$1;\n /** Indicates whether this slot is locked. */\n locked?: boolean | null;\n }\n interface WaitingList$1 {\n /**\n * Total number of spots and open spots for this waiting list.\n * For example, a Yoga class of 10 waiting list spots with 3 registered on the waiting list has total_spots: 10 and open_spots: 7.\n */\n totalSpots?: number | null;\n openSpots?: number | null;\n }\n interface AvailableResources {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Available resources for the slot.\n * maxSize defined by 135 staff members + 3 resource types and 50 resources per type.\n * Availability-2 currently have no maxSize defined.\n */\n resourceIds?: string[];\n }\n interface GetScheduleAvailabilityRequest$1 {\n /** The schedule ID for which availability is checked. */\n scheduleId: string;\n }\n interface GetScheduleAvailabilityResponse$1 {\n availability?: ScheduleAvailability$1;\n bookingPolicySettings?: BookingPolicySettings$1;\n }\n interface ScheduleAvailability$1 {\n totalSpots?: number | null;\n openSpots?: number | null;\n /** Indicators of booking policy violations for the given Schedule. */\n bookingPolicyViolations?: BookingPolicyViolations$1;\n }\n interface MarkBookingAsPendingRequest {\n /** ID of the booking to mark as PENDING. */\n bookingId: string;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Payment status to set for the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before updating the booking's status.\n */\n flowControlSettings?: MarkBookingAsPendingFlowControlSettings;\n }\n interface MarkBookingAsPendingResponse {\n /** The updated booking */\n booking?: Booking;\n }\n interface BookingMarkedAsPending {\n /** The booking object that was marked as pending. */\n booking?: Booking;\n /** Information about whether to notify the customer upon manual confirmation of the pending booking and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** ID of the mark as pending initiator. */\n initiatedBy?: IdentificationData$2;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus;\n /** The previous payment status of the booking. */\n previousPaymentStatus?: PaymentStatus;\n }\n interface MigrationCheckIfClashesWithBlockedTimeRequest {\n msidAndBookingIds?: MsidAndBookingId[];\n }\n interface MsidAndBookingId {\n msid?: string;\n bookingId?: string;\n }\n interface MigrationCheckIfClashesWithBlockedTimeResponse {\n clashes?: Clash[];\n }\n interface Clash {\n msid?: string;\n bookingId?: string;\n sessionId?: string;\n resourceName?: string;\n contactName?: string;\n }\n interface ConfirmOrDeclineBookingRequest {\n /** ID of the booking to confirm or decline. */\n bookingId: string;\n /** Current payment status of the booking. */\n paymentStatus?: PaymentStatus;\n }\n interface ConfirmOrDeclineBookingResponse {\n booking?: Booking;\n }\n interface BulkConfirmOrDeclineBookingRequest {\n /** The bookings to confirm or decline. */\n details: BulkConfirmOrDeclineBookingRequestBookingDetails[];\n /**\n * Whether to return the confirmed or declined bookings entities.\n * Not supported yet, currently the entity is not returned.\n */\n returnEntity?: boolean;\n }\n interface BulkConfirmOrDeclineBookingRequestBookingDetails {\n /** ID of the booking to confirm or decline. */\n bookingId?: string;\n /** Current payment status of the booking. */\n paymentStatus?: PaymentStatus;\n }\n interface BulkConfirmOrDeclineBookingResponse {\n /**\n * The bulk confirm or decline results.\n * For each booking, the results contain the metadata of the confirm or decline action.\n */\n results?: BulkBookingResult[];\n /** Total successes and failures of the bulk confirm or decline action. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface V2CreateBookingRequest extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {\n /**\n * Information about the slot to create a booking for.\n * If you set `slot.location.locationType` to `CUSTOM`, the created slot's\n * location is set to `slot.location.formattedAddress` when provided.\n * Otherwise it's set to `contactDetails.fullAddress.formattedAddress`.\n */\n slot?: Slot$1;\n /** Information about the schedule to create a booking for. */\n schedule?: BookedSchedule;\n /** Contact details of the customer booking the service. */\n contactDetails?: ContactDetails;\n /**\n * Booking status.\n * One of:\n * - `\"CREATED\"` - The booking was created.\n * - `\"UPDATED\"` - The booking was updated.\n * - `\"CONFIRMED\"` - The booking has been confirmed and appears on the bookings calendar.\n * Booking can be manually confirmed using the Set As Confirmed endpoint.\n * Booking can be automatically confirmed when the following requirements are met:\n * + The service is configured as automatically confirmed.\n * + Invoking eCommerce checkout API and an order has been created.\n * - `\"CANCELED\"` - The booking has been canceled and synced to bookings calendar.\n * The booking can be canceled using cancel API.\n * - `\"PENDING\"` - The booking waiting to be confirmed or declined buy the owner and is synced to bookings calendar.\n * Bookings can be manually set as pending using setAsPending API, requires manage booking status permissions.\n * Booking can be automatically set as pending when the following requirements are met:\n * + The Service is configured as manually confirmed.\n * + Invoking the eCommerce checkout API and an order has been created.\n * - `\"WAITING_LIST\"` - The booking is pending on a waiting list.\n * Booking can be created with this status when invoking waiting list join API.\n * - `\"DECLINED\"` - The booking was declined by the owner and synced to bookings calendar.\n * Booking can be manually declined using decline API and requires manage booking permissions.\n * Booking can be automatically declined when the following requirements are met:\n * + Invoking eCommerce checkout API and the order declined event has been sent.\n * + Invoking eCommerce checkout API and order approved event has been sent, but the booking is offline and the booking causes a double booking.\n */\n status?: BookingStatus;\n /**\n * Additional custom fields of the booking form. The customer must provide\n * information for each field when booking the service. For example, that they\n * bring their own towels or whether they use a wheelchair.\n *\n * Max: 100 fields\n */\n additionalFields?: CustomFormField[];\n /**\n * Total number of participants. Available only when the service doesn't have\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n *\n * Max: `20`\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note. Not visible to the customer.\n *\n * Max: 200 characters\n */\n internalBusinessNote?: string | null;\n /**\n * Payment option the customer intends to use.\n * Must be one of the payment options defined for the service, unless\n * you pass `flowControlSettings.skipSelectedPaymentOptionValidation` as `true`.\n */\n selectedPaymentOption?: SelectedPaymentOption;\n /**\n * Identifies the source (platform, actor and app) that created this booking.\n * This property of the booking cannot be changed.\n * The app_def_id and app_name will be resolved automatically.\n * TODO GAP See if we need this - might be able to get this data from the headers?\n */\n bookingSource?: BookingSource;\n /**\n * A user identifier of an external application user that initiated the book request.\n * Allows an external application to later identify its own bookings and correlate to its own internal users\n */\n externalUserId?: string | null;\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n *\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingRequestFlowControlSettings;\n }\n /** @oneof */\n interface V2CreateBookingRequestBookableItemOneOf {\n /**\n * Information about the slot to create a booking for.\n * If you set `slot.location.locationType` to `CUSTOM`, the created slot's\n * location is set to `slot.location.formattedAddress` when provided.\n * Otherwise it's set to `contactDetails.fullAddress.formattedAddress`.\n */\n slot?: Slot$1;\n /** Information about the schedule to create a booking for. */\n schedule?: BookedSchedule;\n }\n /** @oneof */\n interface V2CreateBookingRequestParticipantsInfoOneOf {\n }\n interface Slot$1 {\n /**\n * ID for the slot's corresponding session, when the session is either a single session\n * or a specific session generated from a recurring session.\n */\n sessionId?: string | null;\n /** Service ID. */\n serviceId?: string;\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n *\n * If `timezone` is specified,\n * dates are based on the local date/time. This means that the timezone offset\n * in the `start_date` is ignored.\n */\n startDate?: string | null;\n /**\n * The end time of this slot in\n * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.\n *\n * If `timezone` is specified,\n * dates are based on the local date/time. This means that the timezone offset\n * in the `end_date` is ignored.\n */\n endDate?: string | null;\n /**\n * The timezone for which slot availability is to be calculated.\n *\n * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)\n * when calculating availability.\n */\n timezone?: string | null;\n /**\n * The resource required for this slot. Currently, the only supported resource\n * is the relevant staff member for the slot.\n */\n resource?: SlotResource$1;\n /** Geographic location of the slot. */\n location?: Location$5;\n }\n interface SlotResource$1 {\n /**\n * Resource ID.\n * @readonly\n */\n _id?: string | null;\n /** Resource name. Read only. */\n name?: string | null;\n }\n interface CreateBookingRequestFlowControlSettings {\n /**\n * Whether the availability is checked before creating the booking. When\n * passing `false` a booking is only created when the slot or schedule is\n * available. Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY`\n * permission scope when passing `true`.\n *\n * Default: `false`.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * Whether `PENDING` bookings are automatically set to `CONFIRMED` for\n * services that normally require the owner's manual confirmation. Your\n * app must have the `BOOKINGS.OVERRIDE_AVAILABILITY` permission scope\n * when passing `true`.\n *\n * Default: `false`.\n */\n skipBusinessConfirmation?: boolean;\n /**\n * Whether customers can pay using a payment method that isn't supported\n * for the service, but that's supported for other services. Your app\n * must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing\n * `true`.\n *\n * Default: `false`.\n */\n skipSelectedPaymentOptionValidation?: boolean;\n }\n interface V2CreateBookingResponse {\n /** Created booking. */\n booking?: Booking;\n }\n interface V2CancelBookingRequest {\n /** ID of the booking to cancel. */\n bookingId: string;\n /**\n * Information about whether to notify the customer about the cancelation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when managing the booking.\n */\n revision: string | null;\n }\n interface CancelBookingRequestFlowControlSettings {\n /**\n * Whether the cancelation policy applies when canceling the booking. When\n * passing `false` you can only cancel a booking if the cancelation policy\n * allows it. Your app must have the `BOOKINGS.IGNORE_BOOKING_POLICY `\n * permission scope when passing `true`.\n *\n * Default: `false`.\n */\n ignoreCancellationPolicy?: boolean;\n /**\n * Whether to issue a refund when canceling the booking.\n * The refund will be issued only if the booking is refundable.\n * Currently, booking is considered refundable when it was paid by membership.\n * If passing `true`, the booking flow control settings will be set with refund,\n * otherwise, either if `false` is passed or the field remains empty,\n * the booking flow control settings will be set with no refund.\n *\n * Default: `false`.\n */\n withRefund?: boolean | null;\n }\n interface V2CancelBookingResponse {\n /** Canceled booking. */\n booking?: Booking;\n }\n interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestParticipantsInfoOneOf {\n /** Id of the booking to reschedule. */\n bookingId: string;\n /** Information about the new slot. */\n slot: Slot$1;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the rescheduling and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n }\n /** @oneof */\n interface V2RescheduleBookingRequestParticipantsInfoOneOf {\n }\n interface RescheduleBookingRequestFlowControlSettings {\n /**\n * Whether the rescheduling policy applies when rescheduling the booking.\n * When passing `false` you can only cancel a booking if the rescheduling\n * policy allows it. Your app must have the `BOOKINGS.IGNORE_BOOKING_POLICY `\n * permission scope when passing `true`.\n *\n * Default: `false`.\n */\n ignoreReschedulePolicy?: boolean;\n /**\n * Whether the availability is checked before rescheduling the booking.\n * When passing `false` a booking is only created when the slot or\n * schedule is available. Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY`\n * permission scope when passing `true`.\n *\n * Default: `false`.\n */\n skipAvailabilityValidation?: boolean;\n /**\n * Whether the rescheduled booking's status is automatically set to\n * `CONFIRMED` for services that normally require the owner's manual\n * confirmation. Your app must have the `BOOKINGS.OVERRIDE_AVAILABILITY`\n * permission scope when passing `true`.\n *\n * Default: `false`.\n */\n skipBusinessConfirmation?: boolean;\n }\n interface V2RescheduleBookingResponse {\n /** Rescheduled booking. */\n booking?: Booking;\n }\n interface V2ConfirmBookingRequest {\n /** ID of the booking to confirm. */\n bookingId: string;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the confirmation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n }\n interface V2ConfirmBookingResponse {\n booking?: Booking;\n }\n interface V2DeclineBookingRequest {\n /** ID of the booking to decline. */\n bookingId: string;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the decline and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n }\n interface V2DeclineBookingResponse {\n /** Declined booking. */\n booking?: Booking;\n }\n interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /** ID of the booking to update the number of participants for. */\n bookingId: string;\n /** Updated number of participants. */\n numberOfParticipants?: number | null;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n }\n /** @oneof */\n interface V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n }\n interface V2UpdateNumberOfParticipantsResponse {\n /** Booking with updated number of participants. */\n booking?: Booking;\n }\n interface CreateMultiServiceBookingOptions {\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingFlowControlSettings;\n /** Whether to return the created bookings entities. */\n returnFullEntity?: boolean;\n /**\n * Multi service booking type.\n * One of:\n * - `\"SEQUENTIAL_BOOKINGS\"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * - `\"SEPARATE_BOOKINGS\"` Not supported yet.\n * - `\"PARALLEL_BOOKINGS\"` Not supported yet.\n */\n multiServiceBookingType?: MultiServiceBookingType;\n }\n interface RescheduleMultiServiceBookingOptions {\n /** Information about whether to notify the customer about the rescheduling and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * rescheduling flow are changed. For example, whether the availability of\n * the new slot is checked before rescheduling the booking or if you can\n * reschedule the booking even though the rescheduling policy doesn't allow it.\n */\n flowControlSettings?: RescheduleBookingFlowControlSettings;\n /** Whether to return the rescheduled bookings entities. */\n returnFullEntity?: boolean;\n }\n interface CancelMultiServiceBookingOptions {\n /** Information about whether to notify the customer about the cancelation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * cancelation flow are changed. For example, whether the you can cancel\n * a booking even though the cancelation policy doesn't allow it or whether\n * to issue a refund.\n */\n flowControlSettings?: CancelBookingFlowControlSettings;\n /** Whether to return the canceled bookings entities. */\n returnFullEntity?: boolean;\n }\n interface MarkMultiServiceBookingAsPendingOptions {\n /** Bookings to mark as pending. */\n markAsPendingBookingsInfo?: BookingInfo[];\n /** Information about whether to notify the customer upon manual confirmation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** Whether to return the pending bookings entities. */\n returnFullEntity?: boolean;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before updating the booking.\n */\n flowControlSettings?: MarkBookingAsPendingFlowControlSettings;\n }\n interface ConfirmMultiServiceBookingOptions {\n /** Bookings to confirm. */\n confirmBookingsInfo?: BookingInfo[];\n /** Information about whether to notify the customer about the confirmation and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** Whether to return the confirmed bookings entities. */\n returnFullEntity?: boolean;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * confirmation flow are changed. For example, whether the availability is\n * checked before confirming the booking.\n */\n flowControlSettings?: ConfirmBookingFlowControlSettings;\n }\n interface DeclineMultiServiceBookingOptions {\n /** Bookings to decline. */\n declineBookingsInfo?: BookingInfo[];\n /** Information about whether to notify the customer about the decline and the message to send. */\n participantNotification?: ParticipantNotification$4;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** Whether to return the declined bookings entities. */\n returnFullEntity?: boolean;\n }\n interface MarkAsMultiServiceBookingOptions {\n /**\n * Multi service booking type.\n * One of:\n * - `\"SEQUENTIAL_BOOKINGS\"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.\n * - `\"SEPARATE_BOOKINGS\"` Not supported yet.\n * - `\"PARALLEL_BOOKINGS\"` Not supported yet.\n */\n multiServiceBookingType?: MultiServiceBookingType;\n }\n interface AddBookingsToMultiServiceBookingOptions {\n /** List of bookings ids and their revisions to add to the multi service booking. */\n bookings: BookingIdAndRevision[];\n /** Whether to return the bookings entities. */\n returnFullEntity?: boolean;\n }\n interface RemoveBookingsFromMultiServiceBookingOptions {\n /** List of bookings ids and their revisions to remove from the multi service booking. */\n bookings?: BookingIdAndRevision[];\n /** Whether to return the bookings entities. */\n returnFullEntity?: boolean;\n }\n /**\n * Creates a booking.\n *\n *\n * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.\n *\n * To create a booking for the entire course, pass a booking with the relevant `schedule`.\n * You can use Query Availability to check the availability beforehand.\n *\n * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.\n * Then, any specified slot details are calculated.\n *\n * If you create a booking for a new session, we recommend to call Query Availability first.\n * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.\n *\n * Bookings are created with a status of `CREATED`.\n * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.\n *\n * To create a booking with a given status, pass a booking with the wanted status.\n * This is only permitted for site Owners.\n *\n * You can pass a `participantNotification.message` to notify the customer of the booking with a message.\n * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.\n *\n * You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.\n *\n * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the\n * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.\n *\n * When creating a booking, you can pass `selectedPaymentOption`.\n * This specifies which payment method the customer plans to use.\n * But it's possible for them to later use another supported payment method.\n *\n * You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the\n * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.\n * @param booking - The booking to create.\n * @public\n * @documentationMaturity preview\n * @requiredField booking\n * @requiredField booking.additionalFields._id\n * @requiredField booking.bookedEntity\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function createBooking(booking: Booking, options?: CreateBookingOptions): Promise;\n interface CreateBookingOptions {\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingFlowControlSettings;\n }\n interface UpdateBooking {\n /** Total number of participants. Available only when the booking includes a single service variant. */\n totalParticipants?: number;\n /**\n * Information about the booked service choices and participants.\n * Available only when the booking includes multiple service variants.\n */\n participantsChoices?: ParticipantChoices;\n /**\n * Booking ID.\n * @readonly\n */\n _id?: string | null;\n /** An object describing the slot or schedule that was booked. */\n bookedEntity?: BookedEntity;\n /** Contact details of the site visitor or member making the booking. */\n contactDetails?: ContactDetails;\n /** Additional custom fields submitted with the booking form. */\n additionalFields?: CustomFormField[];\n /**\n * Booking status.\n * Supported values:\n * - `CREATED`: The booking was created.\n * - `UPDATED`: The booking was updated.\n * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business owner confirmation and an eCommerce order was created.\n * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an eCommerce order was created. If the service isn't configured to automatically confirm bookings, you can use `confirmOrDeclineBooking()`.\n * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an eCommerce order was created that resulted in a double booking.\n * - `CANCELED`: The booking was canceled.\n * - `WAITING_LIST`: The booking is on a wait list.\n */\n status?: BookingStatus;\n /**\n * Payment status.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n * @readonly\n */\n paymentStatus?: PaymentStatus;\n /**\n * Selected payment option.\n * One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.\n * When undefined, the payment option is resolved by the service configuration on checkout.\n */\n selectedPaymentOption?: SelectedPaymentOption;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */\n revision?: string | null;\n /**\n * ID of the creator of the Booking.\n * If `appId` and another ID are present, the other ID takes precedence.\n * @readonly\n */\n createdBy?: CommonIdentificationData;\n /**\n * The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.\n * @readonly\n */\n startDate?: Date;\n /**\n * The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.\n * @readonly\n */\n endDate?: Date;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls. */\n extendedFields?: ExtendedFields$1;\n /**\n * Whether this booking overlaps another existing confirmed booking. Returned when: `true`\n * @readonly\n */\n doubleBooked?: boolean | null;\n }\n interface UpdateBookingOptions {\n }\n /**\n * Creates multiple bookings.\n *\n *\n * See [`createBooking()`](https://www.wix.com/velo/reference/wix-bookings-v2/bookings/createbooking) documentation.\n *\n * If for any of the bookings required fields were not passed on the request or if the caller doesn't have the required permissions to create such booking, the call will fail.\n * If the request contains unavailable bookings, the call will be completed successfully, but the unavailable bookings will not be created and will be considered as a failure on the response.\n * @param createBookingsInfo - Bookings to create.\n * Max: 8 bookings.\n * @public\n * @documentationMaturity preview\n * @requiredField createBookingsInfo\n * @requiredField createBookingsInfo.booking\n * @requiredField createBookingsInfo.booking.additionalFields._id\n * @requiredField createBookingsInfo.booking.bookedEntity\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function bulkCreateBooking(createBookingsInfo: CreateBookingInfo[], options?: BulkCreateBookingOptions): Promise;\n interface BulkCreateBookingOptions {\n /** Whether to return the created bookings entities. */\n returnFullEntity?: boolean;\n }\n /**\n * Reschedules a booking to a different slot or session.\n *\n *\n * You can only reschedule bookings for appointments or classes, you can't\n * reschedule course bookings.\n *\n * The old session is removed from the calendar and the new session is\n * added.\n *\n * If you reschedule a booking for a class session the new session must be an\n * existing session for the same class.\n *\n * You can pass a `participantNotification.message` to notify the customer of\n * the rescheduling. You also need to pass `participantNotification.notifyParticipants`\n * as `true` to actually send the message.\n *\n * In case the service has\n * variants, you can call this endpoint to update the booking's `totalParticipants` or `participantsChoices`.\n * If you provide `participantsChoices`, all of the provided choices must exist for\n * the service. Otherwise, the call returns an `INVALID_SERVICE_CHOICES` error.\n * If you omit `participantsChoices` in the request, the existing choices are\n * kept and not replaced with an empty object.\n *\n * \n *\n * In case you want to reschedule a booking on behalf of a customer, we recommend\n * to pass `flowControlSettings.ignoreReschedulePolicy` as `false`. This\n * ensures that the rescheduling is validated against the service's rescheduling\n * policy.\n * @param bookingId - ID of the booking to reschedule.\n * @param slot - Information about the new slot.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField options.revision\n * @requiredField slot\n * @param options - An object representing the available options for rescheduling a booking.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @adminMethod\n */\n function rescheduleBooking(bookingId: string, slot: V2Slot, options?: RescheduleBookingOptions): Promise;\n interface RescheduleBookingOptions extends RescheduleBookingRequestParticipantsInfoOneOf {\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the rescheduling and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * rescheduling flow are changed. For example, whether the availability of\n * the new slot is checked before rescheduling the booking or if you can\n * reschedule the booking even though the rescheduling policy doesn't allow it.\n */\n flowControlSettings?: RescheduleBookingFlowControlSettings;\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n }\n interface BulkRescheduleBookingOptions {\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$4;\n }\n interface BulkUpdateBookedScheduleOptions {\n /** The ID of the schedule to be updated. */\n scheduleId: string;\n /** Whether to notify participants about the change and an optional custom message. */\n participantNotification?: ParticipantNotification$4;\n }\n interface QueryOptions {\n }\n /**\n * Confirms a booking request and changes the booking status to `CONFIRMED`.\n *\n *\n * Calling this method doesn't check whether a slot or schedule is still\n * available at this time.\n *\n * You can only confirm bookings for services that require the owner's manual\n * approval for bookings and that have a status of `PENDING`.\n *\n * For appointment services the slot may become unavailable, depending on the\n * [service's](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business)\n * `policy.bookingApprovalPolicy.requestsAffectsAvailability`.\n *\n * Calling this method also changes the\n * [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)\n * `participants.approvalStatus` to `APPROVED`.\n *\n * You can pass a `participantNotification.message` to notify the customer of\n * the confirmation. You also need to pass `participantNotification.notifyParticipants`\n * as `true` to actually send the message.\n *\n * Bookings are automatically confirmed when the\n * service is configured to automatically confirm\n * bookings and the [eCommerce order](https://www.wix.com/velo/reference/wix-ecom-backend/orders)\n * has been approved. The slot's or schedule's availability is checked just\n * before confirming the booking as part of the automatic flow.\n * @param bookingId - ID of the booking to confirm.\n * @param revision - Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField revision\n * @param options - An object representing the available options for canceling a booking.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function confirmBooking(bookingId: string, revision: string | null, options?: ConfirmBookingOptions): Promise;\n interface ConfirmBookingOptions {\n /**\n * Information about whether to notify the customer about the confirmation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Payment status to set for the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before confirming the booking.\n */\n flowControlSettings?: ConfirmBookingFlowControlSettings;\n }\n interface PartySizeOptions extends PartySizeRequestPartySizeForOneOf {\n sessionId?: string | null;\n scheduleId?: string | null;\n }\n interface ConsistentQueryOptions {\n query?: QueryV2$3;\n }\n interface SetBookingSessionIdOptions {\n /** The sessionId to be set. */\n sessionId?: string;\n }\n /**\n * Updates the extended fields for a booking.\n *\n *\n * Extended fields must first be configured in the [Wix Developers Center](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fextensions).\n *\n * Learn more about setting up extended fields with [schema plugins](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions).\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField namespace\n * @requiredField options\n * @requiredField options.namespaceData\n * @param _id - ID of the booking for which to update extended fields.\n * @param namespace - [Namespace](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-reading-and-writing-schema-plugin-fields#namespaces) of the app for which to update extended fields.\n * @param options - Options for updating the booking's extended fields.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise;\n interface UpdateExtendedFieldsOptions {\n /** Data of the extended field to update. Must be structured according to the [schema](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions#json-schema-for-extended-fields) defined during the configuration of the extended fields. */\n namespaceData: Record | null;\n }\n /**\n * Declines a `PENDING` booking request and changes the booking status to\n * `DECLINED`.\n *\n * Calling this method also changes the\n * [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)\n * `participants.approvalStatus` to `DECLINED`.\n *\n * You can only decline bookings for services that require the owner's manual\n * approval for bookings and that have a status of `PENDING`.\n *\n * You can pass a `participantNotification.message` to notify the customer of\n * the decline. You also need to pass `participantNotification.notifyParticipants`\n * as `true` to actually send the message.\n * @param bookingId - ID of the booking to decline.\n * @param revision - Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField revision\n * @param options - An object representing the available options for declining a booking.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function declineBooking(bookingId: string, revision: string | null, options?: DeclineBookingOptions): Promise;\n interface DeclineBookingOptions {\n /**\n * Information about whether to notify the customer about the decline and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Payment status to set on the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n }\n /**\n * Cancels a booking.\n *\n *\n * The booking status changes to `CANCELED`.\n *\n * If the booking was for an appointment, the corresponding session is\n * deleted from the business calendar.\n *\n * If the booking was for a class or course, the participants are removed\n * from the class session or the course. But the course or class session\n * remains on the business calendar.\n *\n * You can pass a `participantNotification.message` to notify the customer of\n * the cancelation. You also need to pass `participantNotification.notifyParticipants`\n * as `true` to actually send the message.\n *\n * In case you want to cancel a booking on behalf of a customer, we recommend\n * to pass `flowControlSettings.ignoreCancellationPolicy` as `false`. This\n * ensures that the cancelation is validated against the service's cancelation\n * policy.\n * @param bookingId - ID of the booking to cancel.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField options.revision\n * @param options - An object representing the available options for canceling a booking.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @adminMethod\n */\n function cancelBooking(bookingId: string, options?: CancelBookingOptions): Promise;\n interface CancelBookingOptions {\n /**\n * Information about whether to notify the customer about the cancelation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * cancelation flow are changed. For example, whether the you can cancel\n * a booking even though the cancelation policy doesn't allow it or whether\n * to issue a refund.\n */\n flowControlSettings?: CancelBookingFlowControlSettings;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when managing the booking.\n */\n revision: string | null;\n }\n /**\n * Updates the number of participants for a booking.\n *\n *\n * You can only update the number of participants for class and course\n * bookings, you can't update it for appointment bookings.\n *\n * Calling this method also changes the\n * [session's](https://www.wix.com/velo/reference/wix-bookings-backend/sessions/getsession)\n * `totalNumberOfParticipants`.\n *\n * When updating the number of participants for a booking you must pass either\n * `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`\n * for services that have variants,\n * all of the provided choices must exist for the service. Otherwise, the\n * call returns an `INVALID_SERVICE_CHOICES` error.\n * @param bookingId - ID of the booking to update the number of participants for.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField options.revision\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateNumberOfParticipants(bookingId: string, options?: UpdateNumberOfParticipantsOptions): Promise;\n interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Total number of participants. Available only for services with\n * variants.\n * Pass when all participants book the same variant.\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * variants.\n * Pass when not all participants book the same variant.\n */\n participantsChoices?: ParticipantChoices;\n }\n interface GetSlotAvailabilityOptions$1 {\n /** The slot for which the availability is checked. */\n slot?: V2Slot;\n /** The timezone for which availability is to be calculated. */\n timezone?: string | null;\n }\n interface MarkBookingAsPendingOptions {\n /**\n * Information about whether to notify the customer and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Payment status to set for the booking.\n * One of:\n * - `\"NOT_PAID\"` The booking is not paid for.\n * - `\"PAID\"` The booking is fully paid.\n * - `\"PARTIALLY_PAID\"` The booking is partially paid.\n * - `\"REFUNDED\"` The booking is refunded.\n * - `\"EXEMPT\"` The booking is free of charge.\n */\n paymentStatus?: PaymentStatus;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before updating the booking's status.\n */\n flowControlSettings?: MarkBookingAsPendingFlowControlSettings;\n }\n /**\n * Use `confirmOrDeclineBooking()` to determine if the booking is valid, payment is received, and the booking can be processed.\n * Call `confirmOrDeclineBooking()` after checkout or after calling `createBooking()` to verify the booking.\n *\n * + If a session is valid and payment is received, the booking is visible on the calendar.\n * + If a session is double booked, `confirmOrDeclineBooking()` can catch this and decline the duplicate booking, the booking is not visible on the calendar.\n * @param bookingId - ID of the booking to confirm or decline.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingId\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise;\n interface ConfirmOrDeclineBookingOptions {\n /** Current payment status of the booking. */\n paymentStatus?: PaymentStatus;\n }\n interface BulkConfirmOrDeclineBookingOptions {\n /**\n * Whether to return the confirmed or declined bookings entities.\n * Not supported yet, currently the entity is not returned.\n */\n returnEntity?: boolean;\n }\n interface BookingsGatewayCreateBookingOptions extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {\n /**\n * Information about the slot to create a booking for.\n * If you set `slot.location.locationType` to `CUSTOM`, the created slot's\n * location is set to `slot.location.formattedAddress` when provided.\n * Otherwise it's set to `contactDetails.fullAddress.formattedAddress`.\n */\n slot?: Slot$1;\n /** Information about the schedule to create a booking for. */\n schedule?: BookedSchedule;\n /** Contact details of the customer booking the service. */\n contactDetails?: ContactDetails;\n /**\n * Booking status.\n * One of:\n * - `\"CREATED\"` - The booking was created.\n * - `\"UPDATED\"` - The booking was updated.\n * - `\"CONFIRMED\"` - The booking has been confirmed and appears on the bookings calendar.\n * Booking can be manually confirmed using the Set As Confirmed endpoint.\n * Booking can be automatically confirmed when the following requirements are met:\n * + The service is configured as automatically confirmed.\n * + Invoking eCommerce checkout API and an order has been created.\n * - `\"CANCELED\"` - The booking has been canceled and synced to bookings calendar.\n * The booking can be canceled using cancel API.\n * - `\"PENDING\"` - The booking waiting to be confirmed or declined buy the owner and is synced to bookings calendar.\n * Bookings can be manually set as pending using setAsPending API, requires manage booking status permissions.\n * Booking can be automatically set as pending when the following requirements are met:\n * + The Service is configured as manually confirmed.\n * + Invoking the eCommerce checkout API and an order has been created.\n * - `\"WAITING_LIST\"` - The booking is pending on a waiting list.\n * Booking can be created with this status when invoking waiting list join API.\n * - `\"DECLINED\"` - The booking was declined by the owner and synced to bookings calendar.\n * Booking can be manually declined using decline API and requires manage booking permissions.\n * Booking can be automatically declined when the following requirements are met:\n * + Invoking eCommerce checkout API and the order declined event has been sent.\n * + Invoking eCommerce checkout API and order approved event has been sent, but the booking is offline and the booking causes a double booking.\n */\n status?: BookingStatus;\n /**\n * Additional custom fields of the booking form. The customer must provide\n * information for each field when booking the service. For example, that they\n * bring their own towels or whether they use a wheelchair.\n *\n * Max: 100 fields\n */\n additionalFields?: CustomFormField[];\n /**\n * Total number of participants. Available only when the service doesn't have\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n *\n * Max: `20`\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note. Not visible to the customer.\n *\n * Max: 200 characters\n */\n internalBusinessNote?: string | null;\n /**\n * Payment option the customer intends to use.\n * Must be one of the payment options defined for the service, unless\n * you pass `flowControlSettings.skipSelectedPaymentOptionValidation` as `true`.\n */\n selectedPaymentOption?: SelectedPaymentOption;\n /**\n * Identifies the source (platform, actor and app) that created this booking.\n * This property of the booking cannot be changed.\n * The app_def_id and app_name will be resolved automatically.\n * TODO GAP See if we need this - might be able to get this data from the headers?\n */\n bookingSource?: BookingSource;\n /**\n * A user identifier of an external application user that initiated the book request.\n * Allows an external application to later identify its own bookings and correlate to its own internal users\n */\n externalUserId?: string | null;\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$4;\n /**\n * Whether to send an SMS reminder to the customer 24 hours before the\n * session starts. The phone number is taken from `contactDetails.phone`.\n *\n * Default: `true`.\n */\n sendSmsReminder?: boolean | null;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * creation flow are changed. For example, whether the availability is\n * checked before creating the booking or if additional payment options are\n * accepted.\n */\n flowControlSettings?: CreateBookingRequestFlowControlSettings;\n }\n interface BookingsGatewayCancelBookingOptions {\n /**\n * Information about whether to notify the customer about the cancelation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when managing the booking.\n */\n revision: string | null;\n }\n interface BookingsGatewayRescheduleBookingOptions extends V2RescheduleBookingRequestParticipantsInfoOneOf {\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n /**\n * Information about whether to notify the customer about the rescheduling and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n }\n interface BookingsGatewayConfirmBookingOptions {\n /**\n * Information about whether to notify the customer about the confirmation and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n }\n interface BookingsGatewayDeclineBookingOptions {\n /**\n * Information about whether to notify the customer about the decline and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$4;\n }\n interface BookingsGatewayUpdateNumberOfParticipantsOptions extends V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /** Updated number of participants. */\n numberOfParticipants?: number | null;\n /**\n * Revision number, which increments by 1 each time the booking is updated.\n * To prevent conflicting changes, the current revision must be passed when\n * managing the booking.\n */\n revision: string | null;\n }\n type bookingsV2BookingBookings_universal_d_Booking = Booking;\n type bookingsV2BookingBookings_universal_d_BookingParticipantsInfoOneOf = BookingParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_MultiServiceBookingType = MultiServiceBookingType;\n const bookingsV2BookingBookings_universal_d_MultiServiceBookingType: typeof MultiServiceBookingType;\n type bookingsV2BookingBookings_universal_d_BookedEntity = BookedEntity;\n type bookingsV2BookingBookings_universal_d_BookedEntityItemOneOf = BookedEntityItemOneOf;\n type bookingsV2BookingBookings_universal_d_BookedSlot = BookedSlot;\n type bookingsV2BookingBookings_universal_d_BookedResource = BookedResource;\n type bookingsV2BookingBookings_universal_d_BookedSchedule = BookedSchedule;\n type bookingsV2BookingBookings_universal_d_ContactDetails = ContactDetails;\n type bookingsV2BookingBookings_universal_d_CustomFormField = CustomFormField;\n type bookingsV2BookingBookings_universal_d_ValueType = ValueType;\n const bookingsV2BookingBookings_universal_d_ValueType: typeof ValueType;\n type bookingsV2BookingBookings_universal_d_BookingStatus = BookingStatus;\n const bookingsV2BookingBookings_universal_d_BookingStatus: typeof BookingStatus;\n type bookingsV2BookingBookings_universal_d_PaymentStatus = PaymentStatus;\n const bookingsV2BookingBookings_universal_d_PaymentStatus: typeof PaymentStatus;\n type bookingsV2BookingBookings_universal_d_SelectedPaymentOption = SelectedPaymentOption;\n const bookingsV2BookingBookings_universal_d_SelectedPaymentOption: typeof SelectedPaymentOption;\n type bookingsV2BookingBookings_universal_d_BookingSource = BookingSource;\n type bookingsV2BookingBookings_universal_d_Platform = Platform;\n const bookingsV2BookingBookings_universal_d_Platform: typeof Platform;\n type bookingsV2BookingBookings_universal_d_Actor = Actor;\n const bookingsV2BookingBookings_universal_d_Actor: typeof Actor;\n type bookingsV2BookingBookings_universal_d_CommonIdentificationData = CommonIdentificationData;\n type bookingsV2BookingBookings_universal_d_CommonIdentificationDataIdOneOf = CommonIdentificationDataIdOneOf;\n type bookingsV2BookingBookings_universal_d_IdentificationDataIdentityType = IdentificationDataIdentityType;\n const bookingsV2BookingBookings_universal_d_IdentificationDataIdentityType: typeof IdentificationDataIdentityType;\n type bookingsV2BookingBookings_universal_d_FlowControlSettings = FlowControlSettings;\n type bookingsV2BookingBookings_universal_d_ParticipantChoices = ParticipantChoices;\n type bookingsV2BookingBookings_universal_d_ServiceChoices = ServiceChoices;\n type bookingsV2BookingBookings_universal_d_MultiServiceBookingInfo = MultiServiceBookingInfo;\n type bookingsV2BookingBookings_universal_d_CreateMultiServiceBookingRequest = CreateMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_CreateBookingFlowControlSettings = CreateBookingFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_CreateMultiServiceBookingResponse = CreateMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_MultiServiceBooking = MultiServiceBooking;\n type bookingsV2BookingBookings_universal_d_BookingResult = BookingResult;\n type bookingsV2BookingBookings_universal_d_RescheduleMultiServiceBookingRequest = RescheduleMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_V2Slot = V2Slot;\n type bookingsV2BookingBookings_universal_d_LocationLocationType = LocationLocationType;\n const bookingsV2BookingBookings_universal_d_LocationLocationType: typeof LocationLocationType;\n type bookingsV2BookingBookings_universal_d_SlotSlotResource = SlotSlotResource;\n type bookingsV2BookingBookings_universal_d_SlotLocation = SlotLocation;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingInfo = RescheduleBookingInfo;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingInfoParticipantsInfoOneOf = RescheduleBookingInfoParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingFlowControlSettings = RescheduleBookingFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_RescheduleMultiServiceBookingResponse = RescheduleMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_BookingRescheduled = BookingRescheduled;\n type bookingsV2BookingBookings_universal_d_BookingRescheduledPreviousParticipantsInfoOneOf = BookingRescheduledPreviousParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_IdentityType = IdentityType;\n const bookingsV2BookingBookings_universal_d_IdentityType: typeof IdentityType;\n type bookingsV2BookingBookings_universal_d_GetMultiServiceBookingAvailabilityRequest = GetMultiServiceBookingAvailabilityRequest;\n type bookingsV2BookingBookings_universal_d_GetMultiServiceBookingAvailabilityResponse = GetMultiServiceBookingAvailabilityResponse;\n type bookingsV2BookingBookings_universal_d_GetMultiServiceBookingAvailabilityResponseBookingInfo = GetMultiServiceBookingAvailabilityResponseBookingInfo;\n type bookingsV2BookingBookings_universal_d_CancelMultiServiceBookingRequest = CancelMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_CancelBookingFlowControlSettings = CancelBookingFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_CancelMultiServiceBookingResponse = CancelMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_BookingCanceled = BookingCanceled;\n type bookingsV2BookingBookings_universal_d_MarkMultiServiceBookingAsPendingRequest = MarkMultiServiceBookingAsPendingRequest;\n type bookingsV2BookingBookings_universal_d_BookingInfo = BookingInfo;\n type bookingsV2BookingBookings_universal_d_MarkBookingAsPendingFlowControlSettings = MarkBookingAsPendingFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_MarkMultiServiceBookingAsPendingResponse = MarkMultiServiceBookingAsPendingResponse;\n type bookingsV2BookingBookings_universal_d_ConfirmMultiServiceBookingRequest = ConfirmMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_ConfirmBookingFlowControlSettings = ConfirmBookingFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_ConfirmMultiServiceBookingResponse = ConfirmMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_BookingConfirmed = BookingConfirmed;\n type bookingsV2BookingBookings_universal_d_DeclineMultiServiceBookingRequest = DeclineMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_DeclineMultiServiceBookingResponse = DeclineMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_BookingDeclined = BookingDeclined;\n type bookingsV2BookingBookings_universal_d_BulkGetMultiServiceBookingAllowedActionsRequest = BulkGetMultiServiceBookingAllowedActionsRequest;\n type bookingsV2BookingBookings_universal_d_BulkGetMultiServiceBookingAllowedActionsResponse = BulkGetMultiServiceBookingAllowedActionsResponse;\n type bookingsV2BookingBookings_universal_d_BulkCalculateAllowedActionsResult = BulkCalculateAllowedActionsResult;\n type bookingsV2BookingBookings_universal_d_AllowedActions = AllowedActions;\n type bookingsV2BookingBookings_universal_d_MarkAsMultiServiceBookingRequest = MarkAsMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_MarkAsMultiServiceBookingResponse = MarkAsMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_GetMultiServiceBookingRequest = GetMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_GetMultiServiceBookingResponse = GetMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_MultiServiceBookingMetadata = MultiServiceBookingMetadata;\n type bookingsV2BookingBookings_universal_d_AddBookingsToMultiServiceBookingRequest = AddBookingsToMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_BookingIdAndRevision = BookingIdAndRevision;\n type bookingsV2BookingBookings_universal_d_AddBookingsToMultiServiceBookingResponse = AddBookingsToMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_RemoveBookingsFromMultiServiceBookingRequest = RemoveBookingsFromMultiServiceBookingRequest;\n type bookingsV2BookingBookings_universal_d_RemoveBookingsFromMultiServiceBookingResponse = RemoveBookingsFromMultiServiceBookingResponse;\n type bookingsV2BookingBookings_universal_d_WebhooksIdentificationData = WebhooksIdentificationData;\n type bookingsV2BookingBookings_universal_d_WebhooksIdentificationDataIdOneOf = WebhooksIdentificationDataIdOneOf;\n type bookingsV2BookingBookings_universal_d_BookingChanged = BookingChanged;\n type bookingsV2BookingBookings_universal_d_CreateBookingRequest = CreateBookingRequest;\n type bookingsV2BookingBookings_universal_d_CreateBookingResponse = CreateBookingResponse;\n type bookingsV2BookingBookings_universal_d_UpdateBookingRequest = UpdateBookingRequest;\n type bookingsV2BookingBookings_universal_d_UpdateBookingResponse = UpdateBookingResponse;\n type bookingsV2BookingBookings_universal_d_LegacyCreateBookingRequest = LegacyCreateBookingRequest;\n type bookingsV2BookingBookings_universal_d_LegacyCreateBookingResponse = LegacyCreateBookingResponse;\n type bookingsV2BookingBookings_universal_d_BulkUpdateBookingRequest = BulkUpdateBookingRequest;\n type bookingsV2BookingBookings_universal_d_MaskedBooking = MaskedBooking;\n type bookingsV2BookingBookings_universal_d_BulkUpdateBookingResponse = BulkUpdateBookingResponse;\n type bookingsV2BookingBookings_universal_d_BulkCreateBookingRequest = BulkCreateBookingRequest;\n type bookingsV2BookingBookings_universal_d_CreateBookingInfo = CreateBookingInfo;\n type bookingsV2BookingBookings_universal_d_BulkCreateBookingResponse = BulkCreateBookingResponse;\n type bookingsV2BookingBookings_universal_d_BulkBookingResult = BulkBookingResult;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingRequest = RescheduleBookingRequest;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingRequestParticipantsInfoOneOf = RescheduleBookingRequestParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingResponse = RescheduleBookingResponse;\n type bookingsV2BookingBookings_universal_d_BulkRescheduleBookingRequest = BulkRescheduleBookingRequest;\n type bookingsV2BookingBookings_universal_d_BulkRescheduleBookingRequestBooking = BulkRescheduleBookingRequestBooking;\n type bookingsV2BookingBookings_universal_d_SlotBookings = SlotBookings;\n type bookingsV2BookingBookings_universal_d_BulkRescheduleBookingResponse = BulkRescheduleBookingResponse;\n type bookingsV2BookingBookings_universal_d_BulkUpdateBookedScheduleRequest = BulkUpdateBookedScheduleRequest;\n type bookingsV2BookingBookings_universal_d_BookingDetails = BookingDetails;\n type bookingsV2BookingBookings_universal_d_BulkUpdateBookedScheduleResponse = BulkUpdateBookedScheduleResponse;\n type bookingsV2BookingBookings_universal_d_QueryBookingsRequest = QueryBookingsRequest;\n type bookingsV2BookingBookings_universal_d_QueryBookingsResponse = QueryBookingsResponse;\n type bookingsV2BookingBookings_universal_d_ConfirmRequest = ConfirmRequest;\n type bookingsV2BookingBookings_universal_d_ConfirmResponse = ConfirmResponse;\n type bookingsV2BookingBookings_universal_d_ConfirmBookingRequest = ConfirmBookingRequest;\n type bookingsV2BookingBookings_universal_d_ConfirmBookingResponse = ConfirmBookingResponse;\n type bookingsV2BookingBookings_universal_d_PartySizeRequest = PartySizeRequest;\n type bookingsV2BookingBookings_universal_d_PartySizeRequestPartySizeForOneOf = PartySizeRequestPartySizeForOneOf;\n type bookingsV2BookingBookings_universal_d_PartySizeResponse = PartySizeResponse;\n type bookingsV2BookingBookings_universal_d_ConsistentQueryBookingsRequest = ConsistentQueryBookingsRequest;\n type bookingsV2BookingBookings_universal_d_ConsistentQueryBookingsResponse = ConsistentQueryBookingsResponse;\n type bookingsV2BookingBookings_universal_d_SetBookingSessionIdRequest = SetBookingSessionIdRequest;\n type bookingsV2BookingBookings_universal_d_SetBookingSessionIdResponse = SetBookingSessionIdResponse;\n type bookingsV2BookingBookings_universal_d_UpdateExtendedFieldsRequest = UpdateExtendedFieldsRequest;\n type bookingsV2BookingBookings_universal_d_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;\n type bookingsV2BookingBookings_universal_d_DeclineBookingRequest = DeclineBookingRequest;\n type bookingsV2BookingBookings_universal_d_DeclineBookingResponse = DeclineBookingResponse;\n type bookingsV2BookingBookings_universal_d_CancelBookingRequest = CancelBookingRequest;\n type bookingsV2BookingBookings_universal_d_CancelBookingResponse = CancelBookingResponse;\n type bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsRequest = UpdateNumberOfParticipantsRequest;\n type bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsRequestParticipantsInfoOneOf = UpdateNumberOfParticipantsRequestParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsResponse = UpdateNumberOfParticipantsResponse;\n type bookingsV2BookingBookings_universal_d_NumberOfParticipantsUpdated = NumberOfParticipantsUpdated;\n type bookingsV2BookingBookings_universal_d_NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf = NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_CalculateAllowedActionsRequest = CalculateAllowedActionsRequest;\n type bookingsV2BookingBookings_universal_d_CalculateAllowedActionsResponse = CalculateAllowedActionsResponse;\n type bookingsV2BookingBookings_universal_d_BulkCalculateAllowedActionsRequest = BulkCalculateAllowedActionsRequest;\n type bookingsV2BookingBookings_universal_d_BulkCalculateAllowedActionsResponse = BulkCalculateAllowedActionsResponse;\n type bookingsV2BookingBookings_universal_d_AvailableResources = AvailableResources;\n type bookingsV2BookingBookings_universal_d_MarkBookingAsPendingRequest = MarkBookingAsPendingRequest;\n type bookingsV2BookingBookings_universal_d_MarkBookingAsPendingResponse = MarkBookingAsPendingResponse;\n type bookingsV2BookingBookings_universal_d_BookingMarkedAsPending = BookingMarkedAsPending;\n type bookingsV2BookingBookings_universal_d_MigrationCheckIfClashesWithBlockedTimeRequest = MigrationCheckIfClashesWithBlockedTimeRequest;\n type bookingsV2BookingBookings_universal_d_MsidAndBookingId = MsidAndBookingId;\n type bookingsV2BookingBookings_universal_d_MigrationCheckIfClashesWithBlockedTimeResponse = MigrationCheckIfClashesWithBlockedTimeResponse;\n type bookingsV2BookingBookings_universal_d_Clash = Clash;\n type bookingsV2BookingBookings_universal_d_ConfirmOrDeclineBookingRequest = ConfirmOrDeclineBookingRequest;\n type bookingsV2BookingBookings_universal_d_ConfirmOrDeclineBookingResponse = ConfirmOrDeclineBookingResponse;\n type bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingRequest = BulkConfirmOrDeclineBookingRequest;\n type bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingRequestBookingDetails = BulkConfirmOrDeclineBookingRequestBookingDetails;\n type bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingResponse = BulkConfirmOrDeclineBookingResponse;\n type bookingsV2BookingBookings_universal_d_V2CreateBookingRequest = V2CreateBookingRequest;\n type bookingsV2BookingBookings_universal_d_V2CreateBookingRequestBookableItemOneOf = V2CreateBookingRequestBookableItemOneOf;\n type bookingsV2BookingBookings_universal_d_V2CreateBookingRequestParticipantsInfoOneOf = V2CreateBookingRequestParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_CreateBookingRequestFlowControlSettings = CreateBookingRequestFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_V2CreateBookingResponse = V2CreateBookingResponse;\n type bookingsV2BookingBookings_universal_d_V2CancelBookingRequest = V2CancelBookingRequest;\n type bookingsV2BookingBookings_universal_d_CancelBookingRequestFlowControlSettings = CancelBookingRequestFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_V2CancelBookingResponse = V2CancelBookingResponse;\n type bookingsV2BookingBookings_universal_d_V2RescheduleBookingRequest = V2RescheduleBookingRequest;\n type bookingsV2BookingBookings_universal_d_V2RescheduleBookingRequestParticipantsInfoOneOf = V2RescheduleBookingRequestParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingRequestFlowControlSettings = RescheduleBookingRequestFlowControlSettings;\n type bookingsV2BookingBookings_universal_d_V2RescheduleBookingResponse = V2RescheduleBookingResponse;\n type bookingsV2BookingBookings_universal_d_V2ConfirmBookingRequest = V2ConfirmBookingRequest;\n type bookingsV2BookingBookings_universal_d_V2ConfirmBookingResponse = V2ConfirmBookingResponse;\n type bookingsV2BookingBookings_universal_d_V2DeclineBookingRequest = V2DeclineBookingRequest;\n type bookingsV2BookingBookings_universal_d_V2DeclineBookingResponse = V2DeclineBookingResponse;\n type bookingsV2BookingBookings_universal_d_V2UpdateNumberOfParticipantsRequest = V2UpdateNumberOfParticipantsRequest;\n type bookingsV2BookingBookings_universal_d_V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf = V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf;\n type bookingsV2BookingBookings_universal_d_V2UpdateNumberOfParticipantsResponse = V2UpdateNumberOfParticipantsResponse;\n type bookingsV2BookingBookings_universal_d_CreateMultiServiceBookingOptions = CreateMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_RescheduleMultiServiceBookingOptions = RescheduleMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_CancelMultiServiceBookingOptions = CancelMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_MarkMultiServiceBookingAsPendingOptions = MarkMultiServiceBookingAsPendingOptions;\n type bookingsV2BookingBookings_universal_d_ConfirmMultiServiceBookingOptions = ConfirmMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_DeclineMultiServiceBookingOptions = DeclineMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_MarkAsMultiServiceBookingOptions = MarkAsMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_AddBookingsToMultiServiceBookingOptions = AddBookingsToMultiServiceBookingOptions;\n type bookingsV2BookingBookings_universal_d_RemoveBookingsFromMultiServiceBookingOptions = RemoveBookingsFromMultiServiceBookingOptions;\n const bookingsV2BookingBookings_universal_d_createBooking: typeof createBooking;\n type bookingsV2BookingBookings_universal_d_CreateBookingOptions = CreateBookingOptions;\n type bookingsV2BookingBookings_universal_d_UpdateBooking = UpdateBooking;\n type bookingsV2BookingBookings_universal_d_UpdateBookingOptions = UpdateBookingOptions;\n const bookingsV2BookingBookings_universal_d_bulkCreateBooking: typeof bulkCreateBooking;\n type bookingsV2BookingBookings_universal_d_BulkCreateBookingOptions = BulkCreateBookingOptions;\n const bookingsV2BookingBookings_universal_d_rescheduleBooking: typeof rescheduleBooking;\n type bookingsV2BookingBookings_universal_d_RescheduleBookingOptions = RescheduleBookingOptions;\n type bookingsV2BookingBookings_universal_d_BulkRescheduleBookingOptions = BulkRescheduleBookingOptions;\n type bookingsV2BookingBookings_universal_d_BulkUpdateBookedScheduleOptions = BulkUpdateBookedScheduleOptions;\n type bookingsV2BookingBookings_universal_d_QueryOptions = QueryOptions;\n const bookingsV2BookingBookings_universal_d_confirmBooking: typeof confirmBooking;\n type bookingsV2BookingBookings_universal_d_ConfirmBookingOptions = ConfirmBookingOptions;\n type bookingsV2BookingBookings_universal_d_PartySizeOptions = PartySizeOptions;\n type bookingsV2BookingBookings_universal_d_ConsistentQueryOptions = ConsistentQueryOptions;\n type bookingsV2BookingBookings_universal_d_SetBookingSessionIdOptions = SetBookingSessionIdOptions;\n const bookingsV2BookingBookings_universal_d_updateExtendedFields: typeof updateExtendedFields;\n type bookingsV2BookingBookings_universal_d_UpdateExtendedFieldsOptions = UpdateExtendedFieldsOptions;\n const bookingsV2BookingBookings_universal_d_declineBooking: typeof declineBooking;\n type bookingsV2BookingBookings_universal_d_DeclineBookingOptions = DeclineBookingOptions;\n const bookingsV2BookingBookings_universal_d_cancelBooking: typeof cancelBooking;\n type bookingsV2BookingBookings_universal_d_CancelBookingOptions = CancelBookingOptions;\n const bookingsV2BookingBookings_universal_d_updateNumberOfParticipants: typeof updateNumberOfParticipants;\n type bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsOptions = UpdateNumberOfParticipantsOptions;\n type bookingsV2BookingBookings_universal_d_MarkBookingAsPendingOptions = MarkBookingAsPendingOptions;\n const bookingsV2BookingBookings_universal_d_confirmOrDeclineBooking: typeof confirmOrDeclineBooking;\n type bookingsV2BookingBookings_universal_d_ConfirmOrDeclineBookingOptions = ConfirmOrDeclineBookingOptions;\n type bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingOptions = BulkConfirmOrDeclineBookingOptions;\n type bookingsV2BookingBookings_universal_d_BookingsGatewayCreateBookingOptions = BookingsGatewayCreateBookingOptions;\n type bookingsV2BookingBookings_universal_d_BookingsGatewayCancelBookingOptions = BookingsGatewayCancelBookingOptions;\n type bookingsV2BookingBookings_universal_d_BookingsGatewayRescheduleBookingOptions = BookingsGatewayRescheduleBookingOptions;\n type bookingsV2BookingBookings_universal_d_BookingsGatewayConfirmBookingOptions = BookingsGatewayConfirmBookingOptions;\n type bookingsV2BookingBookings_universal_d_BookingsGatewayDeclineBookingOptions = BookingsGatewayDeclineBookingOptions;\n type bookingsV2BookingBookings_universal_d_BookingsGatewayUpdateNumberOfParticipantsOptions = BookingsGatewayUpdateNumberOfParticipantsOptions;\n namespace bookingsV2BookingBookings_universal_d {\n export { bookingsV2BookingBookings_universal_d_Booking as Booking, bookingsV2BookingBookings_universal_d_BookingParticipantsInfoOneOf as BookingParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_MultiServiceBookingType as MultiServiceBookingType, bookingsV2BookingBookings_universal_d_BookedEntity as BookedEntity, bookingsV2BookingBookings_universal_d_BookedEntityItemOneOf as BookedEntityItemOneOf, bookingsV2BookingBookings_universal_d_BookedSlot as BookedSlot, bookingsV2BookingBookings_universal_d_BookedResource as BookedResource, Location$5 as Location, LocationType$5 as LocationType, bookingsV2BookingBookings_universal_d_BookedSchedule as BookedSchedule, bookingsV2BookingBookings_universal_d_ContactDetails as ContactDetails, Address$4 as Address, AddressStreetOneOf$4 as AddressStreetOneOf, StreetAddress$4 as StreetAddress, AddressLocation$4 as AddressLocation, Subdivision$4 as Subdivision, bookingsV2BookingBookings_universal_d_CustomFormField as CustomFormField, bookingsV2BookingBookings_universal_d_ValueType as ValueType, bookingsV2BookingBookings_universal_d_BookingStatus as BookingStatus, bookingsV2BookingBookings_universal_d_PaymentStatus as PaymentStatus, bookingsV2BookingBookings_universal_d_SelectedPaymentOption as SelectedPaymentOption, bookingsV2BookingBookings_universal_d_BookingSource as BookingSource, bookingsV2BookingBookings_universal_d_Platform as Platform, bookingsV2BookingBookings_universal_d_Actor as Actor, ParticipantNotification$4 as ParticipantNotification, bookingsV2BookingBookings_universal_d_CommonIdentificationData as CommonIdentificationData, bookingsV2BookingBookings_universal_d_CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOf, bookingsV2BookingBookings_universal_d_IdentificationDataIdentityType as IdentificationDataIdentityType, bookingsV2BookingBookings_universal_d_FlowControlSettings as FlowControlSettings, ExtendedFields$1 as ExtendedFields, bookingsV2BookingBookings_universal_d_ParticipantChoices as ParticipantChoices, bookingsV2BookingBookings_universal_d_ServiceChoices as ServiceChoices, ServiceChoice$1 as ServiceChoice, ServiceChoiceChoiceOneOf$1 as ServiceChoiceChoiceOneOf, bookingsV2BookingBookings_universal_d_MultiServiceBookingInfo as MultiServiceBookingInfo, bookingsV2BookingBookings_universal_d_CreateMultiServiceBookingRequest as CreateMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_CreateBookingFlowControlSettings as CreateBookingFlowControlSettings, bookingsV2BookingBookings_universal_d_CreateMultiServiceBookingResponse as CreateMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_MultiServiceBooking as MultiServiceBooking, bookingsV2BookingBookings_universal_d_BookingResult as BookingResult, bookingsV2BookingBookings_universal_d_RescheduleMultiServiceBookingRequest as RescheduleMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_V2Slot as V2Slot, bookingsV2BookingBookings_universal_d_LocationLocationType as LocationLocationType, bookingsV2BookingBookings_universal_d_SlotSlotResource as SlotSlotResource, bookingsV2BookingBookings_universal_d_SlotLocation as SlotLocation, bookingsV2BookingBookings_universal_d_RescheduleBookingInfo as RescheduleBookingInfo, bookingsV2BookingBookings_universal_d_RescheduleBookingInfoParticipantsInfoOneOf as RescheduleBookingInfoParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_RescheduleBookingFlowControlSettings as RescheduleBookingFlowControlSettings, bookingsV2BookingBookings_universal_d_RescheduleMultiServiceBookingResponse as RescheduleMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_BookingRescheduled as BookingRescheduled, bookingsV2BookingBookings_universal_d_BookingRescheduledPreviousParticipantsInfoOneOf as BookingRescheduledPreviousParticipantsInfoOneOf, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, bookingsV2BookingBookings_universal_d_IdentityType as IdentityType, bookingsV2BookingBookings_universal_d_GetMultiServiceBookingAvailabilityRequest as GetMultiServiceBookingAvailabilityRequest, bookingsV2BookingBookings_universal_d_GetMultiServiceBookingAvailabilityResponse as GetMultiServiceBookingAvailabilityResponse, BookingPolicyViolations$1 as BookingPolicyViolations, BookingPolicySettings$1 as BookingPolicySettings, bookingsV2BookingBookings_universal_d_GetMultiServiceBookingAvailabilityResponseBookingInfo as GetMultiServiceBookingAvailabilityResponseBookingInfo, bookingsV2BookingBookings_universal_d_CancelMultiServiceBookingRequest as CancelMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_CancelBookingFlowControlSettings as CancelBookingFlowControlSettings, bookingsV2BookingBookings_universal_d_CancelMultiServiceBookingResponse as CancelMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_BookingCanceled as BookingCanceled, bookingsV2BookingBookings_universal_d_MarkMultiServiceBookingAsPendingRequest as MarkMultiServiceBookingAsPendingRequest, bookingsV2BookingBookings_universal_d_BookingInfo as BookingInfo, bookingsV2BookingBookings_universal_d_MarkBookingAsPendingFlowControlSettings as MarkBookingAsPendingFlowControlSettings, bookingsV2BookingBookings_universal_d_MarkMultiServiceBookingAsPendingResponse as MarkMultiServiceBookingAsPendingResponse, bookingsV2BookingBookings_universal_d_ConfirmMultiServiceBookingRequest as ConfirmMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_ConfirmBookingFlowControlSettings as ConfirmBookingFlowControlSettings, bookingsV2BookingBookings_universal_d_ConfirmMultiServiceBookingResponse as ConfirmMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_BookingConfirmed as BookingConfirmed, bookingsV2BookingBookings_universal_d_DeclineMultiServiceBookingRequest as DeclineMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_DeclineMultiServiceBookingResponse as DeclineMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_BookingDeclined as BookingDeclined, bookingsV2BookingBookings_universal_d_BulkGetMultiServiceBookingAllowedActionsRequest as BulkGetMultiServiceBookingAllowedActionsRequest, bookingsV2BookingBookings_universal_d_BulkGetMultiServiceBookingAllowedActionsResponse as BulkGetMultiServiceBookingAllowedActionsResponse, bookingsV2BookingBookings_universal_d_BulkCalculateAllowedActionsResult as BulkCalculateAllowedActionsResult, ItemMetadata$1 as ItemMetadata, ApplicationError$1 as ApplicationError, bookingsV2BookingBookings_universal_d_AllowedActions as AllowedActions, BulkActionMetadata$1 as BulkActionMetadata, bookingsV2BookingBookings_universal_d_MarkAsMultiServiceBookingRequest as MarkAsMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_MarkAsMultiServiceBookingResponse as MarkAsMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_GetMultiServiceBookingRequest as GetMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_GetMultiServiceBookingResponse as GetMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_MultiServiceBookingMetadata as MultiServiceBookingMetadata, bookingsV2BookingBookings_universal_d_AddBookingsToMultiServiceBookingRequest as AddBookingsToMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_BookingIdAndRevision as BookingIdAndRevision, bookingsV2BookingBookings_universal_d_AddBookingsToMultiServiceBookingResponse as AddBookingsToMultiServiceBookingResponse, bookingsV2BookingBookings_universal_d_RemoveBookingsFromMultiServiceBookingRequest as RemoveBookingsFromMultiServiceBookingRequest, bookingsV2BookingBookings_universal_d_RemoveBookingsFromMultiServiceBookingResponse as RemoveBookingsFromMultiServiceBookingResponse, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, MessageEnvelope$2 as MessageEnvelope, bookingsV2BookingBookings_universal_d_WebhooksIdentificationData as WebhooksIdentificationData, bookingsV2BookingBookings_universal_d_WebhooksIdentificationDataIdOneOf as WebhooksIdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, bookingsV2BookingBookings_universal_d_BookingChanged as BookingChanged, bookingsV2BookingBookings_universal_d_CreateBookingRequest as CreateBookingRequest, bookingsV2BookingBookings_universal_d_CreateBookingResponse as CreateBookingResponse, bookingsV2BookingBookings_universal_d_UpdateBookingRequest as UpdateBookingRequest, bookingsV2BookingBookings_universal_d_UpdateBookingResponse as UpdateBookingResponse, bookingsV2BookingBookings_universal_d_LegacyCreateBookingRequest as LegacyCreateBookingRequest, bookingsV2BookingBookings_universal_d_LegacyCreateBookingResponse as LegacyCreateBookingResponse, bookingsV2BookingBookings_universal_d_BulkUpdateBookingRequest as BulkUpdateBookingRequest, bookingsV2BookingBookings_universal_d_MaskedBooking as MaskedBooking, bookingsV2BookingBookings_universal_d_BulkUpdateBookingResponse as BulkUpdateBookingResponse, bookingsV2BookingBookings_universal_d_BulkCreateBookingRequest as BulkCreateBookingRequest, bookingsV2BookingBookings_universal_d_CreateBookingInfo as CreateBookingInfo, bookingsV2BookingBookings_universal_d_BulkCreateBookingResponse as BulkCreateBookingResponse, bookingsV2BookingBookings_universal_d_BulkBookingResult as BulkBookingResult, bookingsV2BookingBookings_universal_d_RescheduleBookingRequest as RescheduleBookingRequest, bookingsV2BookingBookings_universal_d_RescheduleBookingRequestParticipantsInfoOneOf as RescheduleBookingRequestParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_RescheduleBookingResponse as RescheduleBookingResponse, bookingsV2BookingBookings_universal_d_BulkRescheduleBookingRequest as BulkRescheduleBookingRequest, bookingsV2BookingBookings_universal_d_BulkRescheduleBookingRequestBooking as BulkRescheduleBookingRequestBooking, bookingsV2BookingBookings_universal_d_SlotBookings as SlotBookings, bookingsV2BookingBookings_universal_d_BulkRescheduleBookingResponse as BulkRescheduleBookingResponse, bookingsV2BookingBookings_universal_d_BulkUpdateBookedScheduleRequest as BulkUpdateBookedScheduleRequest, bookingsV2BookingBookings_universal_d_BookingDetails as BookingDetails, bookingsV2BookingBookings_universal_d_BulkUpdateBookedScheduleResponse as BulkUpdateBookedScheduleResponse, bookingsV2BookingBookings_universal_d_QueryBookingsRequest as QueryBookingsRequest, QueryV2$3 as QueryV2, QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, Sorting$3 as Sorting, SortOrder$3 as SortOrder, Paging$2 as Paging, CursorPaging$4 as CursorPaging, bookingsV2BookingBookings_universal_d_QueryBookingsResponse as QueryBookingsResponse, PagingMetadataV2$3 as PagingMetadataV2, Cursors$4 as Cursors, bookingsV2BookingBookings_universal_d_ConfirmRequest as ConfirmRequest, bookingsV2BookingBookings_universal_d_ConfirmResponse as ConfirmResponse, bookingsV2BookingBookings_universal_d_ConfirmBookingRequest as ConfirmBookingRequest, bookingsV2BookingBookings_universal_d_ConfirmBookingResponse as ConfirmBookingResponse, bookingsV2BookingBookings_universal_d_PartySizeRequest as PartySizeRequest, bookingsV2BookingBookings_universal_d_PartySizeRequestPartySizeForOneOf as PartySizeRequestPartySizeForOneOf, bookingsV2BookingBookings_universal_d_PartySizeResponse as PartySizeResponse, bookingsV2BookingBookings_universal_d_ConsistentQueryBookingsRequest as ConsistentQueryBookingsRequest, bookingsV2BookingBookings_universal_d_ConsistentQueryBookingsResponse as ConsistentQueryBookingsResponse, bookingsV2BookingBookings_universal_d_SetBookingSessionIdRequest as SetBookingSessionIdRequest, bookingsV2BookingBookings_universal_d_SetBookingSessionIdResponse as SetBookingSessionIdResponse, bookingsV2BookingBookings_universal_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest, bookingsV2BookingBookings_universal_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse, bookingsV2BookingBookings_universal_d_DeclineBookingRequest as DeclineBookingRequest, bookingsV2BookingBookings_universal_d_DeclineBookingResponse as DeclineBookingResponse, bookingsV2BookingBookings_universal_d_CancelBookingRequest as CancelBookingRequest, bookingsV2BookingBookings_universal_d_CancelBookingResponse as CancelBookingResponse, bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsRequest as UpdateNumberOfParticipantsRequest, bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as UpdateNumberOfParticipantsRequestParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsResponse as UpdateNumberOfParticipantsResponse, bookingsV2BookingBookings_universal_d_NumberOfParticipantsUpdated as NumberOfParticipantsUpdated, bookingsV2BookingBookings_universal_d_NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf as NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_CalculateAllowedActionsRequest as CalculateAllowedActionsRequest, bookingsV2BookingBookings_universal_d_CalculateAllowedActionsResponse as CalculateAllowedActionsResponse, bookingsV2BookingBookings_universal_d_BulkCalculateAllowedActionsRequest as BulkCalculateAllowedActionsRequest, bookingsV2BookingBookings_universal_d_BulkCalculateAllowedActionsResponse as BulkCalculateAllowedActionsResponse, GetSlotAvailabilityRequest$1 as GetSlotAvailabilityRequest, GetSlotAvailabilityResponse$1 as GetSlotAvailabilityResponse, SlotAvailability$1 as SlotAvailability, WaitingList$1 as WaitingList, bookingsV2BookingBookings_universal_d_AvailableResources as AvailableResources, GetScheduleAvailabilityRequest$1 as GetScheduleAvailabilityRequest, GetScheduleAvailabilityResponse$1 as GetScheduleAvailabilityResponse, ScheduleAvailability$1 as ScheduleAvailability, bookingsV2BookingBookings_universal_d_MarkBookingAsPendingRequest as MarkBookingAsPendingRequest, bookingsV2BookingBookings_universal_d_MarkBookingAsPendingResponse as MarkBookingAsPendingResponse, bookingsV2BookingBookings_universal_d_BookingMarkedAsPending as BookingMarkedAsPending, bookingsV2BookingBookings_universal_d_MigrationCheckIfClashesWithBlockedTimeRequest as MigrationCheckIfClashesWithBlockedTimeRequest, bookingsV2BookingBookings_universal_d_MsidAndBookingId as MsidAndBookingId, bookingsV2BookingBookings_universal_d_MigrationCheckIfClashesWithBlockedTimeResponse as MigrationCheckIfClashesWithBlockedTimeResponse, bookingsV2BookingBookings_universal_d_Clash as Clash, bookingsV2BookingBookings_universal_d_ConfirmOrDeclineBookingRequest as ConfirmOrDeclineBookingRequest, bookingsV2BookingBookings_universal_d_ConfirmOrDeclineBookingResponse as ConfirmOrDeclineBookingResponse, bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingRequest as BulkConfirmOrDeclineBookingRequest, bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingRequestBookingDetails as BulkConfirmOrDeclineBookingRequestBookingDetails, bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingResponse as BulkConfirmOrDeclineBookingResponse, bookingsV2BookingBookings_universal_d_V2CreateBookingRequest as V2CreateBookingRequest, bookingsV2BookingBookings_universal_d_V2CreateBookingRequestBookableItemOneOf as V2CreateBookingRequestBookableItemOneOf, bookingsV2BookingBookings_universal_d_V2CreateBookingRequestParticipantsInfoOneOf as V2CreateBookingRequestParticipantsInfoOneOf, Slot$1 as Slot, SlotResource$1 as SlotResource, bookingsV2BookingBookings_universal_d_CreateBookingRequestFlowControlSettings as CreateBookingRequestFlowControlSettings, bookingsV2BookingBookings_universal_d_V2CreateBookingResponse as V2CreateBookingResponse, bookingsV2BookingBookings_universal_d_V2CancelBookingRequest as V2CancelBookingRequest, bookingsV2BookingBookings_universal_d_CancelBookingRequestFlowControlSettings as CancelBookingRequestFlowControlSettings, bookingsV2BookingBookings_universal_d_V2CancelBookingResponse as V2CancelBookingResponse, bookingsV2BookingBookings_universal_d_V2RescheduleBookingRequest as V2RescheduleBookingRequest, bookingsV2BookingBookings_universal_d_V2RescheduleBookingRequestParticipantsInfoOneOf as V2RescheduleBookingRequestParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_RescheduleBookingRequestFlowControlSettings as RescheduleBookingRequestFlowControlSettings, bookingsV2BookingBookings_universal_d_V2RescheduleBookingResponse as V2RescheduleBookingResponse, bookingsV2BookingBookings_universal_d_V2ConfirmBookingRequest as V2ConfirmBookingRequest, bookingsV2BookingBookings_universal_d_V2ConfirmBookingResponse as V2ConfirmBookingResponse, bookingsV2BookingBookings_universal_d_V2DeclineBookingRequest as V2DeclineBookingRequest, bookingsV2BookingBookings_universal_d_V2DeclineBookingResponse as V2DeclineBookingResponse, bookingsV2BookingBookings_universal_d_V2UpdateNumberOfParticipantsRequest as V2UpdateNumberOfParticipantsRequest, bookingsV2BookingBookings_universal_d_V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf, bookingsV2BookingBookings_universal_d_V2UpdateNumberOfParticipantsResponse as V2UpdateNumberOfParticipantsResponse, bookingsV2BookingBookings_universal_d_CreateMultiServiceBookingOptions as CreateMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_RescheduleMultiServiceBookingOptions as RescheduleMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_CancelMultiServiceBookingOptions as CancelMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_MarkMultiServiceBookingAsPendingOptions as MarkMultiServiceBookingAsPendingOptions, bookingsV2BookingBookings_universal_d_ConfirmMultiServiceBookingOptions as ConfirmMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_DeclineMultiServiceBookingOptions as DeclineMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_MarkAsMultiServiceBookingOptions as MarkAsMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_AddBookingsToMultiServiceBookingOptions as AddBookingsToMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_RemoveBookingsFromMultiServiceBookingOptions as RemoveBookingsFromMultiServiceBookingOptions, bookingsV2BookingBookings_universal_d_createBooking as createBooking, bookingsV2BookingBookings_universal_d_CreateBookingOptions as CreateBookingOptions, bookingsV2BookingBookings_universal_d_UpdateBooking as UpdateBooking, bookingsV2BookingBookings_universal_d_UpdateBookingOptions as UpdateBookingOptions, bookingsV2BookingBookings_universal_d_bulkCreateBooking as bulkCreateBooking, bookingsV2BookingBookings_universal_d_BulkCreateBookingOptions as BulkCreateBookingOptions, bookingsV2BookingBookings_universal_d_rescheduleBooking as rescheduleBooking, bookingsV2BookingBookings_universal_d_RescheduleBookingOptions as RescheduleBookingOptions, bookingsV2BookingBookings_universal_d_BulkRescheduleBookingOptions as BulkRescheduleBookingOptions, bookingsV2BookingBookings_universal_d_BulkUpdateBookedScheduleOptions as BulkUpdateBookedScheduleOptions, bookingsV2BookingBookings_universal_d_QueryOptions as QueryOptions, bookingsV2BookingBookings_universal_d_confirmBooking as confirmBooking, bookingsV2BookingBookings_universal_d_ConfirmBookingOptions as ConfirmBookingOptions, bookingsV2BookingBookings_universal_d_PartySizeOptions as PartySizeOptions, bookingsV2BookingBookings_universal_d_ConsistentQueryOptions as ConsistentQueryOptions, bookingsV2BookingBookings_universal_d_SetBookingSessionIdOptions as SetBookingSessionIdOptions, bookingsV2BookingBookings_universal_d_updateExtendedFields as updateExtendedFields, bookingsV2BookingBookings_universal_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions, bookingsV2BookingBookings_universal_d_declineBooking as declineBooking, bookingsV2BookingBookings_universal_d_DeclineBookingOptions as DeclineBookingOptions, bookingsV2BookingBookings_universal_d_cancelBooking as cancelBooking, bookingsV2BookingBookings_universal_d_CancelBookingOptions as CancelBookingOptions, bookingsV2BookingBookings_universal_d_updateNumberOfParticipants as updateNumberOfParticipants, bookingsV2BookingBookings_universal_d_UpdateNumberOfParticipantsOptions as UpdateNumberOfParticipantsOptions, GetSlotAvailabilityOptions$1 as GetSlotAvailabilityOptions, bookingsV2BookingBookings_universal_d_MarkBookingAsPendingOptions as MarkBookingAsPendingOptions, bookingsV2BookingBookings_universal_d_confirmOrDeclineBooking as confirmOrDeclineBooking, bookingsV2BookingBookings_universal_d_ConfirmOrDeclineBookingOptions as ConfirmOrDeclineBookingOptions, bookingsV2BookingBookings_universal_d_BulkConfirmOrDeclineBookingOptions as BulkConfirmOrDeclineBookingOptions, bookingsV2BookingBookings_universal_d_BookingsGatewayCreateBookingOptions as BookingsGatewayCreateBookingOptions, bookingsV2BookingBookings_universal_d_BookingsGatewayCancelBookingOptions as BookingsGatewayCancelBookingOptions, bookingsV2BookingBookings_universal_d_BookingsGatewayRescheduleBookingOptions as BookingsGatewayRescheduleBookingOptions, bookingsV2BookingBookings_universal_d_BookingsGatewayConfirmBookingOptions as BookingsGatewayConfirmBookingOptions, bookingsV2BookingBookings_universal_d_BookingsGatewayDeclineBookingOptions as BookingsGatewayDeclineBookingOptions, bookingsV2BookingBookings_universal_d_BookingsGatewayUpdateNumberOfParticipantsOptions as BookingsGatewayUpdateNumberOfParticipantsOptions, };\n }\n interface ExternalCalendar {\n }\n interface ListProvidersRequest {\n }\n interface ListProvidersResponse {\n /**\n * Retrieves a list of the external calendar providers for which the site supports integration.\n *\n *\n * The list of external calendar providers includes:\n *\n * + External calendar providers that are supported by default, such as Google, Apple, and Microsoft.\n * + External calenders for which the site owner has enabled integration by installing an app.\n *\n * For each external calendar provider, the list contains information about supported connection methods and features.\n * For each provider, check `features.connectMethods` to find out whether to use [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth) to establish a connection.\n */\n providers?: Provider[];\n }\n interface Provider {\n /** ID of the external calendar provider. */\n _id?: string | null;\n /** Name of the external calendar provider. */\n name?: string | null;\n /** External calendar provider type. */\n calendarType?: CalendarType$3;\n /** Features the external calendar provider supports. */\n features?: ProviderFeatures;\n }\n enum CalendarType$3 {\n UNDEFINED = \"UNDEFINED\",\n GOOGLE = \"GOOGLE\",\n I_CAL = \"I_CAL\",\n /** Use `MICROSOFT` instead. */\n OUTLOOK = \"OUTLOOK\",\n /** Use `MICROSOFT` instead. */\n OFFICE_365 = \"OFFICE_365\",\n MICROSOFT = \"MICROSOFT\",\n OTHER = \"OTHER\"\n }\n interface ProviderFeatures {\n /**\n * Supported connection methods.\n *\n * For providers supporting `OAUTH`, connect with the [`connectByOAuth()`](#connect-by-o-auth) function.\n * For providers supporting `CREDENTIALS`, connect with the [`connectByCredentials()`](#connect-by-credentials) function.\n */\n connectMethods?: ConnectMethod[];\n /**\n * Whether the sync configuration can be updated after a connection is established.\n *\n * If `true`, you can update the sync configuration using the [`UpdateSyncConfig()`](#update-sync-config) function.\n */\n updateSyncConfig?: boolean | null;\n /**\n * Whether events can be imported from external calendars to the Wix calendar.\n *\n * + `NOT_SUPPORTED`: Importing events from the external calendar is not supported.\n * + `PRIMARY_CALENDAR_ONLY`: Events can be imported only from an external calendar designated as primary.\n * + `SPECIFIC_CALENDARS`: Events can be imported from specific external calendars. Use [`listCalendars()`](#list-calendars) to get a list of calendars for a connected external calendar account.\n */\n listEventFromCalendars?: ListEventFromCalendars;\n /**\n * Whether Wix calendar sessions can be exported to the external calendar.\n *\n * + `NOT_SUPPORTED`: Exporting events to an external calendar is not supported.\n * + `PRIMARY_CALENDAR_ONLY`: Events can only be exported only to an external calendar designated as primary.\n * + `SPECIFIC_CALENDARS`: Events can be exported to specific external calendars. Use [`listCalendars()`](#list-calendars) to get a list of calendars for a connected external calendar account.\n * + `DEDICATED_CALENDAR`: Events can be exported to a newly created, dedicated external calendar in the connected external calendar account.\n */\n syncToCalendar?: SyncToCalendar;\n }\n enum ConnectMethod {\n UNDEFINED = \"UNDEFINED\",\n OAUTH = \"OAUTH\",\n CREDENTIALS = \"CREDENTIALS\"\n }\n enum ListEventFromCalendars {\n /** Dont use. */\n UNDEFINED = \"UNDEFINED\",\n /** Listing events from the external calendar is not supported. */\n NOT_SUPPORTED = \"NOT_SUPPORTED\",\n /** Listing events from the primary external calendar only. */\n PRIMARY_CALENDAR_ONLY = \"PRIMARY_CALENDAR_ONLY\",\n /**\n * Listing events from specific external calendars.\n * The external calendars can be listed using the `ExternalCalendarService.ListCalendars` API.\n */\n SPECIFIC_CALENDARS = \"SPECIFIC_CALENDARS\"\n }\n enum SyncToCalendar {\n /** Dont use. */\n UNDEFINED = \"UNDEFINED\",\n /** Syncing Wix calendar sessions to the external calendar is not supported. */\n NOT_SUPPORTED = \"NOT_SUPPORTED\",\n /** Syncing Wix calendar sessions to the primary external calendar only. */\n PRIMARY_CALENDAR_ONLY = \"PRIMARY_CALENDAR_ONLY\",\n /** Syncing Wix calendar sessions to a specific external calendar. */\n SPECIFIC_CALENDAR = \"SPECIFIC_CALENDAR\",\n /** Syncing Wix calendar sessions to a new external calendar. */\n DEDICATED_CALENDAR = \"DEDICATED_CALENDAR\"\n }\n interface GetConnectionRequest {\n /** ID of the connection to retrieve. */\n connectionId: string | null;\n }\n interface GetConnectionResponse {\n /** Retrieved external calendar connection. */\n connection?: Connection;\n }\n interface Connection {\n /** External calendar connection ID. */\n _id?: string | null;\n /** ID of the external calendar provider. */\n providerId?: string | null;\n /** External calendar type. */\n calendarType?: CalendarType$3;\n /** ID of the schedule connected to the external calendar. */\n scheduleId?: string | null;\n /** ID of the Wix user the external calendar connection belongs to. */\n userId?: string | null;\n /** ID of the Wix App the external calendar connection belongs to. */\n appId?: string | null;\n /** Email address associated with the external calendar account. Empty until sync is completed successfully. */\n externalAccountEmail?: string | null;\n /**\n * Connection status.\n *\n * + `CONNECTED`: A connection has been established with the external calendar.\n * + `SYNC_IN_PROGRESS`: A sync is in progress.\n * + `SYNCED`: External calendar sync complete.\n * + `DISCONNECTED`: External calendar has been disconnected.\n * + `ERROR`: An error occurred when syncing with the external calendar.\n */\n status?: Status$3;\n /**\n * Reason for the error, if `status` is `ERROR`.\n *\n * + `TOKEN_REVOKED`: External calendar access token revoked.\n * + `EXTERNAL_CALENDAR_CREATION_FAILED`: External calendar creation failed.\n * + `EXTERNAL_CALENDAR_DELETED`: External calendar was deleted.\n */\n errorReason?: ErrorReason;\n /**\n * Sync configuration. Contains settings for enabling, configuring, or disabling functionality, including:\n *\n * + Importing events from one or more specified calendars in the connected external calendar account.\n * + Exporting events from the Wix site's calendar to an external calendar.\n */\n syncConfig?: ConnectionSyncConfig;\n }\n enum Status$3 {\n /** Dont use. */\n UNDEFINED = \"UNDEFINED\",\n /** External calendar is connected to the corresponding schedule id. */\n CONNECTED = \"CONNECTED\",\n /** Sync in progress. */\n SYNC_IN_PROGRESS = \"SYNC_IN_PROGRESS\",\n /** Calendars are in-sync. */\n SYNCED = \"SYNCED\",\n /** External calender is disconnected. */\n DISCONNECTED = \"DISCONNECTED\",\n /** The calendars sync is in error state. */\n ERROR = \"ERROR\"\n }\n enum ErrorReason {\n /** Empty or error reason is unknown. */\n UNDEFINED = \"UNDEFINED\",\n /** External calendar access token revoked. */\n TOKEN_REVOKED = \"TOKEN_REVOKED\",\n /** External calendar creation failed. */\n EXTERNAL_CALENDAR_CREATION_FAILED = \"EXTERNAL_CALENDAR_CREATION_FAILED\",\n /** External Calendar was deleted. */\n EXTERNAL_CALENDAR_DELETED = \"EXTERNAL_CALENDAR_DELETED\"\n }\n interface ConnectionSyncConfig {\n /**\n * Configuration for importing events from external calendars.\n * If enabled, use the [`listEvents()`](#list-events) function to retrieve a list of events from external calendars.\n */\n listEventFromCalendars?: ConnectionSyncConfigListEventFromCalendars;\n /** Configuration for exporting calendars from the Wix site's calendar to a connected external calendar. */\n syncToCalendar?: ConnectionSyncConfigSyncToCalendar;\n }\n interface Calendar {\n /**\n * External calendar ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Display name of the external calendar.\n * For example, \"Primary\" or \"Birthdays\".\n */\n name?: string | null;\n }\n interface PrimaryCalendar {\n }\n interface Calendars {\n calendars?: Calendar[];\n }\n interface DedicatedCalendar {\n }\n interface ConnectionSyncConfigListEventFromCalendars extends ConnectionSyncConfigListEventFromCalendarsListFromOneOf {\n /**\n * Import events only from the primary external calendar. Enable this by passing an empty object.\n *\n * **Note**: Not all external calendar providers designate a primary calendar.\n */\n primaryCalendar?: PrimaryCalendar;\n /**\n * Import events from a list of specified external calendars.\n *\n * **Note**: The list can include the primary calendar.\n */\n calendars?: Calendars;\n /** Whether to enable importing events from external calendars through this connection. */\n enabled?: boolean | null;\n }\n /** @oneof */\n interface ConnectionSyncConfigListEventFromCalendarsListFromOneOf {\n /**\n * Import events only from the primary external calendar. Enable this by passing an empty object.\n *\n * **Note**: Not all external calendar providers designate a primary calendar.\n */\n primaryCalendar?: PrimaryCalendar;\n /**\n * Import events from a list of specified external calendars.\n *\n * **Note**: The list can include the primary calendar.\n */\n calendars?: Calendars;\n }\n interface ConnectionSyncConfigSyncToCalendar extends ConnectionSyncConfigSyncToCalendarSyncToOneOf {\n /** Sync to the primary external calendar. Enable this by passing an empty object. */\n primaryCalendar?: PrimaryCalendar;\n /** Sync to a dedicated external calendar. Enable this by passing an empty object. */\n dedicatedCalendar?: DedicatedCalendar;\n /** Whether to enable exporting events to an external calendars through this connection. */\n enabled?: boolean | null;\n }\n /** @oneof */\n interface ConnectionSyncConfigSyncToCalendarSyncToOneOf {\n /** Sync to the primary external calendar. Enable this by passing an empty object. */\n primaryCalendar?: PrimaryCalendar;\n /** Sync to a dedicated external calendar. Enable this by passing an empty object. */\n dedicatedCalendar?: DedicatedCalendar;\n }\n enum SyncToErrorReason {\n /** No sync error. */\n UNDEFINED = \"UNDEFINED\",\n /** Could not create calendar to sync sessions to. */\n CALENDAR_CREATION_FAILURE = \"CALENDAR_CREATION_FAILURE\",\n /** Calendar was deleted while sync was in progress. */\n CALENDAR_DELETED = \"CALENDAR_DELETED\"\n }\n interface ListConnectionsRequest {\n /**\n * Schedule IDs to filter by. If provided, only connections between external calendars and the specified schedules is returned.\n *\n * Default: Returns all connections.\n */\n scheduleIds?: string[] | null;\n /**\n * Whether to return a partial list of connections if details can't be retrieved for some connections.\n *\n * Default: `false`\n */\n partialFailure?: boolean | null;\n }\n interface ListConnectionsResponse {\n /** List of external calendar connections. */\n connections?: Connection[];\n /** List of provider IDs for connections for which retrieval failed. Returned only if `partialFailure` parameter is `true` in the request. */\n failedProviderIds?: string[] | null;\n }\n interface ConnectByOAuthRequest {\n /** ID of the schedule to connect with the external calendar account. */\n scheduleId: string | null;\n /**\n * ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function.\n *\n */\n providerId: string | null;\n /**\n * URL to redirect the user to after they authorize access to the external calendar account.\n *\n * If the connection is successfully established, the user is redirected to this URL with a query parameter `connectionId` containing the new connection ID.\n * If the attempt to connect fails, the user is redirected to this URL with a query parameter `error` containing the error type.\n */\n redirectUrl: string | null;\n }\n interface ConnectByOAuthResponse {\n /** URL of the external calendar authorization page to redirect the user to. */\n oauthUrl?: string | null;\n }\n interface RawHttpRequest {\n body?: Uint8Array;\n pathParams?: PathParametersEntry[];\n queryParams?: QueryParametersEntry[];\n headers?: HeadersEntry[];\n method?: string;\n rawPath?: string;\n rawQuery?: string;\n }\n interface PathParametersEntry {\n key?: string;\n value?: string;\n }\n interface QueryParametersEntry {\n key?: string;\n value?: string;\n }\n interface HeadersEntry {\n key?: string;\n value?: string;\n }\n interface RawHttpResponse {\n body?: Uint8Array;\n statusCode?: number | null;\n headers?: HeadersEntry[];\n }\n interface ConnectByCredentialsRequest {\n /** ID of the schedule to connect with the external calendar account. */\n scheduleId: string | null;\n /** ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function. */\n providerId: string | null;\n /** Email address for the external calendar account. */\n email: string | null;\n /** Password for the external calendar account. */\n password: string | null;\n }\n interface ConnectByCredentialsResponse {\n /** Established connection details. */\n connection?: Connection;\n }\n interface ListCalendarsRequest {\n /** ID of the external calendar connection to list calendars for. */\n connectionId: string | null;\n }\n interface ListCalendarsResponse {\n /** List of calendars belonging to the external calendar account. */\n calendars?: Calendar[];\n }\n interface UpdateSyncConfigRequest {\n /** ID of the external calendar connection to update. */\n connectionId: string | null;\n /** Updated sync configuration details. */\n syncConfig: ConnectionSyncConfig;\n }\n interface UpdateSyncConfigResponse {\n /** Connection with updated sync configuration. */\n connection?: Connection;\n }\n interface DisconnectRequest {\n /** ID of the external calendar connection to disconnect. */\n connectionId: string | null;\n }\n interface DisconnectResponse {\n /** Updated connection details. */\n connection?: Connection;\n }\n interface ListEventsRequest {\n /**\n * Date and time from which to retrieve events,\n * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n * Required, unless `cursorPaging.cursor` is provided.\n *\n * Events which start before the `from` time and end after it are included in the returned list.\n */\n from?: string | null;\n /**\n * Date and time until which to retrieve events,\n * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n * Required, unless `cursorPaging.cursor` is provided.\n *\n * Events which start before the `to` time and end after it are included in the returned list.\n */\n to?: string | null;\n /**\n * Schedule IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to the specified schedules.\n * Maximum of 100 schedule IDs per request.\n */\n scheduleIds?: string[] | null;\n /**\n * Wix user IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to schedules belonging to the specified Wix users.\n * Maximum of 100 Wix user IDs per request.\n */\n userIds?: string[] | null;\n /**\n * Whether to include only all-day events in the returned list.\n * If `true`, only all-day events are returned.\n * If `false`, only events with a specified time are returned.\n *\n * Default: All events are returned.\n */\n allDay?: boolean | null;\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns event objects without personal information.\n * - `OWN_PI`: Returns complete event objects, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n /** Pagination options. */\n cursorPaging?: CursorPaging$3;\n /**\n * Whether to return a partial list of events if details can't be retrieved for some connections.\n *\n * Default: `false`\n */\n partialFailure?: boolean | null;\n }\n interface CursorPaging$3 {\n /**\n * Number of events to load.\n * Max: `1000`\n */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListEventsResponse {\n /** List of external calendar events matching the filters. */\n events?: Event$2[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$2;\n /** List of provider IDs for connections for which retrieval of events failed. Returned only if `partialFailure` parameter is `true` in the request. */\n failedProviderIds?: string[] | null;\n }\n /** An external calendar event. */\n interface Event$2 {\n /** ID of the schedule connected to the external calendar the event belongs to. */\n scheduleId?: string | null;\n /** External calendar type. */\n calendarType?: CalendarType$3;\n /**\n * Display name of the external calendar.\n * For example, \"Primary\" or \"Birthdays\".\n */\n calendarName?: string | null;\n /** Event title. */\n title?: string | null;\n /** Start date and time of the event (inclusive), formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt). */\n start?: string | null;\n /** End date and time of the event (exclusive), formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt). */\n end?: string | null;\n /**\n * Whether the event is an all-day event.\n *\n * Default: `false`\n */\n allDay?: boolean | null;\n /**\n * ID of the Wix user the schedule belongs to.\n * For example, the ID of the staff member (resource) who owns the schedule.\n */\n scheduleOwnerId?: string | null;\n /**\n * Name of the Wix user the schedule belongs to.\n * For example, the name of the staff member (resource) who owns the schedule.\n */\n scheduleOwnerName?: string | null;\n }\n interface CursorPagingMetadata$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$3;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$3 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n }\n interface ScheduleNotification$3 extends ScheduleNotificationEventOneOf$3 {\n scheduleCreated?: ScheduleCreated$3;\n scheduleUpdated?: ScheduleUpdated$3;\n scheduleCancelled?: ScheduleCancelled$3;\n sessionCreated?: SessionCreated$3;\n sessionUpdated?: SessionUpdated$3;\n sessionCancelled?: SessionCancelled$3;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated$3;\n intervalSplit?: IntervalSplit$3;\n recurringSessionSplit?: RecurringSessionSplit$3;\n /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$3;\n preserveFutureSessionsWithParticipants?: boolean | null;\n /** Whether to notify participants about changed sessions. deprecated, use participant_notification */\n notifyParticipants?: boolean;\n /** site properties. Optional. Given in create schedule notification. */\n siteProperties?: SitePropertiesOnScheduleCreation$3;\n instanceId?: string;\n }\n /** @oneof */\n interface ScheduleNotificationEventOneOf$3 {\n scheduleCreated?: ScheduleCreated$3;\n scheduleUpdated?: ScheduleUpdated$3;\n scheduleCancelled?: ScheduleCancelled$3;\n sessionCreated?: SessionCreated$3;\n sessionUpdated?: SessionUpdated$3;\n sessionCancelled?: SessionCancelled$3;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated$3;\n intervalSplit?: IntervalSplit$3;\n recurringSessionSplit?: RecurringSessionSplit$3;\n /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$3;\n }\n interface ScheduleCreated$3 {\n schedule?: Schedule$3;\n }\n interface Schedule$3 {\n /** Schedule ID. */\n _id?: string;\n /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */\n scheduleOwnerId?: string | null;\n /**\n * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.\n * Derived from the Wix Business time zone.\n * @readonly\n */\n timeZone?: string | null;\n /** Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead. */\n intervals?: RecurringInterval$3[];\n /** Default title for the schedule's sessions. Maximum length: 6000 characters. */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.\n * The Wix Bookings app uses the following predefined tags to set schedule type: `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE\"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.\n */\n tags?: string[] | null;\n /** Default location for the schedule's sessions. */\n location?: Location$4;\n /**\n * Maximum number of participants that can be added to the schedule's sessions.\n * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate$3;\n /** __Deprecated.__ */\n availability?: Availability$3;\n /**\n * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** of participants which are registered to sessions in this schedule.\n * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.\n * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n * @readonly\n */\n participants?: Participant$3[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides$3;\n /**\n * Schedule status.\n * @readonly\n */\n status?: ScheduleStatus$3;\n /**\n * Schedule creation date.\n * @readonly\n */\n created?: Date;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * Fields which were inherited from the Business Info page under Settings in the Dashboard.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n conferenceProvider?: ConferenceProvider$3;\n /**\n * A conference created for the schedule. This is used when a participant is added to a schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference$3;\n }\n interface RecurringInterval$3 {\n /**\n * The recurring interval identifier.\n * @readonly\n */\n _id?: string;\n /** The start time of the recurring interval. Required. */\n start?: Date;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date;\n /** The interval rules. The day, hour and minutes the interval is recurring. */\n interval?: Interval$3;\n /** The frequency of the interval. Optional. The default is frequency with the default repetition. */\n frequency?: Frequency$3;\n /** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */\n affectedSchedules?: LinkedSchedule$3[];\n /**\n * The type of recurring interval.\n * \n */\n intervalType?: RecurringIntervalType$3;\n }\n interface Interval$3 {\n /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */\n daysOfWeek?: Day$3;\n /** The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23. */\n hourOfDay?: number | null;\n /** The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59. */\n minuteOfHour?: number | null;\n /** The duration of the interval in minutes. Required. Part of the session end time calculation. */\n duration?: number;\n }\n enum Day$3 {\n /** Undefined. */\n UNDEFINED = \"UNDEFINED\",\n /** Monday. */\n MON = \"MON\",\n /** Tuesday. */\n TUE = \"TUE\",\n /** Wednesday. */\n WED = \"WED\",\n /** Thursday. */\n THU = \"THU\",\n /** Friday. */\n FRI = \"FRI\",\n /** Saturday. */\n SAT = \"SAT\",\n /** Sunday. */\n SUN = \"SUN\"\n }\n interface Frequency$3 {\n /** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */\n repetition?: number | null;\n }\n interface LinkedSchedule$3 {\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `\"BUSY\"`.\n * \n * If set to `\"BUSY\"`, this schedule cannot have any available slots during the linked schedule's sessions.\n * If set to `\"FREE\"`, this schedule can have available slots during the linked schedule's sessions.\n * \n *\n * \n */\n transparency?: Transparency$3;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n }\n enum Transparency$3 {\n UNDEFINED = \"UNDEFINED\",\n /** The schedule can have available slots during the session. */\n FREE = \"FREE\",\n /** The schedule cannot have available slots during the session. Default value. */\n BUSY = \"BUSY\"\n }\n enum RecurringIntervalType$3 {\n /** The default value. Sessions for this interval will be of type EVENT. */\n UNDEFINED = \"UNDEFINED\",\n /** A recurring interval of events */\n EVENT = \"EVENT\",\n /** Deprecated */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** A recurring interval for availability */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface Location$4 {\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: LocationType$4;\n /** Free text address used when locationType is `OWNER_CUSTOM`. */\n address?: string | null;\n /** Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default. */\n customAddress?: Address$3;\n }\n enum LocationType$4 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface Address$3 extends AddressStreetOneOf$3 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$3;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$3;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$3[];\n }\n /** @oneof */\n interface AddressStreetOneOf$3 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$3;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$3 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$3 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$3 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface LocationsLocation$3 {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Note:__ [Archiving a location](https://www.wix.com/velo/reference/wix-business-tools-v2/locations/archivelocation)\n * doesn't affect the location's status. `INACTIVE` is currently not supported.\n */\n status?: LocationStatus$3;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n */\n locationType?: LocationsLocationType$3;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: LocationsAddress$3;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$3;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://www.wix.com/velo/reference/wix-business-tools-v2/locations/archivelocation)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationsLocationType$3[];\n }\n /** For future use */\n enum LocationStatus$3 {\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n /** For future use */\n enum LocationsLocationType$3 {\n UNKNOWN = \"UNKNOWN\",\n BRANCH = \"BRANCH\",\n OFFICES = \"OFFICES\",\n RECEPTION = \"RECEPTION\",\n HEADQUARTERS = \"HEADQUARTERS\",\n INVENTORY = \"INVENTORY\"\n }\n interface LocationsAddress$3 {\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n streetAddress?: LocationsStreetAddress$3;\n /** Full address of the location. */\n formatted?: string | null;\n /** Geographic coordinates of location. */\n location?: LocationsAddressLocation$3;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface LocationsStreetAddress$3 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n /** Address Geolocation */\n interface LocationsAddressLocation$3 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number | null;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number | null;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$3 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$3[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$3[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$3 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$3;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$3;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$3 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$3 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Rate$3 {\n /**\n * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n labeledPriceOptions?: Record;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n priceText?: string | null;\n }\n interface Price$3 {\n /** Required payment amount. */\n amount?: string;\n /** Currency in which the amount is quoted. */\n currency?: string;\n /** Amount of a down payment or deposit as part of the transaction. */\n downPayAmount?: string;\n }\n /**\n * \n */\n interface Availability$3 {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date;\n /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */\n linkedSchedules?: LinkedSchedule$3[];\n /** Constraints for calculating the schedule's availability. */\n constraints?: AvailabilityConstraints$3;\n }\n /** Describes how to calculate the specific slots that are available for booking. */\n interface AvailabilityConstraints$3 {\n /**\n * A list of duration options for slots, in minutes. Minimum value for a duration is 1.\n * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.\n */\n slotDurations?: number[];\n /**\n * The number of minutes between the `end` of one slot, and the `start` of the next.\n * Minimum value is 0, maximum value is 120.\n */\n timeBetweenSlots?: number;\n /**\n * Specify how to split the slots in intervals of minutes.\n * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).\n * Optional. The default is the first duration in slot_durations field.\n * Deprecated. Use the `split_slots_interval.value_in_minutes`.\n */\n splitInterval?: number | null;\n /**\n * An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.\n * @readonly\n */\n slotsSplitInterval?: SplitInterval$3;\n }\n /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */\n interface SplitInterval$3 {\n /**\n * Whether the slot duration is used as the split interval value.\n * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.\n */\n sameAsDuration?: boolean | null;\n /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */\n valueInMinutes?: number | null;\n }\n interface Participant$3 {\n /** Participant ID. Currently represents the booking.id. */\n _id?: string;\n /** Contact ID. */\n contactId?: string | null;\n /** Participant's name. */\n name?: string | null;\n /** Participant's phone number. */\n phone?: string | null;\n /** Participant's email address. */\n email?: string | null;\n /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */\n partySize?: number;\n /**\n * Approval status for the participant.\n * \n * \n */\n approvalStatus?: ApprovalStatus$3;\n /**\n * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.\n * @readonly\n */\n inherited?: boolean;\n }\n enum ApprovalStatus$3 {\n /** Default. */\n UNDEFINED = \"UNDEFINED\",\n /** Pending business approval. */\n PENDING = \"PENDING\",\n /** Approved by the business. */\n APPROVED = \"APPROVED\",\n /** Declined by the business. */\n DECLINED = \"DECLINED\"\n }\n interface ExternalCalendarOverrides$3 {\n /** Synced title of the external calendar event. */\n title?: string | null;\n /** Synced description of the external calendar event. */\n description?: string | null;\n }\n enum ScheduleStatus$3 {\n UNDEFINED = \"UNDEFINED\",\n /** The default value when the schedule is created. */\n CREATED = \"CREATED\",\n /** The schedule has been canceled. */\n CANCELLED = \"CANCELLED\"\n }\n interface Version$3 {\n /** Schedule version number, updated each time the schedule is updated. */\n scheduleVersion?: number | null;\n /** Participants version number, updated each time the schedule participants are updated. */\n participantsVersion?: number | null;\n }\n interface ConferenceProvider$3 {\n /** Conferencing provider ID */\n providerId?: string;\n }\n interface CalendarConference$3 {\n /** Wix Calendar conference ID. */\n _id?: string;\n /** Conference meeting ID in the provider's conferencing system. */\n externalId?: string;\n /** Conference provider ID. */\n providerId?: string;\n /** URL used by the host to start the conference. */\n hostUrl?: string;\n /** URL used by a guest to join the conference. */\n guestUrl?: string;\n /** Password to join the conference. */\n password?: string | null;\n /** Conference description. */\n description?: string | null;\n /**\n * Conference type.\n * \n */\n conferenceType?: ConferenceType$3;\n /** ID of the account owner in the video conferencing service. */\n accountOwnerId?: string | null;\n }\n enum ConferenceType$3 {\n UNDEFINED = \"UNDEFINED\",\n /** API-generated online meeting. */\n ONLINE_MEETING_PROVIDER = \"ONLINE_MEETING_PROVIDER\",\n /** User-defined meeting. */\n CUSTOM = \"CUSTOM\"\n }\n interface ScheduleUpdated$3 {\n /** The old schedule before the update. */\n oldSchedule?: Schedule$3;\n /** The new schedule after the update. */\n newSchedule?: Schedule$3;\n /**\n * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was\n * updating at least one of the given schedule's recurring sessions.\n * This event is triggered by create/update/delete recurring session apis.\n */\n recurringSessions?: RecurringSessionsUpdated$3;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$3;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface RecurringSessionsUpdated$3 {\n /** Old schedule's recurring session list. */\n oldRecurringSessions?: Session$3[];\n /** New schedule's recurring session list. */\n newRecurringSessions?: Session$3[];\n }\n interface Session$3 {\n /**\n * Session ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the schedule that the session belongs to. */\n scheduleId?: string;\n /**\n * ID of the resource or service that the session's schedule belongs to.\n * @readonly\n */\n scheduleOwnerId?: string | null;\n /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */\n originalStart?: Date;\n /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */\n start?: CalendarDateTime$3;\n /**\n * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.\n * If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end?: CalendarDateTime$3;\n /**\n * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.\n * The array is inherited from the schedule and can be overridden even if the session is a recurring session.\n */\n affectedSchedules?: LinkedSchedule$3[];\n /**\n * Session title.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags?: string[] | null;\n /**\n * An object describing the location where the session takes place.\n * Defaults to the schedule location.\n * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.\n */\n location?: Location$4;\n /**\n * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate$3;\n /**\n * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.\n * If the session is a recurring session, this field must be empty.\n */\n timeReservedAfter?: number | null;\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * The number of participants booked for the session. Read-only.\n * Calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** list of participants booked for the session.\n * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.\n * If the session is a recurring session, this field must be empty.\n * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n */\n participants?: Participant$3[];\n /**\n * A list of properties for which values were inherited from the schedule.\n * This does not include participants that were inherited from the schedule.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides$3;\n /**\n * Session status.\n * \n * @readonly\n */\n status?: SessionStatus;\n /**\n * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.\n * For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.\n * This field is omitted for single sessions or instances of recurring sessions.\n * Specified when the session was originally generated from a schedule recurring interval.\n * Deprecated. Use `recurringSessionId`.\n * @readonly\n */\n recurringIntervalId?: string | null;\n /**\n * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.\n * @readonly\n */\n recurringSessionId?: string | null;\n /**\n * Session type.\n * \n */\n type?: SessionType$3;\n /**\n * A conference created for the session according to the details set in the schedule's conference provider information.\n * If the session is a recurring session, this field is inherited from the schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference$3;\n /**\n * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n * \n */\n recurrence?: string | null;\n /**\n * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\n * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.\n * @readonly\n */\n instanceOfRecurrence?: string | null;\n /**\n * The session version.\n * Composed by the schedule, session and participants versions.\n * @readonly\n */\n version?: SessionVersion$3;\n }\n interface CalendarDateTime$3 {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.\n */\n timestamp?: Date;\n /** An object containing the local date and time for the business's time zone. */\n localDateTime?: LocalDateTime$3;\n /**\n * The time zone. Optional. Derived from the schedule's time zone.\n * In case this field is associated with recurring session, this field is empty.\n * @readonly\n */\n timeZone?: string | null;\n }\n interface LocalDateTime$3 {\n /** Year. 4-digit format. */\n year?: number | null;\n /** Month number, from 1-12. */\n monthOfYear?: number | null;\n /** Day of the month, from 1-31. */\n dayOfMonth?: number | null;\n /** Hour of the day in 24-hour format, from 0-23. */\n hourOfDay?: number | null;\n /** Minute, from 0-59. */\n minutesOfHour?: number | null;\n }\n interface ExternalCalendarInfo$3 {\n /** The external calendar type (e.g. Google Calendar, iCal, etc). */\n calendarType?: CalendarType$3;\n }\n enum SessionStatus {\n UNDEFINED = \"UNDEFINED\",\n /** The session is confirmed. Default status. */\n CONFIRMED = \"CONFIRMED\",\n /**\n * The session is cancelled.\n * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.\n * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.\n */\n CANCELLED = \"CANCELLED\"\n }\n enum SessionType$3 {\n UNDEFINED = \"UNDEFINED\",\n /**\n * The session creates an event on the calendar for the owner of the schedule that the session belongs to.\n * Default type.\n */\n EVENT = \"EVENT\",\n /** The session represents a resource's available working hours. */\n WORKING_HOURS = \"WORKING_HOURS\",\n /** Deprecated. please use WORKING_HOURS */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface SessionVersion$3 {\n /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */\n number?: string | null;\n }\n interface ParticipantNotification$3 {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface ScheduleCancelled$3 {\n schedule?: Schedule$3;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$3;\n oldSchedule?: Schedule$3;\n }\n interface SessionCreated$3 {\n session?: Session$3;\n }\n interface SessionUpdated$3 {\n oldSession?: Session$3;\n newSession?: Session$3;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$3;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface SessionCancelled$3 {\n session?: Session$3;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$3;\n }\n interface AvailabilityPolicyUpdated$3 {\n availabilityPolicy?: AvailabilityPolicy$3;\n }\n /** Availability policy applied to all site schedules. */\n interface AvailabilityPolicy$3 {\n /** Specify how to split the schedule slots in intervals of minutes. */\n splitInterval?: SplitInterval$3;\n }\n interface IntervalSplit$3 {\n scheduleId?: string;\n intervals?: RecurringInterval$3[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n interface RecurringSessionSplit$3 {\n scheduleId?: string;\n recurringSessions?: Session$3[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n /** Schedule unassigned from user. */\n interface ScheduleUnassignedFromUser$3 {\n /** The Wix user id. */\n userId?: string | null;\n /** The schedule that was unassigned from the user. */\n schedule?: Schedule$3;\n }\n interface MultipleSessionsCreated$3 {\n schedulesWithSessions?: ScheduleWithSessions$3[];\n }\n interface ScheduleWithSessions$3 {\n schedule?: Schedule$3;\n siteProperties?: SitePropertiesOnScheduleCreation$3;\n sessions?: Session$3[];\n }\n interface SitePropertiesOnScheduleCreation$3 {\n /** The global time zone value. */\n timeZone?: string | null;\n }\n interface MigrationEvent$3 {\n migrationData?: MigrationData$3;\n }\n interface MigrationData$3 {\n businessId?: string | null;\n staffs?: StaffData$3[];\n }\n interface StaffData$3 {\n resourceId?: string;\n syncRequestEmail?: string;\n refreshToken?: string;\n }\n interface Empty$3 {\n }\n /**\n * Retrieves a list of the external calendar providers for which the site supports integration.\n *\n *\n * The list of external calendar providers includes:\n *\n * + External calendar providers that are supported by default, such as Google, Apple, and Microsoft.\n * + External calenders for which the site owner has enabled integration by installing an app.\n *\n * For each external calendar provider, the list contains information about supported connection methods and features.\n * For each provider, check `features.connectMethods` to find out whether to use [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth) to establish a connection.\n *\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listProviders(): Promise;\n /**\n * Retrieves an external calendar connection by ID.\n *\n *\n * The external calendar connection contains details of the connection between a Wix site's calendar and calendars hosted by an external provider.\n *\n * The `syncConfig` property contains configuration details for importing events from an external calendar, exporting events to an external calendar, or both.\n * @param connectionId - ID of the connection to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField connectionId\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function getConnection(connectionId: string | null): Promise;\n /**\n * Retrieves a list of external calendar connections.\n *\n *\n * Each external calendar connections contain details of a connection between a Wix site's calendar and calendars hosted by an external provider.\n *\n * The `syncConfig` property of each connection contains configuration details for importing events from an external calendar, exporting events to an external calendar, or both.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listConnections(options?: ListConnectionsOptions): Promise;\n interface ListConnectionsOptions {\n /**\n * Schedule IDs to filter by. If provided, only connections between external calendars and the specified schedules is returned.\n *\n * Default: Returns all connections.\n */\n scheduleIds?: string[] | null;\n /**\n * Whether to return a partial list of connections if details can't be retrieved for some connections.\n *\n * Default: `false`\n */\n partialFailure?: boolean | null;\n }\n /**\n * Connects to an external calendar using the OAuth authorization protocol.\n *\n *\n * The authorization flow should take place as follows:\n *\n * 1. Call the function with the appropriate parameters.\n * 2. Redirect the user to the URL received in the response.\n * 3. The user authorizes access.\n * 4. The user is redirected to the URL you provide in the `redirectUrl` parameter, with a query parameter `connectionId` containing the new connection ID.\n *\n * If the attempt to connect fails, the user is still redirected to the URL you provide in the `redirectUrl` parameter,\n * but with a query parameter `error` containing one of the following values:\n *\n * - `reject`: The user rejected the authorization request.\n * - `unsupported`: Connecting to the user's external account type is not supported by the provider.\n * - `internal`: An error unrelated to the client or the request that prevents the server from fulfilling the request.\n *\n * Once a connection is successfully created, use [`listEvents()`](#list-events) to obtain an up-to-date list of events in the connected external calendars.\n *\n * > **Note:**\n * > Use [`listProviders()`](#list-providers) to find out whether to connect to a particular provider using this endpoint or [`connectByCredentials()`](#connect-by-credentials).\n * @param scheduleId - ID of the schedule to connect with the external calendar account.\n * @param redirectUrl - URL to redirect the user to after they authorize access to the external calendar account.\n *\n * If the connection is successfully established, the user is redirected to this URL with a query parameter `connectionId` containing the new connection ID.\n * If the attempt to connect fails, the user is redirected to this URL with a query parameter `error` containing the error type.\n * @public\n * @documentationMaturity preview\n * @requiredField providerId\n * @requiredField redirectUrl\n * @requiredField scheduleId\n * @param providerId - ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function.\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function connectByOAuth(providerId: string | null, scheduleId: string | null, redirectUrl: string | null, options?: ConnectByOAuthOptions): Promise;\n interface ConnectByOAuthOptions {\n }\n interface OAuthCompletedOptions {\n body?: Uint8Array;\n pathParams?: PathParametersEntry[];\n queryParams?: QueryParametersEntry[];\n headers?: HeadersEntry[];\n method?: string;\n rawPath?: string;\n rawQuery?: string;\n }\n /**\n * Connects to an external calendar by directly providing the external calendar account credentials.\n *\n *\n * Once a connection is successfully created, use [`listEvents()`](#list-events) to obtain an up-to-date list of events in the connected external calendars.\n *\n * > **Note:**\n * > Use [`listProviders()`](#list-providers) to find out whether to connect to a particular provider using this method or [`connectByOAuth()`](#connect-by-o-auth).\n * @param scheduleId - ID of the schedule to connect with the external calendar account.\n * @param email - Email address for the external calendar account.\n * @param password - Password for the external calendar account.\n * @public\n * @documentationMaturity preview\n * @requiredField email\n * @requiredField password\n * @requiredField providerId\n * @requiredField scheduleId\n * @param providerId - ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function.\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function connectByCredentials(providerId: string | null, scheduleId: string | null, email: string | null, password: string | null): Promise;\n /**\n * Retrieves a list of calendars belonging to the connected external calendar account.\n *\n *\n * > **Note:**\n * > Before using this function, establish a connection with an external calendar using [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth).\n * @param connectionId - ID of the external calendar connection to list calendars for.\n * @public\n * @documentationMaturity preview\n * @requiredField connectionId\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listCalendars(connectionId: string | null): Promise;\n /**\n * Updates the specified external calendar connection's sync configuration.\n *\n *\n * Use Update Sync Config to update a connection's `syncConfig` property.\n * The `syncConfig` property contains settings for enabling, configuring, or disabling functionality, including:\n *\n * + Importing events from one or more specified calendars in the connected external calendar account. If this is enabled, use [`listEvents()`](#list-events) to retrieve a list of events from the external calendar.\n * + Exporting events from the Wix site's calendar to an external calendar.\n *\n * To see an external calendar connection's existing sync configuration, use [`getConnection()`](#get-connection) or [`listConnections()`](#list-connections) and see the `syncConfig` property.\n *\n * > **Note:**\n * > Supported functionality depends on the provider. Use [`listProviders()`](#list-providers) to see details about providers' supported features.\n * @param connectionId - ID of the external calendar connection to update.\n * @param syncConfig - Updated sync configuration details.\n * @public\n * @documentationMaturity preview\n * @requiredField connectionId\n * @requiredField syncConfig\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateSyncConfig(connectionId: string | null, syncConfig: ConnectionSyncConfig, options?: UpdateSyncConfigOptions): Promise;\n interface UpdateSyncConfigOptions {\n }\n /**\n * Disconnects from an external calendar.\n *\n *\n * When an external calendar is disconnected, the external calendar connection's `status` is changed to `DISCONNECTED`.\n *\n * After disconnecting, [`listEvents()`](#list-events) no longer returns events from the disconnected external calendar.\n * Exported Wix calendar sessions are deleted from the external calendar.\n * @param connectionId - ID of the external calendar connection to disconnect.\n * @public\n * @documentationMaturity preview\n * @requiredField connectionId\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function disconnect(connectionId: string | null): Promise;\n /**\n * Retrieves a list of events from all connected external calendars, based on the provided filtering and paging.\n *\n *\n * Use List Events to retrieve an aggregated list of events in the connected external calendars for a specified time range, sorted by start date.\n *\n * > **Note:**\n * > Before using this function, establish a connection with an external calendar using [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth).\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage External Calendars\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listEvents(options?: ListEventsOptions): Promise;\n interface ListEventsOptions {\n /**\n * Date and time from which to retrieve events,\n * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n * Required, unless `cursorPaging.cursor` is provided.\n *\n * Events which start before the `from` time and end after it are included in the returned list.\n */\n from?: string | null;\n /**\n * Date and time until which to retrieve events,\n * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).\n * Required, unless `cursorPaging.cursor` is provided.\n *\n * Events which start before the `to` time and end after it are included in the returned list.\n */\n to?: string | null;\n /**\n * Schedule IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to the specified schedules.\n * Maximum of 100 schedule IDs per request.\n */\n scheduleIds?: string[] | null;\n /**\n * Wix user IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to schedules belonging to the specified Wix users.\n * Maximum of 100 Wix user IDs per request.\n */\n userIds?: string[] | null;\n /**\n * Whether to include only all-day events in the returned list.\n * If `true`, only all-day events are returned.\n * If `false`, only events with a specified time are returned.\n *\n * Default: All events are returned.\n */\n allDay?: boolean | null;\n /**\n * Predefined sets of fields to return.\n * - `NO_PI`: Returns event objects without personal information.\n * - `OWN_PI`: Returns complete event objects, including personal information.\n *\n * Default: `NO_PI`\n */\n fieldsets?: string[];\n /** Pagination options. */\n cursorPaging?: CursorPaging$3;\n /**\n * Whether to return a partial list of events if details can't be retrieved for some connections.\n *\n * Default: `false`\n */\n partialFailure?: boolean | null;\n }\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ExternalCalendar = ExternalCalendar;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListProvidersRequest = ListProvidersRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListProvidersResponse = ListProvidersResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Provider = Provider;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ProviderFeatures = ProviderFeatures;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectMethod = ConnectMethod;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectMethod: typeof ConnectMethod;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventFromCalendars = ListEventFromCalendars;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventFromCalendars: typeof ListEventFromCalendars;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SyncToCalendar = SyncToCalendar;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SyncToCalendar: typeof SyncToCalendar;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_GetConnectionRequest = GetConnectionRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_GetConnectionResponse = GetConnectionResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Connection = Connection;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ErrorReason = ErrorReason;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ErrorReason: typeof ErrorReason;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfig = ConnectionSyncConfig;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Calendar = Calendar;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_PrimaryCalendar = PrimaryCalendar;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Calendars = Calendars;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_DedicatedCalendar = DedicatedCalendar;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigListEventFromCalendars = ConnectionSyncConfigListEventFromCalendars;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigListEventFromCalendarsListFromOneOf = ConnectionSyncConfigListEventFromCalendarsListFromOneOf;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigSyncToCalendar = ConnectionSyncConfigSyncToCalendar;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigSyncToCalendarSyncToOneOf = ConnectionSyncConfigSyncToCalendarSyncToOneOf;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SyncToErrorReason = SyncToErrorReason;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SyncToErrorReason: typeof SyncToErrorReason;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListConnectionsRequest = ListConnectionsRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListConnectionsResponse = ListConnectionsResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByOAuthRequest = ConnectByOAuthRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByOAuthResponse = ConnectByOAuthResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_RawHttpRequest = RawHttpRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_PathParametersEntry = PathParametersEntry;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_QueryParametersEntry = QueryParametersEntry;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_HeadersEntry = HeadersEntry;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_RawHttpResponse = RawHttpResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByCredentialsRequest = ConnectByCredentialsRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByCredentialsResponse = ConnectByCredentialsResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListCalendarsRequest = ListCalendarsRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListCalendarsResponse = ListCalendarsResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_UpdateSyncConfigRequest = UpdateSyncConfigRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_UpdateSyncConfigResponse = UpdateSyncConfigResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_DisconnectRequest = DisconnectRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_DisconnectResponse = DisconnectResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventsRequest = ListEventsRequest;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventsResponse = ListEventsResponse;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SessionStatus = SessionStatus;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SessionStatus: typeof SessionStatus;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listProviders: typeof listProviders;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_getConnection: typeof getConnection;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listConnections: typeof listConnections;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListConnectionsOptions = ListConnectionsOptions;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_connectByOAuth: typeof connectByOAuth;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByOAuthOptions = ConnectByOAuthOptions;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_OAuthCompletedOptions = OAuthCompletedOptions;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_connectByCredentials: typeof connectByCredentials;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listCalendars: typeof listCalendars;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_updateSyncConfig: typeof updateSyncConfig;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_UpdateSyncConfigOptions = UpdateSyncConfigOptions;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_disconnect: typeof disconnect;\n const bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listEvents: typeof listEvents;\n type bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventsOptions = ListEventsOptions;\n namespace bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d {\n export { bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ExternalCalendar as ExternalCalendar, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListProvidersRequest as ListProvidersRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListProvidersResponse as ListProvidersResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Provider as Provider, CalendarType$3 as CalendarType, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ProviderFeatures as ProviderFeatures, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectMethod as ConnectMethod, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventFromCalendars as ListEventFromCalendars, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SyncToCalendar as SyncToCalendar, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_GetConnectionRequest as GetConnectionRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_GetConnectionResponse as GetConnectionResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Connection as Connection, Status$3 as Status, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ErrorReason as ErrorReason, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfig as ConnectionSyncConfig, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Calendar as Calendar, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_PrimaryCalendar as PrimaryCalendar, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_Calendars as Calendars, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_DedicatedCalendar as DedicatedCalendar, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigListEventFromCalendars as ConnectionSyncConfigListEventFromCalendars, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigListEventFromCalendarsListFromOneOf as ConnectionSyncConfigListEventFromCalendarsListFromOneOf, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigSyncToCalendar as ConnectionSyncConfigSyncToCalendar, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectionSyncConfigSyncToCalendarSyncToOneOf as ConnectionSyncConfigSyncToCalendarSyncToOneOf, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SyncToErrorReason as SyncToErrorReason, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListConnectionsRequest as ListConnectionsRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListConnectionsResponse as ListConnectionsResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByOAuthRequest as ConnectByOAuthRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByOAuthResponse as ConnectByOAuthResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_RawHttpRequest as RawHttpRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_PathParametersEntry as PathParametersEntry, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_QueryParametersEntry as QueryParametersEntry, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_HeadersEntry as HeadersEntry, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_RawHttpResponse as RawHttpResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByCredentialsRequest as ConnectByCredentialsRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByCredentialsResponse as ConnectByCredentialsResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListCalendarsRequest as ListCalendarsRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListCalendarsResponse as ListCalendarsResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_UpdateSyncConfigRequest as UpdateSyncConfigRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_UpdateSyncConfigResponse as UpdateSyncConfigResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_DisconnectRequest as DisconnectRequest, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_DisconnectResponse as DisconnectResponse, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventsRequest as ListEventsRequest, CursorPaging$3 as CursorPaging, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventsResponse as ListEventsResponse, Event$2 as Event, CursorPagingMetadata$2 as CursorPagingMetadata, Cursors$3 as Cursors, ScheduleNotification$3 as ScheduleNotification, ScheduleNotificationEventOneOf$3 as ScheduleNotificationEventOneOf, ScheduleCreated$3 as ScheduleCreated, Schedule$3 as Schedule, RecurringInterval$3 as RecurringInterval, Interval$3 as Interval, Day$3 as Day, Frequency$3 as Frequency, LinkedSchedule$3 as LinkedSchedule, Transparency$3 as Transparency, RecurringIntervalType$3 as RecurringIntervalType, Location$4 as Location, LocationType$4 as LocationType, Address$3 as Address, AddressStreetOneOf$3 as AddressStreetOneOf, StreetAddress$3 as StreetAddress, AddressLocation$3 as AddressLocation, Subdivision$3 as Subdivision, LocationsLocation$3 as LocationsLocation, LocationStatus$3 as LocationStatus, LocationsLocationType$3 as LocationsLocationType, LocationsAddress$3 as LocationsAddress, LocationsStreetAddress$3 as LocationsStreetAddress, LocationsAddressLocation$3 as LocationsAddressLocation, BusinessSchedule$3 as BusinessSchedule, TimePeriod$3 as TimePeriod, DayOfWeek$3 as DayOfWeek, SpecialHourPeriod$3 as SpecialHourPeriod, Rate$3 as Rate, Price$3 as Price, Availability$3 as Availability, AvailabilityConstraints$3 as AvailabilityConstraints, SplitInterval$3 as SplitInterval, Participant$3 as Participant, ApprovalStatus$3 as ApprovalStatus, ExternalCalendarOverrides$3 as ExternalCalendarOverrides, ScheduleStatus$3 as ScheduleStatus, Version$3 as Version, ConferenceProvider$3 as ConferenceProvider, CalendarConference$3 as CalendarConference, ConferenceType$3 as ConferenceType, ScheduleUpdated$3 as ScheduleUpdated, RecurringSessionsUpdated$3 as RecurringSessionsUpdated, Session$3 as Session, CalendarDateTime$3 as CalendarDateTime, LocalDateTime$3 as LocalDateTime, ExternalCalendarInfo$3 as ExternalCalendarInfo, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_SessionStatus as SessionStatus, SessionType$3 as SessionType, SessionVersion$3 as SessionVersion, ParticipantNotification$3 as ParticipantNotification, ScheduleCancelled$3 as ScheduleCancelled, SessionCreated$3 as SessionCreated, SessionUpdated$3 as SessionUpdated, SessionCancelled$3 as SessionCancelled, AvailabilityPolicyUpdated$3 as AvailabilityPolicyUpdated, AvailabilityPolicy$3 as AvailabilityPolicy, IntervalSplit$3 as IntervalSplit, RecurringSessionSplit$3 as RecurringSessionSplit, ScheduleUnassignedFromUser$3 as ScheduleUnassignedFromUser, MultipleSessionsCreated$3 as MultipleSessionsCreated, ScheduleWithSessions$3 as ScheduleWithSessions, SitePropertiesOnScheduleCreation$3 as SitePropertiesOnScheduleCreation, MigrationEvent$3 as MigrationEvent, MigrationData$3 as MigrationData, StaffData$3 as StaffData, Empty$3 as Empty, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listProviders as listProviders, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_getConnection as getConnection, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listConnections as listConnections, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListConnectionsOptions as ListConnectionsOptions, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_connectByOAuth as connectByOAuth, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ConnectByOAuthOptions as ConnectByOAuthOptions, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_OAuthCompletedOptions as OAuthCompletedOptions, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_connectByCredentials as connectByCredentials, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listCalendars as listCalendars, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_updateSyncConfig as updateSyncConfig, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_UpdateSyncConfigOptions as UpdateSyncConfigOptions, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_disconnect as disconnect, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_listEvents as listEvents, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d_ListEventsOptions as ListEventsOptions, };\n }\n /** The `Service` object represents the business offering that a business provides to its customers. */\n interface Service$1 {\n /**\n * Service ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Service type.\n *\n * Supported Values:\n * - \"APPOINTMENT\"\n * - \"CLASS\"\n * - \"COURSE\"\n *\n */\n type?: ServiceType;\n /** Order of a service within a category. */\n sortOrder?: number | null;\n name?: string | null;\n description?: string | null;\n tagLine?: string | null;\n /** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */\n defaultCapacity?: number | null;\n /** Media associated with the service. */\n media?: Media$1;\n /** Whether the service is hidden from the site. */\n hidden?: boolean | null;\n /** The category the service is associated with. */\n category?: V2Category;\n /** The form used when booking the service. */\n form?: Form;\n /** Payment options for booking the service. */\n payment?: Payment;\n /** Online booking settings. */\n onlineBooking?: OnlineBooking;\n /** Conferencing options for this service. */\n conferencing?: Conferencing;\n /**\n * The locations this service is offered at.\n * In case of multiple (more than 1) location, All locations must be of type `BUSINESS`.\n * For courses only: Currently, only 1 location is supported, for all location types.\n */\n locations?: V2Location[];\n /** Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins. */\n bookingPolicy?: BookingPolicy$1;\n /** The service's schedule, which can be used to manage the service's sessions. */\n schedule?: V2Schedule;\n /** IDs of the staff members providing the service. For appointments only. */\n staffMemberIds?: string[];\n /**\n * A slug is the last part of the URL address that serves as a unique identifier of the service.\n * The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.\n * @readonly\n */\n supportedSlugs?: Slug[];\n /**\n * The main slug for the service. `mainSlug` is either taken from the current service name or is a custom slug set by the business owner.\n * `mainSlug` is used to construct the service's URLs.\n * @readonly\n */\n mainSlug?: Slug;\n /**\n * URLs to various service-related pages, such as the calendar page and the booking page.\n * @readonly\n */\n urls?: URLs;\n /**\n * Extensions enabling users to save custom data related to the service.\n * @readonly\n */\n extendedFields?: ExtendedFields;\n /** Custom SEO data for the service. */\n seoData?: SeoSchema$1;\n /**\n * Date and time the service was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the service was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.\n * @readonly\n */\n revision?: string | null;\n }\n enum ServiceType {\n UNKNOWN_SERVICE_TYPE = \"UNKNOWN_SERVICE_TYPE\",\n /** Service is an appointment. */\n APPOINTMENT = \"APPOINTMENT\",\n /** Service is a class. */\n CLASS = \"CLASS\",\n /** Service is a course. */\n COURSE = \"COURSE\"\n }\n interface Media$1 {\n /** Media items associated with the service. */\n items?: MediaItem$1[];\n /** Primary media associated with the service. */\n mainMedia?: MediaItem$1;\n /** Cover media associated with the service. */\n coverMedia?: MediaItem$1;\n }\n interface MediaItem$1 extends MediaItemItemOneOf$1 {\n /** The image's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`. */\n image?: string;\n }\n /** @oneof */\n interface MediaItemItemOneOf$1 {\n /** The image's Wix media URL in the following format: `'wix:image://v1//#originWidth=&originHeight=[&watermark=]'`. */\n image?: string;\n }\n interface V2Category {\n /** Category ID. */\n _id?: string;\n /**\n * Category name.\n * @readonly\n */\n name?: string | null;\n /**\n * Order of a category within a category list.\n * @readonly\n */\n sortOrder?: number | null;\n }\n interface Form {\n /**\n * ID of the form associated with the service.\n * Form information submitted when booking, including contact details, participants, and other form fields, set up for the service.\n */\n _id?: string;\n }\n interface FormSettings {\n /** Whether the service booking form should be hidden from the site. */\n hidden?: boolean | null;\n }\n interface Payment extends PaymentRateOneOf {\n /**\n * The details for the fixed price of the service.\n *\n * Required when: `rateType` is `FIXED`\n */\n fixed?: FixedPayment;\n /**\n * The details for the custom price of the service.\n *\n * Required when: `rateType` is `CUSTOM`\n */\n custom?: CustomPayment;\n /**\n * The details for the varied pricing of the service.\n * Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options).\n *\n * Required when: `rateType` is `VARIED`\n */\n varied?: VariedPayment;\n /**\n * The rate the customer is expected to pay for the service.\n * Can be:\n * - `FIXED`: The service has a fixed price.\n * - `CUSTOM`: The service has a custom price, expressed as a price description.\n * - `VARIED`: This service is offered with a set of different prices based on different terms.\n * - `NO_FEE`: This service is offered free of charge.\n */\n rateType?: RateType;\n /** The payment options a customer can use to pay for the service. */\n options?: PaymentOptions$1;\n /**\n * IDs of pricing plans that can be used as payment for the service.\n * @readonly\n */\n pricingPlanIds?: string[];\n }\n /** @oneof */\n interface PaymentRateOneOf {\n /**\n * The details for the fixed price of the service.\n *\n * Required when: `rateType` is `FIXED`\n */\n fixed?: FixedPayment;\n /**\n * The details for the custom price of the service.\n *\n * Required when: `rateType` is `CUSTOM`\n */\n custom?: CustomPayment;\n /**\n * The details for the varied pricing of the service.\n * Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options).\n *\n * Required when: `rateType` is `VARIED`\n */\n varied?: VariedPayment;\n }\n enum RateType {\n UNKNOWN_RATE_TYPE = \"UNKNOWN_RATE_TYPE\",\n /** The service has a fixed price. */\n FIXED = \"FIXED\",\n /** The service has a custom price, expressed as a price description. */\n CUSTOM = \"CUSTOM\",\n /** This service is offered with a set of different prices based on different terms. */\n VARIED = \"VARIED\",\n /** This service is offered free of charge. */\n NO_FEE = \"NO_FEE\"\n }\n interface FixedPayment {\n /**\n * The fixed price required to book the service.\n *\n * Required when: `rateType` is `FIXED`\n */\n price?: Money$1;\n /**\n * The deposit price required to book the service.\n *\n * Required when: `rateType` is `FIXED` and `paymentOptions.deposit` is `true`\n */\n deposit?: Money$1;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface Money$1 {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n formattedValue?: string | null;\n }\n interface CustomPayment {\n /** A custom description explaining to the customer how to pay for the service. */\n description?: string | null;\n }\n interface VariedPayment {\n /** The default price for the service without any variants. It will also be used as the default price for any new variant. */\n defaultPrice?: Money$1;\n /**\n * The deposit price required to book the service.\n *\n * Required when: `rateType` is `VARIED` and `paymentOptions.deposit` is `true`\n */\n deposit?: Money$1;\n /**\n * The minimal price a customer may pay for this service, based on its variants.\n * @readonly\n */\n minPrice?: Money$1;\n /**\n * The maximum price a customer may pay for this service, based on its variants.\n * @readonly\n */\n maxPrice?: Money$1;\n }\n interface PaymentOptions$1 {\n /**\n * Customers can pay for the service online.\n * When `true`:\n * + `rateType` must be either `FIXED` or `VARIED`.\n * + `fixed.price` or `varied.default_price` must be specified respectively. Read more about [getting paid online](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online).\n */\n online?: boolean | null;\n /** Customers can pay for the service in person. */\n inPerson?: boolean | null;\n /**\n * This service requires a deposit to be made online in order to book it.\n * When `true`:\n * + `rateType` must be `VARIED` or `FIXED`.\n * + A `deposit` must be specified.\n */\n deposit?: boolean | null;\n /** Customers can pay for the service using a pricing plan. */\n pricingPlan?: boolean | null;\n }\n interface OnlineBooking {\n /**\n * Whether this service can be booked online.\n * When set to `true`, customers can book the service online. Configuring the payment options is done via `service.payment` property.\n * When set to `false`, customers cannot book the service online, and the service can only be paid for in person.\n */\n enabled?: boolean | null;\n /** Booking the service requires approval by the business owner. */\n requireManualApproval?: boolean | null;\n /** Multiple customers can request to book the same time slot. Relevant when `requireManualApproval` is `true`. */\n allowMultipleRequests?: boolean | null;\n }\n interface Conferencing {\n /** Whether a conference link is generated for the service's sessions. */\n enabled?: boolean | null;\n }\n interface V2Location extends V2LocationOptionsOneOf {\n /** The service is offered at the referenced business location, the location has to reference a location from the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */\n business?: BusinessLocationOptions;\n /** The service is offered at a custom location. */\n custom?: CustomLocationOptions;\n /**\n * The type of location:\n * - `CUSTOM`: The location is specific to this service, and is not derived from the business location.\n * - `BUSINESS`: A business location, either the default business address, or locations defined for the business by the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations).\n * - `CUSTOMER`: Will be determined by the customer. For appointments only.\n */\n type?: LocationTypeEnumLocationType;\n /**\n * The location address, based on the location `type`. If `type` is `CUSTOMER`, this address is empty.\n * @readonly\n */\n calculatedAddress?: CommonAddress;\n }\n /** @oneof */\n interface V2LocationOptionsOneOf {\n /** The service is offered at the referenced business location, the location has to reference a location from the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */\n business?: BusinessLocationOptions;\n /** The service is offered at a custom location. */\n custom?: CustomLocationOptions;\n }\n enum LocationTypeEnumLocationType {\n UNKNOWN_LOCATION_TYPE = \"UNKNOWN_LOCATION_TYPE\",\n /** The location is unique to this service and isn't defined as one of the business locations. `CUSTOM` is the equivalent of the `OWNER_CUSTOM` location type in [Schedules & Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions). */\n CUSTOM = \"CUSTOM\",\n /** The location is one of the business locations available using the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */\n BUSINESS = \"BUSINESS\",\n /** The location can be determined by the customer and is not set up beforehand. This is applicable to services of type `APPOINTMENT` only. */\n CUSTOMER = \"CUSTOMER\"\n }\n interface CommonAddress extends CommonAddressStreetOneOf {\n /** Street name and number. */\n streetAddress?: CommonStreetAddress;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Full address of the location. */\n formatted?: string | null;\n }\n /** @oneof */\n interface CommonAddressStreetOneOf {\n /** Street name and number. */\n streetAddress?: CommonStreetAddress;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface CommonStreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface CommonAddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface BusinessLocationOptions {\n /** Business location ID. */\n _id?: string;\n /**\n * Business location name.\n * @readonly\n */\n name?: string;\n /**\n * Whether this is the default location. There can only be 1 default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean | null;\n /**\n * Business location address. The address is derived from the business location and is read-only.\n * @readonly\n */\n address?: CommonAddress;\n }\n interface CustomLocationOptions {\n /** A custom address for the location. */\n address?: CommonAddress;\n }\n /**\n * `BookingPolicy` is the main entity of `BookingPolicyService` and specifies a set of rules for booking a service\n * by visitors and members.\n *\n * Each `BookingPolicy` consists of a number of sub-policies. When the Bookings App is provisioned to a meta site then a\n * default `BookingPolicy` will be created with defaults for each of these sub-policies. This also applies when a request\n * is received to create a new `BookingPolicy` and one or more of these sub-policies are not provided.\n *\n * Sub-policies are defined in separate objects as specified below.\n *\n * - The `LimitEarlyBookingPolicy` object defines the policy for limiting early bookings.\n * - The `LimitLateBookingPolicy` object defines the policy for limiting late bookings.\n * - The `BookAfterStartPolicy` object defines the policy for booking after the start of the schedule.\n * - The `CancellationPolicy` object defines the policy for canceling a booked entity.\n * - The `ReschedulePolicy` object defines the policy for rescheduling booked entity.\n * - The `WaitlistPolicy` object defines the policy for a waitlist.\n * - The `ParticipantsPolicy` object defines the policy regarding the participants per booking.\n * - The `ResourcesPolicy` object defines the policy regarding the resources per booking.\n *\n * By default each sub-policy is disabled. A more detailed specification of the default settings of each sub-policy\n * can be found in the description of the corresponding object.\n *\n * Partial updates are supported on the main entity level, however in order to update a sub-policy the client needs to provide the whole sub-policy object.\n */\n interface BookingPolicy$1 {\n /** The ID to the policy for the booking. */\n _id?: string;\n /**\n * Date and time the policy was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the policy was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Name of the policy.\n * @readonly\n */\n name?: string | null;\n /**\n * Custom description for the policy. This policy is displayed to the participant.\n * @readonly\n */\n customPolicyDescription?: PolicyDescription;\n /**\n * Whether the policy is the default for the meta site.\n * @readonly\n */\n default?: boolean | null;\n /**\n * Policy for limiting early bookings.\n * @readonly\n */\n limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;\n /**\n * Policy for limiting late bookings.\n * @readonly\n */\n limitLateBookingPolicy?: LimitLateBookingPolicy;\n /**\n * Policy on booking an entity after the start of the schedule.\n * @readonly\n */\n bookAfterStartPolicy?: BookAfterStartPolicy;\n /**\n * Policy for canceling a booked entity.\n * @readonly\n */\n cancellationPolicy?: CancellationPolicy;\n /**\n * Policy for rescheduling a booked entity.\n * @readonly\n */\n reschedulePolicy?: ReschedulePolicy;\n /**\n * Waitlist policy for the service.\n * @readonly\n */\n waitlistPolicy?: WaitlistPolicy;\n /**\n * Policy regarding the participants per booking.\n * @readonly\n */\n participantsPolicy?: ParticipantsPolicy;\n /**\n * Policy for allocating resources.\n * @readonly\n */\n resourcesPolicy?: ResourcesPolicy;\n }\n /** A description of the policy to display to participants. */\n interface PolicyDescription {\n /**\n * Whether the description should be displayed. If `true`, the description is displayed.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * The description to display.\n *\n * Default: Empty\n * Max length: 2500 characters\n */\n description?: string;\n }\n /** The policy for limiting early bookings. */\n interface LimitEarlyBookingPolicy {\n /**\n * Whether there is a limit on how early a customer\n * can book. When `false`, there is no limit on the earliest\n * booking time and customers can book in advance, as early as they like.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Maximum number of minutes before the start of the session that a booking can be made. This value must be greater\n * than `latest_booking_in_minutes` in the `LimitLateBookingPolicy` policy.\n *\n * Default: 10080 minutes (7 days)\n * Min: 1 minute\n */\n earliestBookingInMinutes?: number;\n }\n /**\n * The policy for limiting late bookings.\n *\n * This policy and the `BookAfterStartPolicy` policy cannot be enabled at the same time. So if this policy\n * is enabled, `BookAfterStartPolicy` must be disabled.\n */\n interface LimitLateBookingPolicy {\n /**\n * Whether there is a limit on how late a customer\n * can book. When `false`, there is no limit on the latest\n * booking time and customers can book up to the last minute.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Minimum number of minutes before the start of the session that a booking can be made.\n * For a schedule, this is relative to the start time of the next booked session, excluding past-booked sessions.\n * This value must be less than `earliest_booking_in_minutes` in the `LimitEarlyBookingPolicy` policy.\n *\n * Default: 1440 minutes (1 day)\n * Min: 1 minute\n */\n latestBookingInMinutes?: number;\n }\n /**\n * The policy for whether a session can be booked after the start of the schedule.\n * This policy and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this policy\n * is enabled, the `LimitLateBookingPolicy` policy must be disabled.\n */\n interface BookAfterStartPolicy {\n /**\n * Whether booking is allowed after the start of the schedule. When `true`,\n * customers can book after the start of the schedule.\n *\n * Default: `false`\n */\n enabled?: boolean;\n }\n /** The policy for canceling a booked session. */\n interface CancellationPolicy {\n /**\n * Whether canceling a booking is allowed. When `true`, customers\n * can cancel the booking.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether there is a limit on the latest cancellation time. When `true`,\n * a time limit is enforced.\n *\n * Default: `false`\n */\n limitLatestCancellation?: boolean;\n /**\n * Minimum number of minutes before the start of the booked session that the booking can be canceled.\n *\n * Default: 1440 minutes (1 day)\n * Min: 1 minute\n */\n latestCancellationInMinutes?: number;\n }\n /** The policy for rescheduling a booked session. */\n interface ReschedulePolicy {\n /**\n * Whether rescheduling a booking is allowed. When `true`, customers\n * can reschedule the booking.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether there is a limit on the latest reschedule time. When `true`,\n * a time limit is enforced.\n *\n * Default: `false`\n */\n limitLatestReschedule?: boolean;\n /**\n * Minimum number of minutes before the start of the booked session that the booking can be rescheduled.\n *\n * Default: 1440 minutes (1 day)\n * Min: 1 minute\n */\n latestRescheduleInMinutes?: number;\n }\n /** The policy for the waitlist. */\n interface WaitlistPolicy {\n /**\n * Whether the session has a waitlist. If `true`, there is a waitlist.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Number of spots available in the waitlist.\n *\n * Default: 10 spots\n * Min: 1 spot\n */\n capacity?: number;\n /**\n * Amount of time a participant is given to book, once notified that a spot is available.\n *\n * Default: 10 minutes\n * Min: 1 spot\n */\n reservationTimeInMinutes?: number;\n }\n /** The policy for the maximum number of participants per booking. */\n interface ParticipantsPolicy {\n /**\n * Maximum number of participants allowed.\n *\n * Default: 1 participant\n * Min: 1 participant\n */\n maxParticipantsPerBooking?: number;\n }\n /** The policy regarding the allocation of resources (e.g. staff members). */\n interface ResourcesPolicy {\n /**\n * `true` if this policy is enabled, `false` otherwise.\n * When `false` then the client must always select a resource when booking an appointment.\n */\n enabled?: boolean;\n /**\n * `true`, if it is allowed to automatically assign a resource when booking an appointment,\n * `false`, if the client must always select a resource.\n *\n * Default: `false`\n */\n autoAssignAllowed?: boolean;\n }\n interface V2Schedule {\n /**\n * Schedule ID, used to manage the service's sessions.\n * @readonly\n */\n _id?: string | null;\n /** Limitations dictating the way session availability is calculated. For appointments only. */\n availabilityConstraints?: V2AvailabilityConstraints;\n }\n interface V2AvailabilityConstraints {\n /**\n * A list of duration options for sessions, in minutes.\n *\n * The availability calculation generates slots for sessions with these durations, unless there is a conflict with existing sessions or other availability constraints exist.\n * Required for services of type `APPOINTMENT` to allow the customer to book a session of the service. Not relevant for other service types.\n *\n *\n * Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes\n */\n sessionDurations?: number[];\n /**\n * The number of minutes between the end of a session and the start of the next.\n *\n *\n * Min: 0 minutes\n * Max: 720 minutes\n */\n timeBetweenSessions?: number;\n }\n interface StaffMember {\n /**\n * ID of the staff member providing the service, can be used to retrieve resource information using wix-bookings-backend resources API.\n * @readonly\n */\n staffMemberId?: string;\n /** Name of the staff member */\n name?: string | null;\n }\n interface ResourceGroup {\n /**\n * An optional resource group id, if provided it references a resource group in the resource groups API.\n * TODO - referenced_entity annotation\n */\n resourceGroupId?: string | null;\n /**\n * Resource ids, each referencing a resource in resources API. may be a subset of resources within a resource group.\n * TODO - referenced_entity annotation\n */\n resourceIds?: ResourceIds;\n /**\n * How many resources of the group / resource ids are required in order to book the service.\n * Defaults to 1.\n */\n requiredResourcesNumber?: number | null;\n /**\n * If set to `true`, the custom can select the specific resources while booking the service.\n * If set to `false`, the resources required for to book the service would be auto selected at the time of the booking.\n * Defaults to false.\n * @readonly\n */\n selectableResource?: boolean | null;\n }\n interface ResourceIds {\n /** Values of the resource ids. TODO - referenced_entity annotation */\n values?: string[];\n }\n interface ServiceResource extends ServiceResourceSelectionOneOf {\n /** Resource ids, each referencing a resource in resources API. Must be a subset of resources within the selected resource type. */\n resourceIds?: ResourceIds;\n /** The unique identifier for the service resource, if not provided, would default to the resource type id. */\n _id?: string | null;\n resourceType?: ResourceType;\n /**\n * How many resources of the are required in order to book the service.\n * Defaults to 1.\n */\n requiredResourcesNumber?: number | null;\n /**\n * If set to `true`, the customer can select the specific resources while booking the service.\n * If set to `false`, the resources required for to book the service would be auto selected at the time of the booking.\n * Defaults to false.\n * @readonly\n */\n selectableResource?: boolean | null;\n }\n /** @oneof */\n interface ServiceResourceSelectionOneOf {\n /** Resource ids, each referencing a resource in resources API. Must be a subset of resources within the selected resource type. */\n resourceIds?: ResourceIds;\n }\n interface ResourceType {\n /** The type of the resource. */\n _id?: string | null;\n /**\n * The name of the resource type.\n * @readonly\n */\n name?: string | null;\n }\n interface Slug {\n /** The unique part of service's URL that identifies the service's information page. For example, `service-1` in `https:/example.com/services/service-1`. */\n name?: string;\n /**\n * Whether the slug was generated or customized. If `true`, the slug was customized manually by the business owner. Otherwise, the slug was automatically generated from the service name.\n * @readonly\n */\n custom?: boolean | null;\n /**\n * Date and time the slug was created. This is a system field.\n * @readonly\n */\n _createdDate?: Date;\n }\n interface URLs {\n /**\n * The URL for the service page.\n * @readonly\n */\n servicePage?: string;\n /**\n * The URL for the booking entry point. It can be either to the calendar or to the service page.\n * @readonly\n */\n bookingPage?: string;\n /**\n * The URL for the calendar. Can be empty if no calendar exists.\n * @readonly\n */\n calendarPage?: string;\n }\n interface ExtendedFields {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema$1 {\n /** SEO tag information. */\n tags?: Tag$1[];\n /** SEO general settings. */\n settings?: Settings$1;\n }\n interface Keyword$1 {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n }\n interface Tag$1 {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings$1 {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword$1[];\n }\n /**\n * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as\n * performs context manipulation with adding tenant, provided in message to callscope.\n */\n interface ReindexMessage extends ReindexMessageActionOneOf {\n upsert?: Upsert;\n delete?: Delete;\n entityFqdn?: string;\n tenantId?: string;\n eventTime?: Date;\n entityEventSequence?: string | null;\n schema?: Schema;\n }\n /** @oneof */\n interface ReindexMessageActionOneOf {\n upsert?: Upsert;\n delete?: Delete;\n }\n interface Upsert {\n entityId?: string;\n entityAsJson?: string;\n }\n interface Delete {\n entityId?: string;\n }\n interface Schema {\n label?: string;\n clusterName?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface SetCustomSlugEvent {\n /** The main slug for the service after the update */\n mainSlug?: Slug;\n }\n interface CreateServiceRequest {\n /** Service to be created. */\n service: Service$1;\n }\n interface CreateServiceResponse {\n /** The created service. */\n service?: Service$1;\n }\n interface BulkCreateServicesRequest {\n /** Services to create */\n services: Service$1[];\n /** `true` if the created entities must be included in the response, otherwise no entities are included in the response. */\n returnEntity?: boolean;\n }\n interface BulkCreateServicesResponse {\n /** The result of each service creation. */\n results?: BulkServiceResult[];\n /** Create statistics. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkServiceResult {\n itemMetadata?: ItemMetadata;\n item?: Service$1;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetServiceRequest {\n /** ID of the service to retrieve. */\n serviceId: string;\n }\n enum RequestedFields {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** When passed, `service.staff_members` is returned */\n STAFF_MEMBER_DETAILS = \"STAFF_MEMBER_DETAILS\",\n /** When passed, `service.service_resources.resource_type.name` is returned */\n RESOURCE_TYPE_DETAILS = \"RESOURCE_TYPE_DETAILS\"\n }\n interface GetServiceResponse {\n /** The retrieved service. */\n service?: Service$1;\n }\n interface GetServiceAvailabilityConstraintsRequest {\n /** ID of the service to retrieve. */\n serviceId: string;\n }\n interface GetServiceAvailabilityConstraintsResponse {\n /** The retrieved availability constraints of the service. */\n constraints?: ServiceAvailabilityConstraints;\n }\n interface ServiceAvailabilityConstraints {\n /**\n * The booking policy.\n * @readonly\n */\n bookingPolicy?: BookingPolicy$1;\n /**\n * The service schedule, including the schedule id and availability constraints.\n * @readonly\n */\n schedule?: V2Schedule;\n /**\n * The locations this service is offered at.\n * Only multiple locations of type `BUSINESS` are supported. multiple locations of type `CUSTOM` or `CUSTOMER` are not supported.\n * For courses only: Currently, only 1 location is supported, for all location types.\n * Use `setServiceLocations` method to change the locations this service is offered at.\n * @readonly\n */\n locations?: V2Location[];\n /** @readonly */\n resourceGroups?: ResourceGroup[];\n /**\n * Resource groups required to book the service\n * @readonly\n */\n serviceResources?: ServiceResource[];\n /**\n * The time between available slots' start times.\n * For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc.\n * Is applied to all schedules of the site.\n * For appointment only.\n * @readonly\n */\n slotsSplitInterval?: V1SplitInterval;\n /**\n * Online booking settings.\n * @readonly\n */\n onlineBooking?: OnlineBooking;\n }\n /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */\n interface V1SplitInterval {\n /**\n * Whether the slot duration is used as the split interval value.\n * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.\n */\n sameAsDuration?: boolean | null;\n /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */\n valueInMinutes?: number | null;\n }\n interface UpdateServiceRequest {\n /** Service to update. [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported. */\n service: Service$1;\n }\n interface UpdateServiceResponse {\n /** The updated service. */\n service?: Service$1;\n }\n interface BulkUpdateServicesRequest {\n /** Services to update. */\n services?: MaskedService[];\n /** `true` if the updated entities must be included in the response, otherwise no entities are included in the response. */\n returnEntity?: boolean;\n }\n interface MaskedService {\n /** Service to update. [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported. */\n service?: Service$1;\n }\n interface BulkUpdateServicesResponse {\n /** The result of each service update. */\n results?: BulkServiceResult[];\n /** Update statistics. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface DeleteServiceRequest {\n /** ID of the service to delete. */\n serviceId: string;\n /**\n * Whether to preserve future sessions with participants.\n *\n * Default: `false`\n */\n preserveFutureSessionsWithParticipants?: boolean;\n /** Whether to notify participants about the change and an optional custom message. */\n participantNotification?: V2ParticipantNotification;\n }\n interface V2ParticipantNotification {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean | null;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface DeleteServiceResponse {\n }\n interface BulkDeleteServicesRequest {\n ids: string[];\n preserveFutureSessionsWithParticipants?: boolean;\n /**\n * Whether to preserve future sessions with participants.\n *\n * Default: `false`.\n */\n participantNotification?: V2ParticipantNotification;\n }\n interface BulkDeleteServicesResponse {\n /** The result of each service removal. */\n results?: BulkServiceResult[];\n /** Update statistics. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface QueryServicesRequest {\n /** WQL expression. */\n query: QueryV2$2;\n }\n interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`\n *\n * Read more about [supported fields and operators](https://dev.wix.com/api/rest/wix-bookings/services-v2/filtering-and-sorting).\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[ {\"fieldName\":\"sortField1\",\"order\":\"ASC\"},\n * {\"fieldName\":\"sortField2\",\"order\":\"DESC\"} ]`\n *\n * Read more about [sorting](https://dev.wix.com/api/rest/wix-bookings/services-v2/filtering-and-sorting#wix-bookings_services-v2_filtering-and-sorting_sorting).\n */\n sort?: Sorting$2[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$2 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryServicesResponse {\n /** The retrieved services. */\n services?: Service$1[];\n /** Paging metadata, including offset and count. */\n pagingMetadata?: PagingMetadataV2$2;\n }\n interface PagingMetadataV2$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$2;\n }\n interface Cursors$2 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface SearchServicesRequest {\n search: CursorSearch;\n }\n interface CursorSearch extends CursorSearchPagingMethodOneOf {\n /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */\n cursorPaging?: CursorPaging$2;\n /** A filter object. See documentation [here](https:// bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */\n filter?: Record | null;\n /** Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}] */\n sort?: Sorting$2[];\n /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */\n aggregations?: Aggregation[];\n /** Free text to match in searchable fields */\n search?: SearchDetails;\n }\n /** @oneof */\n interface CursorSearchPagingMethodOneOf {\n /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */\n cursorPaging?: CursorPaging$2;\n }\n interface Aggregation extends AggregationKindOneOf {\n value?: ValueAggregation;\n range?: RangeAggregation;\n scalar?: ScalarAggregation;\n dateHistogram?: DateHistogramAggregation;\n nested?: NestedAggregation;\n name?: string | null;\n type?: AggregationType;\n fieldPath?: string;\n groupBy?: GroupByAggregation;\n }\n /** @oneof */\n interface AggregationKindOneOf {\n value?: ValueAggregation;\n range?: RangeAggregation;\n scalar?: ScalarAggregation;\n dateHistogram?: DateHistogramAggregation;\n nested?: NestedAggregation;\n }\n interface RangeBucket {\n /** Inclusive lower bound of the range. Required if to is not given. */\n from?: number | null;\n /** Exclusive upper bound of the range. Required if from is not given. */\n to?: number | null;\n }\n enum SortType {\n COUNT = \"COUNT\",\n VALUE = \"VALUE\"\n }\n enum SortDirection {\n DESC = \"DESC\",\n ASC = \"ASC\"\n }\n enum MissingValues {\n EXCLUDE = \"EXCLUDE\",\n INCLUDE = \"INCLUDE\"\n }\n interface IncludeMissingValuesOptions {\n /** can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ... */\n addToBucket?: string;\n }\n enum ScalarType {\n UNKNOWN_SCALAR_TYPE = \"UNKNOWN_SCALAR_TYPE\",\n COUNT_DISTINCT = \"COUNT_DISTINCT\",\n MIN = \"MIN\",\n MAX = \"MAX\",\n SUM = \"SUM\",\n AVG = \"AVG\"\n }\n interface ValueAggregation extends ValueAggregationOptionsOneOf {\n /** options for including missing values */\n includeOptions?: IncludeMissingValuesOptions;\n sortType?: SortType;\n sortDirection?: SortDirection;\n /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */\n limit?: number | null;\n /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */\n missingValues?: MissingValues;\n }\n /** @oneof */\n interface ValueAggregationOptionsOneOf {\n /** options for including missing values */\n includeOptions?: IncludeMissingValuesOptions;\n }\n enum NestedAggregationType {\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n VALUE = \"VALUE\",\n RANGE = \"RANGE\",\n SCALAR = \"SCALAR\",\n DATE_HISTOGRAM = \"DATE_HISTOGRAM\"\n }\n interface RangeAggregation {\n /** Range buckets */\n buckets?: RangeBucket[];\n }\n interface ScalarAggregation {\n type?: ScalarType;\n }\n interface DateHistogramAggregation {\n interval?: DateHistogramAggregationInterval;\n }\n enum DateHistogramAggregationInterval {\n UNKNOWN_INTERVAL = \"UNKNOWN_INTERVAL\",\n YEAR = \"YEAR\",\n MONTH = \"MONTH\",\n WEEK = \"WEEK\",\n DAY = \"DAY\",\n HOUR = \"HOUR\",\n MINUTE = \"MINUTE\",\n SECOND = \"SECOND\"\n }\n interface NestedAggregationItem extends NestedAggregationItemKindOneOf {\n value?: ValueAggregation;\n range?: RangeAggregation;\n scalar?: ScalarAggregation;\n dateHistogram?: DateHistogramAggregation;\n name?: string | null;\n type?: NestedAggregationType;\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationItemKindOneOf {\n value?: ValueAggregation;\n range?: RangeAggregation;\n scalar?: ScalarAggregation;\n dateHistogram?: DateHistogramAggregation;\n }\n enum AggregationType {\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n VALUE = \"VALUE\",\n RANGE = \"RANGE\",\n SCALAR = \"SCALAR\",\n DATE_HISTOGRAM = \"DATE_HISTOGRAM\",\n NESTED = \"NESTED\"\n }\n /** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */\n interface NestedAggregation {\n nestedAggregations?: NestedAggregationItem[];\n }\n interface GroupByAggregation extends GroupByAggregationKindOneOf {\n value?: ValueAggregation;\n name?: string | null;\n fieldPath?: string;\n }\n /** @oneof */\n interface GroupByAggregationKindOneOf {\n value?: ValueAggregation;\n }\n interface SearchDetails {\n /** Boolean search mode */\n mode?: Mode;\n /** Search term or expression */\n expression?: string | null;\n /** Fields to search in. If empty - server will search in own default fields */\n fields?: string[];\n /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */\n fuzzy?: boolean;\n }\n enum Mode {\n /** Any */\n OR = \"OR\",\n /** All */\n AND = \"AND\"\n }\n interface SearchServicesResponse {\n /** The retrieved services. */\n services?: Service$1[];\n /** Cursor paging metadata */\n pagingMetadata?: CursorPagingMetadata$1;\n /** Response aggregation data */\n aggregationData?: AggregationData;\n }\n interface CursorPagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */\n cursors?: Cursors$2;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface AggregationData {\n /** key = aggregation name (as derived from search request) */\n results?: AggregationResults[];\n }\n interface ValueAggregationResult {\n value?: string;\n count?: number;\n }\n interface RangeAggregationResult {\n from?: number | null;\n to?: number | null;\n count?: number;\n }\n interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: AggregationResultsScalarResult;\n name?: string;\n type?: AggregationType;\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: AggregationResultsScalarResult;\n }\n interface ValueResults {\n results?: ValueAggregationResult[];\n }\n interface RangeResults {\n results?: RangeAggregationResult[];\n }\n interface AggregationResultsScalarResult {\n type?: ScalarType;\n value?: number;\n }\n interface NestedValueAggregationResult {\n value?: string;\n nestedResults?: NestedAggregationResults;\n }\n interface ValueResult {\n value?: string;\n count?: number | null;\n }\n interface RangeResult {\n from?: number | null;\n to?: number | null;\n count?: number | null;\n }\n interface ScalarResult {\n value?: number;\n }\n interface NestedResultValue extends NestedResultValueResultOneOf {\n value?: ValueResult;\n range?: RangeResult;\n scalar?: ScalarResult;\n dateHistogram?: ValueResult;\n }\n /** @oneof */\n interface NestedResultValueResultOneOf {\n value?: ValueResult;\n range?: RangeResult;\n scalar?: ScalarResult;\n dateHistogram?: ValueResult;\n }\n interface Results {\n results?: Record;\n }\n interface DateHistogramResult {\n value?: string;\n count?: number;\n }\n interface GroupByValueResults {\n results?: NestedValueAggregationResult[];\n }\n interface DateHistogramResults {\n results?: DateHistogramResult[];\n }\n /**\n * results of `NESTED` aggregation type in a flattened form\n * aggregations in resulting array are keyed by requested aggregation `name`.\n */\n interface NestedResults {\n results?: Results[];\n }\n interface AggregationResults extends AggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: AggregationResultsScalarResult;\n groupedByValue?: GroupByValueResults;\n dateHistogram?: DateHistogramResults;\n nested?: NestedResults;\n name?: string;\n type?: AggregationType;\n fieldPath?: string;\n }\n /** @oneof */\n interface AggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: AggregationResultsScalarResult;\n groupedByValue?: GroupByValueResults;\n dateHistogram?: DateHistogramResults;\n nested?: NestedResults;\n }\n interface QueryPoliciesRequest {\n /** WQL expression. */\n query: CursorQuery;\n }\n interface CursorQuery extends CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$2[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n }\n interface QueryPoliciesResponse {\n /** The retrieved policies. */\n bookingPolicies?: BookingPolicyWithServices[];\n /** Paging metadata, including offset and count. */\n pagingMetadata?: CursorPagingMetadata$1;\n }\n interface BookingPolicyWithServices {\n /** The booking policy. */\n bookingPolicy?: BookingPolicy$1;\n /** The services associated with the booking policy. Up to 5 services are returned per policy. */\n services?: Service$1[];\n /** Whether there are more services associated with the booking policy. */\n hasMoreServices?: boolean | null;\n /** The number of services associated with the booking policy. */\n countOfServices?: number;\n }\n interface CountServicesRequest {\n /** The filters for performing the count. */\n filter?: Record | null;\n }\n interface CountServicesResponse {\n /** The number of services matching the given filter. */\n count?: number;\n }\n /** An event sent every time a category entity is changed. */\n interface CategoryNotification {\n category?: Category;\n event?: CategoryNotificationEvent;\n }\n /** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */\n interface Category {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string | null;\n /** Category name. */\n name?: string | null;\n /**\n * Category status.\n * Supported values:\n * - \"CREATED\". The category is created.\n * - \"DELETED\". The category is deleted.\n * Default: \"CREATED\"\n * @readonly\n */\n status?: CategoryStatus;\n /** Sort order of the category in the Dashboard. */\n sortOrder?: number | null;\n }\n enum CategoryStatus {\n /** Default status. */\n CREATED = \"CREATED\",\n /** Category is deleted. */\n DELETED = \"DELETED\"\n }\n enum CategoryNotificationEvent {\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\"\n }\n interface Empty$2 {\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$2 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$2 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface ScheduleNotification$2 extends ScheduleNotificationEventOneOf$2 {\n scheduleCreated?: ScheduleCreated$2;\n scheduleUpdated?: ScheduleUpdated$2;\n scheduleCancelled?: ScheduleCancelled$2;\n sessionCreated?: SessionCreated$2;\n sessionUpdated?: SessionUpdated$2;\n sessionCancelled?: SessionCancelled$2;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated$2;\n intervalSplit?: IntervalSplit$2;\n recurringSessionSplit?: RecurringSessionSplit$2;\n /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$2;\n preserveFutureSessionsWithParticipants?: boolean | null;\n /** Whether to notify participants about changed sessions. deprecated, use participant_notification */\n notifyParticipants?: boolean;\n /** site properties. Optional. Given in create schedule notification. */\n siteProperties?: SitePropertiesOnScheduleCreation$2;\n instanceId?: string;\n }\n /** @oneof */\n interface ScheduleNotificationEventOneOf$2 {\n scheduleCreated?: ScheduleCreated$2;\n scheduleUpdated?: ScheduleUpdated$2;\n scheduleCancelled?: ScheduleCancelled$2;\n sessionCreated?: SessionCreated$2;\n sessionUpdated?: SessionUpdated$2;\n sessionCancelled?: SessionCancelled$2;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated$2;\n intervalSplit?: IntervalSplit$2;\n recurringSessionSplit?: RecurringSessionSplit$2;\n /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$2;\n }\n interface ScheduleCreated$2 {\n schedule?: Schedule$2;\n }\n interface Schedule$2 {\n /** Schedule ID. */\n _id?: string;\n /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */\n scheduleOwnerId?: string | null;\n /**\n * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.\n * Derived from the Wix Business time zone.\n * @readonly\n */\n timeZone?: string | null;\n /** Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead. */\n intervals?: RecurringInterval$2[];\n /** Default title for the schedule's sessions. Maximum length: 6000 characters. */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.\n * The Wix Bookings app uses the following predefined tags to set schedule type: `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE\"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.\n */\n tags?: string[] | null;\n /** Default location for the schedule's sessions. */\n location?: Location$3;\n /**\n * Maximum number of participants that can be added to the schedule's sessions.\n * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate$2;\n /** __Deprecated.__ */\n availability?: Availability$2;\n /**\n * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** of participants which are registered to sessions in this schedule.\n * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.\n * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n * @readonly\n */\n participants?: Participant$2[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides$2;\n /**\n * Schedule status.\n * @readonly\n */\n status?: ScheduleStatus$2;\n /**\n * Schedule creation date.\n * @readonly\n */\n created?: Date;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * Fields which were inherited from the Business Info page under Settings in the Dashboard.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n conferenceProvider?: ConferenceProvider$2;\n /**\n * A conference created for the schedule. This is used when a participant is added to a schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference$2;\n }\n interface RecurringInterval$2 {\n /**\n * The recurring interval identifier.\n * @readonly\n */\n _id?: string;\n /** The start time of the recurring interval. Required. */\n start?: Date;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date;\n /** The interval rules. The day, hour and minutes the interval is recurring. */\n interval?: Interval$2;\n /** The frequency of the interval. Optional. The default is frequency with the default repetition. */\n frequency?: Frequency$2;\n /** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */\n affectedSchedules?: LinkedSchedule$2[];\n /**\n * The type of recurring interval.\n * \n */\n intervalType?: RecurringIntervalType$2;\n }\n interface Interval$2 {\n /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */\n daysOfWeek?: Day$2;\n /** The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23. */\n hourOfDay?: number | null;\n /** The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59. */\n minuteOfHour?: number | null;\n /** The duration of the interval in minutes. Required. Part of the session end time calculation. */\n duration?: number;\n }\n enum Day$2 {\n /** Undefined. */\n UNDEFINED = \"UNDEFINED\",\n /** Monday. */\n MON = \"MON\",\n /** Tuesday. */\n TUE = \"TUE\",\n /** Wednesday. */\n WED = \"WED\",\n /** Thursday. */\n THU = \"THU\",\n /** Friday. */\n FRI = \"FRI\",\n /** Saturday. */\n SAT = \"SAT\",\n /** Sunday. */\n SUN = \"SUN\"\n }\n interface Frequency$2 {\n /** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */\n repetition?: number | null;\n }\n interface LinkedSchedule$2 {\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `\"BUSY\"`.\n * \n * If set to `\"BUSY\"`, this schedule cannot have any available slots during the linked schedule's sessions.\n * If set to `\"FREE\"`, this schedule can have available slots during the linked schedule's sessions.\n * \n *\n * \n */\n transparency?: Transparency$2;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n }\n enum Transparency$2 {\n UNDEFINED = \"UNDEFINED\",\n /** The schedule can have available slots during the session. */\n FREE = \"FREE\",\n /** The schedule cannot have available slots during the session. Default value. */\n BUSY = \"BUSY\"\n }\n enum RecurringIntervalType$2 {\n /** The default value. Sessions for this interval will be of type EVENT. */\n UNDEFINED = \"UNDEFINED\",\n /** A recurring interval of events */\n EVENT = \"EVENT\",\n /** Deprecated */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** A recurring interval for availability */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface Location$3 {\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: LocationType$3;\n /** Free text address used when locationType is `OWNER_CUSTOM`. */\n address?: string | null;\n /** Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default. */\n customAddress?: Address$2;\n }\n enum LocationType$3 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface Address$2 extends AddressStreetOneOf$2 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$2;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$2;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$2[];\n }\n /** @oneof */\n interface AddressStreetOneOf$2 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$2;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$2 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$2 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$2 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface LocationsLocation$2 {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status. `INACTIVE` is currently not supported.\n */\n status?: LocationStatus$2;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n */\n locationType?: LocationsLocationType$2;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: LocationsAddress$2;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$2;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationsLocationType$2[];\n }\n /** For future use */\n enum LocationStatus$2 {\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n /** For future use */\n enum LocationsLocationType$2 {\n UNKNOWN = \"UNKNOWN\",\n BRANCH = \"BRANCH\",\n OFFICES = \"OFFICES\",\n RECEPTION = \"RECEPTION\",\n HEADQUARTERS = \"HEADQUARTERS\",\n INVENTORY = \"INVENTORY\"\n }\n interface LocationsAddress$2 {\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n streetAddress?: LocationsStreetAddress$2;\n /** Full address of the location. */\n formatted?: string | null;\n /** Geographic coordinates of location. */\n location?: LocationsAddressLocation$2;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface LocationsStreetAddress$2 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n /** Address Geolocation */\n interface LocationsAddressLocation$2 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number | null;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number | null;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$2 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$2[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$2[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$2 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$2;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$2;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$2 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$2 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Rate$2 {\n /**\n * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n labeledPriceOptions?: Record;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n priceText?: string | null;\n }\n interface Price$2 {\n /** Required payment amount. */\n amount?: string;\n /** Currency in which the amount is quoted. */\n currency?: string;\n /** Amount of a down payment or deposit as part of the transaction. */\n downPayAmount?: string;\n }\n /**\n * \n */\n interface Availability$2 {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date;\n /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */\n linkedSchedules?: LinkedSchedule$2[];\n /** Constraints for calculating the schedule's availability. */\n constraints?: AvailabilityConstraints$2;\n }\n /** Describes how to calculate the specific slots that are available for booking. */\n interface AvailabilityConstraints$2 {\n /**\n * A list of duration options for slots, in minutes. Minimum value for a duration is 1.\n * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.\n */\n slotDurations?: number[];\n /**\n * The number of minutes between the `end` of one slot, and the `start` of the next.\n * Minimum value is 0, maximum value is 120.\n */\n timeBetweenSlots?: number;\n /**\n * Specify how to split the slots in intervals of minutes.\n * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).\n * Optional. The default is the first duration in slot_durations field.\n * Deprecated. Use the `split_slots_interval.value_in_minutes`.\n */\n splitInterval?: number | null;\n /**\n * An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.\n * @readonly\n */\n slotsSplitInterval?: SplitInterval$2;\n }\n /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */\n interface SplitInterval$2 {\n /**\n * Whether the slot duration is used as the split interval value.\n * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.\n */\n sameAsDuration?: boolean | null;\n /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */\n valueInMinutes?: number | null;\n }\n interface Participant$2 {\n /** Participant ID. Currently represents the booking.id. */\n _id?: string;\n /** Contact ID. */\n contactId?: string | null;\n /** Participant's name. */\n name?: string | null;\n /** Participant's phone number. */\n phone?: string | null;\n /** Participant's email address. */\n email?: string | null;\n /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */\n partySize?: number;\n /**\n * Approval status for the participant.\n * \n * \n */\n approvalStatus?: ApprovalStatus$2;\n /**\n * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.\n * @readonly\n */\n inherited?: boolean;\n }\n enum ApprovalStatus$2 {\n /** Default. */\n UNDEFINED = \"UNDEFINED\",\n /** Pending business approval. */\n PENDING = \"PENDING\",\n /** Approved by the business. */\n APPROVED = \"APPROVED\",\n /** Declined by the business. */\n DECLINED = \"DECLINED\"\n }\n interface ExternalCalendarOverrides$2 {\n /** Synced title of the external calendar event. */\n title?: string | null;\n /** Synced description of the external calendar event. */\n description?: string | null;\n }\n enum ScheduleStatus$2 {\n UNDEFINED = \"UNDEFINED\",\n /** The default value when the schedule is created. */\n CREATED = \"CREATED\",\n /** The schedule has been canceled. */\n CANCELLED = \"CANCELLED\"\n }\n interface Version$2 {\n /** Schedule version number, updated each time the schedule is updated. */\n scheduleVersion?: number | null;\n /** Participants version number, updated each time the schedule participants are updated. */\n participantsVersion?: number | null;\n }\n interface ConferenceProvider$2 {\n /** Conferencing provider ID */\n providerId?: string;\n }\n interface CalendarConference$2 {\n /** Wix Calendar conference ID. */\n _id?: string;\n /** Conference meeting ID in the provider's conferencing system. */\n externalId?: string;\n /** Conference provider ID. */\n providerId?: string;\n /** URL used by the host to start the conference. */\n hostUrl?: string;\n /** URL used by a guest to join the conference. */\n guestUrl?: string;\n /** Password to join the conference. */\n password?: string | null;\n /** Conference description. */\n description?: string | null;\n /**\n * Conference type.\n * \n */\n conferenceType?: ConferenceType$2;\n /** ID of the account owner in the video conferencing service. */\n accountOwnerId?: string | null;\n }\n enum ConferenceType$2 {\n UNDEFINED = \"UNDEFINED\",\n /** API-generated online meeting. */\n ONLINE_MEETING_PROVIDER = \"ONLINE_MEETING_PROVIDER\",\n /** User-defined meeting. */\n CUSTOM = \"CUSTOM\"\n }\n interface ScheduleUpdated$2 {\n /** The old schedule before the update. */\n oldSchedule?: Schedule$2;\n /** The new schedule after the update. */\n newSchedule?: Schedule$2;\n /**\n * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was\n * updating at least one of the given schedule's recurring sessions.\n * This event is triggered by create/update/delete recurring session apis.\n */\n recurringSessions?: RecurringSessionsUpdated$2;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$2;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface RecurringSessionsUpdated$2 {\n /** Old schedule's recurring session list. */\n oldRecurringSessions?: Session$2[];\n /** New schedule's recurring session list. */\n newRecurringSessions?: Session$2[];\n }\n interface Session$2 {\n /**\n * Session ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the schedule that the session belongs to. */\n scheduleId?: string;\n /**\n * ID of the resource or service that the session's schedule belongs to.\n * @readonly\n */\n scheduleOwnerId?: string | null;\n /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */\n originalStart?: Date;\n /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */\n start?: CalendarDateTime$2;\n /**\n * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.\n * If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end?: CalendarDateTime$2;\n /**\n * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.\n * The array is inherited from the schedule and can be overridden even if the session is a recurring session.\n */\n affectedSchedules?: LinkedSchedule$2[];\n /**\n * Session title.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags?: string[] | null;\n /**\n * An object describing the location where the session takes place.\n * Defaults to the schedule location.\n * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.\n */\n location?: Location$3;\n /**\n * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate$2;\n /**\n * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.\n * If the session is a recurring session, this field must be empty.\n */\n timeReservedAfter?: number | null;\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * The number of participants booked for the session. Read-only.\n * Calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** list of participants booked for the session.\n * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.\n * If the session is a recurring session, this field must be empty.\n * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n */\n participants?: Participant$2[];\n /**\n * A list of properties for which values were inherited from the schedule.\n * This does not include participants that were inherited from the schedule.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides$2;\n /**\n * Session status.\n * \n * @readonly\n */\n status?: Status$2;\n /**\n * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.\n * For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.\n * This field is omitted for single sessions or instances of recurring sessions.\n * Specified when the session was originally generated from a schedule recurring interval.\n * Deprecated. Use `recurringSessionId`.\n * @readonly\n */\n recurringIntervalId?: string | null;\n /**\n * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.\n * @readonly\n */\n recurringSessionId?: string | null;\n /**\n * Session type.\n * \n */\n type?: SessionType$2;\n /**\n * A conference created for the session according to the details set in the schedule's conference provider information.\n * If the session is a recurring session, this field is inherited from the schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference$2;\n /**\n * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n * \n */\n recurrence?: string | null;\n /**\n * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\n * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.\n * @readonly\n */\n instanceOfRecurrence?: string | null;\n /**\n * The session version.\n * Composed by the schedule, session and participants versions.\n * @readonly\n */\n version?: SessionVersion$2;\n }\n interface CalendarDateTime$2 {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.\n */\n timestamp?: Date;\n /** An object containing the local date and time for the business's time zone. */\n localDateTime?: LocalDateTime$2;\n /**\n * The time zone. Optional. Derived from the schedule's time zone.\n * In case this field is associated with recurring session, this field is empty.\n * @readonly\n */\n timeZone?: string | null;\n }\n interface LocalDateTime$2 {\n /** Year. 4-digit format. */\n year?: number | null;\n /** Month number, from 1-12. */\n monthOfYear?: number | null;\n /** Day of the month, from 1-31. */\n dayOfMonth?: number | null;\n /** Hour of the day in 24-hour format, from 0-23. */\n hourOfDay?: number | null;\n /** Minute, from 0-59. */\n minutesOfHour?: number | null;\n }\n interface ExternalCalendarInfo$2 {\n /** The external calendar type (e.g. Google Calendar, iCal, etc). */\n calendarType?: CalendarType$2;\n }\n enum CalendarType$2 {\n UNDEFINED = \"UNDEFINED\",\n GOOGLE = \"GOOGLE\",\n I_CAL = \"I_CAL\",\n /** Use `MICROSOFT` instead. */\n OUTLOOK = \"OUTLOOK\",\n /** Use `MICROSOFT` instead. */\n OFFICE_365 = \"OFFICE_365\",\n MICROSOFT = \"MICROSOFT\",\n OTHER = \"OTHER\"\n }\n enum Status$2 {\n UNDEFINED = \"UNDEFINED\",\n /** The session is confirmed. Default status. */\n CONFIRMED = \"CONFIRMED\",\n /**\n * The session is cancelled.\n * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.\n * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.\n */\n CANCELLED = \"CANCELLED\"\n }\n enum SessionType$2 {\n UNDEFINED = \"UNDEFINED\",\n /**\n * The session creates an event on the calendar for the owner of the schedule that the session belongs to.\n * Default type.\n */\n EVENT = \"EVENT\",\n /** The session represents a resource's available working hours. */\n WORKING_HOURS = \"WORKING_HOURS\",\n /** Deprecated. please use WORKING_HOURS */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface SessionVersion$2 {\n /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */\n number?: string | null;\n }\n interface ParticipantNotification$2 {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface ScheduleCancelled$2 {\n schedule?: Schedule$2;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$2;\n oldSchedule?: Schedule$2;\n }\n interface SessionCreated$2 {\n session?: Session$2;\n }\n interface SessionUpdated$2 {\n oldSession?: Session$2;\n newSession?: Session$2;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$2;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface SessionCancelled$2 {\n session?: Session$2;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$2;\n }\n interface AvailabilityPolicyUpdated$2 {\n availabilityPolicy?: AvailabilityPolicy$2;\n }\n /** Availability policy applied to all site schedules. */\n interface AvailabilityPolicy$2 {\n /** Specify how to split the schedule slots in intervals of minutes. */\n splitInterval?: SplitInterval$2;\n }\n interface IntervalSplit$2 {\n scheduleId?: string;\n intervals?: RecurringInterval$2[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n interface RecurringSessionSplit$2 {\n scheduleId?: string;\n recurringSessions?: Session$2[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n /** Schedule unassigned from user. */\n interface ScheduleUnassignedFromUser$2 {\n /** The Wix user id. */\n userId?: string | null;\n /** The schedule that was unassigned from the user. */\n schedule?: Schedule$2;\n }\n interface MultipleSessionsCreated$2 {\n schedulesWithSessions?: ScheduleWithSessions$2[];\n }\n interface ScheduleWithSessions$2 {\n schedule?: Schedule$2;\n siteProperties?: SitePropertiesOnScheduleCreation$2;\n sessions?: Session$2[];\n }\n interface SitePropertiesOnScheduleCreation$2 {\n /** The global time zone value. */\n timeZone?: string | null;\n }\n interface MigrationEvent$2 {\n migrationData?: MigrationData$2;\n }\n interface MigrationData$2 {\n businessId?: string | null;\n staffs?: StaffData$2[];\n }\n interface StaffData$2 {\n resourceId?: string;\n syncRequestEmail?: string;\n refreshToken?: string;\n }\n interface ResourceNotification$1 {\n /**\n * Updated resource entity.\n * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.\n */\n resource?: Resource$1;\n /** Event type. */\n event?: ResourceNotificationEvent;\n }\n interface Resource$1 {\n /**\n * Resource ID.\n * @readonly\n */\n _id?: string | null;\n /** Resource name. */\n name?: string | null;\n /** Resource email address. */\n email?: string | null;\n /** Resource phone number. */\n phone?: string | null;\n /** Resource description. */\n description?: string | null;\n /** Deprecated. Please use tags. */\n tag?: string | null;\n /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */\n tags?: string[] | null;\n /** Resource images. */\n images?: string[];\n /** Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1. */\n schedules?: Schedule$2[];\n /**\n * List of IDs of schedules owned by this resource.\n * @readonly\n */\n scheduleIds?: string[] | null;\n /**\n * Resource status.\n * \n * @readonly\n */\n status?: ResourceStatus$1;\n /**\n * Wix user ID, if the resource is associated with the Wix user.\n * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.\n * \n * @readonly\n */\n wixUserId?: string | null;\n }\n enum ResourceStatus$1 {\n UNDEFINED = \"UNDEFINED\",\n /** Default status. */\n CREATED = \"CREATED\",\n /** The resource was deleted. */\n DELETED = \"DELETED\",\n /** The resource was updated. */\n UPDATED = \"UPDATED\"\n }\n interface BusinessLocation$1 {\n /** The ID of the business location. Has to be non-empty */\n locationId?: string;\n }\n enum ResourceNotificationEvent {\n UNDEFINED = \"UNDEFINED\",\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\",\n Schedule_Updated = \"Schedule_Updated\"\n }\n interface BenefitNotification {\n /** Plan unique ID */\n planId?: string;\n /** App def ID */\n appDefId?: string;\n /** Current benefit details */\n benefit?: Benefit;\n /** Previous benefit */\n prevBenefit?: Benefit;\n /** Notification event */\n event?: Event$1;\n }\n interface Benefit {\n /**\n * Benefit unique ID\n * @readonly\n */\n _id?: string | null;\n /** Benefit Type */\n benefitType?: BenefitType;\n /** Resource IDs that serves by this benefit */\n resourceIds?: string[];\n /** Amount of credits that provided by this benefit */\n creditAmount?: number | null;\n /** additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value */\n customFields?: Record;\n /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */\n editable?: boolean | null;\n /** Benefit behavior */\n behavior?: Behavior;\n /**\n * Id of the app associated with this benefit\n * @readonly\n */\n appDefId?: string | null;\n }\n interface EntryPass {\n }\n interface Discount extends DiscountDiscountOneOf {\n /** Fixed-rate percent off discount */\n percentOffRate?: string;\n /** Absolute amount discount */\n moneyOffAmount?: string;\n }\n /** @oneof */\n interface DiscountDiscountOneOf {\n /** Fixed-rate percent off discount */\n percentOffRate?: string;\n /** Absolute amount discount */\n moneyOffAmount?: string;\n }\n enum BenefitType {\n /** Should never be used */\n UNDEFINED = \"UNDEFINED\",\n /** Limited benefit type */\n LIMITED = \"LIMITED\",\n /** Unlimited benefit type */\n UNLIMITED = \"UNLIMITED\"\n }\n interface Behavior extends BehaviorBehaviorOneOf {\n /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */\n defaultBehavior?: EntryPass;\n /** Discount applied to paid resources */\n discount?: Discount;\n }\n /** @oneof */\n interface BehaviorBehaviorOneOf {\n /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */\n defaultBehavior?: EntryPass;\n /** Discount applied to paid resources */\n discount?: Discount;\n }\n enum Event$1 {\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\"\n }\n interface UserDomainInfoChangedEvent {\n domainName?: string;\n crudType?: CrudType;\n metaSiteId?: string | null;\n changeTime?: Date;\n }\n enum CrudType {\n INVALID_CRUD_TYPE = \"INVALID_CRUD_TYPE\",\n CREATE = \"CREATE\",\n UPDATE = \"UPDATE\",\n DELETE = \"DELETE\",\n /** Unfortunately this action is used by hibernate save in wix-war */\n CREATE_OR_UPDATE = \"CREATE_OR_UPDATE\"\n }\n interface HtmlSitePublished {\n /** Application instance ID */\n appInstanceId?: string;\n /** Application type */\n appType?: string;\n /** Revision */\n revision?: string;\n /** MSID */\n metaSiteId?: string | null;\n /** optional branch id if publish is done from branch */\n branchId?: string | null;\n /** The site's last transactionId */\n lastTransactionId?: string | null;\n /** A list of the site's pages */\n pages?: Page[];\n /** Site's publish date */\n publishDate?: string;\n }\n interface Page {\n /** Page's Id */\n _id?: string;\n }\n /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */\n interface SitePropertiesNotification$1 {\n /** The site ID for which this update notification applies. */\n metasiteId?: string;\n /** The actual update event. */\n event?: SitePropertiesEvent$1;\n /** A convenience set of mappings from the MetaSite ID to its constituent services. */\n translations?: Translation$1[];\n /** Context of the notification */\n changeContext?: ChangeContext$1;\n }\n /** The actual update event for a particular notification. */\n interface SitePropertiesEvent$1 {\n /** Version of the site's properties represented by this update. */\n version?: number;\n /** Updated properties. */\n properties?: Properties$1;\n }\n interface Properties$1 {\n /** Site categories. */\n categories?: Categories$1;\n /** Site locale. */\n locale?: Locale$1;\n /**\n * Site language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Site currency format used to bill customers.\n *\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n paymentCurrency?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Fax number. */\n fax?: string | null;\n /** Address. */\n address?: V4Address$1;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n /**\n * Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$2;\n /** Supported languages of a site and the primary language. */\n multilingual?: Multilingual$1;\n /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */\n consentPolicy?: ConsentPolicy$1;\n /**\n * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n *\n * Site business type.\n */\n businessConfig?: string | null;\n /** External site url that uses Wix as its headless business solution */\n externalSiteUrl?: string | null;\n /** Track clicks analytics */\n trackClicksAnalytics?: boolean;\n }\n interface Categories$1 {\n /** Primary site category. */\n primary?: string;\n /** Secondary site category. */\n secondary?: string[];\n /** Business Term Id */\n businessTermId?: string | null;\n }\n interface Locale$1 {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string;\n }\n interface V4Address$1 {\n /** Street name. */\n street?: string;\n /** City name. */\n city?: string;\n /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string;\n /** State. */\n state?: string;\n /** Zip or postal code. */\n zip?: string;\n /** Extra information to be displayed in the address. */\n hint?: AddressHint$1;\n /** Whether this address represents a physical location. */\n isPhysical?: boolean;\n /** Google-formatted version of this address. */\n googleFormattedAddress?: string;\n /** Street number. */\n streetNumber?: string;\n /** Apartment number. */\n apartmentNumber?: string;\n /** Geographic coordinates of location. */\n coordinates?: GeoCoordinates$1;\n }\n /**\n * Extra information on displayed addresses.\n * This is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\n * Free text. In addition the user can state where he wants that additional description - before, after, or instead\n * the address string.\n */\n interface AddressHint$1 {\n /** Extra text displayed next to, or instead of, the actual address. */\n text?: string;\n /** Where the extra text should be displayed. */\n placement?: PlacementType$1;\n }\n /** Where the extra text should be displayed: before, after or instead of the actual address. */\n enum PlacementType$1 {\n BEFORE = \"BEFORE\",\n AFTER = \"AFTER\",\n REPLACE = \"REPLACE\"\n }\n /** Geocoordinates for a particular address. */\n interface GeoCoordinates$1 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number;\n }\n interface Multilingual$1 {\n /** Supported languages list. */\n supportedLanguages?: SupportedLanguage$1[];\n /** Whether to redirect to user language. */\n autoRedirect?: boolean;\n }\n interface SupportedLanguage$1 {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Locale. */\n locale?: Locale$1;\n /** Whether the supported language is the primary language for the site. */\n isPrimary?: boolean;\n /** Language icon. */\n countryCode?: string;\n /** How the language will be resolved. For internal use. */\n resolutionMethod?: ResolutionMethod$1;\n }\n enum ResolutionMethod$1 {\n QUERY_PARAM = \"QUERY_PARAM\",\n SUBDOMAIN = \"SUBDOMAIN\",\n SUBDIRECTORY = \"SUBDIRECTORY\"\n }\n interface ConsentPolicy$1 {\n /** Whether the site uses cookies that are essential to site operation. */\n essential?: boolean | null;\n /** Whether the site uses cookies that affect site performance and other functional measurements. */\n functional?: boolean | null;\n /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */\n analytics?: boolean | null;\n /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */\n advertising?: boolean | null;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean | null;\n }\n /** A single mapping from the MetaSite ID to a particular service. */\n interface Translation$1 {\n /** The service type. */\n serviceType?: string;\n /** The application definition ID; this only applies to services of type ThirdPartyApps. */\n appDefId?: string;\n /** The instance ID of the service. */\n instanceId?: string;\n }\n interface ChangeContext$1 extends ChangeContextPayloadOneOf$1 {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange$1;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated$1;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$1;\n }\n /** @oneof */\n interface ChangeContextPayloadOneOf$1 {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange$1;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated$1;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$1;\n }\n interface PropertiesChange$1 {\n }\n interface SiteCreated$1 {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned$1 {\n /** Origin site id. */\n originMetaSiteId?: string;\n }\n interface SetServiceLocationsRequest {\n /** ID of the service. */\n serviceId: string;\n /** The locations you specify replace the existing service locations. */\n locations: V2Location[];\n /** The action to perform on sessions currently set to a removed location. For example, move existing sessions to a new specified location. */\n removedLocationSessionsAction?: RemovedLocationSessionsAction;\n /** Whether to notify participants about the change of location, and an optional custom message. */\n participantNotification?: V2ParticipantNotification;\n }\n interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {\n /** Options related to the action, such as a new location to move existing sessions to. */\n moveToLocationOptions?: MoveToNewLocationsOptions;\n /** The action to perform on sessions currently set to a removed location. For example, move existing sessions to a new specified location. */\n action?: Action;\n }\n /** @oneof */\n interface RemovedLocationSessionsActionActionOptionsOneOf {\n /** Options related to the action, such as a new location to move existing sessions to. */\n moveToLocationOptions?: MoveToNewLocationsOptions;\n }\n enum Action {\n UNKNOWN_ACTION_TYPE = \"UNKNOWN_ACTION_TYPE\",\n /**\n * Keep future sessions at their current location. This is the default.\n * Note: The location will be set directly on the session. i.e, if the location is currently inherited from the schedule, the inheritance will be overridden.\n */\n KEEP_AT_CURRENT_LOCATION = \"KEEP_AT_CURRENT_LOCATION\",\n /**\n * Move future sessions to a new location.\n * The new location must be specified in the availability locations to set ('SetAvailabilityLocationsRequest.locations').\n */\n MOVE_TO_LOCATION = \"MOVE_TO_LOCATION\",\n /**\n * Delete future sessions.\n * Currently not supported.\n */\n DELETE = \"DELETE\"\n }\n interface MoveToNewLocationsOptions {\n /** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */\n newLocation?: V2Location;\n }\n interface SetServiceLocationsResponse {\n /** The updated service with the newly set locations. */\n service?: Service$1;\n }\n interface EnablePricingPlansForServiceRequest {\n /** ID of the service to add the pricing plans to. */\n serviceId: string;\n /** IDs of the pricing plans to connect to the service. */\n pricingPlanIds: string[];\n }\n interface EnablePricingPlansForServiceResponse {\n /** IDs of the pricing plans connected to the service. */\n pricingPlanIds?: string[];\n /** The service after the pricing plans update. */\n service?: Service$1;\n }\n interface InvalidPricingPlan {\n /** The invalid pricing plan id. */\n _id?: string;\n /** The reason for the pricing plan considered as invalid */\n message?: string;\n }\n interface DisablePricingPlansForServiceRequest {\n /** ID of the service to disconnect the pricing plans from. */\n serviceId: string;\n /** ID of the pricing plans to disconnect from the service. */\n pricingPlanIds?: string[];\n }\n interface DisablePricingPlansForServiceResponse {\n /** The service after the pricing plans update. */\n service?: Service$1;\n }\n interface SetCustomSlugRequest {\n /** ID of the service to assign the custom slug to. */\n serviceId: string;\n /** The custom name to set as the active slug for the service. */\n slugName: string;\n }\n interface SetCustomSlugResponse {\n /** The new slug set as the active slug for the service. */\n slug?: Slug;\n /** The service after the custom slug update. */\n service?: Service$1;\n }\n interface ValidateSlugRequest {\n /** ID of the service to validate the slug name for. */\n serviceId: string;\n /** The custom name to validate as a slug for the service. */\n slugName: string;\n }\n interface ValidateSlugResponse {\n /** Whether the requested slug name is valid. */\n valid?: boolean;\n /** The requested custom slug name to validate. If valid, the slug name can be set as a slug for the service and is populated with the requested slug. Otherwise, `slugName` is empty. */\n slugName?: string | null;\n /** If the slug is invalid, this field is populated with the reasons why the slug is invalid. Validation errors may include `SLUG_IS_TOO_LONG`, `SLUG_CONTAIN_ILLEGAL_CHARACTERS`, and `SLUG_ALREADY_EXISTS`. */\n errors?: InvalidSlugError[];\n }\n enum InvalidSlugError {\n UNKNOWN_SLUG_ERROR = \"UNKNOWN_SLUG_ERROR\",\n /** The provided slug name contains illegal characters. */\n SLUG_CONTAINS_ILLEGAL_CHARACTERS = \"SLUG_CONTAINS_ILLEGAL_CHARACTERS\",\n /** The provided slug name already exists for another service. */\n SLUG_ALREADY_EXISTS = \"SLUG_ALREADY_EXISTS\"\n }\n interface CloneServiceRequest {\n /** ID of a source service */\n sourceServiceId: string;\n /** copy recurring sessions of an active service's schedule */\n copyRecurringSessions?: boolean;\n /** copy benefits with pricing plans that are connected to the source service. If the source service is connected to more than 120 benefits with pricing plans then they will not be copied. In that case the field `error_types` in the response will include `PRICING_PLANS`. */\n copyPricingPlans?: boolean;\n /** whether to hide service from the list or not. Empty means that we will copy this value from the source service without overriding it */\n hideService?: boolean | null;\n /** the name of the clone service. The title of the clone service's schedule will also be set to this name. When this parameter is omitted then the clone service will have the same name as the source service and the clone service's schedule will get the same title as the source service's active schedule. */\n cloneServiceName?: string | null;\n }\n interface CloneServiceResponse {\n /** Cloned service */\n service?: Service$1;\n /** List of entity types that we failed to clone */\n errors?: CloneErrors[];\n }\n enum CloneErrors {\n UNKNOWN_CLONE_ERROR = \"UNKNOWN_CLONE_ERROR\",\n /** Failed to clone sessions of active service's schedule */\n SESSIONS = \"SESSIONS\",\n /** Failed to clone service's options and variants even though source service have them */\n OPTIONS_AND_VARIANTS = \"OPTIONS_AND_VARIANTS\",\n /** Failed to clone service's form */\n FORM = \"FORM\",\n /** Failed to clone pricing plans connected to the source service */\n PRICING_PLANS = \"PRICING_PLANS\"\n }\n interface MultiServiceEnabledNotification {\n }\n /**\n * Creates a new service.\n * @param service - Service to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField service\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The created service.\n */\n function createService(service: Service$1): Promise;\n interface BulkCreateServicesOptions {\n /** `true` if the created entities must be included in the response, otherwise no entities are included in the response. */\n returnEntity?: boolean;\n }\n /**\n * Retrieves a service.\n * @param serviceId - ID of the service to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceId\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns The retrieved service.\n */\n function getService(serviceId: string, options?: GetServiceOptions): Promise;\n interface GetServiceOptions {\n }\n /**\n * Updates a service.\n *\n * [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported.\n *\n * Each time the service is updated, `revision` increments by 1. You must include the\n * number of the existing revision when\n * updating the service. This ensures you're working with the\n * latest service information and prevents unintended overwrites.\n * @param _id - Service ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField service\n * @requiredField service.revision\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated service.\n */\n function updateService(_id: string | null, service: UpdateService, options?: UpdateServiceOptions): Promise;\n interface UpdateService {\n /**\n * Service ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Service type.\n *\n * Supported Values:\n * - \"APPOINTMENT\"\n * - \"CLASS\"\n * - \"COURSE\"\n *\n */\n type?: ServiceType;\n /** Order of a service within a category. */\n sortOrder?: number | null;\n name?: string | null;\n description?: string | null;\n tagLine?: string | null;\n /** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */\n defaultCapacity?: number | null;\n /** Media associated with the service. */\n media?: Media$1;\n /** Whether the service is hidden from the site. */\n hidden?: boolean | null;\n /** The category the service is associated with. */\n category?: V2Category;\n /** The form used when booking the service. */\n form?: Form;\n /** Payment options for booking the service. */\n payment?: Payment;\n /** Online booking settings. */\n onlineBooking?: OnlineBooking;\n /** Conferencing options for this service. */\n conferencing?: Conferencing;\n /**\n * The locations this service is offered at.\n * In case of multiple (more than 1) location, All locations must be of type `BUSINESS`.\n * For courses only: Currently, only 1 location is supported, for all location types.\n */\n locations?: V2Location[];\n /** Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins. */\n bookingPolicy?: BookingPolicy$1;\n /** The service's schedule, which can be used to manage the service's sessions. */\n schedule?: V2Schedule;\n /** IDs of the staff members providing the service. For appointments only. */\n staffMemberIds?: string[];\n /**\n * A slug is the last part of the URL address that serves as a unique identifier of the service.\n * The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.\n * @readonly\n */\n supportedSlugs?: Slug[];\n /**\n * The main slug for the service. `mainSlug` is either taken from the current service name or is a custom slug set by the business owner.\n * `mainSlug` is used to construct the service's URLs.\n * @readonly\n */\n mainSlug?: Slug;\n /**\n * URLs to various service-related pages, such as the calendar page and the booking page.\n * @readonly\n */\n urls?: URLs;\n /**\n * Extensions enabling users to save custom data related to the service.\n * @readonly\n */\n extendedFields?: ExtendedFields;\n /** Custom SEO data for the service. */\n seoData?: SeoSchema$1;\n /**\n * Date and time the service was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the service was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.\n * @readonly\n */\n revision?: string | null;\n }\n interface UpdateServiceOptions {\n }\n interface BulkUpdateServicesOptions {\n /** Services to update. */\n services?: MaskedService[];\n /** `true` if the updated entities must be included in the response, otherwise no entities are included in the response. */\n returnEntity?: boolean;\n }\n /**\n * Deletes a service.\n * @param serviceId - ID of the service to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceId\n * @param options - Allows you to configure how to handle the deleted service's future sessions and how to notify the sessions participants.\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteService(serviceId: string, options?: DeleteServiceOptions): Promise;\n interface DeleteServiceOptions {\n /**\n * Whether to preserve future sessions with participants.\n *\n * Default: `false`\n */\n preserveFutureSessionsWithParticipants?: boolean;\n /** Whether to notify participants about the change and an optional custom message. */\n participantNotification?: V2ParticipantNotification;\n }\n interface BulkDeleteServicesOptions {\n preserveFutureSessionsWithParticipants?: boolean;\n /**\n * Whether to preserve future sessions with participants.\n *\n * Default: `false`.\n */\n participantNotification?: V2ParticipantNotification;\n }\n /**\n * Retrieves a list of up to 100 services, given the provided paging, filtering, and sorting.\n * `queryServices()` runs with these defaults, which you can override:\n * + `paging.limit` is `100`.\n * + `paging.offset` is `0`.\n *\n *\n * >**Notes:**\n * > + Use UTC format when filtering with dates.\n * > + Only 1 use of each filter in the same query is supported. If a filter is defined more than once in a query, only the first occurrence is processed.\n * @public\n * @documentationMaturity preview\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryServices(options?: QueryServicesOptions): ServicesQueryBuilder;\n interface QueryServicesOptions {\n }\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ServicesQueryResult extends QueryOffsetResult {\n items: Service$1[];\n query: ServicesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ServicesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"type\" | \"name\" | \"description\" | \"tagLine\" | \"hidden\" | \"category.id\" | \"category.name\" | \"form.id\" | \"payment.options.online\" | \"payment.options.inPerson\" | \"payment.options.pricingPlan\" | \"onlineBooking.enabled\" | \"locations.business.id\" | \"staffMemberIds\" | \"supportedSlugs.name\" | \"mainSlug.name\", value: any) => ServicesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"type\" | \"name\" | \"description\" | \"tagLine\" | \"hidden\" | \"category.id\" | \"category.name\" | \"form.id\" | \"payment.options.online\" | \"payment.options.inPerson\" | \"payment.options.pricingPlan\" | \"onlineBooking.enabled\" | \"locations.business.id\" | \"staffMemberIds\" | \"supportedSlugs.name\" | \"mainSlug.name\", value: any) => ServicesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"name\" | \"description\" | \"tagLine\" | \"category.id\" | \"category.name\" | \"form.id\" | \"locations.business.id\" | \"supportedSlugs.name\" | \"mainSlug.name\", value: string) => ServicesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"type\" | \"name\" | \"description\" | \"tagLine\" | \"hidden\" | \"category.id\" | \"category.name\" | \"form.id\" | \"payment.options.online\" | \"payment.options.inPerson\" | \"payment.options.pricingPlan\" | \"onlineBooking.enabled\" | \"locations.business.id\" | \"staffMemberIds\" | \"supportedSlugs.name\" | \"mainSlug.name\", value: any[]) => ServicesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasAll: (propertyName: \"staffMemberIds\", value: any[]) => ServicesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"type\" | \"name\" | \"description\" | \"tagLine\" | \"hidden\" | \"category.id\" | \"category.name\" | \"form.id\" | \"payment.options.online\" | \"payment.options.inPerson\" | \"payment.options.pricingPlan\" | \"onlineBooking.enabled\" | \"locations.business.id\" | \"staffMemberIds\" | \"supportedSlugs.name\" | \"mainSlug.name\", value: any) => ServicesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"type\" | \"name\" | \"description\" | \"tagLine\" | \"hidden\" | \"category.id\" | \"category.name\" | \"form.id\" | \"payment.options.online\" | \"payment.options.inPerson\" | \"payment.options.pricingPlan\" | \"onlineBooking.enabled\" | \"locations.business.id\" | \"staffMemberIds\" | \"supportedSlugs.name\" | \"mainSlug.name\", value: boolean) => ServicesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => ServicesQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => ServicesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts services according to given criteria.\n * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function countServices(options?: CountServicesOptions): Promise;\n interface CountServicesOptions {\n /** The filters for performing the count. */\n filter?: Record | null;\n }\n interface SetServiceLocationsOptions {\n /** The action to perform on sessions currently set to a removed location. For example, move existing sessions to a new specified location. */\n removedLocationSessionsAction?: RemovedLocationSessionsAction;\n /** Whether to notify participants about the change of location, and an optional custom message. */\n participantNotification?: V2ParticipantNotification;\n }\n interface DisablePricingPlansForServiceOptions {\n /** ID of the pricing plans to disconnect from the service. */\n pricingPlanIds?: string[];\n }\n interface ValidateSlugOptions {\n /** The custom name to validate as a slug for the service. */\n slugName: string;\n }\n interface CloneServiceOptions {\n /** copy recurring sessions of an active service's schedule */\n copyRecurringSessions?: boolean;\n /** copy benefits with pricing plans that are connected to the source service. If the source service is connected to more than 120 benefits with pricing plans then they will not be copied. In that case the field `error_types` in the response will include `PRICING_PLANS`. */\n copyPricingPlans?: boolean;\n /** whether to hide service from the list or not. Empty means that we will copy this value from the source service without overriding it */\n hideService?: boolean | null;\n /** the name of the clone service. The title of the clone service's schedule will also be set to this name. When this parameter is omitted then the clone service will have the same name as the source service and the clone service's schedule will get the same title as the source service's active schedule. */\n cloneServiceName?: string | null;\n }\n type bookingsServicesV2ServiceServices_universal_d_ServiceType = ServiceType;\n const bookingsServicesV2ServiceServices_universal_d_ServiceType: typeof ServiceType;\n type bookingsServicesV2ServiceServices_universal_d_V2Category = V2Category;\n type bookingsServicesV2ServiceServices_universal_d_Form = Form;\n type bookingsServicesV2ServiceServices_universal_d_FormSettings = FormSettings;\n type bookingsServicesV2ServiceServices_universal_d_Payment = Payment;\n type bookingsServicesV2ServiceServices_universal_d_PaymentRateOneOf = PaymentRateOneOf;\n type bookingsServicesV2ServiceServices_universal_d_RateType = RateType;\n const bookingsServicesV2ServiceServices_universal_d_RateType: typeof RateType;\n type bookingsServicesV2ServiceServices_universal_d_FixedPayment = FixedPayment;\n type bookingsServicesV2ServiceServices_universal_d_CustomPayment = CustomPayment;\n type bookingsServicesV2ServiceServices_universal_d_VariedPayment = VariedPayment;\n type bookingsServicesV2ServiceServices_universal_d_OnlineBooking = OnlineBooking;\n type bookingsServicesV2ServiceServices_universal_d_Conferencing = Conferencing;\n type bookingsServicesV2ServiceServices_universal_d_V2Location = V2Location;\n type bookingsServicesV2ServiceServices_universal_d_V2LocationOptionsOneOf = V2LocationOptionsOneOf;\n type bookingsServicesV2ServiceServices_universal_d_LocationTypeEnumLocationType = LocationTypeEnumLocationType;\n const bookingsServicesV2ServiceServices_universal_d_LocationTypeEnumLocationType: typeof LocationTypeEnumLocationType;\n type bookingsServicesV2ServiceServices_universal_d_CommonAddress = CommonAddress;\n type bookingsServicesV2ServiceServices_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type bookingsServicesV2ServiceServices_universal_d_CommonStreetAddress = CommonStreetAddress;\n type bookingsServicesV2ServiceServices_universal_d_CommonAddressLocation = CommonAddressLocation;\n type bookingsServicesV2ServiceServices_universal_d_BusinessLocationOptions = BusinessLocationOptions;\n type bookingsServicesV2ServiceServices_universal_d_CustomLocationOptions = CustomLocationOptions;\n type bookingsServicesV2ServiceServices_universal_d_PolicyDescription = PolicyDescription;\n type bookingsServicesV2ServiceServices_universal_d_LimitEarlyBookingPolicy = LimitEarlyBookingPolicy;\n type bookingsServicesV2ServiceServices_universal_d_LimitLateBookingPolicy = LimitLateBookingPolicy;\n type bookingsServicesV2ServiceServices_universal_d_BookAfterStartPolicy = BookAfterStartPolicy;\n type bookingsServicesV2ServiceServices_universal_d_CancellationPolicy = CancellationPolicy;\n type bookingsServicesV2ServiceServices_universal_d_ReschedulePolicy = ReschedulePolicy;\n type bookingsServicesV2ServiceServices_universal_d_WaitlistPolicy = WaitlistPolicy;\n type bookingsServicesV2ServiceServices_universal_d_ParticipantsPolicy = ParticipantsPolicy;\n type bookingsServicesV2ServiceServices_universal_d_ResourcesPolicy = ResourcesPolicy;\n type bookingsServicesV2ServiceServices_universal_d_V2Schedule = V2Schedule;\n type bookingsServicesV2ServiceServices_universal_d_V2AvailabilityConstraints = V2AvailabilityConstraints;\n type bookingsServicesV2ServiceServices_universal_d_StaffMember = StaffMember;\n type bookingsServicesV2ServiceServices_universal_d_ResourceGroup = ResourceGroup;\n type bookingsServicesV2ServiceServices_universal_d_ResourceIds = ResourceIds;\n type bookingsServicesV2ServiceServices_universal_d_ServiceResource = ServiceResource;\n type bookingsServicesV2ServiceServices_universal_d_ServiceResourceSelectionOneOf = ServiceResourceSelectionOneOf;\n type bookingsServicesV2ServiceServices_universal_d_ResourceType = ResourceType;\n type bookingsServicesV2ServiceServices_universal_d_Slug = Slug;\n type bookingsServicesV2ServiceServices_universal_d_URLs = URLs;\n type bookingsServicesV2ServiceServices_universal_d_ExtendedFields = ExtendedFields;\n type bookingsServicesV2ServiceServices_universal_d_ReindexMessage = ReindexMessage;\n type bookingsServicesV2ServiceServices_universal_d_ReindexMessageActionOneOf = ReindexMessageActionOneOf;\n type bookingsServicesV2ServiceServices_universal_d_Upsert = Upsert;\n type bookingsServicesV2ServiceServices_universal_d_Delete = Delete;\n type bookingsServicesV2ServiceServices_universal_d_Schema = Schema;\n type bookingsServicesV2ServiceServices_universal_d_SetCustomSlugEvent = SetCustomSlugEvent;\n type bookingsServicesV2ServiceServices_universal_d_CreateServiceRequest = CreateServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_CreateServiceResponse = CreateServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_BulkCreateServicesRequest = BulkCreateServicesRequest;\n type bookingsServicesV2ServiceServices_universal_d_BulkCreateServicesResponse = BulkCreateServicesResponse;\n type bookingsServicesV2ServiceServices_universal_d_BulkServiceResult = BulkServiceResult;\n type bookingsServicesV2ServiceServices_universal_d_ItemMetadata = ItemMetadata;\n type bookingsServicesV2ServiceServices_universal_d_ApplicationError = ApplicationError;\n type bookingsServicesV2ServiceServices_universal_d_BulkActionMetadata = BulkActionMetadata;\n type bookingsServicesV2ServiceServices_universal_d_GetServiceRequest = GetServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_RequestedFields = RequestedFields;\n const bookingsServicesV2ServiceServices_universal_d_RequestedFields: typeof RequestedFields;\n type bookingsServicesV2ServiceServices_universal_d_GetServiceResponse = GetServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_GetServiceAvailabilityConstraintsRequest = GetServiceAvailabilityConstraintsRequest;\n type bookingsServicesV2ServiceServices_universal_d_GetServiceAvailabilityConstraintsResponse = GetServiceAvailabilityConstraintsResponse;\n type bookingsServicesV2ServiceServices_universal_d_ServiceAvailabilityConstraints = ServiceAvailabilityConstraints;\n type bookingsServicesV2ServiceServices_universal_d_V1SplitInterval = V1SplitInterval;\n type bookingsServicesV2ServiceServices_universal_d_UpdateServiceRequest = UpdateServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_UpdateServiceResponse = UpdateServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_BulkUpdateServicesRequest = BulkUpdateServicesRequest;\n type bookingsServicesV2ServiceServices_universal_d_MaskedService = MaskedService;\n type bookingsServicesV2ServiceServices_universal_d_BulkUpdateServicesResponse = BulkUpdateServicesResponse;\n type bookingsServicesV2ServiceServices_universal_d_DeleteServiceRequest = DeleteServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_V2ParticipantNotification = V2ParticipantNotification;\n type bookingsServicesV2ServiceServices_universal_d_DeleteServiceResponse = DeleteServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_BulkDeleteServicesRequest = BulkDeleteServicesRequest;\n type bookingsServicesV2ServiceServices_universal_d_BulkDeleteServicesResponse = BulkDeleteServicesResponse;\n type bookingsServicesV2ServiceServices_universal_d_QueryServicesRequest = QueryServicesRequest;\n type bookingsServicesV2ServiceServices_universal_d_QueryServicesResponse = QueryServicesResponse;\n type bookingsServicesV2ServiceServices_universal_d_SearchServicesRequest = SearchServicesRequest;\n type bookingsServicesV2ServiceServices_universal_d_CursorSearch = CursorSearch;\n type bookingsServicesV2ServiceServices_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type bookingsServicesV2ServiceServices_universal_d_Aggregation = Aggregation;\n type bookingsServicesV2ServiceServices_universal_d_AggregationKindOneOf = AggregationKindOneOf;\n type bookingsServicesV2ServiceServices_universal_d_RangeBucket = RangeBucket;\n type bookingsServicesV2ServiceServices_universal_d_SortType = SortType;\n const bookingsServicesV2ServiceServices_universal_d_SortType: typeof SortType;\n type bookingsServicesV2ServiceServices_universal_d_SortDirection = SortDirection;\n const bookingsServicesV2ServiceServices_universal_d_SortDirection: typeof SortDirection;\n type bookingsServicesV2ServiceServices_universal_d_MissingValues = MissingValues;\n const bookingsServicesV2ServiceServices_universal_d_MissingValues: typeof MissingValues;\n type bookingsServicesV2ServiceServices_universal_d_IncludeMissingValuesOptions = IncludeMissingValuesOptions;\n type bookingsServicesV2ServiceServices_universal_d_ScalarType = ScalarType;\n const bookingsServicesV2ServiceServices_universal_d_ScalarType: typeof ScalarType;\n type bookingsServicesV2ServiceServices_universal_d_ValueAggregation = ValueAggregation;\n type bookingsServicesV2ServiceServices_universal_d_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;\n type bookingsServicesV2ServiceServices_universal_d_NestedAggregationType = NestedAggregationType;\n const bookingsServicesV2ServiceServices_universal_d_NestedAggregationType: typeof NestedAggregationType;\n type bookingsServicesV2ServiceServices_universal_d_RangeAggregation = RangeAggregation;\n type bookingsServicesV2ServiceServices_universal_d_ScalarAggregation = ScalarAggregation;\n type bookingsServicesV2ServiceServices_universal_d_DateHistogramAggregation = DateHistogramAggregation;\n type bookingsServicesV2ServiceServices_universal_d_DateHistogramAggregationInterval = DateHistogramAggregationInterval;\n const bookingsServicesV2ServiceServices_universal_d_DateHistogramAggregationInterval: typeof DateHistogramAggregationInterval;\n type bookingsServicesV2ServiceServices_universal_d_NestedAggregationItem = NestedAggregationItem;\n type bookingsServicesV2ServiceServices_universal_d_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;\n type bookingsServicesV2ServiceServices_universal_d_AggregationType = AggregationType;\n const bookingsServicesV2ServiceServices_universal_d_AggregationType: typeof AggregationType;\n type bookingsServicesV2ServiceServices_universal_d_NestedAggregation = NestedAggregation;\n type bookingsServicesV2ServiceServices_universal_d_GroupByAggregation = GroupByAggregation;\n type bookingsServicesV2ServiceServices_universal_d_GroupByAggregationKindOneOf = GroupByAggregationKindOneOf;\n type bookingsServicesV2ServiceServices_universal_d_SearchDetails = SearchDetails;\n type bookingsServicesV2ServiceServices_universal_d_Mode = Mode;\n const bookingsServicesV2ServiceServices_universal_d_Mode: typeof Mode;\n type bookingsServicesV2ServiceServices_universal_d_SearchServicesResponse = SearchServicesResponse;\n type bookingsServicesV2ServiceServices_universal_d_AggregationData = AggregationData;\n type bookingsServicesV2ServiceServices_universal_d_ValueAggregationResult = ValueAggregationResult;\n type bookingsServicesV2ServiceServices_universal_d_RangeAggregationResult = RangeAggregationResult;\n type bookingsServicesV2ServiceServices_universal_d_NestedAggregationResults = NestedAggregationResults;\n type bookingsServicesV2ServiceServices_universal_d_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;\n type bookingsServicesV2ServiceServices_universal_d_ValueResults = ValueResults;\n type bookingsServicesV2ServiceServices_universal_d_RangeResults = RangeResults;\n type bookingsServicesV2ServiceServices_universal_d_AggregationResultsScalarResult = AggregationResultsScalarResult;\n type bookingsServicesV2ServiceServices_universal_d_NestedValueAggregationResult = NestedValueAggregationResult;\n type bookingsServicesV2ServiceServices_universal_d_ValueResult = ValueResult;\n type bookingsServicesV2ServiceServices_universal_d_RangeResult = RangeResult;\n type bookingsServicesV2ServiceServices_universal_d_ScalarResult = ScalarResult;\n type bookingsServicesV2ServiceServices_universal_d_NestedResultValue = NestedResultValue;\n type bookingsServicesV2ServiceServices_universal_d_NestedResultValueResultOneOf = NestedResultValueResultOneOf;\n type bookingsServicesV2ServiceServices_universal_d_Results = Results;\n type bookingsServicesV2ServiceServices_universal_d_DateHistogramResult = DateHistogramResult;\n type bookingsServicesV2ServiceServices_universal_d_GroupByValueResults = GroupByValueResults;\n type bookingsServicesV2ServiceServices_universal_d_DateHistogramResults = DateHistogramResults;\n type bookingsServicesV2ServiceServices_universal_d_NestedResults = NestedResults;\n type bookingsServicesV2ServiceServices_universal_d_AggregationResults = AggregationResults;\n type bookingsServicesV2ServiceServices_universal_d_AggregationResultsResultOneOf = AggregationResultsResultOneOf;\n type bookingsServicesV2ServiceServices_universal_d_QueryPoliciesRequest = QueryPoliciesRequest;\n type bookingsServicesV2ServiceServices_universal_d_CursorQuery = CursorQuery;\n type bookingsServicesV2ServiceServices_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type bookingsServicesV2ServiceServices_universal_d_QueryPoliciesResponse = QueryPoliciesResponse;\n type bookingsServicesV2ServiceServices_universal_d_BookingPolicyWithServices = BookingPolicyWithServices;\n type bookingsServicesV2ServiceServices_universal_d_CountServicesRequest = CountServicesRequest;\n type bookingsServicesV2ServiceServices_universal_d_CountServicesResponse = CountServicesResponse;\n type bookingsServicesV2ServiceServices_universal_d_CategoryNotification = CategoryNotification;\n type bookingsServicesV2ServiceServices_universal_d_Category = Category;\n type bookingsServicesV2ServiceServices_universal_d_CategoryStatus = CategoryStatus;\n const bookingsServicesV2ServiceServices_universal_d_CategoryStatus: typeof CategoryStatus;\n type bookingsServicesV2ServiceServices_universal_d_CategoryNotificationEvent = CategoryNotificationEvent;\n const bookingsServicesV2ServiceServices_universal_d_CategoryNotificationEvent: typeof CategoryNotificationEvent;\n type bookingsServicesV2ServiceServices_universal_d_ResourceNotificationEvent = ResourceNotificationEvent;\n const bookingsServicesV2ServiceServices_universal_d_ResourceNotificationEvent: typeof ResourceNotificationEvent;\n type bookingsServicesV2ServiceServices_universal_d_BenefitNotification = BenefitNotification;\n type bookingsServicesV2ServiceServices_universal_d_Benefit = Benefit;\n type bookingsServicesV2ServiceServices_universal_d_EntryPass = EntryPass;\n type bookingsServicesV2ServiceServices_universal_d_Discount = Discount;\n type bookingsServicesV2ServiceServices_universal_d_DiscountDiscountOneOf = DiscountDiscountOneOf;\n type bookingsServicesV2ServiceServices_universal_d_BenefitType = BenefitType;\n const bookingsServicesV2ServiceServices_universal_d_BenefitType: typeof BenefitType;\n type bookingsServicesV2ServiceServices_universal_d_Behavior = Behavior;\n type bookingsServicesV2ServiceServices_universal_d_BehaviorBehaviorOneOf = BehaviorBehaviorOneOf;\n type bookingsServicesV2ServiceServices_universal_d_UserDomainInfoChangedEvent = UserDomainInfoChangedEvent;\n type bookingsServicesV2ServiceServices_universal_d_CrudType = CrudType;\n const bookingsServicesV2ServiceServices_universal_d_CrudType: typeof CrudType;\n type bookingsServicesV2ServiceServices_universal_d_HtmlSitePublished = HtmlSitePublished;\n type bookingsServicesV2ServiceServices_universal_d_Page = Page;\n type bookingsServicesV2ServiceServices_universal_d_SetServiceLocationsRequest = SetServiceLocationsRequest;\n type bookingsServicesV2ServiceServices_universal_d_RemovedLocationSessionsAction = RemovedLocationSessionsAction;\n type bookingsServicesV2ServiceServices_universal_d_RemovedLocationSessionsActionActionOptionsOneOf = RemovedLocationSessionsActionActionOptionsOneOf;\n type bookingsServicesV2ServiceServices_universal_d_Action = Action;\n const bookingsServicesV2ServiceServices_universal_d_Action: typeof Action;\n type bookingsServicesV2ServiceServices_universal_d_MoveToNewLocationsOptions = MoveToNewLocationsOptions;\n type bookingsServicesV2ServiceServices_universal_d_SetServiceLocationsResponse = SetServiceLocationsResponse;\n type bookingsServicesV2ServiceServices_universal_d_EnablePricingPlansForServiceRequest = EnablePricingPlansForServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_EnablePricingPlansForServiceResponse = EnablePricingPlansForServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_InvalidPricingPlan = InvalidPricingPlan;\n type bookingsServicesV2ServiceServices_universal_d_DisablePricingPlansForServiceRequest = DisablePricingPlansForServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_DisablePricingPlansForServiceResponse = DisablePricingPlansForServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_SetCustomSlugRequest = SetCustomSlugRequest;\n type bookingsServicesV2ServiceServices_universal_d_SetCustomSlugResponse = SetCustomSlugResponse;\n type bookingsServicesV2ServiceServices_universal_d_ValidateSlugRequest = ValidateSlugRequest;\n type bookingsServicesV2ServiceServices_universal_d_ValidateSlugResponse = ValidateSlugResponse;\n type bookingsServicesV2ServiceServices_universal_d_InvalidSlugError = InvalidSlugError;\n const bookingsServicesV2ServiceServices_universal_d_InvalidSlugError: typeof InvalidSlugError;\n type bookingsServicesV2ServiceServices_universal_d_CloneServiceRequest = CloneServiceRequest;\n type bookingsServicesV2ServiceServices_universal_d_CloneServiceResponse = CloneServiceResponse;\n type bookingsServicesV2ServiceServices_universal_d_CloneErrors = CloneErrors;\n const bookingsServicesV2ServiceServices_universal_d_CloneErrors: typeof CloneErrors;\n type bookingsServicesV2ServiceServices_universal_d_MultiServiceEnabledNotification = MultiServiceEnabledNotification;\n const bookingsServicesV2ServiceServices_universal_d_createService: typeof createService;\n type bookingsServicesV2ServiceServices_universal_d_BulkCreateServicesOptions = BulkCreateServicesOptions;\n const bookingsServicesV2ServiceServices_universal_d_getService: typeof getService;\n type bookingsServicesV2ServiceServices_universal_d_GetServiceOptions = GetServiceOptions;\n const bookingsServicesV2ServiceServices_universal_d_updateService: typeof updateService;\n type bookingsServicesV2ServiceServices_universal_d_UpdateService = UpdateService;\n type bookingsServicesV2ServiceServices_universal_d_UpdateServiceOptions = UpdateServiceOptions;\n type bookingsServicesV2ServiceServices_universal_d_BulkUpdateServicesOptions = BulkUpdateServicesOptions;\n const bookingsServicesV2ServiceServices_universal_d_deleteService: typeof deleteService;\n type bookingsServicesV2ServiceServices_universal_d_DeleteServiceOptions = DeleteServiceOptions;\n type bookingsServicesV2ServiceServices_universal_d_BulkDeleteServicesOptions = BulkDeleteServicesOptions;\n const bookingsServicesV2ServiceServices_universal_d_queryServices: typeof queryServices;\n type bookingsServicesV2ServiceServices_universal_d_QueryServicesOptions = QueryServicesOptions;\n type bookingsServicesV2ServiceServices_universal_d_ServicesQueryResult = ServicesQueryResult;\n type bookingsServicesV2ServiceServices_universal_d_ServicesQueryBuilder = ServicesQueryBuilder;\n const bookingsServicesV2ServiceServices_universal_d_countServices: typeof countServices;\n type bookingsServicesV2ServiceServices_universal_d_CountServicesOptions = CountServicesOptions;\n type bookingsServicesV2ServiceServices_universal_d_SetServiceLocationsOptions = SetServiceLocationsOptions;\n type bookingsServicesV2ServiceServices_universal_d_DisablePricingPlansForServiceOptions = DisablePricingPlansForServiceOptions;\n type bookingsServicesV2ServiceServices_universal_d_ValidateSlugOptions = ValidateSlugOptions;\n type bookingsServicesV2ServiceServices_universal_d_CloneServiceOptions = CloneServiceOptions;\n namespace bookingsServicesV2ServiceServices_universal_d {\n export { Service$1 as Service, bookingsServicesV2ServiceServices_universal_d_ServiceType as ServiceType, Media$1 as Media, MediaItem$1 as MediaItem, MediaItemItemOneOf$1 as MediaItemItemOneOf, bookingsServicesV2ServiceServices_universal_d_V2Category as V2Category, bookingsServicesV2ServiceServices_universal_d_Form as Form, bookingsServicesV2ServiceServices_universal_d_FormSettings as FormSettings, bookingsServicesV2ServiceServices_universal_d_Payment as Payment, bookingsServicesV2ServiceServices_universal_d_PaymentRateOneOf as PaymentRateOneOf, bookingsServicesV2ServiceServices_universal_d_RateType as RateType, bookingsServicesV2ServiceServices_universal_d_FixedPayment as FixedPayment, Money$1 as Money, bookingsServicesV2ServiceServices_universal_d_CustomPayment as CustomPayment, bookingsServicesV2ServiceServices_universal_d_VariedPayment as VariedPayment, PaymentOptions$1 as PaymentOptions, bookingsServicesV2ServiceServices_universal_d_OnlineBooking as OnlineBooking, bookingsServicesV2ServiceServices_universal_d_Conferencing as Conferencing, bookingsServicesV2ServiceServices_universal_d_V2Location as V2Location, bookingsServicesV2ServiceServices_universal_d_V2LocationOptionsOneOf as V2LocationOptionsOneOf, bookingsServicesV2ServiceServices_universal_d_LocationTypeEnumLocationType as LocationTypeEnumLocationType, bookingsServicesV2ServiceServices_universal_d_CommonAddress as CommonAddress, bookingsServicesV2ServiceServices_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf, bookingsServicesV2ServiceServices_universal_d_CommonStreetAddress as CommonStreetAddress, bookingsServicesV2ServiceServices_universal_d_CommonAddressLocation as CommonAddressLocation, bookingsServicesV2ServiceServices_universal_d_BusinessLocationOptions as BusinessLocationOptions, bookingsServicesV2ServiceServices_universal_d_CustomLocationOptions as CustomLocationOptions, BookingPolicy$1 as BookingPolicy, bookingsServicesV2ServiceServices_universal_d_PolicyDescription as PolicyDescription, bookingsServicesV2ServiceServices_universal_d_LimitEarlyBookingPolicy as LimitEarlyBookingPolicy, bookingsServicesV2ServiceServices_universal_d_LimitLateBookingPolicy as LimitLateBookingPolicy, bookingsServicesV2ServiceServices_universal_d_BookAfterStartPolicy as BookAfterStartPolicy, bookingsServicesV2ServiceServices_universal_d_CancellationPolicy as CancellationPolicy, bookingsServicesV2ServiceServices_universal_d_ReschedulePolicy as ReschedulePolicy, bookingsServicesV2ServiceServices_universal_d_WaitlistPolicy as WaitlistPolicy, bookingsServicesV2ServiceServices_universal_d_ParticipantsPolicy as ParticipantsPolicy, bookingsServicesV2ServiceServices_universal_d_ResourcesPolicy as ResourcesPolicy, bookingsServicesV2ServiceServices_universal_d_V2Schedule as V2Schedule, bookingsServicesV2ServiceServices_universal_d_V2AvailabilityConstraints as V2AvailabilityConstraints, bookingsServicesV2ServiceServices_universal_d_StaffMember as StaffMember, bookingsServicesV2ServiceServices_universal_d_ResourceGroup as ResourceGroup, bookingsServicesV2ServiceServices_universal_d_ResourceIds as ResourceIds, bookingsServicesV2ServiceServices_universal_d_ServiceResource as ServiceResource, bookingsServicesV2ServiceServices_universal_d_ServiceResourceSelectionOneOf as ServiceResourceSelectionOneOf, bookingsServicesV2ServiceServices_universal_d_ResourceType as ResourceType, bookingsServicesV2ServiceServices_universal_d_Slug as Slug, bookingsServicesV2ServiceServices_universal_d_URLs as URLs, bookingsServicesV2ServiceServices_universal_d_ExtendedFields as ExtendedFields, SeoSchema$1 as SeoSchema, Keyword$1 as Keyword, Tag$1 as Tag, Settings$1 as Settings, bookingsServicesV2ServiceServices_universal_d_ReindexMessage as ReindexMessage, bookingsServicesV2ServiceServices_universal_d_ReindexMessageActionOneOf as ReindexMessageActionOneOf, bookingsServicesV2ServiceServices_universal_d_Upsert as Upsert, bookingsServicesV2ServiceServices_universal_d_Delete as Delete, bookingsServicesV2ServiceServices_universal_d_Schema as Schema, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, bookingsServicesV2ServiceServices_universal_d_SetCustomSlugEvent as SetCustomSlugEvent, bookingsServicesV2ServiceServices_universal_d_CreateServiceRequest as CreateServiceRequest, bookingsServicesV2ServiceServices_universal_d_CreateServiceResponse as CreateServiceResponse, bookingsServicesV2ServiceServices_universal_d_BulkCreateServicesRequest as BulkCreateServicesRequest, bookingsServicesV2ServiceServices_universal_d_BulkCreateServicesResponse as BulkCreateServicesResponse, bookingsServicesV2ServiceServices_universal_d_BulkServiceResult as BulkServiceResult, bookingsServicesV2ServiceServices_universal_d_ItemMetadata as ItemMetadata, bookingsServicesV2ServiceServices_universal_d_ApplicationError as ApplicationError, bookingsServicesV2ServiceServices_universal_d_BulkActionMetadata as BulkActionMetadata, bookingsServicesV2ServiceServices_universal_d_GetServiceRequest as GetServiceRequest, bookingsServicesV2ServiceServices_universal_d_RequestedFields as RequestedFields, bookingsServicesV2ServiceServices_universal_d_GetServiceResponse as GetServiceResponse, bookingsServicesV2ServiceServices_universal_d_GetServiceAvailabilityConstraintsRequest as GetServiceAvailabilityConstraintsRequest, bookingsServicesV2ServiceServices_universal_d_GetServiceAvailabilityConstraintsResponse as GetServiceAvailabilityConstraintsResponse, bookingsServicesV2ServiceServices_universal_d_ServiceAvailabilityConstraints as ServiceAvailabilityConstraints, bookingsServicesV2ServiceServices_universal_d_V1SplitInterval as V1SplitInterval, bookingsServicesV2ServiceServices_universal_d_UpdateServiceRequest as UpdateServiceRequest, bookingsServicesV2ServiceServices_universal_d_UpdateServiceResponse as UpdateServiceResponse, bookingsServicesV2ServiceServices_universal_d_BulkUpdateServicesRequest as BulkUpdateServicesRequest, bookingsServicesV2ServiceServices_universal_d_MaskedService as MaskedService, bookingsServicesV2ServiceServices_universal_d_BulkUpdateServicesResponse as BulkUpdateServicesResponse, bookingsServicesV2ServiceServices_universal_d_DeleteServiceRequest as DeleteServiceRequest, bookingsServicesV2ServiceServices_universal_d_V2ParticipantNotification as V2ParticipantNotification, bookingsServicesV2ServiceServices_universal_d_DeleteServiceResponse as DeleteServiceResponse, bookingsServicesV2ServiceServices_universal_d_BulkDeleteServicesRequest as BulkDeleteServicesRequest, bookingsServicesV2ServiceServices_universal_d_BulkDeleteServicesResponse as BulkDeleteServicesResponse, bookingsServicesV2ServiceServices_universal_d_QueryServicesRequest as QueryServicesRequest, QueryV2$2 as QueryV2, QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf, Sorting$2 as Sorting, SortOrder$2 as SortOrder, Paging$1 as Paging, CursorPaging$2 as CursorPaging, bookingsServicesV2ServiceServices_universal_d_QueryServicesResponse as QueryServicesResponse, PagingMetadataV2$2 as PagingMetadataV2, Cursors$2 as Cursors, bookingsServicesV2ServiceServices_universal_d_SearchServicesRequest as SearchServicesRequest, bookingsServicesV2ServiceServices_universal_d_CursorSearch as CursorSearch, bookingsServicesV2ServiceServices_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, bookingsServicesV2ServiceServices_universal_d_Aggregation as Aggregation, bookingsServicesV2ServiceServices_universal_d_AggregationKindOneOf as AggregationKindOneOf, bookingsServicesV2ServiceServices_universal_d_RangeBucket as RangeBucket, bookingsServicesV2ServiceServices_universal_d_SortType as SortType, bookingsServicesV2ServiceServices_universal_d_SortDirection as SortDirection, bookingsServicesV2ServiceServices_universal_d_MissingValues as MissingValues, bookingsServicesV2ServiceServices_universal_d_IncludeMissingValuesOptions as IncludeMissingValuesOptions, bookingsServicesV2ServiceServices_universal_d_ScalarType as ScalarType, bookingsServicesV2ServiceServices_universal_d_ValueAggregation as ValueAggregation, bookingsServicesV2ServiceServices_universal_d_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf, bookingsServicesV2ServiceServices_universal_d_NestedAggregationType as NestedAggregationType, bookingsServicesV2ServiceServices_universal_d_RangeAggregation as RangeAggregation, bookingsServicesV2ServiceServices_universal_d_ScalarAggregation as ScalarAggregation, bookingsServicesV2ServiceServices_universal_d_DateHistogramAggregation as DateHistogramAggregation, bookingsServicesV2ServiceServices_universal_d_DateHistogramAggregationInterval as DateHistogramAggregationInterval, bookingsServicesV2ServiceServices_universal_d_NestedAggregationItem as NestedAggregationItem, bookingsServicesV2ServiceServices_universal_d_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, bookingsServicesV2ServiceServices_universal_d_AggregationType as AggregationType, bookingsServicesV2ServiceServices_universal_d_NestedAggregation as NestedAggregation, bookingsServicesV2ServiceServices_universal_d_GroupByAggregation as GroupByAggregation, bookingsServicesV2ServiceServices_universal_d_GroupByAggregationKindOneOf as GroupByAggregationKindOneOf, bookingsServicesV2ServiceServices_universal_d_SearchDetails as SearchDetails, bookingsServicesV2ServiceServices_universal_d_Mode as Mode, bookingsServicesV2ServiceServices_universal_d_SearchServicesResponse as SearchServicesResponse, CursorPagingMetadata$1 as CursorPagingMetadata, bookingsServicesV2ServiceServices_universal_d_AggregationData as AggregationData, bookingsServicesV2ServiceServices_universal_d_ValueAggregationResult as ValueAggregationResult, bookingsServicesV2ServiceServices_universal_d_RangeAggregationResult as RangeAggregationResult, bookingsServicesV2ServiceServices_universal_d_NestedAggregationResults as NestedAggregationResults, bookingsServicesV2ServiceServices_universal_d_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf, bookingsServicesV2ServiceServices_universal_d_ValueResults as ValueResults, bookingsServicesV2ServiceServices_universal_d_RangeResults as RangeResults, bookingsServicesV2ServiceServices_universal_d_AggregationResultsScalarResult as AggregationResultsScalarResult, bookingsServicesV2ServiceServices_universal_d_NestedValueAggregationResult as NestedValueAggregationResult, bookingsServicesV2ServiceServices_universal_d_ValueResult as ValueResult, bookingsServicesV2ServiceServices_universal_d_RangeResult as RangeResult, bookingsServicesV2ServiceServices_universal_d_ScalarResult as ScalarResult, bookingsServicesV2ServiceServices_universal_d_NestedResultValue as NestedResultValue, bookingsServicesV2ServiceServices_universal_d_NestedResultValueResultOneOf as NestedResultValueResultOneOf, bookingsServicesV2ServiceServices_universal_d_Results as Results, bookingsServicesV2ServiceServices_universal_d_DateHistogramResult as DateHistogramResult, bookingsServicesV2ServiceServices_universal_d_GroupByValueResults as GroupByValueResults, bookingsServicesV2ServiceServices_universal_d_DateHistogramResults as DateHistogramResults, bookingsServicesV2ServiceServices_universal_d_NestedResults as NestedResults, bookingsServicesV2ServiceServices_universal_d_AggregationResults as AggregationResults, bookingsServicesV2ServiceServices_universal_d_AggregationResultsResultOneOf as AggregationResultsResultOneOf, bookingsServicesV2ServiceServices_universal_d_QueryPoliciesRequest as QueryPoliciesRequest, bookingsServicesV2ServiceServices_universal_d_CursorQuery as CursorQuery, bookingsServicesV2ServiceServices_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, bookingsServicesV2ServiceServices_universal_d_QueryPoliciesResponse as QueryPoliciesResponse, bookingsServicesV2ServiceServices_universal_d_BookingPolicyWithServices as BookingPolicyWithServices, bookingsServicesV2ServiceServices_universal_d_CountServicesRequest as CountServicesRequest, bookingsServicesV2ServiceServices_universal_d_CountServicesResponse as CountServicesResponse, bookingsServicesV2ServiceServices_universal_d_CategoryNotification as CategoryNotification, bookingsServicesV2ServiceServices_universal_d_Category as Category, bookingsServicesV2ServiceServices_universal_d_CategoryStatus as CategoryStatus, bookingsServicesV2ServiceServices_universal_d_CategoryNotificationEvent as CategoryNotificationEvent, Empty$2 as Empty, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, ScheduleNotification$2 as ScheduleNotification, ScheduleNotificationEventOneOf$2 as ScheduleNotificationEventOneOf, ScheduleCreated$2 as ScheduleCreated, Schedule$2 as Schedule, RecurringInterval$2 as RecurringInterval, Interval$2 as Interval, Day$2 as Day, Frequency$2 as Frequency, LinkedSchedule$2 as LinkedSchedule, Transparency$2 as Transparency, RecurringIntervalType$2 as RecurringIntervalType, Location$3 as Location, LocationType$3 as LocationType, Address$2 as Address, AddressStreetOneOf$2 as AddressStreetOneOf, StreetAddress$2 as StreetAddress, AddressLocation$2 as AddressLocation, Subdivision$2 as Subdivision, LocationsLocation$2 as LocationsLocation, LocationStatus$2 as LocationStatus, LocationsLocationType$2 as LocationsLocationType, LocationsAddress$2 as LocationsAddress, LocationsStreetAddress$2 as LocationsStreetAddress, LocationsAddressLocation$2 as LocationsAddressLocation, BusinessSchedule$2 as BusinessSchedule, TimePeriod$2 as TimePeriod, DayOfWeek$2 as DayOfWeek, SpecialHourPeriod$2 as SpecialHourPeriod, Rate$2 as Rate, Price$2 as Price, Availability$2 as Availability, AvailabilityConstraints$2 as AvailabilityConstraints, SplitInterval$2 as SplitInterval, Participant$2 as Participant, ApprovalStatus$2 as ApprovalStatus, ExternalCalendarOverrides$2 as ExternalCalendarOverrides, ScheduleStatus$2 as ScheduleStatus, Version$2 as Version, ConferenceProvider$2 as ConferenceProvider, CalendarConference$2 as CalendarConference, ConferenceType$2 as ConferenceType, ScheduleUpdated$2 as ScheduleUpdated, RecurringSessionsUpdated$2 as RecurringSessionsUpdated, Session$2 as Session, CalendarDateTime$2 as CalendarDateTime, LocalDateTime$2 as LocalDateTime, ExternalCalendarInfo$2 as ExternalCalendarInfo, CalendarType$2 as CalendarType, Status$2 as Status, SessionType$2 as SessionType, SessionVersion$2 as SessionVersion, ParticipantNotification$2 as ParticipantNotification, ScheduleCancelled$2 as ScheduleCancelled, SessionCreated$2 as SessionCreated, SessionUpdated$2 as SessionUpdated, SessionCancelled$2 as SessionCancelled, AvailabilityPolicyUpdated$2 as AvailabilityPolicyUpdated, AvailabilityPolicy$2 as AvailabilityPolicy, IntervalSplit$2 as IntervalSplit, RecurringSessionSplit$2 as RecurringSessionSplit, ScheduleUnassignedFromUser$2 as ScheduleUnassignedFromUser, MultipleSessionsCreated$2 as MultipleSessionsCreated, ScheduleWithSessions$2 as ScheduleWithSessions, SitePropertiesOnScheduleCreation$2 as SitePropertiesOnScheduleCreation, MigrationEvent$2 as MigrationEvent, MigrationData$2 as MigrationData, StaffData$2 as StaffData, ResourceNotification$1 as ResourceNotification, Resource$1 as Resource, ResourceStatus$1 as ResourceStatus, BusinessLocation$1 as BusinessLocation, bookingsServicesV2ServiceServices_universal_d_ResourceNotificationEvent as ResourceNotificationEvent, bookingsServicesV2ServiceServices_universal_d_BenefitNotification as BenefitNotification, bookingsServicesV2ServiceServices_universal_d_Benefit as Benefit, bookingsServicesV2ServiceServices_universal_d_EntryPass as EntryPass, bookingsServicesV2ServiceServices_universal_d_Discount as Discount, bookingsServicesV2ServiceServices_universal_d_DiscountDiscountOneOf as DiscountDiscountOneOf, bookingsServicesV2ServiceServices_universal_d_BenefitType as BenefitType, bookingsServicesV2ServiceServices_universal_d_Behavior as Behavior, bookingsServicesV2ServiceServices_universal_d_BehaviorBehaviorOneOf as BehaviorBehaviorOneOf, Event$1 as Event, bookingsServicesV2ServiceServices_universal_d_UserDomainInfoChangedEvent as UserDomainInfoChangedEvent, bookingsServicesV2ServiceServices_universal_d_CrudType as CrudType, bookingsServicesV2ServiceServices_universal_d_HtmlSitePublished as HtmlSitePublished, bookingsServicesV2ServiceServices_universal_d_Page as Page, SitePropertiesNotification$1 as SitePropertiesNotification, SitePropertiesEvent$1 as SitePropertiesEvent, Properties$1 as Properties, Categories$1 as Categories, Locale$1 as Locale, V4Address$1 as V4Address, AddressHint$1 as AddressHint, PlacementType$1 as PlacementType, GeoCoordinates$1 as GeoCoordinates, Multilingual$1 as Multilingual, SupportedLanguage$1 as SupportedLanguage, ResolutionMethod$1 as ResolutionMethod, ConsentPolicy$1 as ConsentPolicy, Translation$1 as Translation, ChangeContext$1 as ChangeContext, ChangeContextPayloadOneOf$1 as ChangeContextPayloadOneOf, PropertiesChange$1 as PropertiesChange, SiteCreated$1 as SiteCreated, SiteCloned$1 as SiteCloned, bookingsServicesV2ServiceServices_universal_d_SetServiceLocationsRequest as SetServiceLocationsRequest, bookingsServicesV2ServiceServices_universal_d_RemovedLocationSessionsAction as RemovedLocationSessionsAction, bookingsServicesV2ServiceServices_universal_d_RemovedLocationSessionsActionActionOptionsOneOf as RemovedLocationSessionsActionActionOptionsOneOf, bookingsServicesV2ServiceServices_universal_d_Action as Action, bookingsServicesV2ServiceServices_universal_d_MoveToNewLocationsOptions as MoveToNewLocationsOptions, bookingsServicesV2ServiceServices_universal_d_SetServiceLocationsResponse as SetServiceLocationsResponse, bookingsServicesV2ServiceServices_universal_d_EnablePricingPlansForServiceRequest as EnablePricingPlansForServiceRequest, bookingsServicesV2ServiceServices_universal_d_EnablePricingPlansForServiceResponse as EnablePricingPlansForServiceResponse, bookingsServicesV2ServiceServices_universal_d_InvalidPricingPlan as InvalidPricingPlan, bookingsServicesV2ServiceServices_universal_d_DisablePricingPlansForServiceRequest as DisablePricingPlansForServiceRequest, bookingsServicesV2ServiceServices_universal_d_DisablePricingPlansForServiceResponse as DisablePricingPlansForServiceResponse, bookingsServicesV2ServiceServices_universal_d_SetCustomSlugRequest as SetCustomSlugRequest, bookingsServicesV2ServiceServices_universal_d_SetCustomSlugResponse as SetCustomSlugResponse, bookingsServicesV2ServiceServices_universal_d_ValidateSlugRequest as ValidateSlugRequest, bookingsServicesV2ServiceServices_universal_d_ValidateSlugResponse as ValidateSlugResponse, bookingsServicesV2ServiceServices_universal_d_InvalidSlugError as InvalidSlugError, bookingsServicesV2ServiceServices_universal_d_CloneServiceRequest as CloneServiceRequest, bookingsServicesV2ServiceServices_universal_d_CloneServiceResponse as CloneServiceResponse, bookingsServicesV2ServiceServices_universal_d_CloneErrors as CloneErrors, bookingsServicesV2ServiceServices_universal_d_MultiServiceEnabledNotification as MultiServiceEnabledNotification, bookingsServicesV2ServiceServices_universal_d_createService as createService, bookingsServicesV2ServiceServices_universal_d_BulkCreateServicesOptions as BulkCreateServicesOptions, bookingsServicesV2ServiceServices_universal_d_getService as getService, bookingsServicesV2ServiceServices_universal_d_GetServiceOptions as GetServiceOptions, bookingsServicesV2ServiceServices_universal_d_updateService as updateService, bookingsServicesV2ServiceServices_universal_d_UpdateService as UpdateService, bookingsServicesV2ServiceServices_universal_d_UpdateServiceOptions as UpdateServiceOptions, bookingsServicesV2ServiceServices_universal_d_BulkUpdateServicesOptions as BulkUpdateServicesOptions, bookingsServicesV2ServiceServices_universal_d_deleteService as deleteService, bookingsServicesV2ServiceServices_universal_d_DeleteServiceOptions as DeleteServiceOptions, bookingsServicesV2ServiceServices_universal_d_BulkDeleteServicesOptions as BulkDeleteServicesOptions, bookingsServicesV2ServiceServices_universal_d_queryServices as queryServices, bookingsServicesV2ServiceServices_universal_d_QueryServicesOptions as QueryServicesOptions, bookingsServicesV2ServiceServices_universal_d_ServicesQueryResult as ServicesQueryResult, bookingsServicesV2ServiceServices_universal_d_ServicesQueryBuilder as ServicesQueryBuilder, bookingsServicesV2ServiceServices_universal_d_countServices as countServices, bookingsServicesV2ServiceServices_universal_d_CountServicesOptions as CountServicesOptions, bookingsServicesV2ServiceServices_universal_d_SetServiceLocationsOptions as SetServiceLocationsOptions, bookingsServicesV2ServiceServices_universal_d_DisablePricingPlansForServiceOptions as DisablePricingPlansForServiceOptions, bookingsServicesV2ServiceServices_universal_d_ValidateSlugOptions as ValidateSlugOptions, bookingsServicesV2ServiceServices_universal_d_CloneServiceOptions as CloneServiceOptions, };\n }\n /**\n * The `serviceOptionsAndVariants` object links a service to its variants.\n * You can use it to offer customers different prices for a service,\n * depending on which choices they book.\n * Read more about [service options and variants](https://wix.wixanswers.com/app/kb/article/2e91a25b-b3c2-4cf7-9005-429a4929fc36/en).\n */\n interface ServiceOptionsAndVariants {\n /**\n * ID of the `serviceOptionsAndVariants` object.\n * @readonly\n */\n _id?: string | null;\n /** ID of the service related to these options and variants. */\n serviceId?: string | null;\n /** Service options. Note that currently only a single option is supported per service. */\n options?: ServiceOptions;\n /** Information about the service's variants. */\n variants?: ServiceVariants;\n /**\n * Price of the cheapest service variant.\n * @readonly\n */\n minPrice?: Money;\n /**\n * Price of the most expensive service variant.\n * @readonly\n */\n maxPrice?: Money;\n /**\n * Revision number, which increments by 1 each time the `serviceOptionsAndVariants` object is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating and deleting the `serviceOptionsAndVariants` object.\n *\n * Ignored when creating a `serviceOptionsAndVariants` object.\n */\n revision?: string | null;\n }\n interface ServiceOption extends ServiceOptionOptionSpecificDataOneOf {\n /** Details about the custom option. Available only for `CUSTOM` options. */\n customData?: CustomServiceOption;\n /** ID of the service option. */\n _id?: string;\n /** Type of the service option. */\n type?: ServiceOptionType;\n }\n /** @oneof */\n interface ServiceOptionOptionSpecificDataOneOf {\n /** Details about the custom option. Available only for `CUSTOM` options. */\n customData?: CustomServiceOption;\n }\n enum ServiceOptionType {\n UNKNOWN = \"UNKNOWN\",\n CUSTOM = \"CUSTOM\",\n STAFF_MEMBER = \"STAFF_MEMBER\"\n }\n interface CustomServiceOption {\n /**\n * Name of the service option. For example, `Age group`, `Location`, `Equipment`,\n * or `Time`.\n */\n name?: string;\n /**\n * Available choices for the service option. For example, `child`, `student`,\n * `adult`, and `senior` for a service option named `Age group`. Each value must\n * be unique. The value's case is ignored, meaning `Child` and `child` are\n * considered to be identical. Currently, only a single choice is supported\n * because a service can have only a single option.\n *\n * Max: 1 choice\n */\n choices?: string[];\n }\n interface ServiceVariant {\n /**\n * Choices for the service option. Currently, only a single choice is supported\n * because a service can have only a single option.\n *\n * Max: 1 choice\n */\n choices?: ServiceChoice[];\n /** Information about the service variant's price. */\n price?: Money;\n }\n interface ServiceChoice extends ServiceChoiceChoiceOneOf {\n /** Name of the custom choice. */\n custom?: string;\n /**\n * ID of the staff member providing the service. This ID is the equivalent of the `resourceId`\n * of the staff member or the `scheduleOwnerId` of the relevant\n * schedule's\n * `availability.linkedSchedules`.\n */\n staffMemberId?: string;\n /** ID of the service option. */\n optionId?: string;\n }\n /** @oneof */\n interface ServiceChoiceChoiceOneOf {\n /** Name of the custom choice. */\n custom?: string;\n /**\n * ID of the staff member providing the service. This ID is the equivalent of the `resourceId`\n * of the staff member or the `scheduleOwnerId` of the relevant\n * [schedule's](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object)\n * `availability.linkedSchedules`.\n */\n staffMemberId?: string;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface Money {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n formattedValue?: string | null;\n }\n interface ServiceOptions {\n /**\n * Values of the service options.\n *\n * Max: 1 service option\n */\n values?: ServiceOption[];\n }\n interface ServiceVariants {\n /** Values of the service variants. */\n values?: ServiceVariant[];\n }\n interface CreateServiceOptionsAndVariantsRequest {\n /** Service options and variants to create. */\n serviceOptionsAndVariants: ServiceOptionsAndVariants;\n }\n interface CreateServiceOptionsAndVariantsResponse {\n /** Information about the created service options and variants. */\n serviceOptionsAndVariants?: ServiceOptionsAndVariants;\n }\n interface CloneServiceOptionsAndVariantsRequest {\n /** ID of the `serviceOptionsAndVariants` object to clone. */\n cloneFromId: string;\n /** ID of the service that will be set for the cloned `serviceOptionsAndVariants` */\n targetServiceId: string;\n }\n interface CloneServiceOptionsAndVariantsResponse {\n /** The cloned `serviceOptionsAndVariants` object. */\n serviceOptionsAndVariants?: ServiceOptionsAndVariants;\n }\n interface GetServiceOptionsAndVariantsRequest {\n /** ID of the `serviceOptionsAndVariants` object to retrieve. */\n serviceOptionsAndVariantsId: string;\n }\n interface GetServiceOptionsAndVariantsResponse {\n /** Retrieved `serviceOptionsAndVariants` object. */\n serviceOptionsAndVariants?: ServiceOptionsAndVariants;\n }\n interface GetServiceOptionsAndVariantsByServiceIdRequest {\n /** ID of the service to retrieve options and variants for. */\n serviceId: string;\n }\n interface GetServiceOptionsAndVariantsByServiceIdResponse {\n /** Retrieved `serviceOptionsAndVariants` object. */\n serviceVariants?: ServiceOptionsAndVariants;\n }\n interface UpdateServiceOptionsAndVariantsRequest {\n /** `ServiceOptionsAndVariants` object to update. */\n serviceOptionsAndVariants: ServiceOptionsAndVariants;\n }\n interface UpdateServiceOptionsAndVariantsResponse {\n /** Updated `serviceOptionsAndVariants` object. */\n serviceOptionsAndVariants?: ServiceOptionsAndVariants;\n }\n interface DeleteServiceOptionsAndVariantsRequest {\n /** ID of the `serviceOptionsAndVariants` object to delete. */\n serviceOptionsAndVariantsId: string;\n /** Revision of the `serviceOptionsAndVariants` object to delete. */\n revision?: string;\n }\n interface DeleteServiceOptionsAndVariantsResponse {\n }\n interface QueryServiceOptionsAndVariantsRequest {\n /** Information about filters, paging, and returned fields. */\n query: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$1[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$1 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryServiceOptionsAndVariantsResponse {\n /** Retrieved `serviceOptionsAndVariants` objects. */\n serviceOptionsAndVariantsList?: ServiceOptionsAndVariants[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface ResourceNotification {\n /**\n * Updated resource entity.\n * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.\n */\n resource?: Resource;\n /** Event type. */\n event?: Event;\n }\n interface Resource {\n /**\n * Resource ID.\n * @readonly\n */\n _id?: string | null;\n /** Resource name. */\n name?: string | null;\n /** Resource email address. */\n email?: string | null;\n /** Resource phone number. */\n phone?: string | null;\n /** Resource description. */\n description?: string | null;\n /**\n * Deprecated. Please use tags.\n * @deprecated\n */\n tag?: string | null;\n /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */\n tags?: string[] | null;\n /** Resource images. */\n images?: string[];\n /**\n * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.\n * @deprecated\n */\n schedules?: Schedule$1[];\n /**\n * List of IDs of schedules owned by this resource.\n * @readonly\n */\n scheduleIds?: string[] | null;\n /**\n * Resource status.\n * @readonly\n */\n status?: ResourceStatus;\n /**\n * Wix user ID, if the resource is associated with the Wix user.\n * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.\n * @readonly\n */\n wixUserId?: string | null;\n }\n interface Schedule$1 {\n /** Schedule ID. */\n _id?: string;\n /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */\n scheduleOwnerId?: string | null;\n /**\n * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.\n * Derived from the Wix Business time zone.\n * @readonly\n */\n timeZone?: string | null;\n /**\n * Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead.\n * @deprecated\n */\n intervals?: RecurringInterval$1[];\n /** Default title for the schedule's sessions. Maximum length: 6000 characters. */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.\n * The Wix Bookings app uses the following predefined tags to set schedule type: `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE\"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.\n * @deprecated\n */\n tags?: string[] | null;\n /** Default location for the schedule's sessions. */\n location?: Location$2;\n /**\n * Maximum number of participants that can be added to the schedule's sessions.\n * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.\n */\n capacity?: number | null;\n /**\n * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.\n * @deprecated\n */\n rate?: Rate$1;\n /**\n * __Deprecated.__\n * @deprecated\n */\n availability?: Availability$1;\n /**\n * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** of participants which are registered to sessions in this schedule.\n * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.\n * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n * @readonly\n */\n participants?: Participant$1[];\n /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides$1;\n /**\n * Schedule status.\n * @readonly\n */\n status?: ScheduleStatus$1;\n /**\n * Schedule creation date.\n * @readonly\n */\n created?: Date;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * Fields which were inherited from the Business Info page under Settings in the Dashboard.\n * @readonly\n */\n inheritedFields?: string[];\n /**\n * __Deprecated.__\n * @deprecated\n */\n conferenceProvider?: ConferenceProvider$1;\n /**\n * A conference created for the schedule. This is used when a participant is added to a schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n * @deprecated\n */\n calendarConference?: CalendarConference$1;\n }\n interface RecurringInterval$1 {\n /**\n * The recurring interval identifier.\n * @readonly\n */\n _id?: string;\n /** The start time of the recurring interval. Required. */\n start?: Date;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date;\n /** The interval rules. The day, hour and minutes the interval is recurring. */\n interval?: Interval$1;\n /** The frequency of the interval. Optional. The default is frequency with the default repetition. */\n frequency?: Frequency$1;\n /** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */\n affectedSchedules?: LinkedSchedule$1[];\n /** The type of recurring interval. */\n intervalType?: RecurringIntervalType$1;\n }\n interface Interval$1 {\n /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */\n daysOfWeek?: Day$1;\n /** The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23. */\n hourOfDay?: number | null;\n /** The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59. */\n minuteOfHour?: number | null;\n /** The duration of the interval in minutes. Required. Part of the session end time calculation. */\n duration?: number;\n }\n enum Day$1 {\n /** Undefined. */\n UNDEFINED = \"UNDEFINED\",\n /** Monday. */\n MON = \"MON\",\n /** Tuesday. */\n TUE = \"TUE\",\n /** Wednesday. */\n WED = \"WED\",\n /** Thursday. */\n THU = \"THU\",\n /** Friday. */\n FRI = \"FRI\",\n /** Saturday. */\n SAT = \"SAT\",\n /** Sunday. */\n SUN = \"SUN\"\n }\n interface Frequency$1 {\n /** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */\n repetition?: number | null;\n }\n interface LinkedSchedule$1 {\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `\"BUSY\"`.\n * If set to `\"BUSY\"`, this schedule cannot have any available slots during the linked schedule's sessions.\n * If set to `\"FREE\"`, this schedule can have available slots during the linked schedule's sessions.\n */\n transparency?: Transparency$1;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n }\n enum Transparency$1 {\n UNDEFINED = \"UNDEFINED\",\n /** The schedule can have available slots during the session. */\n FREE = \"FREE\",\n /** The schedule cannot have available slots during the session. Default value. */\n BUSY = \"BUSY\"\n }\n enum RecurringIntervalType$1 {\n /** The default value. Sessions for this interval will be of type EVENT. */\n UNDEFINED = \"UNDEFINED\",\n /** A recurring interval of events */\n EVENT = \"EVENT\",\n /** Deprecated */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** A recurring interval for availability */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface Location$2 {\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: LocationType$2;\n /**\n * Free text address used when locationType is `OWNER_CUSTOM`.\n * @deprecated\n */\n address?: string | null;\n /** Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default. */\n customAddress?: Address$1;\n }\n enum LocationType$2 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface Address$1 extends AddressStreetOneOf$1 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$1;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation$1;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision$1[];\n }\n /** @oneof */\n interface AddressStreetOneOf$1 {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress$1;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation$1 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$1 {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface LocationsLocation$1 {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Notes:__\n * - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status.\n * - `INACTIVE` status is currently not supported.\n */\n status?: LocationStatus$1;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n * @deprecated\n */\n locationType?: LocationsLocationType$1;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: LocationsAddress$1;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$1;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationsLocationType$1[];\n }\n /** For future use */\n enum LocationStatus$1 {\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n /** For future use */\n enum LocationsLocationType$1 {\n UNKNOWN = \"UNKNOWN\",\n BRANCH = \"BRANCH\",\n OFFICES = \"OFFICES\",\n RECEPTION = \"RECEPTION\",\n HEADQUARTERS = \"HEADQUARTERS\",\n INVENTORY = \"INVENTORY\"\n }\n interface LocationsAddress$1 {\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n streetAddress?: LocationsStreetAddress$1;\n /** Full address of the location. */\n formatted?: string | null;\n /** Geographic coordinates of location. */\n location?: LocationsAddressLocation$1;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface LocationsStreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n /** Address Geolocation */\n interface LocationsAddressLocation$1 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number | null;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number | null;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$1 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$1[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$1[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$1 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$1;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$1;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$1 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$1 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Rate$1 {\n /**\n * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n labeledPriceOptions?: Record;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n priceText?: string | null;\n }\n interface Price$1 {\n /** Required payment amount. */\n amount?: string;\n /** Currency in which the amount is quoted. */\n currency?: string;\n /** Amount of a down payment or deposit as part of the transaction. */\n downPayAmount?: string;\n }\n /**\n * \n */\n interface Availability$1 {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date;\n /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */\n linkedSchedules?: LinkedSchedule$1[];\n /** Constraints for calculating the schedule's availability. */\n constraints?: AvailabilityConstraints$1;\n }\n /** Describes how to calculate the specific slots that are available for booking. */\n interface AvailabilityConstraints$1 {\n /**\n * A list of duration options for slots, in minutes. Minimum value for a duration is 1.\n * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.\n */\n slotDurations?: number[];\n /**\n * The number of minutes between the `end` of one slot, and the `start` of the next.\n * Minimum value is 0, maximum value is 120.\n */\n timeBetweenSlots?: number;\n /**\n * Specify how to split the slots in intervals of minutes.\n * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).\n * Optional. The default is the first duration in slot_durations field.\n * Deprecated. Use the `split_slots_interval.value_in_minutes`.\n * @deprecated\n */\n splitInterval?: number | null;\n /**\n * An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.\n * @readonly\n */\n slotsSplitInterval?: SplitInterval$1;\n }\n /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */\n interface SplitInterval$1 {\n /**\n * Whether the slot duration is used as the split interval value.\n * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.\n */\n sameAsDuration?: boolean | null;\n /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */\n valueInMinutes?: number | null;\n }\n interface Participant$1 {\n /** Participant ID. Currently represents the booking.id. */\n _id?: string;\n /** Contact ID. */\n contactId?: string | null;\n /** Participant's name. */\n name?: string | null;\n /** Participant's phone number. */\n phone?: string | null;\n /** Participant's email address. */\n email?: string | null;\n /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */\n partySize?: number;\n /**\n * Approval status for the participant.\n * \n */\n approvalStatus?: ApprovalStatus$1;\n /**\n * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.\n * @readonly\n */\n inherited?: boolean;\n }\n enum ApprovalStatus$1 {\n /** Default. */\n UNDEFINED = \"UNDEFINED\",\n /** Pending business approval. */\n PENDING = \"PENDING\",\n /** Approved by the business. */\n APPROVED = \"APPROVED\",\n /** Declined by the business. */\n DECLINED = \"DECLINED\"\n }\n interface ExternalCalendarOverrides$1 {\n /** Synced title of the external calendar event. */\n title?: string | null;\n /** Synced description of the external calendar event. */\n description?: string | null;\n }\n enum ScheduleStatus$1 {\n UNDEFINED = \"UNDEFINED\",\n /** The default value when the schedule is created. */\n CREATED = \"CREATED\",\n /** The schedule has been canceled. */\n CANCELLED = \"CANCELLED\"\n }\n interface Version$1 {\n /** Schedule version number, updated each time the schedule is updated. */\n scheduleVersion?: number | null;\n /** Participants version number, updated each time the schedule participants are updated. */\n participantsVersion?: number | null;\n }\n interface ConferenceProvider$1 {\n /** Conferencing provider ID */\n providerId?: string;\n }\n interface CalendarConference$1 {\n /** Wix Calendar conference ID. */\n _id?: string;\n /** Conference meeting ID in the provider's conferencing system. */\n externalId?: string;\n /** Conference provider ID. */\n providerId?: string;\n /** URL used by the host to start the conference. */\n hostUrl?: string;\n /** URL used by a guest to join the conference. */\n guestUrl?: string;\n /** Password to join the conference. */\n password?: string | null;\n /** Conference description. */\n description?: string | null;\n /** Conference type. */\n conferenceType?: ConferenceType$1;\n /** ID of the account owner in the video conferencing service. */\n accountOwnerId?: string | null;\n }\n enum ConferenceType$1 {\n UNDEFINED = \"UNDEFINED\",\n /** API-generated online meeting. */\n ONLINE_MEETING_PROVIDER = \"ONLINE_MEETING_PROVIDER\",\n /** User-defined meeting. */\n CUSTOM = \"CUSTOM\"\n }\n enum ResourceStatus {\n UNDEFINED = \"UNDEFINED\",\n /** Default status. */\n CREATED = \"CREATED\",\n /** The resource was deleted. */\n DELETED = \"DELETED\",\n /** The resource was updated. */\n UPDATED = \"UPDATED\"\n }\n interface BusinessLocation {\n /** The ID of the business location. Has to be non-empty */\n locationId?: string;\n }\n enum Event {\n UNDEFINED = \"UNDEFINED\",\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\",\n Schedule_Updated = \"Schedule_Updated\"\n }\n interface Empty$1 {\n }\n /** An event sent in the system once the service is changed. */\n interface ServiceNotification extends ServiceNotificationMetadataOneOf {\n deleteMetadata?: DeleteMetadata;\n /** Updated service entity. */\n service?: Service;\n event?: ServiceNotificationEvent;\n policy?: BusinessServicesPolicy;\n }\n /** @oneof */\n interface ServiceNotificationMetadataOneOf {\n deleteMetadata?: DeleteMetadata;\n }\n /** A service describes the business offering that a business provides to its customers. */\n interface Service {\n /**\n * Service ID.\n * @readonly\n */\n _id?: string | null;\n /** Information about the service. */\n info?: ServiceInfo;\n /** Description of the bookings policy for the service. */\n policy?: BookingPolicy;\n /** Payment options available for use when booking the service. */\n paymentOptions?: PaymentOptions;\n /** ID of the category to which the service belongs. */\n categoryId?: string | null;\n /** ID of the form that visitors fill out when booking the service. */\n bookingFormId?: string | null;\n /**\n * List of schedule IDs for the sessions and slots that can be booked for the service.\n * The list can include schedules with any `status` values, however the Bookings application only uses the schedules with a `status` of `\"CREATED\"`. There is only one schedule with a status of `\"CREATED\"` per service. The ID of that schedule must always be the first in the list.\n * @readonly\n */\n scheduleIds?: string[];\n /** Set of custom properties for the service. */\n customProperties?: Record;\n /**\n * Service status.\n * @readonly\n */\n status?: ServiceStatus;\n /** Sort order of the service within its category. */\n sortOrder?: number | null;\n /**\n * Advanced SEO data\n * @deprecated\n */\n advancedSeoData?: SeoSchema;\n /** SEO data */\n seoData?: SeoSchema;\n /** Whether a conference is to be generated for the service. */\n includeConferenceOption?: boolean | null;\n }\n /** Information describing the service. */\n interface ServiceInfo {\n /** Service name. */\n name?: string | null;\n /** Service description. */\n description?: string | null;\n /**\n * Images associated with the service. Deprecated.\n * @deprecated\n */\n images?: string[];\n /** Short service description. */\n tagLine?: string | null;\n /** Images associated with the service. Optional. Not supported yet. */\n media?: Media;\n }\n interface Media {\n /** Images associated with the service. */\n items?: MediaItem[];\n /** Primary image associated with the service. */\n mainMedia?: MediaItem;\n /** Cover image associated with the service. */\n coverMedia?: MediaItem;\n }\n interface MediaItem extends MediaItemItemOneOf {\n /** Image metadata. */\n image?: string;\n }\n /** @oneof */\n interface MediaItemItemOneOf {\n /** Image metadata. */\n image?: string;\n }\n /** A set of rules defining the policies for booking the service for visitors and members. */\n interface BookingPolicy {\n /** Maximum number of participants for a single booking. Defaults to 1. */\n maxParticipantsPerBooking?: number | null;\n /** Minimum number of minutes before the start of a session that a booking can be made. For a schedule, this is relative to the start time of the next session, excluding past sessions. Default value is taken form BusinessServicesPolicy. */\n bookUpToXMinutesBefore?: number | null;\n /** Minimum number of minutes before the start of a session that a booking can be canceled or rescheduled. Default value is taken form BusinessServicesPolicy. */\n cancelRescheduleUpToXMinutesBefore?: number | null;\n /** Whether online booking is available. Defaults to true. */\n isBookOnlineAllowed?: boolean | null;\n /** Whether bookings for the service can be canceled. Defaults to true. */\n isCancelAllowed?: boolean | null;\n /** Whether bookings for the service can be rescheduled. Defaults to true. */\n isRescheduleAllowed?: boolean | null;\n /** How far in advance a booking can be made. Default value is taken form BusinessServicesPolicy. */\n futureBookingsPolicy?: FutureBookingPolicy;\n /** Waitlist policy for the service. Default value is taken form BusinessServicesPolicy. */\n waitingListPolicy?: WaitingListPolicy;\n /** Bookings approval policy for the service. Empty by default. */\n bookingsApprovalPolicy?: BookingsApprovalPolicy;\n /**\n * A list of booking policy field names of fields that override the respective values of the default business booking policy.\n * Currently only 'service.policy.bookUpToXMinutesBefore' field is supported\n */\n overrideBusinessPolicyFields?: string[];\n /**\n * User defined cancellation policy message.\n * @readonly\n */\n cancellationPolicy?: string | null;\n }\n interface FutureBookingPolicy {\n /** Whether a limit is imposed on advance bookings. */\n shouldLimit?: boolean | null;\n /** How far in advance, in minutes, a session can be booked. Defaults to 10,080 minutes (3 days). */\n limitXMinutesToTheFuture?: number | null;\n }\n interface WaitingListPolicy {\n /** Whether waitlisting is enabled for the service. */\n isEnabled?: boolean | null;\n /** Number of spots available in the waitlist. Defaults to 10 spots. */\n capacity?: number | null;\n /** Amount of time a participant is given to book, once notified that a spot is available. Defaults to 10 minutes. */\n timeWindowMinutes?: number | null;\n }\n interface BookingsApprovalPolicy {\n /** Whether bookings to the service require approval. */\n isBusinessApprovalRequired?: boolean | null;\n /** Whether the booking requests affect the session or slot availability. For example, 3 booking requests for a 10-person session will cause the session to have 7 available spots, before the requests are approved. */\n requestsAffectsAvailability?: boolean | null;\n }\n /**\n * Payment options for the service. Multiple payment options can be enabled. For example:\n * For a service to be paid only online using WiX, then set wix_pay_online=true and the rest should be set to false.\n * For a service to accept payment online via Wix or in person, set the wix_pay_online=true & wix_pay_in_person=true.\n */\n interface PaymentOptions {\n /** Whether a booking made for the service can be paid online through Wix. */\n wixPayOnline?: boolean | null;\n /** Whether a booking made for the service can be paid in person. */\n wixPayInPerson?: boolean | null;\n /** Whether a booking made for the service can be paid in a customized way, defined by the API. */\n custom?: boolean | null;\n /** Whether a booking made for the service can be paid using Wix Pricing Plans. */\n wixPaidPlan?: boolean | null;\n }\n enum ServiceStatus {\n /** The default service status. */\n CREATED = \"CREATED\",\n /** The service is deleted. */\n DELETED = \"DELETED\"\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema {\n /** SEO tag information. */\n tags?: Tag[];\n /** SEO general settings. */\n settings?: Settings;\n }\n interface Keyword {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n }\n interface Tag {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\n * For example: `{'name': 'description', 'content': 'the description itself'}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{height: 300, width: 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword[];\n }\n enum ServiceNotificationEvent {\n Unspecified = \"Unspecified\",\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\"\n }\n /**\n * Defines the Bookings Policy applied to the business's services. The policy can be overridden for a service when setting the `Service.BookingsPolicy` property.\n * Unless overridden, each service inherits the settings in the business policy.\n */\n interface BusinessServicesPolicy {\n /** Minimum amount of time to make a booking before the start of the booked item. For sessions, this is relative to the start time of the session. For schedules, this is relative to the start time of the first session, excluding past sessions. Defaults to 0. */\n bookUpToXMinutesBefore?: number | null;\n /** Minimum time that a booking can be canceled or rescheduled before the session starts. Defaults to 0. */\n cancelRescheduleUpToXMinutesBefore?: number | null;\n /** An object specifying how far in advance a booking can be made. */\n futureBookingsPolicy?: FutureBookingPolicy;\n /** Waitlist policy for the service. Empty by default. */\n waitingListPolicy?: WaitingListPolicy;\n /** User defined cancellation policy message. */\n cancellationPolicy?: string | null;\n }\n interface DeleteMetadata {\n preserveFutureSessionsWithParticipants?: boolean;\n participantNotification?: ParticipantNotification$1;\n }\n interface ParticipantNotification$1 {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface ScheduleNotification$1 extends ScheduleNotificationEventOneOf$1 {\n scheduleCreated?: ScheduleCreated$1;\n scheduleUpdated?: ScheduleUpdated$1;\n scheduleCancelled?: ScheduleCancelled$1;\n sessionCreated?: SessionCreated$1;\n sessionUpdated?: SessionUpdated$1;\n sessionCancelled?: SessionCancelled$1;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated$1;\n /** @deprecated */\n intervalSplit?: IntervalSplit$1;\n recurringSessionSplit?: RecurringSessionSplit$1;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$1;\n preserveFutureSessionsWithParticipants?: boolean | null;\n /**\n * Whether to notify participants about changed sessions. deprecated, use participant_notification\n * @deprecated\n */\n notifyParticipants?: boolean;\n /** site properties. Optional. Given in create schedule notification. */\n siteProperties?: SitePropertiesOnScheduleCreation$1;\n instanceId?: string;\n }\n /** @oneof */\n interface ScheduleNotificationEventOneOf$1 {\n scheduleCreated?: ScheduleCreated$1;\n scheduleUpdated?: ScheduleUpdated$1;\n scheduleCancelled?: ScheduleCancelled$1;\n sessionCreated?: SessionCreated$1;\n sessionUpdated?: SessionUpdated$1;\n sessionCancelled?: SessionCancelled$1;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated$1;\n /** @deprecated */\n intervalSplit?: IntervalSplit$1;\n recurringSessionSplit?: RecurringSessionSplit$1;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$1;\n }\n interface ScheduleCreated$1 {\n schedule?: Schedule$1;\n }\n interface ScheduleUpdated$1 {\n /** The old schedule before the update. */\n oldSchedule?: Schedule$1;\n /** The new schedule after the update. */\n newSchedule?: Schedule$1;\n /**\n * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was\n * updating at least one of the given schedule's recurring sessions.\n * This event is triggered by create/update/delete recurring session apis.\n */\n recurringSessions?: RecurringSessionsUpdated$1;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$1;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface RecurringSessionsUpdated$1 {\n /** Old schedule's recurring session list. */\n oldRecurringSessions?: Session$1[];\n /** New schedule's recurring session list. */\n newRecurringSessions?: Session$1[];\n }\n interface Session$1 {\n /**\n * Session ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the schedule that the session belongs to. */\n scheduleId?: string;\n /**\n * ID of the resource or service that the session's schedule belongs to.\n * @readonly\n */\n scheduleOwnerId?: string | null;\n /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */\n originalStart?: Date;\n /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */\n start?: CalendarDateTime$1;\n /**\n * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.\n * If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end?: CalendarDateTime$1;\n /**\n * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.\n * The array is inherited from the schedule and can be overridden even if the session is a recurring session.\n */\n affectedSchedules?: LinkedSchedule$1[];\n /**\n * Session title.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n * @deprecated\n */\n tags?: string[] | null;\n /**\n * An object describing the location where the session takes place.\n * Defaults to the schedule location.\n * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.\n */\n location?: Location$2;\n /**\n * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n capacity?: number | null;\n /**\n * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.\n * @deprecated\n */\n rate?: Rate$1;\n /**\n * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.\n * If the session is a recurring session, this field must be empty.\n */\n timeReservedAfter?: number | null;\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * The number of participants booked for the session. Read-only.\n * Calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** list of participants booked for the session.\n * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.\n * If the session is a recurring session, this field must be empty.\n * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n */\n participants?: Participant$1[];\n /**\n * A list of properties for which values were inherited from the schedule.\n * This does not include participants that were inherited from the schedule.\n * @readonly\n */\n inheritedFields?: string[];\n /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides$1;\n /**\n * Session status.\n * @readonly\n */\n status?: Status$1;\n /**\n * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.\n * For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.\n * This field is omitted for single sessions or instances of recurring sessions.\n * Specified when the session was originally generated from a schedule recurring interval.\n * Deprecated. Use `recurringSessionId`.\n * @readonly\n * @deprecated\n */\n recurringIntervalId?: string | null;\n /**\n * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.\n * @readonly\n */\n recurringSessionId?: string | null;\n /** Session type. */\n type?: SessionType$1;\n /**\n * A conference created for the session according to the details set in the schedule's conference provider information.\n * If the session is a recurring session, this field is inherited from the schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n * @deprecated\n */\n calendarConference?: CalendarConference$1;\n /**\n * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n * \n */\n recurrence?: string | null;\n /**\n * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\n * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.\n * @readonly\n */\n instanceOfRecurrence?: string | null;\n /**\n * The session version.\n * Composed by the schedule, session and participants versions.\n * @readonly\n */\n version?: SessionVersion$1;\n }\n interface CalendarDateTime$1 {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.\n */\n timestamp?: Date;\n /** An object containing the local date and time for the business's time zone. */\n localDateTime?: LocalDateTime$1;\n /**\n * The time zone. Optional. Derived from the schedule's time zone.\n * In case this field is associated with recurring session, this field is empty.\n * @readonly\n */\n timeZone?: string | null;\n }\n interface LocalDateTime$1 {\n /** Year. 4-digit format. */\n year?: number | null;\n /** Month number, from 1-12. */\n monthOfYear?: number | null;\n /** Day of the month, from 1-31. */\n dayOfMonth?: number | null;\n /** Hour of the day in 24-hour format, from 0-23. */\n hourOfDay?: number | null;\n /** Minute, from 0-59. */\n minutesOfHour?: number | null;\n }\n interface ExternalCalendarInfo$1 {\n /** The external calendar type (e.g. Google Calendar, iCal, etc). */\n calendarType?: CalendarType$1;\n }\n enum CalendarType$1 {\n UNDEFINED = \"UNDEFINED\",\n GOOGLE = \"GOOGLE\",\n I_CAL = \"I_CAL\",\n /** Use `MICROSOFT` instead. */\n OUTLOOK = \"OUTLOOK\",\n /** Use `MICROSOFT` instead. */\n OFFICE_365 = \"OFFICE_365\",\n MICROSOFT = \"MICROSOFT\",\n OTHER = \"OTHER\"\n }\n enum Status$1 {\n UNDEFINED = \"UNDEFINED\",\n /** The session is confirmed. Default status. */\n CONFIRMED = \"CONFIRMED\",\n /**\n * The session is cancelled.\n * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.\n * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.\n */\n CANCELLED = \"CANCELLED\"\n }\n enum SessionType$1 {\n UNDEFINED = \"UNDEFINED\",\n /**\n * The session creates an event on the calendar for the owner of the schedule that the session belongs to.\n * Default type.\n */\n EVENT = \"EVENT\",\n /** The session represents a resource's available working hours. */\n WORKING_HOURS = \"WORKING_HOURS\",\n /** Deprecated. please use WORKING_HOURS */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface SessionVersion$1 {\n /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */\n number?: string | null;\n }\n interface ScheduleCancelled$1 {\n schedule?: Schedule$1;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$1;\n oldSchedule?: Schedule$1;\n }\n interface SessionCreated$1 {\n session?: Session$1;\n }\n interface SessionUpdated$1 {\n oldSession?: Session$1;\n newSession?: Session$1;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$1;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface SessionCancelled$1 {\n session?: Session$1;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$1;\n }\n interface AvailabilityPolicyUpdated$1 {\n availabilityPolicy?: AvailabilityPolicy$1;\n }\n /** Availability policy applied to all site schedules. */\n interface AvailabilityPolicy$1 {\n /** Specify how to split the schedule slots in intervals of minutes. */\n splitInterval?: SplitInterval$1;\n }\n interface IntervalSplit$1 {\n scheduleId?: string;\n intervals?: RecurringInterval$1[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n interface RecurringSessionSplit$1 {\n scheduleId?: string;\n recurringSessions?: Session$1[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n /** Schedule unassigned from user. */\n interface ScheduleUnassignedFromUser$1 {\n /** The Wix user id. */\n userId?: string | null;\n /** The schedule that was unassigned from the user. */\n schedule?: Schedule$1;\n }\n interface MultipleSessionsCreated$1 {\n schedulesWithSessions?: ScheduleWithSessions$1[];\n }\n interface ScheduleWithSessions$1 {\n schedule?: Schedule$1;\n siteProperties?: SitePropertiesOnScheduleCreation$1;\n sessions?: Session$1[];\n }\n interface SitePropertiesOnScheduleCreation$1 {\n /** The global time zone value. */\n timeZone?: string | null;\n }\n interface MigrationEvent$1 {\n migrationData?: MigrationData$1;\n }\n interface MigrationData$1 {\n businessId?: string | null;\n staffs?: StaffData$1[];\n }\n interface StaffData$1 {\n resourceId?: string;\n syncRequestEmail?: string;\n refreshToken?: string;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */\n interface SitePropertiesNotification {\n /** The site ID for which this update notification applies. */\n metasiteId?: string;\n /** The actual update event. */\n event?: SitePropertiesEvent;\n /** A convenience set of mappings from the MetaSite ID to its constituent services. */\n translations?: Translation[];\n /** Context of the notification */\n changeContext?: ChangeContext;\n }\n /** The actual update event for a particular notification. */\n interface SitePropertiesEvent {\n /** Version of the site's properties represented by this update. */\n version?: number;\n /** Updated properties. */\n properties?: Properties;\n }\n interface Properties {\n /** Site categories. */\n categories?: Categories;\n /** Site locale. */\n locale?: Locale;\n /**\n * Site language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Site currency format used to bill customers.\n *\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n paymentCurrency?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Fax number. */\n fax?: string | null;\n /** Address. */\n address?: V4Address;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n /**\n * Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$1;\n /** Supported languages of a site and the primary language. */\n multilingual?: Multilingual;\n /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */\n consentPolicy?: ConsentPolicy;\n /**\n * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n *\n * Site business type.\n */\n businessConfig?: string | null;\n /** External site url that uses Wix as its headless business solution */\n externalSiteUrl?: string | null;\n /** Track clicks analytics */\n trackClicksAnalytics?: boolean;\n }\n interface Categories {\n /** Primary site category. */\n primary?: string;\n /** Secondary site category. */\n secondary?: string[];\n /** Business Term Id */\n businessTermId?: string | null;\n }\n interface Locale {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string;\n }\n interface V4Address {\n /** Street name. */\n street?: string;\n /** City name. */\n city?: string;\n /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string;\n /** State. */\n state?: string;\n /** Zip or postal code. */\n zip?: string;\n /** Extra information to be displayed in the address. */\n hint?: AddressHint;\n /** Whether this address represents a physical location. */\n isPhysical?: boolean;\n /** Google-formatted version of this address. */\n googleFormattedAddress?: string;\n /** Street number. */\n streetNumber?: string;\n /** Apartment number. */\n apartmentNumber?: string;\n /** Geographic coordinates of location. */\n coordinates?: GeoCoordinates;\n }\n /**\n * Extra information on displayed addresses.\n * This is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\n * Free text. In addition the user can state where he wants that additional description - before, after, or instead\n * the address string.\n */\n interface AddressHint {\n /** Extra text displayed next to, or instead of, the actual address. */\n text?: string;\n /** Where the extra text should be displayed. */\n placement?: PlacementType;\n }\n /** Where the extra text should be displayed: before, after or instead of the actual address. */\n enum PlacementType {\n BEFORE = \"BEFORE\",\n AFTER = \"AFTER\",\n REPLACE = \"REPLACE\"\n }\n /** Geocoordinates for a particular address. */\n interface GeoCoordinates {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number;\n }\n interface Multilingual {\n /** Supported languages list. */\n supportedLanguages?: SupportedLanguage[];\n /** Whether to redirect to user language. */\n autoRedirect?: boolean;\n }\n interface SupportedLanguage {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Locale. */\n locale?: Locale;\n /** Whether the supported language is the primary language for the site. */\n isPrimary?: boolean;\n /** Language icon. */\n countryCode?: string;\n /** How the language will be resolved. For internal use. */\n resolutionMethod?: ResolutionMethod;\n }\n enum ResolutionMethod {\n QUERY_PARAM = \"QUERY_PARAM\",\n SUBDOMAIN = \"SUBDOMAIN\",\n SUBDIRECTORY = \"SUBDIRECTORY\"\n }\n interface ConsentPolicy {\n /** Whether the site uses cookies that are essential to site operation. */\n essential?: boolean | null;\n /** Whether the site uses cookies that affect site performance and other functional measurements. */\n functional?: boolean | null;\n /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */\n analytics?: boolean | null;\n /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */\n advertising?: boolean | null;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean | null;\n }\n /** A single mapping from the MetaSite ID to a particular service. */\n interface Translation {\n /** The service type. */\n serviceType?: string;\n /** The application definition ID; this only applies to services of type ThirdPartyApps. */\n appDefId?: string;\n /** The instance ID of the service. */\n instanceId?: string;\n }\n interface ChangeContext extends ChangeContextPayloadOneOf {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned;\n }\n /** @oneof */\n interface ChangeContextPayloadOneOf {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned;\n }\n interface PropertiesChange {\n }\n interface SiteCreated {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned {\n /** Origin site id. */\n originMetaSiteId?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates options and variants for a service.\n *\n * Before creating the `serviceOptionsAndVariants` object you need to anticipate and manually define\n * all variants based on the defined options and their choices. You then pass\n * the `options` and `variants` arrays in the\n * request. Variants aren't automatically calculated from the defined options and choices.\n *\n * __Current Limitations:__\n *\n * + Only a single `serviceOptionsAndVariants` object is supported per service.\n *\n * + Only a single option is supported per `serviceOptionsAndVariants` object. This means that services are limited to a single option. Therefore, `variants`provides pricing details for either all choices of the single option (for `CUSTOM` options) or all staff members providing the service (for `STAFF_MEMBER` options).\n *\n * For a list of error messages, see [Create Service Options and Variants Errors](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/error-messages#service-options-and-variants_error-messages_create-service-options-and-variants-errors).\n * @param serviceOptionsAndVariants - Service options and variants to create.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceOptionsAndVariants\n * @requiredField serviceOptionsAndVariants.options\n * @requiredField serviceOptionsAndVariants.serviceId\n * @requiredField serviceOptionsAndVariants.variants\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Information about the created service options and variants.\n */\n function createServiceOptionsAndVariants(serviceOptionsAndVariants: ServiceOptionsAndVariants): Promise;\n /**\n * Clones a `serviceOptionsAndVariants` object. This function can be called, for example, to duplicate a service.\n * The cloned service contains the original service options and variants.\n *\n * Each option\n * in the cloned service has a newly-generated ID that is copied to all choices of the variants in the\n * clone. The cloned service references the service provided in the request by `target_service_id`.\n * @param cloneFromId - ID of the `serviceOptionsAndVariants` object to clone.\n * @param targetServiceId - ID of the service that will be set for the cloned `serviceOptionsAndVariants`\n * @public\n * @documentationMaturity preview\n * @requiredField cloneFromId\n * @requiredField targetServiceId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function cloneServiceOptionsAndVariants(cloneFromId: string, targetServiceId: string): Promise;\n /**\n * Retrieves a `serviceOptionsAndVariants` object by `service_options_and_variants_id`.\n * @param serviceOptionsAndVariantsId - ID of the `serviceOptionsAndVariants` object to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceOptionsAndVariantsId\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Retrieved `serviceOptionsAndVariants` object.\n */\n function getServiceOptionsAndVariants(serviceOptionsAndVariantsId: string): Promise;\n /**\n * Retrieves a service's options and variants by `service_id`.\n * @param serviceId - ID of the service to retrieve options and variants for.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceId\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getServiceOptionsAndVariantsByServiceId(serviceId: string): Promise;\n /**\n * Updates the specified fields of the `serviceOptionsAndVariants` object.\n *\n * Currently, only a single option is supported per `serviceOptionsAndVariants` object.\n *\n * If you want to update `variants`, you must pass the full list of supported variants.\n *\n * If you want to update `options`, you must pass the full list of supported options.\n * @param _id - ID of the `serviceOptionsAndVariants` object.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField serviceOptionsAndVariants\n * @requiredField serviceOptionsAndVariants.revision\n * @param serviceOptionsAndVariants - Service options and variants to update.\n * @param options - Options for updating the service options and variants.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated `serviceOptionsAndVariants` object.\n */\n function updateServiceOptionsAndVariants(_id: string | null, serviceOptionsAndVariants: UpdateServiceOptionsAndVariants, options?: UpdateServiceOptionsAndVariantsOptions): Promise;\n interface UpdateServiceOptionsAndVariants {\n /**\n * ID of the `serviceOptionsAndVariants` object.\n * @readonly\n */\n _id?: string | null;\n /** ID of the service related to these options and variants. */\n serviceId?: string | null;\n /** Service options. Note that currently only a single option is supported per service. */\n options?: ServiceOptions;\n /** Information about the service's variants. */\n variants?: ServiceVariants;\n /**\n * Price of the cheapest service variant.\n * @readonly\n */\n minPrice?: Money;\n /**\n * Price of the most expensive service variant.\n * @readonly\n */\n maxPrice?: Money;\n /**\n * Revision number, which increments by 1 each time the `serviceOptionsAndVariants` object is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating and deleting the `serviceOptionsAndVariants` object.\n *\n * Ignored when creating a `serviceOptionsAndVariants` object.\n */\n revision?: string | null;\n }\n interface UpdateServiceOptionsAndVariantsOptions {\n }\n /**\n * Deletes a `serviceOptionsAndVariants` object.\n *\n *\n * Because each service has only a single `serviceOptionsAndVariants` object, the\n * service won't have any supported options and variants any longer. Instead,\n * the standard Wix Bookings service price calculation is used.\n * @param serviceOptionsAndVariantsId - ID of the `serviceOptionsAndVariants` object to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceOptionsAndVariantsId\n * @param options - Options for deleting the service options and variants.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteServiceOptionsAndVariants(serviceOptionsAndVariantsId: string, options?: DeleteServiceOptionsAndVariantsOptions): Promise;\n interface DeleteServiceOptionsAndVariantsOptions {\n /** Revision of the `serviceOptionsAndVariants` object to delete. */\n revision?: string;\n }\n /**\n * Retrieves a list of `serviceOptionsAndVariants`, given the provided paging, filtering, and sorting.\n *\n * queryServiceOptionsAndVariants() runs with these defaults, which you can override:\n *\n * - `id` is sorted in `ASC` order\n * - `cursorPaging.limit` is `100`\n *\n * For a detailed list of supported filtering operations see\n * [supported filters](https://www.wix.com/velo/reference/wix-bookings-v2/serviceoptionsandvariants/filters).\n * @public\n * @documentationMaturity preview\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryServiceOptionsAndVariants(): ServiceOptionsAndVariantsListQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ServiceOptionsAndVariantsListQueryResult extends QueryCursorResult {\n items: ServiceOptionsAndVariants[];\n query: ServiceOptionsAndVariantsListQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ServiceOptionsAndVariantsListQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"serviceId\", value: any) => ServiceOptionsAndVariantsListQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"serviceId\", value: any) => ServiceOptionsAndVariantsListQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"options.values.id\" | \"options.values.type\" | \"variants.values.choices.custom\" | \"variants.values.choices.optionId\" | \"variants.values.price.value\" | \"variants.values.price.currency\", value: any[]) => ServiceOptionsAndVariantsListQueryBuilder;\n /**\n * Refines a query to match items where the specified property is in a short list of specified values.\n * @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"serviceId\", value: any) => ServiceOptionsAndVariantsListQueryBuilder;\n /**\n * Refines a query to match items where the specified property is in a list of specified values, such as from another table.\n * @documentationMaturity preview */\n exists: (propertyName: \"options.values\" | \"variants.values\", value: boolean) => ServiceOptionsAndVariantsListQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in ascending order.\n *\n * The `ascending()` function refines a `CUSTOM_QUERY_BUILDER_NAME` to sort by the value of `propertyName` in ascending order. You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed. You can sort the following types:\n *\n * - Number: Sorts numerically.\n * - Date: Sorts by date and time.\n * - String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`. If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\n * @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"serviceId\">) => ServiceOptionsAndVariantsListQueryBuilder;\n /**\n * Adds a sort to a query, sorting by the specified properties in descending order.\n *\n * The `descending()` function refines a `CUSTOM_QUERY_BUILDER_NAME` to sort by the value of `propertyName` in descending order.\n *\n * You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed. You can sort the following types:\n *\n * - Number: Sorts numerically.\n * - Date: Sorts by date and time.\n * - String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`. If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\n * @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"serviceId\">) => ServiceOptionsAndVariantsListQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => ServiceOptionsAndVariantsListQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ServiceOptionsAndVariantsListQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariants = ServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOption = ServiceOption;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionOptionSpecificDataOneOf = ServiceOptionOptionSpecificDataOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionType = ServiceOptionType;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionType: typeof ServiceOptionType;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CustomServiceOption = CustomServiceOption;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceVariant = ServiceVariant;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceChoice = ServiceChoice;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceChoiceChoiceOneOf = ServiceChoiceChoiceOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Money = Money;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptions = ServiceOptions;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceVariants = ServiceVariants;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsRequest = CreateServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsResponse = CreateServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsRequest = CloneServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsResponse = CloneServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsRequest = GetServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsResponse = GetServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdRequest = GetServiceOptionsAndVariantsByServiceIdRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdResponse = GetServiceOptionsAndVariantsByServiceIdResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsRequest = UpdateServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsResponse = UpdateServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsRequest = DeleteServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsResponse = DeleteServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsRequest = QueryServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Paging = Paging;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsResponse = QueryServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResourceNotification = ResourceNotification;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Resource = Resource;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResourceStatus = ResourceStatus;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResourceStatus: typeof ResourceStatus;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BusinessLocation = BusinessLocation;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Event = Event;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Event: typeof Event;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotification = ServiceNotification;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotificationMetadataOneOf = ServiceNotificationMetadataOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Service = Service;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceInfo = ServiceInfo;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Media = Media;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_MediaItem = MediaItem;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_MediaItemItemOneOf = MediaItemItemOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BookingPolicy = BookingPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_FutureBookingPolicy = FutureBookingPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_WaitingListPolicy = WaitingListPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BookingsApprovalPolicy = BookingsApprovalPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PaymentOptions = PaymentOptions;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceStatus = ServiceStatus;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceStatus: typeof ServiceStatus;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SeoSchema = SeoSchema;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Keyword = Keyword;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Tag = Tag;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Settings = Settings;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotificationEvent = ServiceNotificationEvent;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotificationEvent: typeof ServiceNotificationEvent;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BusinessServicesPolicy = BusinessServicesPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteMetadata = DeleteMetadata;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_RestoreInfo = RestoreInfo;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SitePropertiesNotification = SitePropertiesNotification;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SitePropertiesEvent = SitePropertiesEvent;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Properties = Properties;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Categories = Categories;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Locale = Locale;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_V4Address = V4Address;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_AddressHint = AddressHint;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PlacementType = PlacementType;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PlacementType: typeof PlacementType;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GeoCoordinates = GeoCoordinates;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Multilingual = Multilingual;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SupportedLanguage = SupportedLanguage;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResolutionMethod = ResolutionMethod;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResolutionMethod: typeof ResolutionMethod;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ConsentPolicy = ConsentPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Translation = Translation;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ChangeContext = ChangeContext;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PropertiesChange = PropertiesChange;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SiteCreated = SiteCreated;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SiteCloned = SiteCloned;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_MessageEnvelope = MessageEnvelope;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_IdentificationData = IdentificationData;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_WebhookIdentityType = WebhookIdentityType;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_createServiceOptionsAndVariants: typeof createServiceOptionsAndVariants;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_cloneServiceOptionsAndVariants: typeof cloneServiceOptionsAndVariants;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariants: typeof getServiceOptionsAndVariants;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariantsByServiceId: typeof getServiceOptionsAndVariantsByServiceId;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_updateServiceOptionsAndVariants: typeof updateServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariants = UpdateServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsOptions = UpdateServiceOptionsAndVariantsOptions;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_deleteServiceOptionsAndVariants: typeof deleteServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsOptions = DeleteServiceOptionsAndVariantsOptions;\n const bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_queryServiceOptionsAndVariants: typeof queryServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryResult = ServiceOptionsAndVariantsListQueryResult;\n type bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryBuilder = ServiceOptionsAndVariantsListQueryBuilder;\n namespace bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d {\n export { bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariants as ServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOption as ServiceOption, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionOptionSpecificDataOneOf as ServiceOptionOptionSpecificDataOneOf, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionType as ServiceOptionType, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CustomServiceOption as CustomServiceOption, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceVariant as ServiceVariant, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceChoice as ServiceChoice, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceChoiceChoiceOneOf as ServiceChoiceChoiceOneOf, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Money as Money, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptions as ServiceOptions, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceVariants as ServiceVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsRequest as CreateServiceOptionsAndVariantsRequest, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsResponse as CreateServiceOptionsAndVariantsResponse, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsRequest as CloneServiceOptionsAndVariantsRequest, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsResponse as CloneServiceOptionsAndVariantsResponse, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsRequest as GetServiceOptionsAndVariantsRequest, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsResponse as GetServiceOptionsAndVariantsResponse, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdRequest as GetServiceOptionsAndVariantsByServiceIdRequest, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdResponse as GetServiceOptionsAndVariantsByServiceIdResponse, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsRequest as UpdateServiceOptionsAndVariantsRequest, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsResponse as UpdateServiceOptionsAndVariantsResponse, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsRequest as DeleteServiceOptionsAndVariantsRequest, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsResponse as DeleteServiceOptionsAndVariantsResponse, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsRequest as QueryServiceOptionsAndVariantsRequest, QueryV2$1 as QueryV2, QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf, Sorting$1 as Sorting, SortOrder$1 as SortOrder, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Paging as Paging, CursorPaging$1 as CursorPaging, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsResponse as QueryServiceOptionsAndVariantsResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResourceNotification as ResourceNotification, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Resource as Resource, Schedule$1 as Schedule, RecurringInterval$1 as RecurringInterval, Interval$1 as Interval, Day$1 as Day, Frequency$1 as Frequency, LinkedSchedule$1 as LinkedSchedule, Transparency$1 as Transparency, RecurringIntervalType$1 as RecurringIntervalType, Location$2 as Location, LocationType$2 as LocationType, Address$1 as Address, AddressStreetOneOf$1 as AddressStreetOneOf, StreetAddress$1 as StreetAddress, AddressLocation$1 as AddressLocation, Subdivision$1 as Subdivision, LocationsLocation$1 as LocationsLocation, LocationStatus$1 as LocationStatus, LocationsLocationType$1 as LocationsLocationType, LocationsAddress$1 as LocationsAddress, LocationsStreetAddress$1 as LocationsStreetAddress, LocationsAddressLocation$1 as LocationsAddressLocation, BusinessSchedule$1 as BusinessSchedule, TimePeriod$1 as TimePeriod, DayOfWeek$1 as DayOfWeek, SpecialHourPeriod$1 as SpecialHourPeriod, Rate$1 as Rate, Price$1 as Price, Availability$1 as Availability, AvailabilityConstraints$1 as AvailabilityConstraints, SplitInterval$1 as SplitInterval, Participant$1 as Participant, ApprovalStatus$1 as ApprovalStatus, ExternalCalendarOverrides$1 as ExternalCalendarOverrides, ScheduleStatus$1 as ScheduleStatus, Version$1 as Version, ConferenceProvider$1 as ConferenceProvider, CalendarConference$1 as CalendarConference, ConferenceType$1 as ConferenceType, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResourceStatus as ResourceStatus, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BusinessLocation as BusinessLocation, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Event as Event, Empty$1 as Empty, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotification as ServiceNotification, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotificationMetadataOneOf as ServiceNotificationMetadataOneOf, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Service as Service, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceInfo as ServiceInfo, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Media as Media, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_MediaItem as MediaItem, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_MediaItemItemOneOf as MediaItemItemOneOf, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BookingPolicy as BookingPolicy, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_FutureBookingPolicy as FutureBookingPolicy, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_WaitingListPolicy as WaitingListPolicy, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BookingsApprovalPolicy as BookingsApprovalPolicy, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PaymentOptions as PaymentOptions, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceStatus as ServiceStatus, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SeoSchema as SeoSchema, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Keyword as Keyword, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Tag as Tag, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Settings as Settings, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceNotificationEvent as ServiceNotificationEvent, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_BusinessServicesPolicy as BusinessServicesPolicy, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteMetadata as DeleteMetadata, ParticipantNotification$1 as ParticipantNotification, ScheduleNotification$1 as ScheduleNotification, ScheduleNotificationEventOneOf$1 as ScheduleNotificationEventOneOf, ScheduleCreated$1 as ScheduleCreated, ScheduleUpdated$1 as ScheduleUpdated, RecurringSessionsUpdated$1 as RecurringSessionsUpdated, Session$1 as Session, CalendarDateTime$1 as CalendarDateTime, LocalDateTime$1 as LocalDateTime, ExternalCalendarInfo$1 as ExternalCalendarInfo, CalendarType$1 as CalendarType, Status$1 as Status, SessionType$1 as SessionType, SessionVersion$1 as SessionVersion, ScheduleCancelled$1 as ScheduleCancelled, SessionCreated$1 as SessionCreated, SessionUpdated$1 as SessionUpdated, SessionCancelled$1 as SessionCancelled, AvailabilityPolicyUpdated$1 as AvailabilityPolicyUpdated, AvailabilityPolicy$1 as AvailabilityPolicy, IntervalSplit$1 as IntervalSplit, RecurringSessionSplit$1 as RecurringSessionSplit, ScheduleUnassignedFromUser$1 as ScheduleUnassignedFromUser, MultipleSessionsCreated$1 as MultipleSessionsCreated, ScheduleWithSessions$1 as ScheduleWithSessions, SitePropertiesOnScheduleCreation$1 as SitePropertiesOnScheduleCreation, MigrationEvent$1 as MigrationEvent, MigrationData$1 as MigrationData, StaffData$1 as StaffData, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_RestoreInfo as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SitePropertiesNotification as SitePropertiesNotification, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SitePropertiesEvent as SitePropertiesEvent, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Properties as Properties, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Categories as Categories, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Locale as Locale, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_V4Address as V4Address, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_AddressHint as AddressHint, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PlacementType as PlacementType, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_GeoCoordinates as GeoCoordinates, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Multilingual as Multilingual, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SupportedLanguage as SupportedLanguage, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ResolutionMethod as ResolutionMethod, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ConsentPolicy as ConsentPolicy, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_Translation as Translation, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ChangeContext as ChangeContext, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_PropertiesChange as PropertiesChange, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SiteCreated as SiteCreated, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_SiteCloned as SiteCloned, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_MessageEnvelope as MessageEnvelope, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_IdentificationData as IdentificationData, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_WebhookIdentityType as WebhookIdentityType, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_createServiceOptionsAndVariants as createServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_cloneServiceOptionsAndVariants as cloneServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariants as getServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariantsByServiceId as getServiceOptionsAndVariantsByServiceId, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_updateServiceOptionsAndVariants as updateServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariants as UpdateServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsOptions as UpdateServiceOptionsAndVariantsOptions, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_deleteServiceOptionsAndVariants as deleteServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsOptions as DeleteServiceOptionsAndVariantsOptions, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_queryServiceOptionsAndVariants as queryServiceOptionsAndVariants, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryResult as ServiceOptionsAndVariantsListQueryResult, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryBuilder as ServiceOptionsAndVariantsListQueryBuilder, };\n }\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface SessionView {\n /**\n * The view end date.\n * @readonly\n */\n endDate?: Date;\n }\n interface SessionViewUpdated extends SessionViewUpdatedTypeOneOf {\n /** Session has been added or updated within the view. */\n sessionAddedOrUpdated?: SessionAddedOrUpdated;\n /** Session has been removed from the view. */\n sessionRemoved?: SessionRemoved;\n }\n /** @oneof */\n interface SessionViewUpdatedTypeOneOf {\n /** Session has been added or updated within the view. */\n sessionAddedOrUpdated?: SessionAddedOrUpdated;\n /** Session has been removed from the view. */\n sessionRemoved?: SessionRemoved;\n }\n interface SessionAddedOrUpdated {\n /** The session which was added or updated within the view. */\n session?: Session;\n /** Optionally, the previous session. */\n previousSession?: Session;\n }\n interface Session {\n /**\n * Session ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the schedule that the session belongs to. */\n scheduleId?: string;\n /**\n * ID of the resource or service that the session's schedule belongs to.\n * @readonly\n */\n scheduleOwnerId?: string | null;\n /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */\n originalStart?: Date;\n /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */\n start?: CalendarDateTime;\n /**\n * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.\n * If the session is a recurring session, `end` must contain a `localDateTime`.\n */\n end?: CalendarDateTime;\n /**\n * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.\n * The array is inherited from the schedule and can be overridden even if the session is a recurring session.\n */\n affectedSchedules?: LinkedSchedule[];\n /**\n * Session title.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for the session.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n tags?: string[] | null;\n /**\n * An object describing the location where the session takes place.\n * Defaults to the schedule location.\n * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.\n */\n location?: Location$1;\n /**\n * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.\n * The value is inherited from the schedule and can be overridden unless the session is a recurring session.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate;\n /**\n * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.\n * If the session is a recurring session, this field must be empty.\n */\n timeReservedAfter?: number | null;\n /**\n * Additional information about the session.\n * Notes are not supported for recurring sessions.\n */\n notes?: string;\n /**\n * The number of participants booked for the session. Read-only.\n * Calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** list of participants booked for the session.\n * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.\n * If the session is a recurring session, this field must be empty.\n * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n */\n participants?: Participant[];\n /**\n * A list of properties for which values were inherited from the schedule.\n * This does not include participants that were inherited from the schedule.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides;\n /**\n * Session status.\n * \n * @readonly\n */\n status?: Status;\n /**\n * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.\n * For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.\n * This field is omitted for single sessions or instances of recurring sessions.\n * Specified when the session was originally generated from a schedule recurring interval.\n * Deprecated. Use `recurringSessionId`.\n * @readonly\n */\n recurringIntervalId?: string | null;\n /**\n * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.\n * @readonly\n */\n recurringSessionId?: string | null;\n /**\n * Session type.\n * \n */\n type?: SessionType;\n /**\n * A conference created for the session according to the details set in the schedule's conference provider information.\n * If the session is a recurring session, this field is inherited from the schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference;\n /**\n * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).\n * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.\n * The RRULE defines a rule for repeating a session.\n * Supported parameters are:\n *\n * |Keyword|Description|Supported values|\n * |--|--|---|\n * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|\n * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|\n * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|\n * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|\n *\n *\n * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:\n * `\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z\"`\n *\n * \n */\n recurrence?: string | null;\n /**\n * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.\n * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.\n * @readonly\n */\n instanceOfRecurrence?: string | null;\n /**\n * The session version.\n * Composed by the schedule, session and participants versions.\n * @readonly\n */\n version?: SessionVersion;\n }\n interface CalendarDateTime {\n /**\n * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `\"2021-01-06T23:00:00.000Z\"`.\n * Required if `localDateTime` is not specified.\n * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.\n */\n timestamp?: Date;\n /** An object containing the local date and time for the business's time zone. */\n localDateTime?: LocalDateTime;\n /**\n * The time zone. Optional. Derived from the schedule's time zone.\n * In case this field is associated with recurring session, this field is empty.\n * @readonly\n */\n timeZone?: string | null;\n }\n interface LocalDateTime {\n /** Year. 4-digit format. */\n year?: number | null;\n /** Month number, from 1-12. */\n monthOfYear?: number | null;\n /** Day of the month, from 1-31. */\n dayOfMonth?: number | null;\n /** Hour of the day in 24-hour format, from 0-23. */\n hourOfDay?: number | null;\n /** Minute, from 0-59. */\n minutesOfHour?: number | null;\n }\n interface LinkedSchedule {\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `\"BUSY\"`.\n * \n * If set to `\"BUSY\"`, this schedule cannot have any available slots during the linked schedule's sessions.\n * If set to `\"FREE\"`, this schedule can have available slots during the linked schedule's sessions.\n * \n *\n * \n */\n transparency?: Transparency;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n }\n enum Transparency {\n UNDEFINED = \"UNDEFINED\",\n /** The schedule can have available slots during the session. */\n FREE = \"FREE\",\n /** The schedule cannot have available slots during the session. Default value. */\n BUSY = \"BUSY\"\n }\n interface Location$1 {\n /**\n * Location type.\n * One of:\n * - `\"OWNER_BUSINESS\"` The business address as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"` The address as set when creating the service.\n * - `\"CUSTOM\"` The address set for the individual session.\n */\n locationType?: LocationType$1;\n /** Free text address used when locationType is `OWNER_CUSTOM`. */\n address?: string | null;\n /** Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default. */\n customAddress?: Address;\n }\n enum LocationType$1 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** A string containing the full address of this location. */\n formattedAddress?: string | null;\n /** Free text to help find the address. */\n hint?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation;\n /** Country full name. */\n countryFullname?: string | null;\n /** Multi-level subdivisions from top to bottom. */\n subdivisions?: Subdivision[];\n }\n /** @oneof */\n interface AddressStreetOneOf {\n /** Street name, number and apartment number. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n interface AddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision {\n /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n interface LocationsLocation {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status. `INACTIVE` is currently not supported.\n */\n status?: LocationStatus;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n */\n locationType?: LocationsLocationType;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: LocationsAddress;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationsLocationType[];\n }\n /** For future use */\n enum LocationStatus {\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n /** For future use */\n enum LocationsLocationType {\n UNKNOWN = \"UNKNOWN\",\n BRANCH = \"BRANCH\",\n OFFICES = \"OFFICES\",\n RECEPTION = \"RECEPTION\",\n HEADQUARTERS = \"HEADQUARTERS\",\n INVENTORY = \"INVENTORY\"\n }\n interface LocationsAddress {\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n streetAddress?: LocationsStreetAddress;\n /** Full address of the location. */\n formatted?: string | null;\n /** Geographic coordinates of location. */\n location?: LocationsAddressLocation;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface LocationsStreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n /** Address Geolocation */\n interface LocationsAddressLocation {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number | null;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number | null;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Rate {\n /**\n * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n labeledPriceOptions?: Record;\n /**\n * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.\n * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.\n */\n priceText?: string | null;\n }\n interface Price {\n /** Required payment amount. */\n amount?: string;\n /** Currency in which the amount is quoted. */\n currency?: string;\n /** Amount of a down payment or deposit as part of the transaction. */\n downPayAmount?: string;\n }\n interface Participant {\n /** Participant ID. Currently represents the booking.id. */\n _id?: string;\n /** Contact ID. */\n contactId?: string | null;\n /** Participant's name. */\n name?: string | null;\n /** Participant's phone number. */\n phone?: string | null;\n /** Participant's email address. */\n email?: string | null;\n /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */\n partySize?: number;\n /**\n * Approval status for the participant.\n * \n * \n */\n approvalStatus?: ApprovalStatus;\n /**\n * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.\n * @readonly\n */\n inherited?: boolean;\n }\n enum ApprovalStatus {\n /** Default. */\n UNDEFINED = \"UNDEFINED\",\n /** Pending business approval. */\n PENDING = \"PENDING\",\n /** Approved by the business. */\n APPROVED = \"APPROVED\",\n /** Declined by the business. */\n DECLINED = \"DECLINED\"\n }\n interface ExternalCalendarInfo {\n /** The external calendar type (e.g. Google Calendar, iCal, etc). */\n calendarType?: CalendarType;\n }\n enum CalendarType {\n UNDEFINED = \"UNDEFINED\",\n GOOGLE = \"GOOGLE\",\n I_CAL = \"I_CAL\",\n /** Use `MICROSOFT` instead. */\n OUTLOOK = \"OUTLOOK\",\n /** Use `MICROSOFT` instead. */\n OFFICE_365 = \"OFFICE_365\",\n MICROSOFT = \"MICROSOFT\",\n OTHER = \"OTHER\"\n }\n interface ExternalCalendarOverrides {\n /** Synced title of the external calendar event. */\n title?: string | null;\n /** Synced description of the external calendar event. */\n description?: string | null;\n }\n enum Status {\n UNDEFINED = \"UNDEFINED\",\n /** The session is confirmed. Default status. */\n CONFIRMED = \"CONFIRMED\",\n /**\n * The session is cancelled.\n * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.\n * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.\n */\n CANCELLED = \"CANCELLED\"\n }\n enum SessionType {\n UNDEFINED = \"UNDEFINED\",\n /**\n * The session creates an event on the calendar for the owner of the schedule that the session belongs to.\n * Default type.\n */\n EVENT = \"EVENT\",\n /** The session represents a resource's available working hours. */\n WORKING_HOURS = \"WORKING_HOURS\",\n /** Deprecated. please use WORKING_HOURS */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */\n AVAILABILITY = \"AVAILABILITY\"\n }\n interface CalendarConference {\n /** Wix Calendar conference ID. */\n _id?: string;\n /** Conference meeting ID in the provider's conferencing system. */\n externalId?: string;\n /** Conference provider ID. */\n providerId?: string;\n /** URL used by the host to start the conference. */\n hostUrl?: string;\n /** URL used by a guest to join the conference. */\n guestUrl?: string;\n /** Password to join the conference. */\n password?: string | null;\n /** Conference description. */\n description?: string | null;\n /**\n * Conference type.\n * \n */\n conferenceType?: ConferenceType;\n /** ID of the account owner in the video conferencing service. */\n accountOwnerId?: string | null;\n }\n enum ConferenceType {\n UNDEFINED = \"UNDEFINED\",\n /** API-generated online meeting. */\n ONLINE_MEETING_PROVIDER = \"ONLINE_MEETING_PROVIDER\",\n /** User-defined meeting. */\n CUSTOM = \"CUSTOM\"\n }\n interface SessionVersion {\n /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */\n number?: string | null;\n }\n interface SessionRemoved {\n /** The updated session which was removed from the view. */\n session?: Session;\n /** Optionally, the previous session. */\n previousSession?: Session;\n }\n interface SessionViewExtended {\n /** The extended session view end date. */\n extendedSessionViewEndDate?: Date;\n }\n interface FeedEvent extends FeedEventTypeOneOf {\n /** Session has been added or updated within the feed window. */\n sessionAddedOrUpdated?: SessionAddedOrUpdated;\n /** Session has been removed from the feed. */\n sessionRemoved?: SessionRemoved;\n /** The feed window has been extended. */\n windowExtended?: WindowExtended;\n }\n /** @oneof */\n interface FeedEventTypeOneOf {\n /** Session has been added or updated within the feed window. */\n sessionAddedOrUpdated?: SessionAddedOrUpdated;\n /** Session has been removed from the feed. */\n sessionRemoved?: SessionRemoved;\n /** The feed window has been extended. */\n windowExtended?: WindowExtended;\n }\n interface WindowExtended {\n /** The updated window end date. */\n windowEndDate?: Date;\n }\n /** Deprecated. Please use `window_extended` instead. */\n interface WindowMoved {\n /** The updated window edge. */\n edge?: Date;\n /** The window version. */\n windowVersion?: number | null;\n }\n interface GetSessionViewRequest {\n }\n interface GetSessionViewResponse {\n /** The sessions view. */\n sessionView?: SessionView;\n }\n interface ExtendSessionViewRequest {\n /**\n * The number of days the view lasts into the future.\n * Must be greater than the current value.\n */\n futureDurationInDays?: number | null;\n }\n interface ExtendSessionViewResponse {\n /** The updated sessions view. */\n sessionView?: SessionView;\n }\n interface ReplayRequest {\n /** The replay id. Required. */\n replayId?: string | null;\n /** The date to replay sessions from. Required. */\n from?: Date;\n /** Filter by either `session.schedule_id` or `session.affectedSchedules[*].scheduleId`. Optional. */\n affectedScheduleId?: string | null;\n }\n interface ReplayResponse {\n /** The feed window. */\n window?: Window;\n }\n interface Window {\n /**\n * The window end date.\n * @readonly\n */\n endDate?: Date;\n /** The number of days the window lasts into the future. */\n futureDurationInDays?: number | null;\n /** The window version. */\n version?: number | null;\n }\n interface FeedReplayEvent extends FeedReplayEventTypeOneOf {\n /** Session has been added within the feed window. */\n sessionAdded?: SessionAdded;\n /** Sessions replay completed. */\n replayCompleted?: ReplayCompleted;\n replayId?: string | null;\n }\n /** @oneof */\n interface FeedReplayEventTypeOneOf {\n /** Session has been added within the feed window. */\n sessionAdded?: SessionAdded;\n /** Sessions replay completed. */\n replayCompleted?: ReplayCompleted;\n }\n interface SessionAdded {\n /** The session which was added within the feed window. */\n session?: Session;\n }\n interface ReplayCompleted {\n /** The (minimum) number of sessions that were replayed. */\n totalSessions?: number | null;\n }\n interface ScheduleNotification extends ScheduleNotificationEventOneOf {\n scheduleCreated?: ScheduleCreated;\n scheduleUpdated?: ScheduleUpdated;\n scheduleCancelled?: ScheduleCancelled;\n sessionCreated?: SessionCreated;\n sessionUpdated?: SessionUpdated;\n sessionCancelled?: SessionCancelled;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated;\n intervalSplit?: IntervalSplit;\n recurringSessionSplit?: RecurringSessionSplit;\n /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;\n preserveFutureSessionsWithParticipants?: boolean | null;\n /** Whether to notify participants about changed sessions. deprecated, use participant_notification */\n notifyParticipants?: boolean;\n /** site properties. Optional. Given in create schedule notification. */\n siteProperties?: SitePropertiesOnScheduleCreation;\n instanceId?: string;\n }\n /** @oneof */\n interface ScheduleNotificationEventOneOf {\n scheduleCreated?: ScheduleCreated;\n scheduleUpdated?: ScheduleUpdated;\n scheduleCancelled?: ScheduleCancelled;\n sessionCreated?: SessionCreated;\n sessionUpdated?: SessionUpdated;\n sessionCancelled?: SessionCancelled;\n availabilityPolicyUpdated?: AvailabilityPolicyUpdated;\n intervalSplit?: IntervalSplit;\n recurringSessionSplit?: RecurringSessionSplit;\n /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;\n }\n interface ScheduleCreated {\n schedule?: Schedule;\n }\n interface Schedule {\n /** Schedule ID. */\n _id?: string;\n /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */\n scheduleOwnerId?: string | null;\n /**\n * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.\n * Derived from the Wix Business time zone.\n * @readonly\n */\n timeZone?: string | null;\n /** Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead. */\n intervals?: RecurringInterval[];\n /** Default title for the schedule's sessions. Maximum length: 6000 characters. */\n title?: string | null;\n /**\n * __Deprecated.__\n * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.\n * The Wix Bookings app uses the following predefined tags to set schedule type: `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE\"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.\n */\n tags?: string[] | null;\n /** Default location for the schedule's sessions. */\n location?: Location$1;\n /**\n * Maximum number of participants that can be added to the schedule's sessions.\n * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.\n */\n capacity?: number | null;\n /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */\n rate?: Rate;\n /** __Deprecated.__ */\n availability?: Availability;\n /**\n * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.\n * @readonly\n */\n totalNumberOfParticipants?: number;\n /**\n * *Partial list** of participants which are registered to sessions in this schedule.\n * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.\n * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).\n * @readonly\n */\n participants?: Participant[];\n /** __Deprecated.__ */\n externalCalendarOverrides?: ExternalCalendarOverrides;\n /**\n * Schedule status.\n * @readonly\n */\n status?: ScheduleStatus;\n /**\n * Schedule creation date.\n * @readonly\n */\n created?: Date;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * Fields which were inherited from the Business Info page under Settings in the Dashboard.\n * @readonly\n */\n inheritedFields?: string[];\n /** __Deprecated.__ */\n conferenceProvider?: ConferenceProvider;\n /**\n * A conference created for the schedule. This is used when a participant is added to a schedule.\n * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.\n */\n calendarConference?: CalendarConference;\n }\n interface RecurringInterval {\n /**\n * The recurring interval identifier.\n * @readonly\n */\n _id?: string;\n /** The start time of the recurring interval. Required. */\n start?: Date;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date;\n /** The interval rules. The day, hour and minutes the interval is recurring. */\n interval?: Interval;\n /** The frequency of the interval. Optional. The default is frequency with the default repetition. */\n frequency?: Frequency;\n /** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */\n affectedSchedules?: LinkedSchedule[];\n /**\n * The type of recurring interval.\n * \n */\n intervalType?: RecurringIntervalType;\n }\n interface Interval {\n /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */\n daysOfWeek?: Day;\n /** The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23. */\n hourOfDay?: number | null;\n /** The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59. */\n minuteOfHour?: number | null;\n /** The duration of the interval in minutes. Required. Part of the session end time calculation. minimum: 1, maximum: 86400. */\n duration?: number;\n }\n enum Day {\n /** Undefined. */\n UNDEFINED = \"UNDEFINED\",\n /** Monday. */\n MON = \"MON\",\n /** Tuesday. */\n TUE = \"TUE\",\n /** Wednesday. */\n WED = \"WED\",\n /** Thursday. */\n THU = \"THU\",\n /** Friday. */\n FRI = \"FRI\",\n /** Saturday. */\n SAT = \"SAT\",\n /** Sunday. */\n SUN = \"SUN\"\n }\n interface Frequency {\n /** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */\n repetition?: number | null;\n }\n enum RecurringIntervalType {\n /** The default value. Sessions for this interval will be of type EVENT. */\n UNDEFINED = \"UNDEFINED\",\n /** A recurring interval of events */\n EVENT = \"EVENT\",\n /** Deprecated */\n TIME_AVAILABILITY = \"TIME_AVAILABILITY\",\n /** A recurring interval for availability */\n AVAILABILITY = \"AVAILABILITY\"\n }\n /**\n * \n */\n interface Availability {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date;\n /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */\n linkedSchedules?: LinkedSchedule[];\n /** Constraints for calculating the schedule's availability. */\n constraints?: AvailabilityConstraints;\n }\n /** Describes how to calculate the specific slots that are available for booking. */\n interface AvailabilityConstraints {\n /**\n * A list of duration options for slots, in minutes. Minimum value for a duration is 1.\n * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.\n */\n slotDurations?: number[];\n /**\n * The number of minutes between the `end` of one slot, and the `start` of the next.\n * Minimum value is 0, maximum value is 120.\n */\n timeBetweenSlots?: number;\n /**\n * Specify how to split the slots in intervals of minutes.\n * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).\n * Optional. The default is the first duration in slot_durations field.\n * Deprecated. Use the `split_slots_interval.value_in_minutes`.\n */\n splitInterval?: number | null;\n /**\n * An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.\n * @readonly\n */\n slotsSplitInterval?: SplitInterval;\n }\n /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */\n interface SplitInterval {\n /**\n * Whether the slot duration is used as the split interval value.\n * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in\n * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.\n */\n sameAsDuration?: boolean | null;\n /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */\n valueInMinutes?: number | null;\n }\n enum ScheduleStatus {\n UNDEFINED = \"UNDEFINED\",\n /** The default value when the schedule is created. */\n CREATED = \"CREATED\",\n /** The schedule has been canceled. */\n CANCELLED = \"CANCELLED\"\n }\n interface Version {\n /** Schedule version number, updated each time the schedule is updated. */\n scheduleVersion?: number | null;\n /** Participants version number, updated each time the schedule participants are updated. */\n participantsVersion?: number | null;\n }\n interface ConferenceProvider {\n /** Conferencing provider ID */\n providerId?: string;\n }\n interface ScheduleUpdated {\n /** The old schedule before the update. */\n oldSchedule?: Schedule;\n /** The new schedule after the update. */\n newSchedule?: Schedule;\n /**\n * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was\n * updating at least one of the given schedule's recurring sessions.\n * This event is triggered by create/update/delete recurring session apis.\n */\n recurringSessions?: RecurringSessionsUpdated;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface RecurringSessionsUpdated {\n /** Old schedule's recurring session list. */\n oldRecurringSessions?: Session[];\n /** New schedule's recurring session list. */\n newRecurringSessions?: Session[];\n }\n interface ParticipantNotification {\n /**\n * Whether to send the message about the changes to the customer.\n *\n * Default: `false`\n */\n notifyParticipants?: boolean;\n /** Custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface ScheduleCancelled {\n schedule?: Schedule;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification;\n oldSchedule?: Schedule;\n }\n interface SessionCreated {\n session?: Session;\n }\n interface SessionUpdated {\n oldSession?: Session;\n newSession?: Session;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification;\n /**\n * Whether this notification was created as a result of an anonymization request, such as GDPR.\n * An anonymized participant will have the following details:\n * name = \"deleted\"\n * phone = \"deleted\"\n * email = \"deleted@deleted.com\"\n */\n triggeredByAnonymizeRequest?: boolean | null;\n }\n interface SessionCancelled {\n session?: Session;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification;\n }\n interface AvailabilityPolicyUpdated {\n availabilityPolicy?: AvailabilityPolicy;\n }\n /** Availability policy applied to all site schedules. */\n interface AvailabilityPolicy {\n /** Specify how to split the schedule slots in intervals of minutes. */\n splitInterval?: SplitInterval;\n }\n interface IntervalSplit {\n scheduleId?: string;\n intervals?: RecurringInterval[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n interface RecurringSessionSplit {\n scheduleId?: string;\n recurringSessions?: Session[];\n newScheduleVersion?: number | null;\n oldScheduleVersion?: number | null;\n }\n /** Schedule unassigned from user. */\n interface ScheduleUnassignedFromUser {\n /** The Wix user id. */\n userId?: string | null;\n /** The schedule that was unassigned from the user. */\n schedule?: Schedule;\n }\n interface MultipleSessionsCreated {\n schedulesWithSessions?: ScheduleWithSessions[];\n }\n interface ScheduleWithSessions {\n schedule?: Schedule;\n siteProperties?: SitePropertiesOnScheduleCreation;\n sessions?: Session[];\n }\n interface SitePropertiesOnScheduleCreation {\n /** The global time zone value. */\n timeZone?: string | null;\n }\n interface MigrationEvent {\n migrationData?: MigrationData;\n }\n interface MigrationData {\n businessId?: string | null;\n staffs?: StaffData[];\n }\n interface StaffData {\n resourceId?: string;\n syncRequestEmail?: string;\n refreshToken?: string;\n }\n interface Empty {\n }\n interface Task {\n key?: TaskKey;\n executeAt?: Date;\n payload?: string | null;\n }\n interface TaskKey {\n appId?: string;\n instanceId?: string;\n subjectId?: string | null;\n }\n interface TaskAction extends TaskActionActionOneOf {\n complete?: Complete;\n cancel?: Cancel;\n reschedule?: Reschedule;\n }\n /** @oneof */\n interface TaskActionActionOneOf {\n complete?: Complete;\n cancel?: Cancel;\n reschedule?: Reschedule;\n }\n interface Complete {\n }\n interface Cancel {\n }\n interface Reschedule {\n executeAt?: Date;\n payload?: string | null;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n /**\n * Gets the sessions view information.\n * E.g. the current view end date, or the future duration in days the view should strive for.\n * @public\n * @documentationMaturity preview\n */\n function getSessionView(): Promise;\n const bookingsCalendarV2SessionViewSessionsView_universal_d___debug: typeof __debug;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionView = SessionView;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionViewUpdated = SessionViewUpdated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionViewUpdatedTypeOneOf = SessionViewUpdatedTypeOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionAddedOrUpdated = SessionAddedOrUpdated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Session = Session;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarDateTime = CalendarDateTime;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocalDateTime = LocalDateTime;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LinkedSchedule = LinkedSchedule;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Transparency = Transparency;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_Transparency: typeof Transparency;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Address = Address;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_StreetAddress = StreetAddress;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_AddressLocation = AddressLocation;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Subdivision = Subdivision;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsLocation = LocationsLocation;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocationStatus = LocationStatus;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_LocationStatus: typeof LocationStatus;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsLocationType = LocationsLocationType;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsLocationType: typeof LocationsLocationType;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsAddress = LocationsAddress;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsStreetAddress = LocationsStreetAddress;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsAddressLocation = LocationsAddressLocation;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_BusinessSchedule = BusinessSchedule;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_TimePeriod = TimePeriod;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_DayOfWeek = DayOfWeek;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_DayOfWeek: typeof DayOfWeek;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Rate = Rate;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Price = Price;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Participant = Participant;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ApprovalStatus = ApprovalStatus;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_ApprovalStatus: typeof ApprovalStatus;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ExternalCalendarInfo = ExternalCalendarInfo;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarType = CalendarType;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarType: typeof CalendarType;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ExternalCalendarOverrides = ExternalCalendarOverrides;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Status = Status;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_Status: typeof Status;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionType = SessionType;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_SessionType: typeof SessionType;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarConference = CalendarConference;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ConferenceType = ConferenceType;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_ConferenceType: typeof ConferenceType;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionVersion = SessionVersion;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionRemoved = SessionRemoved;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionViewExtended = SessionViewExtended;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_FeedEvent = FeedEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_FeedEventTypeOneOf = FeedEventTypeOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_WindowExtended = WindowExtended;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_WindowMoved = WindowMoved;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_GetSessionViewRequest = GetSessionViewRequest;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_GetSessionViewResponse = GetSessionViewResponse;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ExtendSessionViewRequest = ExtendSessionViewRequest;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ExtendSessionViewResponse = ExtendSessionViewResponse;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ReplayRequest = ReplayRequest;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ReplayResponse = ReplayResponse;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Window = Window;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_FeedReplayEvent = FeedReplayEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_FeedReplayEventTypeOneOf = FeedReplayEventTypeOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionAdded = SessionAdded;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ReplayCompleted = ReplayCompleted;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleNotification = ScheduleNotification;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleNotificationEventOneOf = ScheduleNotificationEventOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleCreated = ScheduleCreated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Schedule = Schedule;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringInterval = RecurringInterval;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Interval = Interval;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Day = Day;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_Day: typeof Day;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Frequency = Frequency;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringIntervalType = RecurringIntervalType;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringIntervalType: typeof RecurringIntervalType;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Availability = Availability;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_AvailabilityConstraints = AvailabilityConstraints;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SplitInterval = SplitInterval;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleStatus = ScheduleStatus;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleStatus: typeof ScheduleStatus;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Version = Version;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ConferenceProvider = ConferenceProvider;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleUpdated = ScheduleUpdated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringSessionsUpdated = RecurringSessionsUpdated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ParticipantNotification = ParticipantNotification;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleCancelled = ScheduleCancelled;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionCreated = SessionCreated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionUpdated = SessionUpdated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SessionCancelled = SessionCancelled;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_AvailabilityPolicyUpdated = AvailabilityPolicyUpdated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_AvailabilityPolicy = AvailabilityPolicy;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_IntervalSplit = IntervalSplit;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringSessionSplit = RecurringSessionSplit;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleUnassignedFromUser = ScheduleUnassignedFromUser;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_MultipleSessionsCreated = MultipleSessionsCreated;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleWithSessions = ScheduleWithSessions;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_SitePropertiesOnScheduleCreation = SitePropertiesOnScheduleCreation;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_MigrationEvent = MigrationEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_MigrationData = MigrationData;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_StaffData = StaffData;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Empty = Empty;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Task = Task;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_TaskKey = TaskKey;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_TaskAction = TaskAction;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_TaskActionActionOneOf = TaskActionActionOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Complete = Complete;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Cancel = Cancel;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_Reschedule = Reschedule;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_DomainEvent = DomainEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type bookingsCalendarV2SessionViewSessionsView_universal_d_ActionEvent = ActionEvent;\n const bookingsCalendarV2SessionViewSessionsView_universal_d_getSessionView: typeof getSessionView;\n namespace bookingsCalendarV2SessionViewSessionsView_universal_d {\n export { bookingsCalendarV2SessionViewSessionsView_universal_d___debug as __debug, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionView as SessionView, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionViewUpdated as SessionViewUpdated, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionViewUpdatedTypeOneOf as SessionViewUpdatedTypeOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionAddedOrUpdated as SessionAddedOrUpdated, bookingsCalendarV2SessionViewSessionsView_universal_d_Session as Session, bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarDateTime as CalendarDateTime, bookingsCalendarV2SessionViewSessionsView_universal_d_LocalDateTime as LocalDateTime, bookingsCalendarV2SessionViewSessionsView_universal_d_LinkedSchedule as LinkedSchedule, bookingsCalendarV2SessionViewSessionsView_universal_d_Transparency as Transparency, Location$1 as Location, LocationType$1 as LocationType, bookingsCalendarV2SessionViewSessionsView_universal_d_Address as Address, bookingsCalendarV2SessionViewSessionsView_universal_d_AddressStreetOneOf as AddressStreetOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_StreetAddress as StreetAddress, bookingsCalendarV2SessionViewSessionsView_universal_d_AddressLocation as AddressLocation, bookingsCalendarV2SessionViewSessionsView_universal_d_Subdivision as Subdivision, bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsLocation as LocationsLocation, bookingsCalendarV2SessionViewSessionsView_universal_d_LocationStatus as LocationStatus, bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsLocationType as LocationsLocationType, bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsAddress as LocationsAddress, bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsStreetAddress as LocationsStreetAddress, bookingsCalendarV2SessionViewSessionsView_universal_d_LocationsAddressLocation as LocationsAddressLocation, bookingsCalendarV2SessionViewSessionsView_universal_d_BusinessSchedule as BusinessSchedule, bookingsCalendarV2SessionViewSessionsView_universal_d_TimePeriod as TimePeriod, bookingsCalendarV2SessionViewSessionsView_universal_d_DayOfWeek as DayOfWeek, bookingsCalendarV2SessionViewSessionsView_universal_d_SpecialHourPeriod as SpecialHourPeriod, bookingsCalendarV2SessionViewSessionsView_universal_d_Rate as Rate, bookingsCalendarV2SessionViewSessionsView_universal_d_Price as Price, bookingsCalendarV2SessionViewSessionsView_universal_d_Participant as Participant, bookingsCalendarV2SessionViewSessionsView_universal_d_ApprovalStatus as ApprovalStatus, bookingsCalendarV2SessionViewSessionsView_universal_d_ExternalCalendarInfo as ExternalCalendarInfo, bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarType as CalendarType, bookingsCalendarV2SessionViewSessionsView_universal_d_ExternalCalendarOverrides as ExternalCalendarOverrides, bookingsCalendarV2SessionViewSessionsView_universal_d_Status as Status, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionType as SessionType, bookingsCalendarV2SessionViewSessionsView_universal_d_CalendarConference as CalendarConference, bookingsCalendarV2SessionViewSessionsView_universal_d_ConferenceType as ConferenceType, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionVersion as SessionVersion, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionRemoved as SessionRemoved, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionViewExtended as SessionViewExtended, bookingsCalendarV2SessionViewSessionsView_universal_d_FeedEvent as FeedEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_FeedEventTypeOneOf as FeedEventTypeOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_WindowExtended as WindowExtended, bookingsCalendarV2SessionViewSessionsView_universal_d_WindowMoved as WindowMoved, bookingsCalendarV2SessionViewSessionsView_universal_d_GetSessionViewRequest as GetSessionViewRequest, bookingsCalendarV2SessionViewSessionsView_universal_d_GetSessionViewResponse as GetSessionViewResponse, bookingsCalendarV2SessionViewSessionsView_universal_d_ExtendSessionViewRequest as ExtendSessionViewRequest, bookingsCalendarV2SessionViewSessionsView_universal_d_ExtendSessionViewResponse as ExtendSessionViewResponse, bookingsCalendarV2SessionViewSessionsView_universal_d_ReplayRequest as ReplayRequest, bookingsCalendarV2SessionViewSessionsView_universal_d_ReplayResponse as ReplayResponse, bookingsCalendarV2SessionViewSessionsView_universal_d_Window as Window, bookingsCalendarV2SessionViewSessionsView_universal_d_FeedReplayEvent as FeedReplayEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_FeedReplayEventTypeOneOf as FeedReplayEventTypeOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionAdded as SessionAdded, bookingsCalendarV2SessionViewSessionsView_universal_d_ReplayCompleted as ReplayCompleted, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleNotification as ScheduleNotification, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleNotificationEventOneOf as ScheduleNotificationEventOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleCreated as ScheduleCreated, bookingsCalendarV2SessionViewSessionsView_universal_d_Schedule as Schedule, bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringInterval as RecurringInterval, bookingsCalendarV2SessionViewSessionsView_universal_d_Interval as Interval, bookingsCalendarV2SessionViewSessionsView_universal_d_Day as Day, bookingsCalendarV2SessionViewSessionsView_universal_d_Frequency as Frequency, bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringIntervalType as RecurringIntervalType, bookingsCalendarV2SessionViewSessionsView_universal_d_Availability as Availability, bookingsCalendarV2SessionViewSessionsView_universal_d_AvailabilityConstraints as AvailabilityConstraints, bookingsCalendarV2SessionViewSessionsView_universal_d_SplitInterval as SplitInterval, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleStatus as ScheduleStatus, bookingsCalendarV2SessionViewSessionsView_universal_d_Version as Version, bookingsCalendarV2SessionViewSessionsView_universal_d_ConferenceProvider as ConferenceProvider, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleUpdated as ScheduleUpdated, bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringSessionsUpdated as RecurringSessionsUpdated, bookingsCalendarV2SessionViewSessionsView_universal_d_ParticipantNotification as ParticipantNotification, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleCancelled as ScheduleCancelled, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionCreated as SessionCreated, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionUpdated as SessionUpdated, bookingsCalendarV2SessionViewSessionsView_universal_d_SessionCancelled as SessionCancelled, bookingsCalendarV2SessionViewSessionsView_universal_d_AvailabilityPolicyUpdated as AvailabilityPolicyUpdated, bookingsCalendarV2SessionViewSessionsView_universal_d_AvailabilityPolicy as AvailabilityPolicy, bookingsCalendarV2SessionViewSessionsView_universal_d_IntervalSplit as IntervalSplit, bookingsCalendarV2SessionViewSessionsView_universal_d_RecurringSessionSplit as RecurringSessionSplit, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleUnassignedFromUser as ScheduleUnassignedFromUser, bookingsCalendarV2SessionViewSessionsView_universal_d_MultipleSessionsCreated as MultipleSessionsCreated, bookingsCalendarV2SessionViewSessionsView_universal_d_ScheduleWithSessions as ScheduleWithSessions, bookingsCalendarV2SessionViewSessionsView_universal_d_SitePropertiesOnScheduleCreation as SitePropertiesOnScheduleCreation, bookingsCalendarV2SessionViewSessionsView_universal_d_MigrationEvent as MigrationEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_MigrationData as MigrationData, bookingsCalendarV2SessionViewSessionsView_universal_d_StaffData as StaffData, bookingsCalendarV2SessionViewSessionsView_universal_d_Empty as Empty, bookingsCalendarV2SessionViewSessionsView_universal_d_Task as Task, bookingsCalendarV2SessionViewSessionsView_universal_d_TaskKey as TaskKey, bookingsCalendarV2SessionViewSessionsView_universal_d_TaskAction as TaskAction, bookingsCalendarV2SessionViewSessionsView_universal_d_TaskActionActionOneOf as TaskActionActionOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_Complete as Complete, bookingsCalendarV2SessionViewSessionsView_universal_d_Cancel as Cancel, bookingsCalendarV2SessionViewSessionsView_universal_d_Reschedule as Reschedule, bookingsCalendarV2SessionViewSessionsView_universal_d_DomainEvent as DomainEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, bookingsCalendarV2SessionViewSessionsView_universal_d_EntityCreatedEvent as EntityCreatedEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_EntityDeletedEvent as EntityDeletedEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_ActionEvent as ActionEvent, bookingsCalendarV2SessionViewSessionsView_universal_d_getSessionView as getSessionView, };\n }\n interface SlotAvailability {\n /**\n * The slot for the corresponding session, when the session is either a single session\n * or a specific session generated from a recurring session.\n */\n slot?: Slot;\n /**\n * Whether the slot is bookable. Bookability is determined by checking a\n * session's open slots and booking policies. Locks are not taken into\n * account.\n */\n bookable?: boolean;\n /**\n * Total number of spots for this slot.\n * For example, if a session has a total of 10 spots and 3 spots are booked,\n * `spotsTotal` is 10 and `openSpots` is 7.\n */\n totalSpots?: number | null;\n /** Number of open spots for this slot. */\n openSpots?: number | null;\n /** An object describing the slot's waitlist and its occupancy. */\n waitingList?: WaitingList;\n /** Booking policy violations for the slot. */\n bookingPolicyViolations?: BookingPolicyViolations;\n /**\n * Indicates whether the slot is locked because a waitlist exists.\n * When a slot frees up, the slot is offered to the next customer on the waitlist. Read-only.\n */\n locked?: boolean | null;\n isFromV2?: boolean;\n }\n interface Slot {\n /**\n * ID for the slot's corresponding session, when the session is either a single session\n * or a specific session generated from a recurring session.\n */\n sessionId?: string | null;\n /** Service ID. */\n serviceId?: string;\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n *\n * If `timezone` is specified,\n * dates are based on the local date/time. This means that the timezone offset\n * in the `start_date` is ignored.\n */\n startDate?: string | null;\n /**\n * The end time of this slot in\n * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.\n *\n * If `timezone` is specified,\n * dates are based on the local date/time. This means that the timezone offset\n * in the `end_date` is ignored.\n */\n endDate?: string | null;\n /**\n * The timezone for which slot availability is to be calculated. If specified,\n * dates are based on the local date/time, meaning that the timezone offset\n * in the date's format is ignored.\n */\n timezone?: string | null;\n /**\n * The resource required for this slot. Currently, the only supported resource\n * is the relevant staff member for the slot.\n */\n resource?: SlotResource;\n /** Geographic location of the slot. */\n location?: Location;\n }\n interface SlotResource {\n /**\n * Resource ID.\n * @readonly\n */\n _id?: string | null;\n /** Resource name. Read only. */\n name?: string | null;\n }\n interface Location {\n /**\n * Business location ID. Available only for locations that are business locations,\n * meaning the `location_type` is `\"OWNER_BUSINESS\"`.\n */\n _id?: string | null;\n /** Location name. */\n name?: string | null;\n /** The full address of this location. */\n formattedAddress?: string | null;\n /**\n * Location type.\n *\n * - `\"OWNER_BUSINESS\"`: The business address, as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"`: The address as set when creating the service.\n * - `\"CUSTOM\"`: The address as set for the individual session.\n */\n locationType?: LocationType;\n }\n enum LocationType {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface WaitingList {\n /**\n * Total number of spots and open spots for this waitlist.\n * For example, a Yoga class with 10 waitlist spots and 3 registered\n * on the waitlist has 10 `total_spots` and 7 `open_spots`.\n */\n totalSpots?: number | null;\n /** Number of open spots for this waitlist. */\n openSpots?: number | null;\n }\n interface BookingPolicyViolations {\n /** Bookings policy violation. Too early to book this slot. */\n tooEarlyToBook?: boolean | null;\n /** Bookings policy violation. Too late to book this slot. */\n tooLateToBook?: boolean | null;\n /** Bookings policy violation. Online booking is disabled for this slot. */\n bookOnlineDisabled?: boolean | null;\n }\n interface NestedTimeSlot {\n serviceId?: string;\n start?: string;\n end?: string;\n resource?: SlotResource;\n /** Schedule ID. */\n scheduleId?: string;\n }\n interface QueryAvailabilityRequest {\n /** Query options. */\n query: QueryV2;\n /**\n * The timezone for which slot availability is to be calculated. If specified,\n * dates are based on the local date/time, meaning that the timezone offset\n * in the date's format is ignored.\n */\n timezone?: string | null;\n /**\n * Maximum number of slots to load for each date. For example, if `slots_per_day` is set to `3`,\n * at most 3 available slots are returned for each day in the date range specified in the query's\n * `filter`.\n *\n * When a day has both bookable and non-bookable slots, bookable slots are returned first.\n * Non-bookable slots are returned according to the specified filters, after all\n * bookable slots are already included.\n */\n slotsPerDay?: number | null;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\n /**\n * Filter object. You must include `serviceId`, `startDate` and `endDate` in the filter. This avoids large results that can impact performance.\n */\n filter?: Record | null;\n /** Currently, only sorting by `startDate` is supported. */\n sort?: Sorting[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf {\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n /**\n * Selected customer choices.\n * These choices are selected by the customer during the booking flow and can be utilized to calculate the corresponding service's configuration properties.\n */\n interface CustomerChoices {\n /**\n * The selected customer duration in minutes.\n * Min: `1 minute`\n * Max: `44639 minutes` (30 days, 23 hours, and 59 minutes)\n */\n durationInMinutes?: number | null;\n }\n interface QueryAvailabilityResponse {\n /** List of slots that potentially can be booked. */\n availabilityEntries?: SlotAvailability[];\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface GetSlotAvailabilityRequest {\n /** The slot for which the availability is checked. */\n slot?: Slot;\n /**\n * The timezone for which slot availability is to be calculated. If specified,\n * dates are based on the local date/time, meaning that the timezone offset\n * in the date's format is ignored.\n */\n timezone?: string | null;\n }\n interface GetSlotAvailabilityResponse {\n availability?: SlotAvailability;\n bookingPolicySettings?: BookingPolicySettings;\n }\n interface BookingPolicySettings {\n /**\n * The policy defining the maximum number of participants that can\n * be booked for a slot or a schedule.\n */\n maxParticipantsPerBooking?: number | null;\n }\n interface GetScheduleAvailabilityRequest {\n /** The schedule ID for which availability is being checked. */\n scheduleId: string;\n }\n interface GetScheduleAvailabilityResponse {\n availability?: ScheduleAvailability;\n bookingPolicySettings?: BookingPolicySettings;\n }\n interface ScheduleAvailability {\n /**\n * The total number of spots defined for the schedule, including\n * both open and non-available spots.\n */\n totalSpots?: number | null;\n /** The number of open spots defined for the schedule. */\n openSpots?: number | null;\n /** Booking policy violations for the schedule. */\n bookingPolicyViolations?: BookingPolicyViolations;\n }\n interface CalculateMultiSlotAvailabilityRequest {\n from?: string;\n to?: string;\n timeZone?: string;\n /** TODO good definition of what bookable means https://github.com/wix-private/scheduler/pull/18267/files?file-filters%5B%5D=.proto&show-viewed-files=true#r1199809006 */\n bookable?: boolean | null;\n /**\n * each nested field is checked on its own. i.e. if `too_early_to_book` is defined and `too_late_to_book` is not defined\n * we will return slots for which `too_early_to_book` is same as on the request, regardless of `too_late_to_book`.\n */\n bookingPolicyViolations?: BookingPolicyViolations;\n /**\n * support filtering by location type, or by locationId. Other fields like `name` are ignored\n * must be set, and must have locationType. If locationType is `OWNER_BUSINESS`, must have location_id\n */\n location?: Location;\n slots?: RuleBasedConstraints[];\n /**\n * Maximum number of slots to load for each date. For example, if `slots_per_day` is set to `3`,\n * at most 3 available slots are returned for each day in the date range specified in the query's\n * `filter`.\n *\n * When a day has both bookable and non-bookable slots, bookable slots are returned first.\n * Non-bookable slots are returned according to the specified filters, after all\n * bookable slots are already included.\n */\n slotsPerDay?: number | null;\n cursorPaging?: CursorPaging;\n }\n interface RuleBasedConstraints {\n serviceId?: string;\n resourcesFilter?: ResourcesFilter;\n }\n interface ResourcesFilter {\n resourceIds?: string[];\n }\n interface CalculateMultiSlotAvailabilityResponse {\n slots?: SlotAvailability[];\n cursorPagingMetadata?: CursorPagingMetadata;\n }\n interface CursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n /**\n * Retrieves the availability for sessions\n * that match the provided query criteria (paging, filtering, and sorting).\n *\n *\n * The Availability Calendar APIs calculate the availability of sessions for\n * appointments and classes, but not\n * for courses.\n *\n * The entire list of slots is returned in case you want to display both\n * available and non-available slots in the calendar for your customers.\n * Using the `bookable` property, you can limit the display to available\n * slots only.\n *\n * When querying, you must enter a start date and an end date. This avoids very large\n * results that can impact performance.\n *\n * #### Calculating availability\n *\n * The availability is determined\n * by checking:\n * + **The sessions' open slots**. A slot is considered open if the session's\n * capacity is greater than number of participants.\n * + **Booking policies**. Policies that affect whether a slot is considered\n * available include `tooEarlyToBook`, `tooLateToBook`, and `bookOnlineDisabled`.\n *\n * Locked sessions do not impact session availability and `bookable` can\n * be `true` even if `locked` is `true`. For example, if a session has a waitlist and a\n * place frees up, the slot is offered to the customers on the waitlist, one by one. The\n * session remains locked because there is still a waitlist, but for a period of time\n * there is availability, until a customer on the waitlist takes the slot. Locking\n * prevents customers who are not yet on the waitlist from grabbing the slot.\n *\n * #### Handling Daylight Savings Time (DST) for local time zones\n *\n * Because of DST, there are cases where certain times either do not exist\n * or exist twice for a local time zone.\n * For example, the tine `00:05` on September 5th 2021 might not exist in Santiago, Chile,\n * because at `00:00` the clock moved\n * 1 hour forward to `01:00`.\n *\n * In this case, the Availability Calendar APIs take this\n * into account and mediate the time gaps automatically. The non-existent local time is\n * automatically moved forward 1 hour to match local DST. Local times that exist do not change.\n * So if the `queryAvailability()` function is called with a `startDate` of `2021-09-05T00:00:01.000`\n * and an `endDate` of `2021-09-06T00:00:02.000`, `2021-09-05T01:00:01.000` is used in the query\n * instead. The start time shifts one hour forward and the end time remains the same.\n * @param query - Query options.\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @requiredField query.filter\n * @param options - Additional options for performing the query.\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @adminMethod\n */\n function queryAvailability(query: QueryV2, options?: QueryAvailabilityOptions): Promise;\n interface QueryAvailabilityOptions {\n /**\n * The timezone for which slot availability is to be calculated. If specified,\n * dates are based on the local date/time, meaning that the timezone offset\n * in the date's format is ignored.\n */\n timezone?: string | null;\n /**\n * Maximum number of slots to load for each date. For example, if `slots_per_day` is set to `3`,\n * at most 3 available slots are returned for each day in the date range specified in the query's\n * `filter`.\n *\n * When a day has both bookable and non-bookable slots, bookable slots are returned first.\n * Non-bookable slots are returned according to the specified filters, after all\n * bookable slots are already included.\n */\n slotsPerDay?: number | null;\n }\n interface GetSlotAvailabilityOptions {\n /** The slot for which the availability is checked. */\n slot?: Slot;\n /**\n * The timezone for which slot availability is to be calculated. If specified,\n * dates are based on the local date/time, meaning that the timezone offset\n * in the date's format is ignored.\n */\n timezone?: string | null;\n }\n interface GetScheduleAvailabilityOptions {\n }\n interface CalculateMultiSlotAvailabilityOptions {\n from?: string;\n to?: string;\n timeZone?: string;\n /** TODO good definition of what bookable means https://github.com/wix-private/scheduler/pull/18267/files?file-filters%5B%5D=.proto&show-viewed-files=true#r1199809006 */\n bookable?: boolean | null;\n /**\n * each nested field is checked on its own. i.e. if `too_early_to_book` is defined and `too_late_to_book` is not defined\n * we will return slots for which `too_early_to_book` is same as on the request, regardless of `too_late_to_book`.\n */\n bookingPolicyViolations?: BookingPolicyViolations;\n /**\n * support filtering by location type, or by locationId. Other fields like `name` are ignored\n * must be set, and must have locationType. If locationType is `OWNER_BUSINESS`, must have location_id\n */\n location?: Location;\n slots?: RuleBasedConstraints[];\n /**\n * Maximum number of slots to load for each date. For example, if `slots_per_day` is set to `3`,\n * at most 3 available slots are returned for each day in the date range specified in the query's\n * `filter`.\n *\n * When a day has both bookable and non-bookable slots, bookable slots are returned first.\n * Non-bookable slots are returned according to the specified filters, after all\n * bookable slots are already included.\n */\n slotsPerDay?: number | null;\n cursorPaging?: CursorPaging;\n }\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SlotAvailability = SlotAvailability;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Slot = Slot;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SlotResource = SlotResource;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Location = Location;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_LocationType = LocationType;\n const bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_LocationType: typeof LocationType;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_WaitingList = WaitingList;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_BookingPolicyViolations = BookingPolicyViolations;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_NestedTimeSlot = NestedTimeSlot;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryAvailabilityRequest = QueryAvailabilityRequest;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryV2 = QueryV2;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Sorting = Sorting;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SortOrder = SortOrder;\n const bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SortOrder: typeof SortOrder;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CursorPaging = CursorPaging;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CustomerChoices = CustomerChoices;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryAvailabilityResponse = QueryAvailabilityResponse;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Cursors = Cursors;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetSlotAvailabilityRequest = GetSlotAvailabilityRequest;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetSlotAvailabilityResponse = GetSlotAvailabilityResponse;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_BookingPolicySettings = BookingPolicySettings;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetScheduleAvailabilityRequest = GetScheduleAvailabilityRequest;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetScheduleAvailabilityResponse = GetScheduleAvailabilityResponse;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_ScheduleAvailability = ScheduleAvailability;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CalculateMultiSlotAvailabilityRequest = CalculateMultiSlotAvailabilityRequest;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_RuleBasedConstraints = RuleBasedConstraints;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_ResourcesFilter = ResourcesFilter;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CalculateMultiSlotAvailabilityResponse = CalculateMultiSlotAvailabilityResponse;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n const bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_queryAvailability: typeof queryAvailability;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryAvailabilityOptions = QueryAvailabilityOptions;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetSlotAvailabilityOptions = GetSlotAvailabilityOptions;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetScheduleAvailabilityOptions = GetScheduleAvailabilityOptions;\n type bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CalculateMultiSlotAvailabilityOptions = CalculateMultiSlotAvailabilityOptions;\n namespace bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d {\n export { bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SlotAvailability as SlotAvailability, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Slot as Slot, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SlotResource as SlotResource, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Location as Location, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_LocationType as LocationType, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_WaitingList as WaitingList, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_BookingPolicyViolations as BookingPolicyViolations, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_NestedTimeSlot as NestedTimeSlot, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryAvailabilityRequest as QueryAvailabilityRequest, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryV2 as QueryV2, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Sorting as Sorting, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_SortOrder as SortOrder, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CursorPaging as CursorPaging, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CustomerChoices as CustomerChoices, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryAvailabilityResponse as QueryAvailabilityResponse, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_PagingMetadataV2 as PagingMetadataV2, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_Cursors as Cursors, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetSlotAvailabilityRequest as GetSlotAvailabilityRequest, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetSlotAvailabilityResponse as GetSlotAvailabilityResponse, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_BookingPolicySettings as BookingPolicySettings, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetScheduleAvailabilityRequest as GetScheduleAvailabilityRequest, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetScheduleAvailabilityResponse as GetScheduleAvailabilityResponse, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_ScheduleAvailability as ScheduleAvailability, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CalculateMultiSlotAvailabilityRequest as CalculateMultiSlotAvailabilityRequest, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_RuleBasedConstraints as RuleBasedConstraints, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_ResourcesFilter as ResourcesFilter, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CalculateMultiSlotAvailabilityResponse as CalculateMultiSlotAvailabilityResponse, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CursorPagingMetadata as CursorPagingMetadata, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_queryAvailability as queryAvailability, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_QueryAvailabilityOptions as QueryAvailabilityOptions, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetSlotAvailabilityOptions as GetSlotAvailabilityOptions, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_GetScheduleAvailabilityOptions as GetScheduleAvailabilityOptions, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d_CalculateMultiSlotAvailabilityOptions as CalculateMultiSlotAvailabilityOptions, };\n }\n export { bookingsV2AttendanceAttendance_universal_d as attendance, bookingsAvailabilityV1SlotAvailabilityAvailabilityCalendar_universal_d as availabilityCalendar, bookingsV2BookingBookings_universal_d as bookings, bookingsReaderV2ExtendedBookingExtendedBookings_universal_d as extendedBookings, bookingsCalendarV2ExternalCalendarExternalCalendars_universal_d as externalCalendars, bookingsV2PriceInfoPricing_universal_d as pricing, bookingsCatalogV1ServiceOptionsAndVariantsServiceOptionsAndVariants_universal_d as serviceOptionsAndVariants, bookingsServicesV2ServiceServices_universal_d as services, bookingsCalendarV1SessionSessions_universal_d as sessions, bookingsCalendarV2SessionViewSessionsView_universal_d as sessionsView };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-forum.v2.d.ts", "content": "declare module \"wix-forum.v2\" {\n interface Post {\n /**\n * Post ID.\n * @readonly\n */\n _id?: string | null;\n /** Category ID the post is listed under. */\n categoryId?: string;\n /**\n * Post owner's member ID.\n * @readonly\n */\n ownerId?: string | null;\n /** Post title. */\n title?: string | null;\n /** The post content in plain text. */\n contentText?: string | null;\n /**\n * Total number of post comments.\n * @readonly\n */\n commentCount?: number | null;\n /**\n * Total number of post likes.\n * @readonly\n */\n likeCount?: number | null;\n /**\n * Total number of post views.\n * @readonly\n */\n viewCount?: number | null;\n /**\n * Date post was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date of latest activity on this post (e.g., date the latest comment was added to post).\n * @readonly\n */\n lastActivityDate?: Date | null;\n /**\n * Post URL.\n * @readonly\n */\n url?: string;\n /**\n * Post slug.\n * @readonly\n */\n slug?: string | null;\n /**\n * Images from post content.\n * @readonly\n */\n images?: string[];\n /**\n * Videos from post content.\n * @readonly\n */\n videos?: string[];\n /** Whether the post is pinned. Places the post at the top of the post list. */\n pinned?: boolean | null;\n /** Whether post is closed and commenting is disabled. */\n closed?: boolean | null;\n /** Date post was updated. */\n _updatedDate?: Date | null;\n /** Defines what interactions may be applied on the comment under the post, vote or like. */\n commentInteraction?: Interaction$1;\n /**\n * IDs of the marked comments for this post. Posts are marked by the forum admin or the post owner.\n * @readonly\n */\n markedComments?: string[];\n /**\n * Recent activity of post. For example, a comment added to a post.\n * @readonly\n */\n recentActivity?: RecentActivity;\n /**\n * List of reaction identities grouped by reaction code.\n * @readonly\n */\n reactionIdentities?: ReactionIdentity[];\n }\n enum PostType$1 {\n DISCUSSION = \"DISCUSSION\",\n QUESTION = \"QUESTION\"\n }\n interface FocalPoint$1 {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n /** crop by height */\n height?: number | null;\n /** crop by width */\n width?: number | null;\n }\n interface VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /** Video format for example, mp4, hls. */\n format?: string;\n }\n enum Interaction$1 {\n UNKNOWN = \"UNKNOWN\",\n REACTION = \"REACTION\",\n VOTE = \"VOTE\",\n NONE = \"NONE\"\n }\n interface RecentActivity extends RecentActivityInitiatorOneOf {\n /** Site member ID. */\n memberId?: string;\n /** ID of recent activity entity. */\n entityId?: string;\n /** Type of entity. */\n type?: EntityType;\n /** Date activity was created. */\n activityDate?: string;\n }\n /** @oneof */\n interface RecentActivityInitiatorOneOf {\n /** Site member ID. */\n memberId?: string;\n }\n enum EntityType {\n UNKNOWN = \"UNKNOWN\",\n COMMENT = \"COMMENT\",\n REPLY = \"REPLY\"\n }\n interface ReactionCodeCount {\n /** Reaction code. */\n reactionCode?: string;\n /** Total number of reaction. */\n count?: number;\n }\n interface ReactionIdentity {\n /** Reaction code. */\n reactionCode?: string;\n /**\n * Reacted identities.\n * @readonly\n */\n identities?: Identity[];\n /** Total number of reacted identities count. */\n count?: number;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n VISITOR = \"VISITOR\",\n MEMBER = \"MEMBER\"\n }\n interface Identity {\n /** Identity id. */\n identityId?: string;\n /** Reacted identity type. */\n identityType?: IdentityType;\n }\n interface Moved {\n /** Old category ID. */\n oldCategoryId?: string;\n /** New current category ID. */\n currentCategoryId?: string;\n /** ID of the moved post. */\n postId?: string;\n }\n interface Liked {\n /** ID of the liked post. */\n postId?: string;\n }\n interface Unliked {\n /** ID of the unliked post. */\n postId?: string;\n }\n interface Pinned {\n /** ID of the pinned post. */\n postId?: string;\n }\n interface Unpinned {\n /** ID of the unpinned post. */\n postId?: string;\n }\n interface Closed {\n /** ID of the closed post. */\n postId?: string;\n }\n interface Opened {\n /** ID of the opened post. */\n postId?: string;\n }\n interface Reported {\n /** Type of report. */\n reportType?: ReportType;\n /** ID of the reported post. */\n postId?: string;\n }\n enum ReportType {\n OFFENSIVE_CONTENT = \"OFFENSIVE_CONTENT\",\n OFFENSIVE_MEDIA = \"OFFENSIVE_MEDIA\",\n SPAM = \"SPAM\"\n }\n interface Reacted {\n postId?: string;\n reactionCode?: string;\n }\n interface Unreacted {\n postId?: string;\n reactionCode?: string;\n }\n interface PostRequest {\n /** Post ID. */\n postId: string;\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field$1[];\n }\n enum PostFieldField {\n UNKNOWN = \"UNKNOWN\",\n /** Includes Post content as a stringified DraftJS document (internal only). */\n CONTENT = \"CONTENT\",\n /** Includes images from Post content (internal only). */\n IMAGES = \"IMAGES\",\n /** Includes videos from Post content (internal only). */\n VIDEOS = \"VIDEOS\",\n /** Includes Post URL. */\n URL = \"URL\",\n /** Includes Post content as a stringified Rich Content document (internal only). */\n RICH_CONTENT = \"RICH_CONTENT\"\n }\n enum Field$1 {\n /** Undefined field type. */\n UNKNOWN = \"UNKNOWN\",\n /** Include images from post content. */\n IMAGES = \"IMAGES\",\n /** Include videos from post content. */\n VIDEOS = \"VIDEOS\",\n /** Include post URL. */\n URL = \"URL\",\n /** Include reaction identities. */\n REACTION_IDENTITIES = \"REACTION_IDENTITIES\"\n }\n interface PostResponse {\n /** Post for the provided post ID. */\n post?: Post;\n }\n interface PostSlugRequest {\n /** URL slug. */\n slug: string;\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field$1[];\n }\n interface QueryPostsRequest {\n /** Paging object (e.g., { limit: 10, offset: 100 } ). */\n paging?: PostsPaging;\n /** Filter object (e.g., { $and: [{ ownerId: { eq: 'ownerId' } }, { likeCount: { $gt: 0 }] } ). */\n filter?: Record | null;\n /** Array of sort objects (e.g., [{ fieldName: createdDate, order: Order.ASC }] ). */\n sort?: PostsSort[];\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field$1[];\n }\n interface PostsPaging {\n /** The number of items to load. */\n limit?: number;\n /** Number of items to skip in the current sort order. */\n offset?: number;\n }\n interface PostsSort {\n /**\n * Records can be sorted by:\n * lastActivityDate\n * createdDate\n * commentCount\n * viewCount\n * likeCount\n * isPinned\n */\n fieldName?: string;\n /** Records can be sorted in ascending (default) or descending order. */\n order?: Order$1;\n }\n enum Order$1 {\n /** Sort by ascending order. */\n ASC = \"ASC\",\n /** Sort by descending order. */\n DESC = \"DESC\"\n }\n interface QueryPostsResponse {\n /** List of posts. */\n posts?: Post[];\n /** Pagination. */\n metaData?: QueryPostsResponseMetaData;\n }\n interface QueryPostsResponseMetaData {\n /** Total number of records returned. */\n count?: number;\n /** Offset of records. */\n offset?: number;\n /** Total number of records that match the filters. */\n total?: number;\n }\n interface ViewPostRequest {\n /** ID of the read post. */\n postId: string;\n }\n interface ViewPostResponse {\n }\n interface MarkPostReadRequest {\n /** ID of the read post. */\n postId: string;\n }\n interface MarkPostReadResponse {\n }\n interface MarkPostsSeenRequest {\n /** IDs of the seen posts. */\n postsIds?: string[];\n }\n interface MarkPostsSeenResponse {\n }\n interface MarkPostUnreadRequest {\n /** ID of the unread post. */\n postId: string;\n }\n interface MarkPostUnreadResponse {\n }\n interface CreatePostRequest {\n /** New post to create. */\n post?: Post;\n }\n interface CreatePostResponse {\n /** Created post. */\n post?: Post;\n }\n interface UpdatePostRequest {\n /** ID of the post to update. */\n postId: string;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /** Post data with partial data to update. */\n post?: Post;\n }\n interface UpdatePostResponse {\n /** Updated post. */\n post?: Post;\n }\n interface DeletePostRequest {\n /** ID of the post to delete. */\n postId: string;\n }\n interface DeletePostResponse {\n /** Deleted post. */\n post?: Post;\n }\n interface SetBestAnswerRequest {\n /** Post ID. */\n postId: string;\n /** ID of the \"best answer\" comment on the post. */\n commentId: string;\n }\n interface SetBestAnswerResponse {\n }\n interface RemoveBestAnswerRequest {\n /** Post ID */\n postId: string;\n }\n interface RemoveBestAnswerResponse {\n }\n interface PinPostRequest {\n /** Post ID */\n postId: string;\n /** The amount of minutes after which the pin will be removed (unpinned) */\n expiresInMinutes?: number | null;\n }\n interface PinPostResponse {\n }\n interface UnpinPostRequest {\n /** Post ID */\n postId: string;\n }\n interface UnpinPostResponse {\n }\n interface AddReactionRequest {\n /** Post ID */\n postId: string;\n /** Code of reaction to add. */\n reactionCode: string;\n }\n interface AddReactionResponse {\n /**\n * Total number of comment reactions.\n * @readonly\n */\n reactionCount?: number;\n /**\n * List of reacted identities grouped by reaction code.\n * @readonly\n */\n reactionIdentities?: ReactionIdentity[];\n }\n interface RemoveReactionRequest {\n /** Post ID */\n postId: string;\n /** Code of reaction to remove. */\n reactionCode: string;\n }\n interface RemoveReactionResponse {\n /**\n * Total number of comment reactions.\n * @readonly\n */\n reactionCount?: number;\n /**\n * List of reacted identities grouped by reaction code.\n * @readonly\n */\n reactionIdentities?: ReactionIdentity[];\n }\n interface ReportPostRequest {\n /** Post ID */\n postId: string;\n /** Type of report. */\n reportType?: ReportType;\n }\n interface ReportPostResponse {\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves a single post by ID.\n * @param postId - Post ID.\n * @public\n * @documentationMaturity preview\n * @requiredField postId\n * @param options - Options specifying which additional fields to return.\n * @permissionId WIX_FORUM.POST_READ\n * @permissionScope Read Forums\n * @permissionScopeId SCOPE.DC-FORUM.READ-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Post for the provided post ID.\n * @fqn com.wixpress.npm.communities.forum.api.PostManagementService.GetPost\n */\n function getPost(postId: string, options?: GetPostOptions): Promise;\n interface GetPostOptions {\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field$1[];\n }\n /**\n * Retrieves a single post by URL slug.\n * @param slug - URL slug.\n * @public\n * @documentationMaturity preview\n * @requiredField slug\n * @param options - Options specifying which additional fields to return.\n * @permissionId WIX_FORUM.POST_READ\n * @permissionScope Read Forums\n * @permissionScopeId SCOPE.DC-FORUM.READ-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.npm.communities.forum.api.PostManagementService.GetPostBySlug\n */\n function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise;\n interface GetPostBySlugOptions {\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field$1[];\n }\n /**\n * Returns a list of posts by query.\n *\n * Paging\n * - limit: default - 10, min - 0, max - 100\n * - offset: default - 0, min - 0\n *\n * Filterable fields:\n * - id\n * - categoryId\n * - ownerId\n * - title\n * - contentText\n * - bestAnswerCommentId\n * - pinned\n * - commentingEnabled\n * - commentCount\n * - likeCount\n * - viewCount\n * - createdDate\n * - editedDate\n * - lastActivityDate\n * - slug\n *\n * Sortable fields:\n * - lastActivityDate\n * - createdDate\n * - commentCount\n * - viewCount\n * - likeCount\n * - pinned\n * @public\n * @documentationMaturity preview\n * @param options - Options for sorting, filtering, paging, and specifying return fields.\n * @permissionId WIX_FORUM.POST_READ\n * @permissionScope Read Forums\n * @permissionScopeId SCOPE.DC-FORUM.READ-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.npm.communities.forum.api.PostManagementService.QueryPosts\n */\n function queryPosts(options?: QueryPostsOptions): Promise;\n interface QueryPostsOptions {\n /** Paging object (e.g., { limit: 10, offset: 100 } ). */\n paging?: PostsPaging;\n /** Filter object (e.g., { $and: [{ ownerId: { eq: 'ownerId' } }, { likeCount: { $gt: 0 }] } ). */\n filter?: Record | null;\n /** Array of sort objects (e.g., [{ fieldName: createdDate, order: Order.ASC }] ). */\n sort?: PostsSort[];\n /** Array of extra post fields to be included in the response. */\n extraFields?: Field$1[];\n }\n interface MarkPostsSeenOptions {\n /** IDs of the seen posts. */\n postsIds?: string[];\n }\n interface CreatePostOptions {\n /** New post to create. */\n post?: Post;\n }\n interface UpdatePostOptions {\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /** Post data with partial data to update. */\n post?: Post;\n }\n interface PinPostOptions {\n /** The amount of minutes after which the pin will be removed (unpinned) */\n expiresInMinutes?: number | null;\n }\n interface ReportPostOptions {\n /** Type of report. */\n reportType?: ReportType;\n }\n type forumV1PostPosts_universal_d_Post = Post;\n type forumV1PostPosts_universal_d_VideoResolution = VideoResolution;\n type forumV1PostPosts_universal_d_RecentActivity = RecentActivity;\n type forumV1PostPosts_universal_d_RecentActivityInitiatorOneOf = RecentActivityInitiatorOneOf;\n type forumV1PostPosts_universal_d_EntityType = EntityType;\n const forumV1PostPosts_universal_d_EntityType: typeof EntityType;\n type forumV1PostPosts_universal_d_ReactionCodeCount = ReactionCodeCount;\n type forumV1PostPosts_universal_d_ReactionIdentity = ReactionIdentity;\n type forumV1PostPosts_universal_d_IdentityType = IdentityType;\n const forumV1PostPosts_universal_d_IdentityType: typeof IdentityType;\n type forumV1PostPosts_universal_d_Identity = Identity;\n type forumV1PostPosts_universal_d_Moved = Moved;\n type forumV1PostPosts_universal_d_Liked = Liked;\n type forumV1PostPosts_universal_d_Unliked = Unliked;\n type forumV1PostPosts_universal_d_Pinned = Pinned;\n type forumV1PostPosts_universal_d_Unpinned = Unpinned;\n type forumV1PostPosts_universal_d_Closed = Closed;\n type forumV1PostPosts_universal_d_Opened = Opened;\n type forumV1PostPosts_universal_d_Reported = Reported;\n type forumV1PostPosts_universal_d_ReportType = ReportType;\n const forumV1PostPosts_universal_d_ReportType: typeof ReportType;\n type forumV1PostPosts_universal_d_Reacted = Reacted;\n type forumV1PostPosts_universal_d_Unreacted = Unreacted;\n type forumV1PostPosts_universal_d_PostRequest = PostRequest;\n type forumV1PostPosts_universal_d_PostFieldField = PostFieldField;\n const forumV1PostPosts_universal_d_PostFieldField: typeof PostFieldField;\n type forumV1PostPosts_universal_d_PostResponse = PostResponse;\n type forumV1PostPosts_universal_d_PostSlugRequest = PostSlugRequest;\n type forumV1PostPosts_universal_d_QueryPostsRequest = QueryPostsRequest;\n type forumV1PostPosts_universal_d_PostsPaging = PostsPaging;\n type forumV1PostPosts_universal_d_PostsSort = PostsSort;\n type forumV1PostPosts_universal_d_QueryPostsResponse = QueryPostsResponse;\n type forumV1PostPosts_universal_d_QueryPostsResponseMetaData = QueryPostsResponseMetaData;\n type forumV1PostPosts_universal_d_ViewPostRequest = ViewPostRequest;\n type forumV1PostPosts_universal_d_ViewPostResponse = ViewPostResponse;\n type forumV1PostPosts_universal_d_MarkPostReadRequest = MarkPostReadRequest;\n type forumV1PostPosts_universal_d_MarkPostReadResponse = MarkPostReadResponse;\n type forumV1PostPosts_universal_d_MarkPostsSeenRequest = MarkPostsSeenRequest;\n type forumV1PostPosts_universal_d_MarkPostsSeenResponse = MarkPostsSeenResponse;\n type forumV1PostPosts_universal_d_MarkPostUnreadRequest = MarkPostUnreadRequest;\n type forumV1PostPosts_universal_d_MarkPostUnreadResponse = MarkPostUnreadResponse;\n type forumV1PostPosts_universal_d_CreatePostRequest = CreatePostRequest;\n type forumV1PostPosts_universal_d_CreatePostResponse = CreatePostResponse;\n type forumV1PostPosts_universal_d_UpdatePostRequest = UpdatePostRequest;\n type forumV1PostPosts_universal_d_UpdatePostResponse = UpdatePostResponse;\n type forumV1PostPosts_universal_d_DeletePostRequest = DeletePostRequest;\n type forumV1PostPosts_universal_d_DeletePostResponse = DeletePostResponse;\n type forumV1PostPosts_universal_d_SetBestAnswerRequest = SetBestAnswerRequest;\n type forumV1PostPosts_universal_d_SetBestAnswerResponse = SetBestAnswerResponse;\n type forumV1PostPosts_universal_d_RemoveBestAnswerRequest = RemoveBestAnswerRequest;\n type forumV1PostPosts_universal_d_RemoveBestAnswerResponse = RemoveBestAnswerResponse;\n type forumV1PostPosts_universal_d_PinPostRequest = PinPostRequest;\n type forumV1PostPosts_universal_d_PinPostResponse = PinPostResponse;\n type forumV1PostPosts_universal_d_UnpinPostRequest = UnpinPostRequest;\n type forumV1PostPosts_universal_d_UnpinPostResponse = UnpinPostResponse;\n type forumV1PostPosts_universal_d_AddReactionRequest = AddReactionRequest;\n type forumV1PostPosts_universal_d_AddReactionResponse = AddReactionResponse;\n type forumV1PostPosts_universal_d_RemoveReactionRequest = RemoveReactionRequest;\n type forumV1PostPosts_universal_d_RemoveReactionResponse = RemoveReactionResponse;\n type forumV1PostPosts_universal_d_ReportPostRequest = ReportPostRequest;\n type forumV1PostPosts_universal_d_ReportPostResponse = ReportPostResponse;\n const forumV1PostPosts_universal_d_getPost: typeof getPost;\n type forumV1PostPosts_universal_d_GetPostOptions = GetPostOptions;\n const forumV1PostPosts_universal_d_getPostBySlug: typeof getPostBySlug;\n type forumV1PostPosts_universal_d_GetPostBySlugOptions = GetPostBySlugOptions;\n const forumV1PostPosts_universal_d_queryPosts: typeof queryPosts;\n type forumV1PostPosts_universal_d_QueryPostsOptions = QueryPostsOptions;\n type forumV1PostPosts_universal_d_MarkPostsSeenOptions = MarkPostsSeenOptions;\n type forumV1PostPosts_universal_d_CreatePostOptions = CreatePostOptions;\n type forumV1PostPosts_universal_d_UpdatePostOptions = UpdatePostOptions;\n type forumV1PostPosts_universal_d_PinPostOptions = PinPostOptions;\n type forumV1PostPosts_universal_d_ReportPostOptions = ReportPostOptions;\n namespace forumV1PostPosts_universal_d {\n export { forumV1PostPosts_universal_d_Post as Post, PostType$1 as PostType, FocalPoint$1 as FocalPoint, forumV1PostPosts_universal_d_VideoResolution as VideoResolution, Interaction$1 as Interaction, forumV1PostPosts_universal_d_RecentActivity as RecentActivity, forumV1PostPosts_universal_d_RecentActivityInitiatorOneOf as RecentActivityInitiatorOneOf, forumV1PostPosts_universal_d_EntityType as EntityType, forumV1PostPosts_universal_d_ReactionCodeCount as ReactionCodeCount, forumV1PostPosts_universal_d_ReactionIdentity as ReactionIdentity, forumV1PostPosts_universal_d_IdentityType as IdentityType, forumV1PostPosts_universal_d_Identity as Identity, forumV1PostPosts_universal_d_Moved as Moved, forumV1PostPosts_universal_d_Liked as Liked, forumV1PostPosts_universal_d_Unliked as Unliked, forumV1PostPosts_universal_d_Pinned as Pinned, forumV1PostPosts_universal_d_Unpinned as Unpinned, forumV1PostPosts_universal_d_Closed as Closed, forumV1PostPosts_universal_d_Opened as Opened, forumV1PostPosts_universal_d_Reported as Reported, forumV1PostPosts_universal_d_ReportType as ReportType, forumV1PostPosts_universal_d_Reacted as Reacted, forumV1PostPosts_universal_d_Unreacted as Unreacted, forumV1PostPosts_universal_d_PostRequest as PostRequest, forumV1PostPosts_universal_d_PostFieldField as PostFieldField, Field$1 as Field, forumV1PostPosts_universal_d_PostResponse as PostResponse, forumV1PostPosts_universal_d_PostSlugRequest as PostSlugRequest, forumV1PostPosts_universal_d_QueryPostsRequest as QueryPostsRequest, forumV1PostPosts_universal_d_PostsPaging as PostsPaging, forumV1PostPosts_universal_d_PostsSort as PostsSort, Order$1 as Order, forumV1PostPosts_universal_d_QueryPostsResponse as QueryPostsResponse, forumV1PostPosts_universal_d_QueryPostsResponseMetaData as QueryPostsResponseMetaData, forumV1PostPosts_universal_d_ViewPostRequest as ViewPostRequest, forumV1PostPosts_universal_d_ViewPostResponse as ViewPostResponse, forumV1PostPosts_universal_d_MarkPostReadRequest as MarkPostReadRequest, forumV1PostPosts_universal_d_MarkPostReadResponse as MarkPostReadResponse, forumV1PostPosts_universal_d_MarkPostsSeenRequest as MarkPostsSeenRequest, forumV1PostPosts_universal_d_MarkPostsSeenResponse as MarkPostsSeenResponse, forumV1PostPosts_universal_d_MarkPostUnreadRequest as MarkPostUnreadRequest, forumV1PostPosts_universal_d_MarkPostUnreadResponse as MarkPostUnreadResponse, forumV1PostPosts_universal_d_CreatePostRequest as CreatePostRequest, forumV1PostPosts_universal_d_CreatePostResponse as CreatePostResponse, forumV1PostPosts_universal_d_UpdatePostRequest as UpdatePostRequest, forumV1PostPosts_universal_d_UpdatePostResponse as UpdatePostResponse, forumV1PostPosts_universal_d_DeletePostRequest as DeletePostRequest, forumV1PostPosts_universal_d_DeletePostResponse as DeletePostResponse, forumV1PostPosts_universal_d_SetBestAnswerRequest as SetBestAnswerRequest, forumV1PostPosts_universal_d_SetBestAnswerResponse as SetBestAnswerResponse, forumV1PostPosts_universal_d_RemoveBestAnswerRequest as RemoveBestAnswerRequest, forumV1PostPosts_universal_d_RemoveBestAnswerResponse as RemoveBestAnswerResponse, forumV1PostPosts_universal_d_PinPostRequest as PinPostRequest, forumV1PostPosts_universal_d_PinPostResponse as PinPostResponse, forumV1PostPosts_universal_d_UnpinPostRequest as UnpinPostRequest, forumV1PostPosts_universal_d_UnpinPostResponse as UnpinPostResponse, forumV1PostPosts_universal_d_AddReactionRequest as AddReactionRequest, forumV1PostPosts_universal_d_AddReactionResponse as AddReactionResponse, forumV1PostPosts_universal_d_RemoveReactionRequest as RemoveReactionRequest, forumV1PostPosts_universal_d_RemoveReactionResponse as RemoveReactionResponse, forumV1PostPosts_universal_d_ReportPostRequest as ReportPostRequest, forumV1PostPosts_universal_d_ReportPostResponse as ReportPostResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, forumV1PostPosts_universal_d_getPost as getPost, forumV1PostPosts_universal_d_GetPostOptions as GetPostOptions, forumV1PostPosts_universal_d_getPostBySlug as getPostBySlug, forumV1PostPosts_universal_d_GetPostBySlugOptions as GetPostBySlugOptions, forumV1PostPosts_universal_d_queryPosts as queryPosts, forumV1PostPosts_universal_d_QueryPostsOptions as QueryPostsOptions, forumV1PostPosts_universal_d_MarkPostsSeenOptions as MarkPostsSeenOptions, forumV1PostPosts_universal_d_CreatePostOptions as CreatePostOptions, forumV1PostPosts_universal_d_UpdatePostOptions as UpdatePostOptions, forumV1PostPosts_universal_d_PinPostOptions as PinPostOptions, forumV1PostPosts_universal_d_ReportPostOptions as ReportPostOptions, };\n }\n interface Category {\n /**\n * Category ID.\n * @readonly\n */\n _id?: string | null;\n /** Category parent ID. */\n parentId?: string | null;\n /** Category name. */\n name?: string | null;\n /** Category header title. */\n headerTitle?: string | null;\n /** Category header type. */\n headerType?: HeaderType;\n /** Category header image. */\n headerImage?: string;\n /**\n * Category rank (display order).\n * @readonly\n */\n rank?: number | null;\n /**\n * Total number of posts in category.\n * @readonly\n */\n postCount?: number | null;\n /**\n * Total number of post views in category.\n * @readonly\n */\n postViewCount?: number | null;\n /**\n * Category slug.\n * @readonly\n */\n slug?: string | null;\n /**\n * Category URL.\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string;\n /**\n * Date category was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Whether all site visitors and members (`PUBLIC`), all members (`MEMBERS_ONLY`), or only specific members and groups of members with roles, badges or paid subscriptions (`PRIVATE`) can access posts in category.\n * @readonly\n */\n categoryAccess?: Access;\n /** Date category was updated. */\n _updatedDate?: Date | null;\n /** Whether only admins and moderators can write posts in category. */\n noMemberPosting?: boolean;\n /**\n * IDs of groups which can access this category if `categoryAccess` is `PRIVATE`.\n * @readonly\n */\n groups?: string[];\n /** Defines what interactions may be applied on the comment under the posts created in this category, vote or like. */\n commentInteraction?: Interaction;\n /**\n * Defines which icon will be used for the main reaction on the comment under the posts created in this category.\n *\n * Default `type`: `\"LIKE\"`.\n */\n mainCommentReaction?: Reaction;\n /** Defines what additional reactions may be applied on the comment under the posts created in this category. */\n additionalCommentReactions?: Reaction[];\n /** Defines what interactions may be applied on the posts created in this category, like or multiple reactions. */\n postInteraction?: PostInteraction;\n /**\n * Defines which icon will be used for main reaction on the posts created in this category.\n *\n * Default `type`: `\"LIKE\"`.\n */\n mainPostReaction?: Reaction;\n /** Defines what additional reactions may be applied on the posts created in this category. */\n additionalPostReactions?: Reaction[];\n }\n enum HeaderType {\n NONE = \"NONE\",\n COLOR = \"COLOR\",\n IMAGE = \"IMAGE\"\n }\n interface FocalPoint {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n /** crop by height */\n height?: number | null;\n /** crop by width */\n width?: number | null;\n }\n interface ColorComponent {\n /** Hex Color Code */\n color?: string | null;\n /** Opacity (from 0 to 1) */\n opacity?: number | null;\n }\n enum PostType {\n DISCUSSION = \"DISCUSSION\",\n QUESTION = \"QUESTION\"\n }\n enum Access {\n UNKNOWN = \"UNKNOWN\",\n PUBLIC = \"PUBLIC\",\n MEMBERS_ONLY = \"MEMBERS_ONLY\",\n PRIVATE = \"PRIVATE\"\n }\n enum Interaction {\n UNKNOWN = \"UNKNOWN\",\n REACTION = \"REACTION\",\n VOTE = \"VOTE\",\n NONE = \"NONE\"\n }\n interface Reaction extends ReactionReactionOneOf {\n type?: Type;\n /** @readonly */\n code?: string | null;\n }\n /** @oneof */\n interface ReactionReactionOneOf {\n type?: Type;\n }\n enum Type {\n LIKE = \"LIKE\",\n ANGRY = \"ANGRY\",\n CLAP = \"CLAP\",\n LOVE = \"LOVE\",\n HAHA = \"HAHA\",\n SAD = \"SAD\",\n SMILE = \"SMILE\",\n WOW = \"WOW\",\n THINKING = \"THINKING\",\n THUMBS_UP = \"THUMBS_UP\",\n THUMBS_DOWN = \"THUMBS_DOWN\"\n }\n enum PostInteraction {\n UNKNOWN = \"UNKNOWN\",\n REACTION = \"REACTION\",\n NONE = \"NONE\"\n }\n enum CommentOrder {\n UNKNOWN = \"UNKNOWN\",\n OLDEST = \"OLDEST\",\n NEWEST = \"NEWEST\",\n MOST_VOTES = \"MOST_VOTES\",\n LEAST_VOTES = \"LEAST_VOTES\",\n LOWEST_RATED = \"LOWEST_RATED\",\n HIGHEST_RATED = \"HIGHEST_RATED\",\n MOST_REACTIONS = \"MOST_REACTIONS\"\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema {\n /** SEO tag information. */\n tags?: Tag[];\n /** SEO general settings. */\n settings?: Settings;\n }\n interface Keyword {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\n }\n interface Tag {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{\"key\": \"value\"}` pair object where each SEO tag property (`\"name\"`, `\"content\"`, `\"rel\"`, `\"href\"`) contains a value.\n * For example: `{\"name\": \"description\", \"content\": \"the description itself\"}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{\"height\": 300, \"width\": 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword[];\n }\n interface CategoryRequest {\n /** ID of the retrieved category. */\n categoryId: string;\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field[];\n }\n enum CategoryFieldField {\n UNKNOWN = \"UNKNOWN\",\n /** Includes the category's URL. */\n URL = \"URL\"\n }\n enum Field {\n /** Undefined field. */\n UNKNOWN = \"UNKNOWN\",\n /** Include the category's URL. */\n URL = \"URL\"\n }\n interface CategoryResponse {\n /** Retrieved category for the provided category ID. */\n category?: Category;\n }\n interface CategorySlugRequest {\n /** URL slug. */\n slug: string;\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field[];\n }\n interface QueryCategoriesRequest {\n /** Paging object (e.g., {limit: 10, offset: 100 } ) */\n paging?: CategoriesPaging;\n /** Filter object (e.g., { $and: [{ postViewCount: { $gt: 0 } }, { postCount: { $gt: 0 }] } ) */\n filter?: Record | null;\n /** Array of sort objects (e.g., [{ fieldName: rank, order: Order.ASC }] ) */\n sort?: CategoriesSort[];\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field[];\n }\n interface CategoriesPaging {\n /** The number of items to load. */\n limit?: number;\n /** Number of items to skip in the current sort order. */\n offset?: number;\n }\n interface CategoriesSort {\n /**\n * Records can be sorted by:\n * rank\n * postCount\n * postViewCount\n */\n fieldName?: string;\n /** Records can be sorted in ascending (default) or descending order. */\n order?: Order;\n }\n enum Order {\n /** Sort by ascending order. */\n ASC = \"ASC\",\n /** Sort by descending order. */\n DESC = \"DESC\"\n }\n interface QueryCategoriesResponse {\n /** List of categories. */\n categories?: Category[];\n /** Pagination. */\n metaData?: QueryCategoriesResponseMetaData;\n }\n interface QueryCategoriesResponseMetaData {\n /** Total number of records returned. */\n count?: number;\n /** Offset of records. */\n offset?: number;\n /** Total number of records that match the filters. */\n total?: number;\n }\n interface MarkCategoryReadRequest {\n /** ID of the read category. */\n categoryId: string;\n }\n interface MarkCategoryReadResponse {\n }\n interface MarkAllPostsAsReadRequest {\n /** ID of the read posts category. */\n categoryId?: string;\n }\n interface MarkAllPostsAsReadResponse {\n }\n interface CreateCategoryRequest {\n category?: Category;\n }\n interface UpdateCategoryRequest {\n /** ID of category. */\n categoryId: string;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /** Editable category data. */\n category?: Category;\n }\n interface DeleteCategoryRequest {\n /** ID of category. */\n categoryId: string;\n }\n interface DeleteCategoryResponse {\n category?: Category;\n }\n interface SubscribeContactToCategoryRequest {\n /** Category ID. */\n categoryId: string;\n /** Contact ID. */\n contactId?: string | null;\n }\n interface SubscribeContactToCategoryResponse {\n }\n interface UnsubscribeContactFromCategoryRequest {\n /** Category ID. */\n categoryId: string;\n /** Contact ID. */\n contactId?: string | null;\n }\n interface UnsubscribeContactFromCategoryResponse {\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Returns a single category by ID.\n * @param categoryId - ID of the retrieved category.\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @param options - Options specifying which fields to return.\n * @permissionId WIX_FORUM.CATEGORY_READ\n * @permissionScope Read Forums\n * @permissionScopeId SCOPE.DC-FORUM.READ-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved category for the provided category ID.\n * @fqn com.wixpress.npm.communities.forum.api.CategoryManagementService.GetCategory\n */\n function getCategory(categoryId: string, options?: GetCategoryOptions): Promise;\n interface GetCategoryOptions {\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field[];\n }\n /**\n * Returns a single category by URL slug.\n * @param slug - URL slug.\n * @public\n * @documentationMaturity preview\n * @requiredField slug\n * @param options - Options specifying which fields to return.\n * @permissionId WIX_FORUM.CATEGORY_READ\n * @permissionScope Read Forums\n * @permissionScopeId SCOPE.DC-FORUM.READ-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.npm.communities.forum.api.CategoryManagementService.GetCategoryBySlug\n */\n function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise;\n interface GetCategoryBySlugOptions {\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field[];\n }\n /**\n * Retrieves a list of categories, given the provided paging, filtering, and sorting.\n *\n * Query Categories runs with these defaults, which you can override:\n *\n * - `paging.limit` is `10`\n * - `paging.offset` is `0`\n *\n * For field support for filters and sorting,\n * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-forum/wix-forum/filter-and-sort#category-api-supported-filters-and-sorting).\n *\n * To learn about working with _Query_ endpoints, see\n * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging),\n * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n * @public\n * @documentationMaturity preview\n * @param options - Options for sorting, filtering, paging, and specifying return fields.\n * @permissionId WIX_FORUM.CATEGORY_READ\n * @permissionScope Read Forums\n * @permissionScopeId SCOPE.DC-FORUM.READ-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.npm.communities.forum.api.CategoryManagementService.QueryCategories\n */\n function queryCategories(options?: QueryCategoriesOptions): Promise;\n interface QueryCategoriesOptions {\n /** Paging object (e.g., {limit: 10, offset: 100 } ) */\n paging?: CategoriesPaging;\n /** Filter object (e.g., { $and: [{ postViewCount: { $gt: 0 } }, { postCount: { $gt: 0 }] } ) */\n filter?: Record | null;\n /** Array of sort objects (e.g., [{ fieldName: rank, order: Order.ASC }] ) */\n sort?: CategoriesSort[];\n /** Array of extra category fields to be included in the response. */\n extraFields?: Field[];\n }\n interface MarkAllPostsAsReadOptions {\n /** ID of the read posts category. */\n categoryId?: string;\n }\n interface CreateCategoryOptions {\n category?: Category;\n }\n interface UpdateCategoryOptions {\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /** Editable category data. */\n category?: Category;\n }\n /**\n * Subscribes a contact to a specific forum category.\n *\n * By default a contact isn't subscribed to any forum categories.\n *\n * By subscribing a contact to a category, the contact receives notifications for that category.\n *\n * If `contactId` is not provided, it is implicitly resolved from the caller's context.\n * @param categoryId - Category ID.\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @param options - Options for subscribing the contact.\n * @permissionId WIX_FORUM.CATEGORY_SUBSCRIBE\n * @permissionId WIX_FORUM.CATEGORY_SUBSCRIBE_OVERRIDE_CONTACT_ID\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.npm.communities.forum.api.CategoryManagementService.SubscribeContactToCategory\n */\n function subscribeContactToCategory(categoryId: string, options?: SubscribeContactToCategoryOptions): Promise;\n interface SubscribeContactToCategoryOptions {\n /** Contact ID. */\n contactId?: string | null;\n }\n /**\n * Unsubscribes a contact from a specific forum category.\n *\n * By default a contact isn't subscribed to any forum categories.\n *\n * By unsubscribing a contact from a category, the contact won’t receive notifications for that category.\n *\n * If `contactId` is not provided, it is implicitly resolved from the caller's context.\n * @param categoryId - Category ID.\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @param options - Options for unsubscribing the contact.\n * @permissionId WIX_FORUM.CATEGORY_SUBSCRIBE\n * @permissionId WIX_FORUM.CATEGORY_SUBSCRIBE_OVERRIDE_CONTACT_ID\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @permissionScope Manage Forums\n * @permissionScopeId SCOPE.DC-FORUM.MANAGE-FORUM\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.npm.communities.forum.api.CategoryManagementService.UnsubscribeContactFromCategory\n */\n function unsubscribeContactFromCategory(categoryId: string, options?: UnsubscribeContactFromCategoryOptions): Promise;\n interface UnsubscribeContactFromCategoryOptions {\n /** Contact ID. */\n contactId?: string | null;\n }\n type forumV1CategoryCategories_universal_d_Category = Category;\n type forumV1CategoryCategories_universal_d_HeaderType = HeaderType;\n const forumV1CategoryCategories_universal_d_HeaderType: typeof HeaderType;\n type forumV1CategoryCategories_universal_d_FocalPoint = FocalPoint;\n type forumV1CategoryCategories_universal_d_ColorComponent = ColorComponent;\n type forumV1CategoryCategories_universal_d_PostType = PostType;\n const forumV1CategoryCategories_universal_d_PostType: typeof PostType;\n type forumV1CategoryCategories_universal_d_Access = Access;\n const forumV1CategoryCategories_universal_d_Access: typeof Access;\n type forumV1CategoryCategories_universal_d_Interaction = Interaction;\n const forumV1CategoryCategories_universal_d_Interaction: typeof Interaction;\n type forumV1CategoryCategories_universal_d_Reaction = Reaction;\n type forumV1CategoryCategories_universal_d_ReactionReactionOneOf = ReactionReactionOneOf;\n type forumV1CategoryCategories_universal_d_Type = Type;\n const forumV1CategoryCategories_universal_d_Type: typeof Type;\n type forumV1CategoryCategories_universal_d_PostInteraction = PostInteraction;\n const forumV1CategoryCategories_universal_d_PostInteraction: typeof PostInteraction;\n type forumV1CategoryCategories_universal_d_CommentOrder = CommentOrder;\n const forumV1CategoryCategories_universal_d_CommentOrder: typeof CommentOrder;\n type forumV1CategoryCategories_universal_d_SeoSchema = SeoSchema;\n type forumV1CategoryCategories_universal_d_Keyword = Keyword;\n type forumV1CategoryCategories_universal_d_Tag = Tag;\n type forumV1CategoryCategories_universal_d_Settings = Settings;\n type forumV1CategoryCategories_universal_d_CategoryRequest = CategoryRequest;\n type forumV1CategoryCategories_universal_d_CategoryFieldField = CategoryFieldField;\n const forumV1CategoryCategories_universal_d_CategoryFieldField: typeof CategoryFieldField;\n type forumV1CategoryCategories_universal_d_Field = Field;\n const forumV1CategoryCategories_universal_d_Field: typeof Field;\n type forumV1CategoryCategories_universal_d_CategoryResponse = CategoryResponse;\n type forumV1CategoryCategories_universal_d_CategorySlugRequest = CategorySlugRequest;\n type forumV1CategoryCategories_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type forumV1CategoryCategories_universal_d_CategoriesPaging = CategoriesPaging;\n type forumV1CategoryCategories_universal_d_CategoriesSort = CategoriesSort;\n type forumV1CategoryCategories_universal_d_Order = Order;\n const forumV1CategoryCategories_universal_d_Order: typeof Order;\n type forumV1CategoryCategories_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type forumV1CategoryCategories_universal_d_QueryCategoriesResponseMetaData = QueryCategoriesResponseMetaData;\n type forumV1CategoryCategories_universal_d_MarkCategoryReadRequest = MarkCategoryReadRequest;\n type forumV1CategoryCategories_universal_d_MarkCategoryReadResponse = MarkCategoryReadResponse;\n type forumV1CategoryCategories_universal_d_MarkAllPostsAsReadRequest = MarkAllPostsAsReadRequest;\n type forumV1CategoryCategories_universal_d_MarkAllPostsAsReadResponse = MarkAllPostsAsReadResponse;\n type forumV1CategoryCategories_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type forumV1CategoryCategories_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type forumV1CategoryCategories_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type forumV1CategoryCategories_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type forumV1CategoryCategories_universal_d_SubscribeContactToCategoryRequest = SubscribeContactToCategoryRequest;\n type forumV1CategoryCategories_universal_d_SubscribeContactToCategoryResponse = SubscribeContactToCategoryResponse;\n type forumV1CategoryCategories_universal_d_UnsubscribeContactFromCategoryRequest = UnsubscribeContactFromCategoryRequest;\n type forumV1CategoryCategories_universal_d_UnsubscribeContactFromCategoryResponse = UnsubscribeContactFromCategoryResponse;\n type forumV1CategoryCategories_universal_d_DomainEvent = DomainEvent;\n type forumV1CategoryCategories_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type forumV1CategoryCategories_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type forumV1CategoryCategories_universal_d_RestoreInfo = RestoreInfo;\n type forumV1CategoryCategories_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type forumV1CategoryCategories_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type forumV1CategoryCategories_universal_d_ActionEvent = ActionEvent;\n type forumV1CategoryCategories_universal_d_MessageEnvelope = MessageEnvelope;\n type forumV1CategoryCategories_universal_d_IdentificationData = IdentificationData;\n type forumV1CategoryCategories_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type forumV1CategoryCategories_universal_d_WebhookIdentityType = WebhookIdentityType;\n const forumV1CategoryCategories_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const forumV1CategoryCategories_universal_d_getCategory: typeof getCategory;\n type forumV1CategoryCategories_universal_d_GetCategoryOptions = GetCategoryOptions;\n const forumV1CategoryCategories_universal_d_getCategoryBySlug: typeof getCategoryBySlug;\n type forumV1CategoryCategories_universal_d_GetCategoryBySlugOptions = GetCategoryBySlugOptions;\n const forumV1CategoryCategories_universal_d_queryCategories: typeof queryCategories;\n type forumV1CategoryCategories_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n type forumV1CategoryCategories_universal_d_MarkAllPostsAsReadOptions = MarkAllPostsAsReadOptions;\n type forumV1CategoryCategories_universal_d_CreateCategoryOptions = CreateCategoryOptions;\n type forumV1CategoryCategories_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const forumV1CategoryCategories_universal_d_subscribeContactToCategory: typeof subscribeContactToCategory;\n type forumV1CategoryCategories_universal_d_SubscribeContactToCategoryOptions = SubscribeContactToCategoryOptions;\n const forumV1CategoryCategories_universal_d_unsubscribeContactFromCategory: typeof unsubscribeContactFromCategory;\n type forumV1CategoryCategories_universal_d_UnsubscribeContactFromCategoryOptions = UnsubscribeContactFromCategoryOptions;\n namespace forumV1CategoryCategories_universal_d {\n export { forumV1CategoryCategories_universal_d_Category as Category, forumV1CategoryCategories_universal_d_HeaderType as HeaderType, forumV1CategoryCategories_universal_d_FocalPoint as FocalPoint, forumV1CategoryCategories_universal_d_ColorComponent as ColorComponent, forumV1CategoryCategories_universal_d_PostType as PostType, forumV1CategoryCategories_universal_d_Access as Access, forumV1CategoryCategories_universal_d_Interaction as Interaction, forumV1CategoryCategories_universal_d_Reaction as Reaction, forumV1CategoryCategories_universal_d_ReactionReactionOneOf as ReactionReactionOneOf, forumV1CategoryCategories_universal_d_Type as Type, forumV1CategoryCategories_universal_d_PostInteraction as PostInteraction, forumV1CategoryCategories_universal_d_CommentOrder as CommentOrder, forumV1CategoryCategories_universal_d_SeoSchema as SeoSchema, forumV1CategoryCategories_universal_d_Keyword as Keyword, forumV1CategoryCategories_universal_d_Tag as Tag, forumV1CategoryCategories_universal_d_Settings as Settings, forumV1CategoryCategories_universal_d_CategoryRequest as CategoryRequest, forumV1CategoryCategories_universal_d_CategoryFieldField as CategoryFieldField, forumV1CategoryCategories_universal_d_Field as Field, forumV1CategoryCategories_universal_d_CategoryResponse as CategoryResponse, forumV1CategoryCategories_universal_d_CategorySlugRequest as CategorySlugRequest, forumV1CategoryCategories_universal_d_QueryCategoriesRequest as QueryCategoriesRequest, forumV1CategoryCategories_universal_d_CategoriesPaging as CategoriesPaging, forumV1CategoryCategories_universal_d_CategoriesSort as CategoriesSort, forumV1CategoryCategories_universal_d_Order as Order, forumV1CategoryCategories_universal_d_QueryCategoriesResponse as QueryCategoriesResponse, forumV1CategoryCategories_universal_d_QueryCategoriesResponseMetaData as QueryCategoriesResponseMetaData, forumV1CategoryCategories_universal_d_MarkCategoryReadRequest as MarkCategoryReadRequest, forumV1CategoryCategories_universal_d_MarkCategoryReadResponse as MarkCategoryReadResponse, forumV1CategoryCategories_universal_d_MarkAllPostsAsReadRequest as MarkAllPostsAsReadRequest, forumV1CategoryCategories_universal_d_MarkAllPostsAsReadResponse as MarkAllPostsAsReadResponse, forumV1CategoryCategories_universal_d_CreateCategoryRequest as CreateCategoryRequest, forumV1CategoryCategories_universal_d_UpdateCategoryRequest as UpdateCategoryRequest, forumV1CategoryCategories_universal_d_DeleteCategoryRequest as DeleteCategoryRequest, forumV1CategoryCategories_universal_d_DeleteCategoryResponse as DeleteCategoryResponse, forumV1CategoryCategories_universal_d_SubscribeContactToCategoryRequest as SubscribeContactToCategoryRequest, forumV1CategoryCategories_universal_d_SubscribeContactToCategoryResponse as SubscribeContactToCategoryResponse, forumV1CategoryCategories_universal_d_UnsubscribeContactFromCategoryRequest as UnsubscribeContactFromCategoryRequest, forumV1CategoryCategories_universal_d_UnsubscribeContactFromCategoryResponse as UnsubscribeContactFromCategoryResponse, forumV1CategoryCategories_universal_d_DomainEvent as DomainEvent, forumV1CategoryCategories_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, forumV1CategoryCategories_universal_d_EntityCreatedEvent as EntityCreatedEvent, forumV1CategoryCategories_universal_d_RestoreInfo as RestoreInfo, forumV1CategoryCategories_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, forumV1CategoryCategories_universal_d_EntityDeletedEvent as EntityDeletedEvent, forumV1CategoryCategories_universal_d_ActionEvent as ActionEvent, forumV1CategoryCategories_universal_d_MessageEnvelope as MessageEnvelope, forumV1CategoryCategories_universal_d_IdentificationData as IdentificationData, forumV1CategoryCategories_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, forumV1CategoryCategories_universal_d_WebhookIdentityType as WebhookIdentityType, forumV1CategoryCategories_universal_d_getCategory as getCategory, forumV1CategoryCategories_universal_d_GetCategoryOptions as GetCategoryOptions, forumV1CategoryCategories_universal_d_getCategoryBySlug as getCategoryBySlug, forumV1CategoryCategories_universal_d_GetCategoryBySlugOptions as GetCategoryBySlugOptions, forumV1CategoryCategories_universal_d_queryCategories as queryCategories, forumV1CategoryCategories_universal_d_QueryCategoriesOptions as QueryCategoriesOptions, forumV1CategoryCategories_universal_d_MarkAllPostsAsReadOptions as MarkAllPostsAsReadOptions, forumV1CategoryCategories_universal_d_CreateCategoryOptions as CreateCategoryOptions, forumV1CategoryCategories_universal_d_UpdateCategoryOptions as UpdateCategoryOptions, forumV1CategoryCategories_universal_d_subscribeContactToCategory as subscribeContactToCategory, forumV1CategoryCategories_universal_d_SubscribeContactToCategoryOptions as SubscribeContactToCategoryOptions, forumV1CategoryCategories_universal_d_unsubscribeContactFromCategory as unsubscribeContactFromCategory, forumV1CategoryCategories_universal_d_UnsubscribeContactFromCategoryOptions as UnsubscribeContactFromCategoryOptions, };\n }\n export { forumV1CategoryCategories_universal_d as categories, forumV1PostPosts_universal_d as posts };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-activity-counters.v2.d.ts", "content": "declare module \"wix-activity-counters.v2\" {\n interface ActivityCounter {\n /** Member ID. */\n memberId?: string;\n /**\n * App ID.\n *\n * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.\n */\n appId?: string;\n /** Counters for this member. */\n counters?: Counter[];\n /** @readonly */\n revision?: string | null;\n }\n interface Counter {\n /** Key of the counter. Must be unique. */\n key?: string;\n /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */\n public?: boolean;\n /** Count of activity. */\n count?: number;\n }\n interface SetActivityCountersRequest {\n memberId: string;\n /** Site member ID whose counter will be set. */\n counter: Counter;\n }\n interface SetActivityCountersResponse {\n activityCounter?: ActivityCounter;\n }\n interface IncrementActivityCountersRequest {\n memberId: string;\n /** Site member ID whose counter will increment. */\n counter: Counter;\n }\n interface IncrementActivityCountersResponse {\n activityCounter?: ActivityCounter;\n }\n interface GetActivityCountersRequest {\n memberId: string;\n }\n interface GetActivityCountersResponse {\n activityCounters?: ActivityCounter[];\n }\n interface QueryActivityCountersRequest {\n /** Information about the activity counters to retrieve. */\n query?: Query;\n }\n interface Query {\n /** A filter object. */\n filter?: any;\n /** Limit number of results. */\n paging?: Paging;\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryActivityCountersResponse {\n /** Retrieved activity counters. */\n activityCounters?: ActivityCounter[];\n /** Retrieved activity counters. */\n metadata?: PagingMetadata;\n }\n interface PagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Sets activity counters for a requested site member.\n *\n * If a counter does not yet exist, it will be created.\n *\n * Counters are set under a custom key, which is an ID for the counter, and is unique.\n *\n * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.\n * @public\n * @documentationMaturity preview\n * @requiredField counter\n * @requiredField memberId\n * @param memberId - ID of the member to upsert an activity counter for.\n * @param counter - Details of the counter to be set.\n * @permissionId MEMBERS.ACTIVITY_COUNTERS_WRITE\n * @permissionScope Manage Activity Counters\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function setActivityCounters(memberId: string, counter: Counter): Promise;\n /**\n * Increments activity counters for a requested site member by the count provided in counter.\n *\n * If a counter does not yet exist, it will be created.\n *\n * Counters are incremented under a custom key, which is an ID for the counter, and is unique.\n *\n * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.\n * @param counter - Site member ID whose counter will increment.\n * @public\n * @documentationMaturity preview\n * @requiredField counter\n * @requiredField memberId\n * @permissionId MEMBERS.ACTIVITY_COUNTERS_WRITE\n * @permissionScope Manage Activity Counters\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function incrementActivityCounters(memberId: string, counter: Counter): Promise;\n /**\n * Returns activity counters for a requested site member.\n * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.\n *\n * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @param memberId - ID of the member to retrieve activity counters for.\n * @permissionId MEMBERS.ACTIVITY_COUNTERS_READ\n * @permissionScope Manage Activity Counters\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS\n * @permissionScope Read Activity Counters\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-ACTIVITY-COUNTERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getActivityCounters(memberId: string): Promise;\n /**\n * Returns up to 100 activity counters for the provided filter and paging.\n *\n * Service will return only counters that are marked as public, or private counters from apps created by the requesting third party.\n *\n * Supported fields for filtering:\n * - memberId\n *\n * Supported operations:\n * Comparison:\n * - $eq\n * - $ne\n * - $in\n * Logical:\n * - $and\n * - $not\n * - $or\n * @public\n * @documentationMaturity preview\n * @param options - Information about the activity counters to retrieve.\n * @permissionScope Manage Activity Counters\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS\n * @permissionScope Read Activity Counters\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-ACTIVITY-COUNTERS\n * @permissionId MEMBERS.ACTIVITY_COUNTERS_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryActivityCounters(): ActivityCountersQueryBuilder;\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ActivityCountersQueryResult extends QueryOffsetResult {\n items: ActivityCounter[];\n query: ActivityCountersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ActivityCountersQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"memberId\", value: any) => ActivityCountersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"memberId\", value: any) => ActivityCountersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"memberId\", value: any) => ActivityCountersQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => ActivityCountersQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => ActivityCountersQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n type membersV1ActivityCounterActivityCounters_universal_d_ActivityCounter = ActivityCounter;\n type membersV1ActivityCounterActivityCounters_universal_d_Counter = Counter;\n type membersV1ActivityCounterActivityCounters_universal_d_SetActivityCountersRequest = SetActivityCountersRequest;\n type membersV1ActivityCounterActivityCounters_universal_d_SetActivityCountersResponse = SetActivityCountersResponse;\n type membersV1ActivityCounterActivityCounters_universal_d_IncrementActivityCountersRequest = IncrementActivityCountersRequest;\n type membersV1ActivityCounterActivityCounters_universal_d_IncrementActivityCountersResponse = IncrementActivityCountersResponse;\n type membersV1ActivityCounterActivityCounters_universal_d_GetActivityCountersRequest = GetActivityCountersRequest;\n type membersV1ActivityCounterActivityCounters_universal_d_GetActivityCountersResponse = GetActivityCountersResponse;\n type membersV1ActivityCounterActivityCounters_universal_d_QueryActivityCountersRequest = QueryActivityCountersRequest;\n type membersV1ActivityCounterActivityCounters_universal_d_Query = Query;\n type membersV1ActivityCounterActivityCounters_universal_d_Paging = Paging;\n type membersV1ActivityCounterActivityCounters_universal_d_QueryActivityCountersResponse = QueryActivityCountersResponse;\n type membersV1ActivityCounterActivityCounters_universal_d_PagingMetadata = PagingMetadata;\n type membersV1ActivityCounterActivityCounters_universal_d_DomainEvent = DomainEvent;\n type membersV1ActivityCounterActivityCounters_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type membersV1ActivityCounterActivityCounters_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type membersV1ActivityCounterActivityCounters_universal_d_RestoreInfo = RestoreInfo;\n type membersV1ActivityCounterActivityCounters_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type membersV1ActivityCounterActivityCounters_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type membersV1ActivityCounterActivityCounters_universal_d_ActionEvent = ActionEvent;\n type membersV1ActivityCounterActivityCounters_universal_d_Empty = Empty;\n type membersV1ActivityCounterActivityCounters_universal_d_MessageEnvelope = MessageEnvelope;\n type membersV1ActivityCounterActivityCounters_universal_d_IdentificationData = IdentificationData;\n type membersV1ActivityCounterActivityCounters_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type membersV1ActivityCounterActivityCounters_universal_d_WebhookIdentityType = WebhookIdentityType;\n const membersV1ActivityCounterActivityCounters_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const membersV1ActivityCounterActivityCounters_universal_d_setActivityCounters: typeof setActivityCounters;\n const membersV1ActivityCounterActivityCounters_universal_d_incrementActivityCounters: typeof incrementActivityCounters;\n const membersV1ActivityCounterActivityCounters_universal_d_getActivityCounters: typeof getActivityCounters;\n const membersV1ActivityCounterActivityCounters_universal_d_queryActivityCounters: typeof queryActivityCounters;\n type membersV1ActivityCounterActivityCounters_universal_d_ActivityCountersQueryResult = ActivityCountersQueryResult;\n type membersV1ActivityCounterActivityCounters_universal_d_ActivityCountersQueryBuilder = ActivityCountersQueryBuilder;\n namespace membersV1ActivityCounterActivityCounters_universal_d {\n export { membersV1ActivityCounterActivityCounters_universal_d_ActivityCounter as ActivityCounter, membersV1ActivityCounterActivityCounters_universal_d_Counter as Counter, membersV1ActivityCounterActivityCounters_universal_d_SetActivityCountersRequest as SetActivityCountersRequest, membersV1ActivityCounterActivityCounters_universal_d_SetActivityCountersResponse as SetActivityCountersResponse, membersV1ActivityCounterActivityCounters_universal_d_IncrementActivityCountersRequest as IncrementActivityCountersRequest, membersV1ActivityCounterActivityCounters_universal_d_IncrementActivityCountersResponse as IncrementActivityCountersResponse, membersV1ActivityCounterActivityCounters_universal_d_GetActivityCountersRequest as GetActivityCountersRequest, membersV1ActivityCounterActivityCounters_universal_d_GetActivityCountersResponse as GetActivityCountersResponse, membersV1ActivityCounterActivityCounters_universal_d_QueryActivityCountersRequest as QueryActivityCountersRequest, membersV1ActivityCounterActivityCounters_universal_d_Query as Query, membersV1ActivityCounterActivityCounters_universal_d_Paging as Paging, membersV1ActivityCounterActivityCounters_universal_d_QueryActivityCountersResponse as QueryActivityCountersResponse, membersV1ActivityCounterActivityCounters_universal_d_PagingMetadata as PagingMetadata, membersV1ActivityCounterActivityCounters_universal_d_DomainEvent as DomainEvent, membersV1ActivityCounterActivityCounters_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, membersV1ActivityCounterActivityCounters_universal_d_EntityCreatedEvent as EntityCreatedEvent, membersV1ActivityCounterActivityCounters_universal_d_RestoreInfo as RestoreInfo, membersV1ActivityCounterActivityCounters_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, membersV1ActivityCounterActivityCounters_universal_d_EntityDeletedEvent as EntityDeletedEvent, membersV1ActivityCounterActivityCounters_universal_d_ActionEvent as ActionEvent, membersV1ActivityCounterActivityCounters_universal_d_Empty as Empty, membersV1ActivityCounterActivityCounters_universal_d_MessageEnvelope as MessageEnvelope, membersV1ActivityCounterActivityCounters_universal_d_IdentificationData as IdentificationData, membersV1ActivityCounterActivityCounters_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, membersV1ActivityCounterActivityCounters_universal_d_WebhookIdentityType as WebhookIdentityType, membersV1ActivityCounterActivityCounters_universal_d_setActivityCounters as setActivityCounters, membersV1ActivityCounterActivityCounters_universal_d_incrementActivityCounters as incrementActivityCounters, membersV1ActivityCounterActivityCounters_universal_d_getActivityCounters as getActivityCounters, membersV1ActivityCounterActivityCounters_universal_d_queryActivityCounters as queryActivityCounters, membersV1ActivityCounterActivityCounters_universal_d_ActivityCountersQueryResult as ActivityCountersQueryResult, membersV1ActivityCounterActivityCounters_universal_d_ActivityCountersQueryBuilder as ActivityCountersQueryBuilder, };\n }\n export { membersV1ActivityCounterActivityCounters_universal_d as activityCounters };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-loyalty.v2.d.ts", "content": "declare module \"wix-loyalty.v2\" {\n /**\n * A loyalty reward is an object a customer can redeem with loyalty points.\n * Redeeming a reward then creates a loyalty coupon that the customer can use.\n */\n interface Reward extends RewardTypeDetailsOneOf {\n /** Discount details. */\n discountAmount?: DiscountAmount;\n /** Coupon details. */\n couponReward?: CouponReward;\n /**\n * Reward ID.\n * @readonly\n */\n _id?: string | null;\n /** Reward name. */\n name?: string;\n /** Whether the reward is active. Default: `FALSE` */\n active?: boolean;\n /**\n * Reward type.\n *\n * + `DISCOUNT_AMOUNT`: Discount reward. Special flexible reward type used in checkout.\n * + `COUPON_REWARD`: Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards)\n * + `SPI_DISCOUNT_AMOUNT`: Same as discount reward, provided by an SPI implementation - i.e. Functions, Velo, etc.\n */\n type?: RewardType;\n /**\n * Revision number, which increments by 1 each time the loyalty reward is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the reward was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the reward was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n /** @oneof */\n interface RewardTypeDetailsOneOf {\n /** Discount details. */\n discountAmount?: DiscountAmount;\n /** Coupon details. */\n couponReward?: CouponReward;\n }\n /** Available reward types. */\n enum RewardType {\n UNDEFINED = \"UNDEFINED\",\n DISCOUNT_AMOUNT = \"DISCOUNT_AMOUNT\",\n COUPON_REWARD = \"COUPON_REWARD\",\n SPI_DISCOUNT_AMOUNT = \"SPI_DISCOUNT_AMOUNT\"\n }\n interface DiscountAmount {\n /** Discount details for each tier. */\n configsByTier?: DiscountAmountConfig[];\n }\n interface DiscountAmountConfig {\n /** Discount amount. Must be a positive value. */\n amount?: string;\n /** Tier ID, or empty if config applies to the base tier. */\n tierId?: string | null;\n /** Amount of points required to redeem the reward. */\n costInPoints?: number;\n }\n interface CouponReward extends CouponRewardDiscountTypeOneOf, CouponRewardScopeOrMinSubtotalOneOf {\n /** Discount as a fixed amount. */\n fixedAmount?: FixedAmountDiscount;\n /** Discount as a percentage. */\n percentage?: PercentageDiscount;\n /** Free shipping. */\n freeShipping?: FreeShippingDiscount;\n /** Limit the coupon to carts with a subtotal greater than this number. */\n minimumSubtotal?: number;\n /**\n * Specifies the type of line items this coupon will apply to.\n *\n * For more information, see the Coupons API.\n */\n scope?: CouponScope;\n /** Whether the coupon is limited to one item. */\n limitedToOneItem?: boolean | null;\n /**\n * Whether the coupon applies to subscription products.\n *\n * If set to `true`, the discount will apply to all billing cycles.\n */\n appliesToSubscriptions?: boolean | null;\n /** Reserved for internal use. */\n discountedCycleCount?: number | null;\n }\n /** @oneof */\n interface CouponRewardDiscountTypeOneOf {\n /** Discount as a fixed amount. */\n fixedAmount?: FixedAmountDiscount;\n /** Discount as a percentage. */\n percentage?: PercentageDiscount;\n /** Free shipping. */\n freeShipping?: FreeShippingDiscount;\n }\n /** @oneof */\n interface CouponRewardScopeOrMinSubtotalOneOf {\n /** Limit the coupon to carts with a subtotal greater than this number. */\n minimumSubtotal?: number;\n /**\n * Specifies the type of line items this coupon will apply to.\n *\n * For more information, see the Coupons API.\n */\n scope?: CouponScope;\n }\n interface FixedAmountDiscount {\n /** Discount details for each tier. */\n configsByTier?: FixedAmountDiscountConfig[];\n }\n interface FixedAmountDiscountConfig {\n /** Tier ID, or empty if config applies to the base tier. */\n tierId?: string | null;\n /** Amount of points required to redeem the reward. */\n costInPoints?: number;\n /** Discount amount. */\n amount?: number;\n }\n interface PercentageDiscount {\n /** Discount details for each tier. */\n configsByTier?: PercentageDiscountConfig[];\n }\n interface PercentageDiscountConfig {\n /** Tier ID, or empty if config applies to the base tier. */\n tierId?: string | null;\n /** Amount of points required to redeem the reward. */\n costInPoints?: number;\n /** Percentage discount. */\n percentage?: number;\n }\n interface FreeShippingDiscount {\n /** Discount details for each tier. */\n configsByTier?: FreeShippingDiscountConfig[];\n }\n interface FreeShippingDiscountConfig {\n /** Tier ID, or empty if config applies to the base tier. */\n tierId?: string | null;\n /** Amount of points required to redeem the reward. */\n costInPoints?: number;\n }\n interface CouponScope {\n /**\n * Scope namespace.\n *\n * See the Coupons API for valid namespaces.\n */\n namespace?: string;\n /**\n * Coupon scope's applied group.\n *\n * See the Coupons API for valid groups.\n */\n group?: Group;\n }\n interface Group {\n /**\n * Name of coupon scope's group.\n *\n * See the Coupons API for valid groups.\n */\n name?: string;\n /** Entity ID, if the coupon scope is limited to just one item. */\n entityId?: string | null;\n }\n interface SpiDiscountAmount {\n /** Discount details for each tier. */\n configsByTier?: DiscountAmountConfig[];\n /** Description of the SPI discount amount reward. Taken from user input in the SPI config. */\n description?: string;\n }\n interface RewardDisabled {\n }\n interface CreateRewardRequest {\n /** Reward to create. */\n reward: Reward;\n }\n interface CreateRewardResponse {\n /** Created reward. */\n reward?: Reward;\n }\n interface BulkCreateRewardsRequest {\n /** Rewards to create. */\n rewards: Reward[];\n }\n interface BulkCreateRewardsResponse {\n /** Created rewards. */\n results?: BulkRewardResult[];\n /** Total successes and failures of the bulk create rewards action. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface BulkRewardResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata$3;\n /** Created reward. */\n item?: Reward;\n }\n interface ItemMetadata$3 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$3;\n }\n interface ApplicationError$3 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$3 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetRewardRequest {\n /** ID of the reward to retrieve. */\n _id: string;\n }\n interface GetRewardResponse {\n /** Retrieved reward. */\n reward?: Reward;\n }\n interface BulkGetRewardsRequest {\n }\n interface BulkGetRewardsResponse {\n /** Found rewards per site. */\n rewardsInSite?: RewardsInSite[];\n }\n interface RewardsInSite {\n /** Metasite id. */\n metaSiteId?: string;\n /** Rewards. */\n rewards?: Reward[];\n }\n interface QueryRewardsRequest {\n /** Query parameters. */\n query: CursorQuery$2;\n }\n interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging$3;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting$3[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$2 {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging$3;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n }\n enum SortOrder$3 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$3 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryRewardsResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: CursorPagingMetadata$2;\n }\n interface CursorPagingMetadata$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors$3;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$3 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface UpdateRewardRequest {\n /** Reward information to update. */\n reward: Reward;\n }\n interface UpdateRewardResponse {\n /** Updated reward. */\n reward?: Reward;\n }\n interface DeleteRewardRequest {\n /** ID of the reward to delete. */\n _id: string;\n /**\n * Revision number, which increments by 1 each time the reward is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.\n */\n revision?: string;\n }\n interface DeleteRewardResponse {\n }\n interface ListRewardsRequest {\n /** Pagination options. */\n cursorPaging?: CursorPaging$3;\n }\n interface ListRewardsResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2$2;\n }\n interface PagingMetadataV2$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$3;\n }\n interface ListRewardsInTierRequest {\n /**\n * Tier id.\n * @readonly\n */\n tierId?: string | null;\n /** Pagination options. */\n cursorPaging?: CursorPaging$3;\n }\n interface ListRewardsInTierResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2$2;\n }\n interface DomainEvent$5 extends DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n }\n interface EntityCreatedEvent$5 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n }\n interface RestoreInfo$5 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$5 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$5 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\n }\n interface Empty$5 {\n }\n interface MessageEnvelope$5 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$5;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$5;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$5 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a reward that can be redeemed with loyalty points.\n *\n * When a customer redeems a reward, a loyalty coupon is created\n * based on the specifications detailed in either the `discountAmount` or `couponReward` fields. This coupon can\n * then be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,\n * no coupon is actually created until a reward is redeemed with points.\n * See the Coupons API for more information about coupons.\n *\n * A reward's `active` status defaults to `false`. To make the reward available to customers,\n * either set the `active` field to `true` during creation or call [`updateReward()`](#updatereward)\n * to change the status.\n *\n * To customize a reward for each loyalty tier, use the `configsByTier` parameter.\n * This allows you to specify the amount of the earned discount, the cost in loyalty points\n * to redeem the reward, and the tier to which this configuration applies. Each tier requires its own\n * `configsByTier` configuration. To create a reward that is available to loyalty accounts in the base tier,\n * leave the `tierId` field empty. See the Loyalty Tiers API for more information on tiers.\n * @param reward - Reward to create.\n * @public\n * @requiredField reward\n * @requiredField reward.name\n * @permissionId LOYALTY.MANAGE_REWARDS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created reward.\n */\n function createReward(reward: Reward): Promise;\n /**\n * Creates multiple rewards.\n * @param rewards - Rewards to create.\n * @public\n * @requiredField rewards\n * @requiredField rewards.name\n * @permissionId LOYALTY.MANAGE_REWARDS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateRewards(rewards: Reward[]): Promise;\n /**\n * Retrieves a reward.\n * @param _id - ID of the reward to retrieve.\n * @public\n * @requiredField _id\n * @permissionId LOYALTY.READ_REWARDS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Retrieved reward.\n */\n function getReward(_id: string): Promise;\n /**\n * Retrieves rewards from all metasites that the caller is the member of.\n *\n * Must be called with user identity.\n * @public\n * @documentationMaturity preview\n * @permissionId LOYALTY.REWARD_BULK_READ\n * @adminMethod\n */\n function bulkGetRewards(): Promise;\n /**\n * Retrieves a list of rewards, given the provided paging, filtering, and sorting.\n *\n * Query Rewards runs with these defaults, which you can override: `cursorPaging.limit` is `50`.\n *\n * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n * @param query - Query parameters.\n * @public\n * @requiredField query\n * @permissionId LOYALTY.READ_REWARDS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryRewards(query: CursorQuery$2): Promise;\n /**\n * Updates a loyalty reward.\n *\n * Use this endpoint to update details of a reward, such as the name, whether or not a reward is active,\n * or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.\n *\n * You may not change the `type` of a reward. That is set upon creation and cannot be updated.\n * @param _id - Reward ID.\n * @public\n * @requiredField _id\n * @requiredField reward\n * @requiredField reward.name\n * @requiredField reward.revision\n * @param reward - Reward info to update.\n * @permissionId LOYALTY.MANAGE_REWARDS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateReward(_id: string | null, reward: UpdateReward): Promise;\n interface UpdateReward {\n /** Discount details. */\n discountAmount?: DiscountAmount;\n /** Coupon details. */\n couponReward?: CouponReward;\n /**\n * Reward ID.\n * @readonly\n */\n _id?: string | null;\n /** Reward name. */\n name?: string;\n /** Whether the reward is active. Default: `FALSE` */\n active?: boolean;\n /**\n * Reward type.\n *\n * + `DISCOUNT_AMOUNT`: Discount reward. Special flexible reward type used in checkout.\n * + `COUPON_REWARD`: Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards)\n * + `SPI_DISCOUNT_AMOUNT`: Same as discount reward, provided by an SPI implementation - i.e. Functions, Velo, etc.\n */\n type?: RewardType;\n /**\n * Revision number, which increments by 1 each time the loyalty reward is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the reward was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the reward was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n /**\n * Deletes a reward.\n * @param _id - ID of the reward to delete.\n * @param revision - Revision number, which increments by 1 each time the reward is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.\n * @public\n * @requiredField _id\n * @requiredField revision\n * @permissionId LOYALTY.MANAGE_REWARDS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteReward(_id: string, revision: string): Promise;\n /**\n * Retrieves a list of rewards.\n *\n * The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.\n * @public\n * @param options - List options.\n * @permissionId LOYALTY.READ_REWARDS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listRewards(options?: ListRewardsOptions): Promise;\n interface ListRewardsOptions {\n /** Pagination options. */\n cursorPaging?: CursorPaging$3;\n }\n interface ListRewardsInTierOptions {\n /**\n * Tier id.\n * @readonly\n */\n tierId?: string | null;\n /** Pagination options. */\n cursorPaging?: CursorPaging$3;\n }\n type loyaltyV1RewardRewards_universal_d_Reward = Reward;\n type loyaltyV1RewardRewards_universal_d_RewardTypeDetailsOneOf = RewardTypeDetailsOneOf;\n type loyaltyV1RewardRewards_universal_d_RewardType = RewardType;\n const loyaltyV1RewardRewards_universal_d_RewardType: typeof RewardType;\n type loyaltyV1RewardRewards_universal_d_DiscountAmount = DiscountAmount;\n type loyaltyV1RewardRewards_universal_d_DiscountAmountConfig = DiscountAmountConfig;\n type loyaltyV1RewardRewards_universal_d_CouponReward = CouponReward;\n type loyaltyV1RewardRewards_universal_d_CouponRewardDiscountTypeOneOf = CouponRewardDiscountTypeOneOf;\n type loyaltyV1RewardRewards_universal_d_CouponRewardScopeOrMinSubtotalOneOf = CouponRewardScopeOrMinSubtotalOneOf;\n type loyaltyV1RewardRewards_universal_d_FixedAmountDiscount = FixedAmountDiscount;\n type loyaltyV1RewardRewards_universal_d_FixedAmountDiscountConfig = FixedAmountDiscountConfig;\n type loyaltyV1RewardRewards_universal_d_PercentageDiscount = PercentageDiscount;\n type loyaltyV1RewardRewards_universal_d_PercentageDiscountConfig = PercentageDiscountConfig;\n type loyaltyV1RewardRewards_universal_d_FreeShippingDiscount = FreeShippingDiscount;\n type loyaltyV1RewardRewards_universal_d_FreeShippingDiscountConfig = FreeShippingDiscountConfig;\n type loyaltyV1RewardRewards_universal_d_CouponScope = CouponScope;\n type loyaltyV1RewardRewards_universal_d_Group = Group;\n type loyaltyV1RewardRewards_universal_d_SpiDiscountAmount = SpiDiscountAmount;\n type loyaltyV1RewardRewards_universal_d_RewardDisabled = RewardDisabled;\n type loyaltyV1RewardRewards_universal_d_CreateRewardRequest = CreateRewardRequest;\n type loyaltyV1RewardRewards_universal_d_CreateRewardResponse = CreateRewardResponse;\n type loyaltyV1RewardRewards_universal_d_BulkCreateRewardsRequest = BulkCreateRewardsRequest;\n type loyaltyV1RewardRewards_universal_d_BulkCreateRewardsResponse = BulkCreateRewardsResponse;\n type loyaltyV1RewardRewards_universal_d_BulkRewardResult = BulkRewardResult;\n type loyaltyV1RewardRewards_universal_d_GetRewardRequest = GetRewardRequest;\n type loyaltyV1RewardRewards_universal_d_GetRewardResponse = GetRewardResponse;\n type loyaltyV1RewardRewards_universal_d_BulkGetRewardsRequest = BulkGetRewardsRequest;\n type loyaltyV1RewardRewards_universal_d_BulkGetRewardsResponse = BulkGetRewardsResponse;\n type loyaltyV1RewardRewards_universal_d_RewardsInSite = RewardsInSite;\n type loyaltyV1RewardRewards_universal_d_QueryRewardsRequest = QueryRewardsRequest;\n type loyaltyV1RewardRewards_universal_d_QueryRewardsResponse = QueryRewardsResponse;\n type loyaltyV1RewardRewards_universal_d_UpdateRewardRequest = UpdateRewardRequest;\n type loyaltyV1RewardRewards_universal_d_UpdateRewardResponse = UpdateRewardResponse;\n type loyaltyV1RewardRewards_universal_d_DeleteRewardRequest = DeleteRewardRequest;\n type loyaltyV1RewardRewards_universal_d_DeleteRewardResponse = DeleteRewardResponse;\n type loyaltyV1RewardRewards_universal_d_ListRewardsRequest = ListRewardsRequest;\n type loyaltyV1RewardRewards_universal_d_ListRewardsResponse = ListRewardsResponse;\n type loyaltyV1RewardRewards_universal_d_ListRewardsInTierRequest = ListRewardsInTierRequest;\n type loyaltyV1RewardRewards_universal_d_ListRewardsInTierResponse = ListRewardsInTierResponse;\n const loyaltyV1RewardRewards_universal_d_createReward: typeof createReward;\n const loyaltyV1RewardRewards_universal_d_bulkCreateRewards: typeof bulkCreateRewards;\n const loyaltyV1RewardRewards_universal_d_getReward: typeof getReward;\n const loyaltyV1RewardRewards_universal_d_bulkGetRewards: typeof bulkGetRewards;\n const loyaltyV1RewardRewards_universal_d_queryRewards: typeof queryRewards;\n const loyaltyV1RewardRewards_universal_d_updateReward: typeof updateReward;\n type loyaltyV1RewardRewards_universal_d_UpdateReward = UpdateReward;\n const loyaltyV1RewardRewards_universal_d_deleteReward: typeof deleteReward;\n const loyaltyV1RewardRewards_universal_d_listRewards: typeof listRewards;\n type loyaltyV1RewardRewards_universal_d_ListRewardsOptions = ListRewardsOptions;\n type loyaltyV1RewardRewards_universal_d_ListRewardsInTierOptions = ListRewardsInTierOptions;\n namespace loyaltyV1RewardRewards_universal_d {\n export { loyaltyV1RewardRewards_universal_d_Reward as Reward, loyaltyV1RewardRewards_universal_d_RewardTypeDetailsOneOf as RewardTypeDetailsOneOf, loyaltyV1RewardRewards_universal_d_RewardType as RewardType, loyaltyV1RewardRewards_universal_d_DiscountAmount as DiscountAmount, loyaltyV1RewardRewards_universal_d_DiscountAmountConfig as DiscountAmountConfig, loyaltyV1RewardRewards_universal_d_CouponReward as CouponReward, loyaltyV1RewardRewards_universal_d_CouponRewardDiscountTypeOneOf as CouponRewardDiscountTypeOneOf, loyaltyV1RewardRewards_universal_d_CouponRewardScopeOrMinSubtotalOneOf as CouponRewardScopeOrMinSubtotalOneOf, loyaltyV1RewardRewards_universal_d_FixedAmountDiscount as FixedAmountDiscount, loyaltyV1RewardRewards_universal_d_FixedAmountDiscountConfig as FixedAmountDiscountConfig, loyaltyV1RewardRewards_universal_d_PercentageDiscount as PercentageDiscount, loyaltyV1RewardRewards_universal_d_PercentageDiscountConfig as PercentageDiscountConfig, loyaltyV1RewardRewards_universal_d_FreeShippingDiscount as FreeShippingDiscount, loyaltyV1RewardRewards_universal_d_FreeShippingDiscountConfig as FreeShippingDiscountConfig, loyaltyV1RewardRewards_universal_d_CouponScope as CouponScope, loyaltyV1RewardRewards_universal_d_Group as Group, loyaltyV1RewardRewards_universal_d_SpiDiscountAmount as SpiDiscountAmount, loyaltyV1RewardRewards_universal_d_RewardDisabled as RewardDisabled, loyaltyV1RewardRewards_universal_d_CreateRewardRequest as CreateRewardRequest, loyaltyV1RewardRewards_universal_d_CreateRewardResponse as CreateRewardResponse, loyaltyV1RewardRewards_universal_d_BulkCreateRewardsRequest as BulkCreateRewardsRequest, loyaltyV1RewardRewards_universal_d_BulkCreateRewardsResponse as BulkCreateRewardsResponse, loyaltyV1RewardRewards_universal_d_BulkRewardResult as BulkRewardResult, ItemMetadata$3 as ItemMetadata, ApplicationError$3 as ApplicationError, BulkActionMetadata$3 as BulkActionMetadata, loyaltyV1RewardRewards_universal_d_GetRewardRequest as GetRewardRequest, loyaltyV1RewardRewards_universal_d_GetRewardResponse as GetRewardResponse, loyaltyV1RewardRewards_universal_d_BulkGetRewardsRequest as BulkGetRewardsRequest, loyaltyV1RewardRewards_universal_d_BulkGetRewardsResponse as BulkGetRewardsResponse, loyaltyV1RewardRewards_universal_d_RewardsInSite as RewardsInSite, loyaltyV1RewardRewards_universal_d_QueryRewardsRequest as QueryRewardsRequest, CursorQuery$2 as CursorQuery, CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, Sorting$3 as Sorting, SortOrder$3 as SortOrder, CursorPaging$3 as CursorPaging, loyaltyV1RewardRewards_universal_d_QueryRewardsResponse as QueryRewardsResponse, CursorPagingMetadata$2 as CursorPagingMetadata, Cursors$3 as Cursors, loyaltyV1RewardRewards_universal_d_UpdateRewardRequest as UpdateRewardRequest, loyaltyV1RewardRewards_universal_d_UpdateRewardResponse as UpdateRewardResponse, loyaltyV1RewardRewards_universal_d_DeleteRewardRequest as DeleteRewardRequest, loyaltyV1RewardRewards_universal_d_DeleteRewardResponse as DeleteRewardResponse, loyaltyV1RewardRewards_universal_d_ListRewardsRequest as ListRewardsRequest, loyaltyV1RewardRewards_universal_d_ListRewardsResponse as ListRewardsResponse, PagingMetadataV2$2 as PagingMetadataV2, loyaltyV1RewardRewards_universal_d_ListRewardsInTierRequest as ListRewardsInTierRequest, loyaltyV1RewardRewards_universal_d_ListRewardsInTierResponse as ListRewardsInTierResponse, DomainEvent$5 as DomainEvent, DomainEventBodyOneOf$5 as DomainEventBodyOneOf, EntityCreatedEvent$5 as EntityCreatedEvent, RestoreInfo$5 as RestoreInfo, EntityUpdatedEvent$5 as EntityUpdatedEvent, EntityDeletedEvent$5 as EntityDeletedEvent, ActionEvent$5 as ActionEvent, Empty$5 as Empty, MessageEnvelope$5 as MessageEnvelope, IdentificationData$5 as IdentificationData, IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, WebhookIdentityType$5 as WebhookIdentityType, loyaltyV1RewardRewards_universal_d_createReward as createReward, loyaltyV1RewardRewards_universal_d_bulkCreateRewards as bulkCreateRewards, loyaltyV1RewardRewards_universal_d_getReward as getReward, loyaltyV1RewardRewards_universal_d_bulkGetRewards as bulkGetRewards, loyaltyV1RewardRewards_universal_d_queryRewards as queryRewards, loyaltyV1RewardRewards_universal_d_updateReward as updateReward, loyaltyV1RewardRewards_universal_d_UpdateReward as UpdateReward, loyaltyV1RewardRewards_universal_d_deleteReward as deleteReward, loyaltyV1RewardRewards_universal_d_listRewards as listRewards, loyaltyV1RewardRewards_universal_d_ListRewardsOptions as ListRewardsOptions, loyaltyV1RewardRewards_universal_d_ListRewardsInTierOptions as ListRewardsInTierOptions, };\n }\n /**\n * A loyalty program allows sites to maintain customer reward accounts. Site owners can create a\n * loyalty program to increase customer retention. Read more about the loyalty program in\n * [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).\n */\n interface LoyaltyProgram {\n /** Program name. */\n name?: string | null;\n /** Information about the program's collectible entity. */\n pointDefinition?: PointDefinition;\n /**\n * Program status. Customers can only earn or redeem points while the program is `ACTIVE`.\n *\n * Default: `\"DRAFT\"`\n * @readonly\n */\n status?: ProgramStatus;\n /**\n * Date and time the program was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the program was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Points expiration configuration */\n pointsExpiration?: PointsExpiration$1;\n /**\n * Information about available premium features\n * @readonly\n */\n premiumFeatures?: PremiumFeatures;\n }\n interface PointDefinition {\n /**\n * Display name for the program's collectible unit.\n *\n * It's recommended to use a plural, for example `Stars`.\n *\n * In contrast to a custom name, the default `\"Points\"` name is translated and adjusted to singular based on circumstances.\n *\n * Default: `Points`.\n *\n * Max: `20` characters.\n */\n customName?: string | null;\n /** Image URL. See [Image]($w/image/introduction) for more information on URL formats for images. */\n icon?: string;\n }\n enum ProgramStatus {\n UNKNOWN = \"UNKNOWN\",\n /** initial program status (program was created but was not enabled yet) */\n DRAFT = \"DRAFT\",\n /** program is active */\n ACTIVE = \"ACTIVE\",\n /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again) */\n PAUSED = \"PAUSED\"\n }\n interface PointsExpiration$1 {\n /**\n * Status of points expiration feature\n * @readonly\n */\n status?: Status$3;\n /** Expire points after set months of inactivity */\n monthsOfInactivity?: number;\n /** Percentage of points expiring */\n expiringPointsPercentage?: number;\n }\n enum Status$3 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Points expiration feature is disabled */\n DISABLED = \"DISABLED\",\n /** Points expiration feature is enabled */\n ENABLED = \"ENABLED\"\n }\n interface PremiumFeatures {\n /**\n * Set to true if user has loyalty program premium feature\n * @readonly\n */\n loyaltyProgram?: boolean;\n /**\n * Set to true if user has tiers premium feature\n * @readonly\n */\n tiers?: boolean;\n /**\n * Set to true if user has points expiration premium feature\n * @readonly\n */\n pointsExpiration?: boolean;\n }\n interface EarningRuleDisabled {\n }\n interface GetLoyaltyProgramRequest {\n }\n interface GetLoyaltyProgramResponse {\n /** Retrieved loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface BulkGetLoyaltyProgramRequest {\n }\n interface BulkGetLoyaltyProgramResponse {\n /** Retrieved loyalty programs. */\n programInSites?: ProgramInSite[];\n }\n interface ProgramInSite {\n /** Metasite ID. */\n metaSiteId?: string;\n /** Loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface UpdateLoyaltyProgramRequest {\n /** Loyalty program fields to update. */\n loyaltyProgram: LoyaltyProgram;\n }\n interface UpdateLoyaltyProgramResponse {\n /** Updated loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface PointsExpirationConfigurationChanged {\n /** Loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n /** Points expiration configuration changes */\n pointsExpirationChanges?: PointsExpirationChanges;\n }\n interface PointsExpirationChanges {\n monthsOfInactivity?: number | null;\n expiringPointsPercentage?: number | null;\n }\n interface ActivateLoyaltyProgramRequest {\n }\n interface ActivateLoyaltyProgramResponse {\n /** Activated loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface LoyaltyProgramActivated {\n /** Activated loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface PauseLoyaltyProgramRequest {\n }\n interface PauseLoyaltyProgramResponse {\n /** Paused loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface GetLoyaltyProgramDescriptionRequest {\n /** List of description fields to retrieve. Supported values: `description`, `updatedDate`. */\n fields?: string[];\n }\n interface GetLoyaltyProgramDescriptionResponse {\n /** Retrieved loyalty program description. */\n description?: string | null;\n /** Date and time of the latest description update. */\n _updatedDate?: Date;\n }\n interface UpdateLoyaltyProgramDescriptionRequest {\n /** Loyalty program description to update. */\n description?: string;\n }\n interface UpdateLoyaltyProgramDescriptionResponse {\n }\n interface LoyaltyProgramDescriptionUpdated {\n }\n interface GetLoyaltyProgramPremiumFeaturesRequest {\n }\n interface GetLoyaltyProgramPremiumFeaturesResponse {\n /**\n * Set to true if user has loyalty program premium feature\n * @readonly\n */\n loyaltyProgram?: boolean;\n /**\n * Set to true if user has tiers premium feature\n * @readonly\n */\n tiers?: boolean;\n /**\n * Set to true if user has points expiration premium feature\n * @readonly\n */\n pointsExpiration?: boolean;\n }\n interface EnablePointsExpirationRequest {\n }\n interface EnablePointsExpirationResponse {\n /** Loyalty program with enabled points expiration feature. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface PointsExpirationEnabled {\n /** Loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface DisablePointsExpirationRequest {\n }\n interface DisablePointsExpirationResponse {\n /** Loyalty program with disabled points expiration feature. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface PointsExpirationDisabled {\n /** Loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface MetaSiteSpecialEvent$1 extends MetaSiteSpecialEventPayloadOneOf$1 {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated$1;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred$1;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted$1;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted$1;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished$1;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished$1;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate$1;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite$1;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned$1;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved$1;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed$1;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted$1;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged$1;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned$1;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned$1;\n /** A meta site id. */\n metaSiteId?: string;\n /** A meta site version. Monotonically increasing. */\n version?: string;\n /** A timestamp of the event. */\n timestamp?: string;\n /** A list of \"assets\" (applications). The same as MetaSiteContext. */\n assets?: Asset$1[];\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf$1 {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated$1;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred$1;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted$1;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted$1;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished$1;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished$1;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate$1;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite$1;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned$1;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved$1;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed$1;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted$1;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged$1;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned$1;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned$1;\n }\n interface Asset$1 {\n /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */\n appDefId?: string;\n /** An instance id. For legacy reasons may be UUID or a string. */\n instanceId?: string;\n /** An application state. */\n state?: State$1;\n }\n enum State$1 {\n UNKNOWN = \"UNKNOWN\",\n ENABLED = \"ENABLED\",\n DISABLED = \"DISABLED\",\n PENDING = \"PENDING\",\n DEMO = \"DEMO\"\n }\n interface SiteCreated$1 {\n /** A template identifier (empty if not created from a template). */\n originTemplateId?: string;\n /** An account id of the owner. */\n ownerId?: string;\n /** A context in which meta site was created. */\n context?: SiteCreatedContext$1;\n /**\n * A meta site id from which this site was created.\n *\n * In case of a creation from a template it's a template id.\n * In case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.\n */\n originMetaSiteId?: string | null;\n /** A meta site name (URL slug). */\n siteName?: string;\n /** A namespace. */\n namespace?: Namespace$1;\n }\n enum SiteCreatedContext$1 {\n /** A valid option, we don't expose all reasons why site might be created. */\n OTHER = \"OTHER\",\n /** A meta site was created from template. */\n FROM_TEMPLATE = \"FROM_TEMPLATE\",\n /** A meta site was created by copying of the transfferred meta site. */\n DUPLICATE_BY_SITE_TRANSFER = \"DUPLICATE_BY_SITE_TRANSFER\",\n /** A copy of existing meta site. */\n DUPLICATE = \"DUPLICATE\",\n /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */\n OLD_SITE_TRANSFER = \"OLD_SITE_TRANSFER\",\n /** deprecated A meta site was created for Flash editor. */\n FLASH = \"FLASH\"\n }\n enum Namespace$1 {\n UNKNOWN_NAMESPACE = \"UNKNOWN_NAMESPACE\",\n /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */\n WIX = \"WIX\",\n /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n SHOUT_OUT = \"SHOUT_OUT\",\n /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ALBUMS = \"ALBUMS\",\n /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n WIX_STORES_TEST_DRIVE = \"WIX_STORES_TEST_DRIVE\",\n /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n HOTELS = \"HOTELS\",\n /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n CLUBS = \"CLUBS\",\n /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ONBOARDING_DRAFT = \"ONBOARDING_DRAFT\",\n /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_SITE = \"DEV_SITE\",\n /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n LOGOS = \"LOGOS\",\n /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n VIDEO_MAKER = \"VIDEO_MAKER\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n PARTNER_DASHBOARD = \"PARTNER_DASHBOARD\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_CENTER_COMPANY = \"DEV_CENTER_COMPANY\",\n /**\n * A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n *\n * Meta site with this namespace will *not* be shown in a user's site list by default.\n */\n HTML_DRAFT = \"HTML_DRAFT\",\n /**\n * the user-journey for Fitness users who want to start from managing their business instead of designing their website.\n * Will be accessible from Site List and will not have a website app.\n * Once the user attaches a site, the site will become a regular wixsite.\n */\n SITELESS_BUSINESS = \"SITELESS_BUSINESS\",\n /** Belongs to \"strategic products\" company. Supports new product in the creator's economy space. */\n CREATOR_ECONOMY = \"CREATOR_ECONOMY\",\n /** It is to be used in the Business First efforts. */\n DASHBOARD_FIRST = \"DASHBOARD_FIRST\",\n /** Bookings business flow with no site. */\n ANYWHERE = \"ANYWHERE\",\n /** Namespace for Headless Backoffice with no editor */\n HEADLESS = \"HEADLESS\",\n /**\n * Namespace for master site that will exist in parent account that will be referenced by subaccounts\n * The site will be used for account level CSM feature for enterprise\n */\n ACCOUNT_MASTER_CMS = \"ACCOUNT_MASTER_CMS\",\n /** Rise.ai Siteless account management for Gift Cards and Store Credit. */\n RISE = \"RISE\",\n /**\n * As part of the branded app new funnel, users now can create a meta site that will be branded app first.\n * There's a blank site behind the scene but it's blank).\n * The Mobile company will be the owner of this namespace.\n */\n BRANDED_FIRST = \"BRANDED_FIRST\",\n /** Nownia.com Siteless account management for Ai Scheduling Assistant. */\n NOWNIA = \"NOWNIA\"\n }\n /** Site transferred to another user. */\n interface SiteTransferred$1 {\n /** A previous owner id (user that transfers meta site). */\n oldOwnerId?: string;\n /** A new owner id (user that accepts meta site). */\n newOwnerId?: string;\n }\n /** Soft deletion of the meta site. Could be restored. */\n interface SiteDeleted$1 {\n /** A deletion context. */\n deleteContext?: DeleteContext$1;\n }\n interface DeleteContext$1 {\n /** When the meta site was deleted. */\n dateDeleted?: Date;\n /** A status. */\n deleteStatus?: DeleteStatus$1;\n /** A reason (flow). */\n deleteOrigin?: string;\n /** A service that deleted it. */\n initiatorId?: string | null;\n }\n enum DeleteStatus$1 {\n UNKNOWN = \"UNKNOWN\",\n TRASH = \"TRASH\",\n DELETED = \"DELETED\",\n PENDING_PURGE = \"PENDING_PURGE\"\n }\n /** Restoration of the meta site. */\n interface SiteUndeleted$1 {\n }\n /** First publish of a meta site. Or subsequent publish after unpublish. */\n interface SitePublished$1 {\n }\n interface SiteUnpublished$1 {\n /** A list of URLs previously associated with the meta site. */\n urls?: string[];\n }\n interface SiteMarkedAsTemplate$1 {\n }\n interface SiteMarkedAsWixSite$1 {\n }\n interface ServiceProvisioned$1 {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** An instance id from which this instance is originated. */\n originInstanceId?: string;\n /** A version. */\n version?: string | null;\n }\n interface ServiceRemoved$1 {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** A version. */\n version?: string | null;\n }\n /** Rename of the site. Meaning, free public url has been changed as well. */\n interface SiteRenamed$1 {\n /** A new meta site name (URL slug). */\n newSiteName?: string;\n /** A previous meta site name (URL slug). */\n oldSiteName?: string;\n }\n /**\n * Hard deletion of the meta site.\n *\n * Could not be restored. Therefore it's desirable to cleanup data.\n */\n interface SiteHardDeleted$1 {\n /** A deletion context. */\n deleteContext?: DeleteContext$1;\n }\n interface NamespaceChanged$1 {\n /** A previous namespace. */\n oldNamespace?: Namespace$1;\n /** A new namespace. */\n newNamespace?: Namespace$1;\n }\n /** Assigned Studio editor */\n interface StudioAssigned$1 {\n }\n /** Unassigned Studio editor */\n interface StudioUnassigned$1 {\n }\n interface Empty$4 {\n }\n interface FeatureEvent extends FeatureEventEventOneOf {\n /**\n * Information about an event that makes a feature eligible to the user.\n * Triggered for example, for new features or when a feature is reassigned\n * to an account or a site.\n */\n enabled?: FeatureEnabled;\n /**\n * Information about an event that disables a feature for the user.\n * Triggered for example, when a feature is unassigned from a site,\n * reassigned to a different site, or the user switched to a different contract.\n */\n disabled?: FeatureDisabled;\n /**\n * Information about an event that updates a feature. An `updated` event\n * is triggered for example by the\n * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\n * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\n * endpoints.\n */\n updated?: FeatureUpdated;\n /**\n * Information about an event that cancels a feature for the user.\n * Triggered for example, when a feature is canceled, transferred to\n * another account, or the user switched to a different contract.\n */\n cancelled?: FeatureCancelled;\n /**\n * Timestamp of the event in\n * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n */\n timestamp?: Date;\n }\n /** @oneof */\n interface FeatureEventEventOneOf {\n /**\n * Information about an event that makes a feature eligible to the user.\n * Triggered for example, for new features or when a feature is reassigned\n * to an account or a site.\n */\n enabled?: FeatureEnabled;\n /**\n * Information about an event that disables a feature for the user.\n * Triggered for example, when a feature is unassigned from a site,\n * reassigned to a different site, or the user switched to a different contract.\n */\n disabled?: FeatureDisabled;\n /**\n * Information about an event that updates a feature. An `updated` event\n * is triggered for example by the\n * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\n * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\n * endpoints.\n */\n updated?: FeatureUpdated;\n /**\n * Information about an event that cancels a feature for the user.\n * Triggered for example, when a feature is canceled, transferred to\n * another account, or the user switched to a different contract.\n */\n cancelled?: FeatureCancelled;\n }\n /** Feature created or enabled after disabled state */\n interface FeatureEnabled extends FeatureEnabledReasonOneOf {\n /** Information about a transfer from another account. */\n transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;\n /** Information about a transfer from another site. */\n reassignedFromSite?: ReassignedFromSiteReason;\n /** Information about a feature that hadn't been assigned to site. */\n assignedFromFloating?: AssignedFromFloatingReason;\n /** Information about the new feature. */\n newFeature?: NewFeatureReason;\n /** Information about the contract switch. */\n contractSwitched?: ContractSwitchedReason;\n /** Information about the manually created features. */\n manualFeatureCreation?: ManualFeatureCreationReason;\n /** Information about a feature that was migrated from legacy. */\n migratedFromLegacy?: MigratedFromLegacyReason;\n /** Enabled feature. */\n feature?: Feature;\n /**\n * Information about a transfer from another account.\n * __Deprecated__. Use `reason.transferred_from_another_account` instead.\n */\n transferredFromAccount?: string | null;\n /**\n * Information about a transfer from another site.\n * __Deprecated__. Use `reason.reassigned_from_site` instead.\n */\n reassignedFromMetasite?: string | null;\n }\n /** @oneof */\n interface FeatureEnabledReasonOneOf {\n /** Information about a transfer from another account. */\n transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;\n /** Information about a transfer from another site. */\n reassignedFromSite?: ReassignedFromSiteReason;\n /** Information about a feature that hadn't been assigned to site. */\n assignedFromFloating?: AssignedFromFloatingReason;\n /** Information about the new feature. */\n newFeature?: NewFeatureReason;\n /** Information about the contract switch. */\n contractSwitched?: ContractSwitchedReason;\n /** Information about the manually created features. */\n manualFeatureCreation?: ManualFeatureCreationReason;\n /** Information about a feature that was migrated from legacy. */\n migratedFromLegacy?: MigratedFromLegacyReason;\n }\n interface Feature extends FeatureQuantityInfoOneOf {\n /**\n * Deprecated. Use `enabled` instead.\n * @deprecated\n */\n booleanFeature?: BooleanFeature;\n /**\n * Deprecated. Use `quotaInfo` instead.\n * @deprecated\n */\n quotaFeature?: QuotaFeature;\n /**\n * ID of the feature. __Note:__ Isn't unique. For example, all features that\n * are available to free Wix accounts or site in some capacity have\n * `{\"id\": \"DEFAULT\"}`. Use `uniqueName` as unique identifier for a feature.\n * @readonly\n */\n _id?: string;\n /**\n * Unique name of the feature. Only lower case letters, numbers, and dashes\n * `-` are supported. Used in the endpoints of the\n * [Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)\n * to specify the feature. Not visible to customers. We recommend to start\n * the unique name with a prefix describing your organization or Wix company.\n * For example, `bookings` or `crm`.\n *\n * Min: 2 characters\n * Max: 50 characters\n */\n uniqueName?: string;\n /**\n * Information about whether the feature belongs to a Wix account or site.\n * Account features have `context.userId`. Site features have `context.metaSiteId` in case\n * they're assigned to a specific site. Site features that aren't assigned to\n * a specific site have neither ID.\n */\n context?: FeatureContext;\n /**\n * Deprecated.\n * @readonly\n * @deprecated\n */\n createdAt?: Date;\n /**\n * Deprecated.\n * @readonly\n * @deprecated\n */\n updatedAt?: Date;\n /**\n * Information about how often customers can use the feature during a specific\n * period. Available only for quota features.\n */\n quotaInfo?: QuotaInfo;\n /**\n * Whether the customer is currently allowed to use the feature.\n * `true` means that the customer can use the feature. This means a boolean\n * feature is active or a quota feature has remaining usage.\n * `false` means that the customer can't use the feature.\n * This means a boolean feature isn't active or a quota feature doesn't\n * have remaining usage.\n */\n enabled?: boolean;\n /**\n * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)\n * to which the feature instance belongs.\n */\n subscriptionId?: string | null;\n /**\n * Metadata of the feature. Wix Premium uses the metadata object to indicate\n * that customers who purchase a product with the feature also get\n * access to an additional product. For these bundled products `metadata`\n * looks like this: `{\"tpa\": \"{\"appDefId\": \"sample-app-def-id-1234567890\", \"vendorProductId\": \"sample-productId\"}}\"`.\n * But you can use the `metadata` property for other purposes, too.\n */\n metadata?: Record;\n }\n /** @oneof */\n interface FeatureQuantityInfoOneOf {\n /**\n * Deprecated. Use `enabled` instead.\n * @deprecated\n */\n booleanFeature?: BooleanFeature;\n /**\n * Deprecated. Use `quotaInfo` instead.\n * @deprecated\n */\n quotaFeature?: QuotaFeature;\n }\n /**\n * Context this feature is currently connected to.\n * Note: Do not confuse with feature scope which is configured in the product catalog\n * and defines in which context the product can be used\n */\n interface FeatureContext {\n /**\n * ID of the Wix account that the feature instance belongs to.\n * Available for both site and account level feature instances.\n */\n userId?: string;\n /**\n * ID of the meta site that the feature instance is assigned to.\n * Only available for site level feature instances that are assigned to a Wix\n * site. Not available for account level and unassigned site level feature\n * instances.\n */\n metaSiteId?: string | null;\n }\n /**\n * A feature that can be either \"enabled\" or \"disabled\". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).\n * A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).\n */\n interface BooleanFeature {\n }\n /** A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature. */\n interface QuotaFeature {\n /** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */\n limit?: string | null;\n /** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */\n period?: FeaturePeriod;\n /** Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit. */\n units?: string | null;\n }\n /** Determines the reset cycle of the feature usage. */\n enum FeaturePeriod {\n NO_PERIOD = \"NO_PERIOD\",\n MILLISECOND = \"MILLISECOND\",\n SECOND = \"SECOND\",\n MINUTE = \"MINUTE\",\n HOUR = \"HOUR\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface QuotaInfo {\n /**\n * How often the customer is allowed to use the feature during the specified\n * period. `null` means that the customer has unlimited access to the feature.\n */\n limit?: string | null;\n /**\n * Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`\n * isn't automatically reset to the feature's `limit` after a specific period.\n * You may still manually call\n * [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).\n */\n period?: FeaturePeriod;\n /**\n * How often the customer has used the feature during the current\n * period.\n */\n currentUsage?: string;\n /**\n * How often the customer can still use the feature during the current\n * period. `null` means that the customer has unlimited access to the feature.\n */\n remainingUsage?: string | null;\n }\n /** Subscription transferred from another account, features on the current account were enabled. */\n interface TransferredFromAnotherAccountReason {\n /** Information about a transfer from another account. */\n transferredFromAccount?: string;\n }\n /** Subscription moved from one site to another in the same account, features enabled on the target site */\n interface ReassignedFromSiteReason {\n /** Information about a transfer from another site. */\n reassignedFromMetasite?: string;\n }\n /** Subscription was floating and assigned to site, features enabled on the target site */\n interface AssignedFromFloatingReason {\n }\n /** New subscription created and features created as enabled */\n interface NewFeatureReason {\n }\n /** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */\n interface ContractSwitchedReason {\n }\n /** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */\n interface ManualFeatureCreationReason {\n }\n /** Subscription created due to migration from old premium model */\n interface MigratedFromLegacyReason {\n }\n /** Feature disabled and can be enabled in the future */\n interface FeatureDisabled extends FeatureDisabledReasonOneOf {\n /** Information about a feature that's no longer assigned to a site. */\n unassingedToFloating?: UnAssingedToFloatingReason;\n /**\n * Information about a feature that's been replaced by a feature from a\n * different subscription.\n */\n replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;\n /**\n * Information about a feature that's been reassigned to a different\n * site.\n */\n reassignedToAnotherSite?: ReassignedToAnotherSiteReason;\n /**\n * Disabled feature. Includes information about the feature's new state,\n * possibly its new context.\n */\n feature?: Feature;\n /** ID of the meta site for which the feature has been disabled. */\n metaSiteId?: string | null;\n }\n /** @oneof */\n interface FeatureDisabledReasonOneOf {\n /** Information about a feature that's no longer assigned to a site. */\n unassingedToFloating?: UnAssingedToFloatingReason;\n /**\n * Information about a feature that's been replaced by a feature from a\n * different subscription.\n */\n replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;\n /**\n * Information about a feature that's been reassigned to a different\n * site.\n */\n reassignedToAnotherSite?: ReassignedToAnotherSiteReason;\n }\n /** Subscription was unassigned from the site and moved into floating state */\n interface UnAssingedToFloatingReason {\n }\n /** Another subscription was assigned to the site, causing existing features on this site to be disabled */\n interface ReplacedByAnotherSubscriptionReason {\n }\n /** Subscription was assigned to another site, causing features on the origin site to be disabled. */\n interface ReassignedToAnotherSiteReason {\n /** Information about a transfer to the site. */\n reassignedToMetasite?: string;\n }\n /** Feature updated, for example Quota was increased due to upgrade */\n interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {\n /** Information about a feature that doesn't have a usage quota. */\n booleanFeature?: BooleanFeature;\n /** Information about a feature that has a usage quota. */\n quotaFeature?: QuotaFeature;\n /** Information about the contract switch. */\n contractSwitched?: ContractSwitchedReason;\n /**\n * Updated feature. Includes information about the feature's new state and\n * possibly its new context.\n */\n feature?: Feature;\n }\n /** @oneof */\n interface FeatureUpdatedPreviousQuantityInfoOneOf {\n /** Information about a feature that doesn't have a usage quota. */\n booleanFeature?: BooleanFeature;\n /** Information about a feature that has a usage quota. */\n quotaFeature?: QuotaFeature;\n }\n /** @oneof */\n interface FeatureUpdatedReasonOneOf {\n /** Information about the contract switch. */\n contractSwitched?: ContractSwitchedReason;\n }\n /** Feature was permanently cancelled */\n interface FeatureCancelled extends FeatureCancelledReasonOneOf {\n /** Information about a transfer to the account. */\n transferredToAnotherAccount?: TransferredToAnotherAccountReason;\n /** Information about the contract switch. */\n contractSwitched?: ContractSwitchedReason;\n /** Information about the feature cancellation. */\n cancelRequest?: CancelRequestedReason;\n /** Canceled feature. */\n feature?: Feature;\n /**\n * Information about a transfer to the account.\n * __Deprecated__. Use `reason.transferred_to_account` instead.\n */\n transferredToAccount?: string | null;\n }\n /** @oneof */\n interface FeatureCancelledReasonOneOf {\n /** Information about a transfer to the account. */\n transferredToAnotherAccount?: TransferredToAnotherAccountReason;\n /** Information about the contract switch. */\n contractSwitched?: ContractSwitchedReason;\n /** Information about the feature cancellation. */\n cancelRequest?: CancelRequestedReason;\n }\n /** Subscription was transferred to another account, features in the origin account were cancelled */\n interface TransferredToAnotherAccountReason {\n /** Information about a transfer to the account. */\n transferredToAccount?: string;\n }\n /** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */\n interface CancelRequestedReason {\n }\n interface DomainEvent$4 extends DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n }\n interface EntityCreatedEvent$4 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$4 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$4 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$4 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$4;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$4;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$4 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves the site's loyalty program.\n *\n * The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.\n * @public\n * @permissionId LOYALTY.READ_PROGRAM\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getLoyaltyProgram(): Promise;\n /**\n * Retrieves loyalty programs for all metasites that the caller is a member of.\n *\n * Must be called with user identity.\n * @public\n * @documentationMaturity preview\n * @permissionId LOYALTY.PROGRAM_BULK_READ\n * @adminMethod\n */\n function bulkGetLoyaltyProgram(): Promise;\n /**\n * Updates the site's loyalty program.\n *\n * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.\n *\n * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty-v2/programs/activateloyaltyprogram) function.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.\n * @param loyaltyProgram - Loyalty program fields to update.\n * @public\n * @requiredField loyaltyProgram\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateLoyaltyProgram(loyaltyProgram: LoyaltyProgram): Promise;\n /**\n * Activates a loyalty program.\n *\n * The `activateLoyaltyProgram()` function returns a Promise that resolves when the status of the loyalty program is successfully changed to `\"ACTIVE\"`.\n *\n * Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `\"DRAFT\"`. You can change the program's status to `\"ACTIVE\"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `\"ACTIVE\"`.\n *\n * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty-v2/programs/updateloyaltyprogram) function.\n *\n * To temporarily pause your loyalty program you must follow three steps:\n * 1. Remove all [`earnPoints()`](wix-loyalty-v2/accounts/earnpoints) functions and switch off all the \"Earn Points\" and \"Rewards\" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).\n * 1. Hide the loyalty page from your site.\n * 1. Delete the My Rewards page from the Member pages.\n * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can activate a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function activateLoyaltyProgram(): Promise;\n /**\n * Changes the program status to `PAUSED`.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function pauseLoyaltyProgram(): Promise;\n interface GetLoyaltyProgramDescriptionOptions {\n /** List of description fields to retrieve. Supported values: `description`, `updatedDate`. */\n fields?: string[];\n }\n interface UpdateLoyaltyProgramDescriptionOptions {\n /** Loyalty program description to update. */\n description?: string;\n }\n /**\n * Get information about available premium features\n * @public\n * @documentationMaturity preview\n * @permissionId LOYALTY.READ_PROGRAM\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function getLoyaltyProgramPremiumFeatures(): Promise;\n /**\n * Updates the `pointsExpiration` status to `ENABLED`.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function enablePointsExpiration(): Promise;\n /**\n * Updates the `pointsExpiration` status to `DISABLED`.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function disablePointsExpiration(): Promise;\n type loyaltyV1ProgramPrograms_universal_d_LoyaltyProgram = LoyaltyProgram;\n type loyaltyV1ProgramPrograms_universal_d_PointDefinition = PointDefinition;\n type loyaltyV1ProgramPrograms_universal_d_ProgramStatus = ProgramStatus;\n const loyaltyV1ProgramPrograms_universal_d_ProgramStatus: typeof ProgramStatus;\n type loyaltyV1ProgramPrograms_universal_d_PremiumFeatures = PremiumFeatures;\n type loyaltyV1ProgramPrograms_universal_d_EarningRuleDisabled = EarningRuleDisabled;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramRequest = GetLoyaltyProgramRequest;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramResponse = GetLoyaltyProgramResponse;\n type loyaltyV1ProgramPrograms_universal_d_BulkGetLoyaltyProgramRequest = BulkGetLoyaltyProgramRequest;\n type loyaltyV1ProgramPrograms_universal_d_BulkGetLoyaltyProgramResponse = BulkGetLoyaltyProgramResponse;\n type loyaltyV1ProgramPrograms_universal_d_ProgramInSite = ProgramInSite;\n type loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramRequest = UpdateLoyaltyProgramRequest;\n type loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramResponse = UpdateLoyaltyProgramResponse;\n type loyaltyV1ProgramPrograms_universal_d_PointsExpirationConfigurationChanged = PointsExpirationConfigurationChanged;\n type loyaltyV1ProgramPrograms_universal_d_PointsExpirationChanges = PointsExpirationChanges;\n type loyaltyV1ProgramPrograms_universal_d_ActivateLoyaltyProgramRequest = ActivateLoyaltyProgramRequest;\n type loyaltyV1ProgramPrograms_universal_d_ActivateLoyaltyProgramResponse = ActivateLoyaltyProgramResponse;\n type loyaltyV1ProgramPrograms_universal_d_LoyaltyProgramActivated = LoyaltyProgramActivated;\n type loyaltyV1ProgramPrograms_universal_d_PauseLoyaltyProgramRequest = PauseLoyaltyProgramRequest;\n type loyaltyV1ProgramPrograms_universal_d_PauseLoyaltyProgramResponse = PauseLoyaltyProgramResponse;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramDescriptionRequest = GetLoyaltyProgramDescriptionRequest;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramDescriptionResponse = GetLoyaltyProgramDescriptionResponse;\n type loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramDescriptionRequest = UpdateLoyaltyProgramDescriptionRequest;\n type loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramDescriptionResponse = UpdateLoyaltyProgramDescriptionResponse;\n type loyaltyV1ProgramPrograms_universal_d_LoyaltyProgramDescriptionUpdated = LoyaltyProgramDescriptionUpdated;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramPremiumFeaturesRequest = GetLoyaltyProgramPremiumFeaturesRequest;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramPremiumFeaturesResponse = GetLoyaltyProgramPremiumFeaturesResponse;\n type loyaltyV1ProgramPrograms_universal_d_EnablePointsExpirationRequest = EnablePointsExpirationRequest;\n type loyaltyV1ProgramPrograms_universal_d_EnablePointsExpirationResponse = EnablePointsExpirationResponse;\n type loyaltyV1ProgramPrograms_universal_d_PointsExpirationEnabled = PointsExpirationEnabled;\n type loyaltyV1ProgramPrograms_universal_d_DisablePointsExpirationRequest = DisablePointsExpirationRequest;\n type loyaltyV1ProgramPrograms_universal_d_DisablePointsExpirationResponse = DisablePointsExpirationResponse;\n type loyaltyV1ProgramPrograms_universal_d_PointsExpirationDisabled = PointsExpirationDisabled;\n type loyaltyV1ProgramPrograms_universal_d_FeatureEvent = FeatureEvent;\n type loyaltyV1ProgramPrograms_universal_d_FeatureEventEventOneOf = FeatureEventEventOneOf;\n type loyaltyV1ProgramPrograms_universal_d_FeatureEnabled = FeatureEnabled;\n type loyaltyV1ProgramPrograms_universal_d_FeatureEnabledReasonOneOf = FeatureEnabledReasonOneOf;\n type loyaltyV1ProgramPrograms_universal_d_Feature = Feature;\n type loyaltyV1ProgramPrograms_universal_d_FeatureQuantityInfoOneOf = FeatureQuantityInfoOneOf;\n type loyaltyV1ProgramPrograms_universal_d_FeatureContext = FeatureContext;\n type loyaltyV1ProgramPrograms_universal_d_BooleanFeature = BooleanFeature;\n type loyaltyV1ProgramPrograms_universal_d_QuotaFeature = QuotaFeature;\n type loyaltyV1ProgramPrograms_universal_d_FeaturePeriod = FeaturePeriod;\n const loyaltyV1ProgramPrograms_universal_d_FeaturePeriod: typeof FeaturePeriod;\n type loyaltyV1ProgramPrograms_universal_d_QuotaInfo = QuotaInfo;\n type loyaltyV1ProgramPrograms_universal_d_TransferredFromAnotherAccountReason = TransferredFromAnotherAccountReason;\n type loyaltyV1ProgramPrograms_universal_d_ReassignedFromSiteReason = ReassignedFromSiteReason;\n type loyaltyV1ProgramPrograms_universal_d_AssignedFromFloatingReason = AssignedFromFloatingReason;\n type loyaltyV1ProgramPrograms_universal_d_NewFeatureReason = NewFeatureReason;\n type loyaltyV1ProgramPrograms_universal_d_ContractSwitchedReason = ContractSwitchedReason;\n type loyaltyV1ProgramPrograms_universal_d_ManualFeatureCreationReason = ManualFeatureCreationReason;\n type loyaltyV1ProgramPrograms_universal_d_MigratedFromLegacyReason = MigratedFromLegacyReason;\n type loyaltyV1ProgramPrograms_universal_d_FeatureDisabled = FeatureDisabled;\n type loyaltyV1ProgramPrograms_universal_d_FeatureDisabledReasonOneOf = FeatureDisabledReasonOneOf;\n type loyaltyV1ProgramPrograms_universal_d_UnAssingedToFloatingReason = UnAssingedToFloatingReason;\n type loyaltyV1ProgramPrograms_universal_d_ReplacedByAnotherSubscriptionReason = ReplacedByAnotherSubscriptionReason;\n type loyaltyV1ProgramPrograms_universal_d_ReassignedToAnotherSiteReason = ReassignedToAnotherSiteReason;\n type loyaltyV1ProgramPrograms_universal_d_FeatureUpdated = FeatureUpdated;\n type loyaltyV1ProgramPrograms_universal_d_FeatureUpdatedPreviousQuantityInfoOneOf = FeatureUpdatedPreviousQuantityInfoOneOf;\n type loyaltyV1ProgramPrograms_universal_d_FeatureUpdatedReasonOneOf = FeatureUpdatedReasonOneOf;\n type loyaltyV1ProgramPrograms_universal_d_FeatureCancelled = FeatureCancelled;\n type loyaltyV1ProgramPrograms_universal_d_FeatureCancelledReasonOneOf = FeatureCancelledReasonOneOf;\n type loyaltyV1ProgramPrograms_universal_d_TransferredToAnotherAccountReason = TransferredToAnotherAccountReason;\n type loyaltyV1ProgramPrograms_universal_d_CancelRequestedReason = CancelRequestedReason;\n const loyaltyV1ProgramPrograms_universal_d_getLoyaltyProgram: typeof getLoyaltyProgram;\n const loyaltyV1ProgramPrograms_universal_d_bulkGetLoyaltyProgram: typeof bulkGetLoyaltyProgram;\n const loyaltyV1ProgramPrograms_universal_d_updateLoyaltyProgram: typeof updateLoyaltyProgram;\n const loyaltyV1ProgramPrograms_universal_d_activateLoyaltyProgram: typeof activateLoyaltyProgram;\n const loyaltyV1ProgramPrograms_universal_d_pauseLoyaltyProgram: typeof pauseLoyaltyProgram;\n type loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramDescriptionOptions = GetLoyaltyProgramDescriptionOptions;\n type loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramDescriptionOptions = UpdateLoyaltyProgramDescriptionOptions;\n const loyaltyV1ProgramPrograms_universal_d_getLoyaltyProgramPremiumFeatures: typeof getLoyaltyProgramPremiumFeatures;\n const loyaltyV1ProgramPrograms_universal_d_enablePointsExpiration: typeof enablePointsExpiration;\n const loyaltyV1ProgramPrograms_universal_d_disablePointsExpiration: typeof disablePointsExpiration;\n namespace loyaltyV1ProgramPrograms_universal_d {\n export { loyaltyV1ProgramPrograms_universal_d_LoyaltyProgram as LoyaltyProgram, loyaltyV1ProgramPrograms_universal_d_PointDefinition as PointDefinition, loyaltyV1ProgramPrograms_universal_d_ProgramStatus as ProgramStatus, PointsExpiration$1 as PointsExpiration, Status$3 as Status, loyaltyV1ProgramPrograms_universal_d_PremiumFeatures as PremiumFeatures, loyaltyV1ProgramPrograms_universal_d_EarningRuleDisabled as EarningRuleDisabled, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramRequest as GetLoyaltyProgramRequest, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramResponse as GetLoyaltyProgramResponse, loyaltyV1ProgramPrograms_universal_d_BulkGetLoyaltyProgramRequest as BulkGetLoyaltyProgramRequest, loyaltyV1ProgramPrograms_universal_d_BulkGetLoyaltyProgramResponse as BulkGetLoyaltyProgramResponse, loyaltyV1ProgramPrograms_universal_d_ProgramInSite as ProgramInSite, loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramRequest as UpdateLoyaltyProgramRequest, loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramResponse as UpdateLoyaltyProgramResponse, loyaltyV1ProgramPrograms_universal_d_PointsExpirationConfigurationChanged as PointsExpirationConfigurationChanged, loyaltyV1ProgramPrograms_universal_d_PointsExpirationChanges as PointsExpirationChanges, loyaltyV1ProgramPrograms_universal_d_ActivateLoyaltyProgramRequest as ActivateLoyaltyProgramRequest, loyaltyV1ProgramPrograms_universal_d_ActivateLoyaltyProgramResponse as ActivateLoyaltyProgramResponse, loyaltyV1ProgramPrograms_universal_d_LoyaltyProgramActivated as LoyaltyProgramActivated, loyaltyV1ProgramPrograms_universal_d_PauseLoyaltyProgramRequest as PauseLoyaltyProgramRequest, loyaltyV1ProgramPrograms_universal_d_PauseLoyaltyProgramResponse as PauseLoyaltyProgramResponse, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramDescriptionRequest as GetLoyaltyProgramDescriptionRequest, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramDescriptionResponse as GetLoyaltyProgramDescriptionResponse, loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramDescriptionRequest as UpdateLoyaltyProgramDescriptionRequest, loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramDescriptionResponse as UpdateLoyaltyProgramDescriptionResponse, loyaltyV1ProgramPrograms_universal_d_LoyaltyProgramDescriptionUpdated as LoyaltyProgramDescriptionUpdated, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramPremiumFeaturesRequest as GetLoyaltyProgramPremiumFeaturesRequest, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramPremiumFeaturesResponse as GetLoyaltyProgramPremiumFeaturesResponse, loyaltyV1ProgramPrograms_universal_d_EnablePointsExpirationRequest as EnablePointsExpirationRequest, loyaltyV1ProgramPrograms_universal_d_EnablePointsExpirationResponse as EnablePointsExpirationResponse, loyaltyV1ProgramPrograms_universal_d_PointsExpirationEnabled as PointsExpirationEnabled, loyaltyV1ProgramPrograms_universal_d_DisablePointsExpirationRequest as DisablePointsExpirationRequest, loyaltyV1ProgramPrograms_universal_d_DisablePointsExpirationResponse as DisablePointsExpirationResponse, loyaltyV1ProgramPrograms_universal_d_PointsExpirationDisabled as PointsExpirationDisabled, MetaSiteSpecialEvent$1 as MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf$1 as MetaSiteSpecialEventPayloadOneOf, Asset$1 as Asset, State$1 as State, SiteCreated$1 as SiteCreated, SiteCreatedContext$1 as SiteCreatedContext, Namespace$1 as Namespace, SiteTransferred$1 as SiteTransferred, SiteDeleted$1 as SiteDeleted, DeleteContext$1 as DeleteContext, DeleteStatus$1 as DeleteStatus, SiteUndeleted$1 as SiteUndeleted, SitePublished$1 as SitePublished, SiteUnpublished$1 as SiteUnpublished, SiteMarkedAsTemplate$1 as SiteMarkedAsTemplate, SiteMarkedAsWixSite$1 as SiteMarkedAsWixSite, ServiceProvisioned$1 as ServiceProvisioned, ServiceRemoved$1 as ServiceRemoved, SiteRenamed$1 as SiteRenamed, SiteHardDeleted$1 as SiteHardDeleted, NamespaceChanged$1 as NamespaceChanged, StudioAssigned$1 as StudioAssigned, StudioUnassigned$1 as StudioUnassigned, Empty$4 as Empty, loyaltyV1ProgramPrograms_universal_d_FeatureEvent as FeatureEvent, loyaltyV1ProgramPrograms_universal_d_FeatureEventEventOneOf as FeatureEventEventOneOf, loyaltyV1ProgramPrograms_universal_d_FeatureEnabled as FeatureEnabled, loyaltyV1ProgramPrograms_universal_d_FeatureEnabledReasonOneOf as FeatureEnabledReasonOneOf, loyaltyV1ProgramPrograms_universal_d_Feature as Feature, loyaltyV1ProgramPrograms_universal_d_FeatureQuantityInfoOneOf as FeatureQuantityInfoOneOf, loyaltyV1ProgramPrograms_universal_d_FeatureContext as FeatureContext, loyaltyV1ProgramPrograms_universal_d_BooleanFeature as BooleanFeature, loyaltyV1ProgramPrograms_universal_d_QuotaFeature as QuotaFeature, loyaltyV1ProgramPrograms_universal_d_FeaturePeriod as FeaturePeriod, loyaltyV1ProgramPrograms_universal_d_QuotaInfo as QuotaInfo, loyaltyV1ProgramPrograms_universal_d_TransferredFromAnotherAccountReason as TransferredFromAnotherAccountReason, loyaltyV1ProgramPrograms_universal_d_ReassignedFromSiteReason as ReassignedFromSiteReason, loyaltyV1ProgramPrograms_universal_d_AssignedFromFloatingReason as AssignedFromFloatingReason, loyaltyV1ProgramPrograms_universal_d_NewFeatureReason as NewFeatureReason, loyaltyV1ProgramPrograms_universal_d_ContractSwitchedReason as ContractSwitchedReason, loyaltyV1ProgramPrograms_universal_d_ManualFeatureCreationReason as ManualFeatureCreationReason, loyaltyV1ProgramPrograms_universal_d_MigratedFromLegacyReason as MigratedFromLegacyReason, loyaltyV1ProgramPrograms_universal_d_FeatureDisabled as FeatureDisabled, loyaltyV1ProgramPrograms_universal_d_FeatureDisabledReasonOneOf as FeatureDisabledReasonOneOf, loyaltyV1ProgramPrograms_universal_d_UnAssingedToFloatingReason as UnAssingedToFloatingReason, loyaltyV1ProgramPrograms_universal_d_ReplacedByAnotherSubscriptionReason as ReplacedByAnotherSubscriptionReason, loyaltyV1ProgramPrograms_universal_d_ReassignedToAnotherSiteReason as ReassignedToAnotherSiteReason, loyaltyV1ProgramPrograms_universal_d_FeatureUpdated as FeatureUpdated, loyaltyV1ProgramPrograms_universal_d_FeatureUpdatedPreviousQuantityInfoOneOf as FeatureUpdatedPreviousQuantityInfoOneOf, loyaltyV1ProgramPrograms_universal_d_FeatureUpdatedReasonOneOf as FeatureUpdatedReasonOneOf, loyaltyV1ProgramPrograms_universal_d_FeatureCancelled as FeatureCancelled, loyaltyV1ProgramPrograms_universal_d_FeatureCancelledReasonOneOf as FeatureCancelledReasonOneOf, loyaltyV1ProgramPrograms_universal_d_TransferredToAnotherAccountReason as TransferredToAnotherAccountReason, loyaltyV1ProgramPrograms_universal_d_CancelRequestedReason as CancelRequestedReason, DomainEvent$4 as DomainEvent, DomainEventBodyOneOf$4 as DomainEventBodyOneOf, EntityCreatedEvent$4 as EntityCreatedEvent, RestoreInfo$4 as RestoreInfo, EntityUpdatedEvent$4 as EntityUpdatedEvent, EntityDeletedEvent$4 as EntityDeletedEvent, ActionEvent$4 as ActionEvent, MessageEnvelope$4 as MessageEnvelope, IdentificationData$4 as IdentificationData, IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, WebhookIdentityType$4 as WebhookIdentityType, loyaltyV1ProgramPrograms_universal_d_getLoyaltyProgram as getLoyaltyProgram, loyaltyV1ProgramPrograms_universal_d_bulkGetLoyaltyProgram as bulkGetLoyaltyProgram, loyaltyV1ProgramPrograms_universal_d_updateLoyaltyProgram as updateLoyaltyProgram, loyaltyV1ProgramPrograms_universal_d_activateLoyaltyProgram as activateLoyaltyProgram, loyaltyV1ProgramPrograms_universal_d_pauseLoyaltyProgram as pauseLoyaltyProgram, loyaltyV1ProgramPrograms_universal_d_GetLoyaltyProgramDescriptionOptions as GetLoyaltyProgramDescriptionOptions, loyaltyV1ProgramPrograms_universal_d_UpdateLoyaltyProgramDescriptionOptions as UpdateLoyaltyProgramDescriptionOptions, loyaltyV1ProgramPrograms_universal_d_getLoyaltyProgramPremiumFeatures as getLoyaltyProgramPremiumFeatures, loyaltyV1ProgramPrograms_universal_d_enablePointsExpiration as enablePointsExpiration, loyaltyV1ProgramPrograms_universal_d_disablePointsExpiration as disablePointsExpiration, };\n }\n /**\n * A tier is a loyalty level that customers are assigned to based on the amount of points they earn.\n * Read more about loyalty tiers [here](https://support.wix.com/en/article/about-tiers).\n */\n interface Tier$1 {\n /**\n * Tier ID.\n * @readonly\n */\n _id?: string | null;\n /** Information about the tier. */\n tierDefinition?: TierDefinition$1;\n /** The amount of points required to be in this tier. */\n requiredPoints?: number;\n /**\n * Revision number, which increments by 1 each time the loyalty tier is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty tier.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the tier was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the tier was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n /** Information about the tier. */\n interface TierDefinition$1 {\n /** Details about the tier icon. */\n icon?: string;\n /** Tier name. */\n name?: string | null;\n /** Tier description. */\n description?: string | null;\n }\n interface FocalPoint$1 {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n /** crop by height */\n height?: number | null;\n /** crop by width */\n width?: number | null;\n }\n interface TiersProgramSettingsChanged$1 {\n /** Settings for the tiers program. */\n programSettings?: TiersProgramSettings$1;\n }\n /** There can be single TiersSettings per site and it's global (i.e. applies to all program's tiers) */\n interface TiersProgramSettings$1 extends TiersProgramSettingsPeriodOneOf$1 {\n /**\n * *Required.**\n * Period of time used to calculate loyalty points for tier assignment.\n *\n * The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.\n */\n rollingWindow?: RollingWindow$1;\n /** Tiers program status. */\n status?: Status$2;\n /**\n * Revision number, which increments by 1 each time the loyalty tiers settings are updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty tiers settings.\n */\n revision?: string | null;\n /**\n * Date and time the loyalty tiers program was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the loyalty tiers program was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Information about the base loyalty tier.\n *\n * The base tier is the default tier for any account that is unassigned for not meeting\n * the required points threshold of any other tier.\n */\n baseTierDefinition?: TierDefinition$1;\n }\n /** @oneof */\n interface TiersProgramSettingsPeriodOneOf$1 {\n /**\n * *Required.**\n * Period of time used to calculate loyalty points for tier assignment.\n *\n * The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.\n */\n rollingWindow?: RollingWindow$1;\n }\n enum Status$2 {\n /** Unknown status. */\n UNKNOWN = \"UNKNOWN\",\n /** Tiers are disabled. */\n DISABLED = \"DISABLED\",\n /** Tiers are enabled but not yet active. */\n DRAFT = \"DRAFT\",\n /** Tiers are active. */\n ACTIVE = \"ACTIVE\",\n /** Tiers are paused. */\n PAUSED = \"PAUSED\"\n }\n /**\n * *Required.** Period of time used to calculate loyalty points for tier assignment.\n *\n * The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.\n */\n interface RollingWindow$1 {\n /**\n * Number of months to use for the rolling window period.\n *\n * Min: `12`\n *\n * Max: `36`\n */\n durationInMonths?: number;\n }\n interface TiersRollingUpdate$1 {\n }\n interface CreateTierRequest {\n /** Tier to create. */\n tier: Tier$1;\n }\n interface CreateTierResponse {\n /** Created loyalty tier. */\n tier?: Tier$1;\n }\n interface BulkCreateTiersRequest {\n /** Tiers to create. */\n tiers?: Tier$1[];\n }\n interface BulkCreateTiersResponse {\n /** Created tiers. */\n results?: BulkTierResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n /** Retrieved tiers. */\n interface BulkTierResult {\n /** Individual tier metadata. */\n itemMetadata?: ItemMetadata$2;\n /** Individual tier information. */\n item?: Tier$1;\n }\n interface ItemMetadata$2 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$2;\n }\n interface ApplicationError$2 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$2 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetTierRequest {\n /** ID of the tier to retrieve. */\n tierId: string;\n }\n interface GetTierResponse {\n /** Retrieved loyalty tier. */\n tier?: Tier$1;\n }\n interface UpdateTierRequest {\n /** Tier details to update. */\n tier: Tier$1;\n }\n interface UpdateTierResponse {\n /** Updated loyalty tier. */\n tier?: Tier$1;\n }\n interface TierRequiredPointsChanged {\n /** Tier. */\n tier?: Tier$1;\n }\n interface DeleteTierRequest {\n /** ID of the tier to delete. */\n tierId: string;\n /** Current `revision` of the tier to delete. */\n revision?: string;\n }\n interface DeleteTierResponse {\n }\n interface ListTiersRequest {\n }\n interface ListTiersResponse {\n /** Retrieved loyalty tiers. */\n tiers?: Tier$1[];\n }\n interface CreateTiersProgramSettingsRequest {\n /** Tiers program settings. */\n programSettings: TiersProgramSettings$1;\n }\n interface CreateTiersProgramSettingsResponse {\n /** Created tiers program settings. */\n programSettings?: TiersProgramSettings$1;\n }\n interface GetTiersProgramRequest {\n }\n interface GetTiersProgramResponse {\n /** Tiers. */\n tiers?: Tier$1[];\n /** Tiers program settings. */\n programSettings?: TiersProgramSettings$1;\n }\n interface GetTiersProgramSettingsRequest {\n }\n interface GetTiersProgramSettingsResponse {\n /** Tiers program settings. */\n programSettings?: TiersProgramSettings$1;\n }\n interface UpdateTiersProgramSettingsRequest {\n /** Settings for the tiers program. */\n programSettings: TiersProgramSettings$1;\n }\n interface UpdateTiersProgramSettingsResponse {\n /** Updated program settings. */\n programSettings?: TiersProgramSettings$1;\n }\n interface RecalculateAllTiersRequest {\n }\n interface RecalculateAllTiersResponse {\n }\n interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned;\n /** A meta site id. */\n metaSiteId?: string;\n /** A meta site version. Monotonically increasing. */\n version?: string;\n /** A timestamp of the event. */\n timestamp?: string;\n /**\n * TODO(meta-site): Change validation once validations are disabled for consumers\n * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659\n */\n assets?: Asset[];\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned;\n }\n interface Asset {\n /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */\n appDefId?: string;\n /** An instance id. For legacy reasons may be UUID or a string. */\n instanceId?: string;\n /** An application state. */\n state?: State;\n }\n enum State {\n UNKNOWN = \"UNKNOWN\",\n ENABLED = \"ENABLED\",\n DISABLED = \"DISABLED\",\n PENDING = \"PENDING\",\n DEMO = \"DEMO\"\n }\n interface SiteCreated {\n /** A template identifier (empty if not created from a template). */\n originTemplateId?: string;\n /** An account id of the owner. */\n ownerId?: string;\n /** A context in which meta site was created. */\n context?: SiteCreatedContext;\n /**\n * A meta site id from which this site was created.\n *\n * In case of a creation from a template it's a template id.\n * In case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.\n */\n originMetaSiteId?: string | null;\n /** A meta site name (URL slug). */\n siteName?: string;\n /** A namespace. */\n namespace?: Namespace;\n }\n enum SiteCreatedContext {\n /** A valid option, we don't expose all reasons why site might be created. */\n OTHER = \"OTHER\",\n /** A meta site was created from template. */\n FROM_TEMPLATE = \"FROM_TEMPLATE\",\n /** A meta site was created by copying of the transfferred meta site. */\n DUPLICATE_BY_SITE_TRANSFER = \"DUPLICATE_BY_SITE_TRANSFER\",\n /** A copy of existing meta site. */\n DUPLICATE = \"DUPLICATE\",\n /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */\n OLD_SITE_TRANSFER = \"OLD_SITE_TRANSFER\",\n /** deprecated A meta site was created for Flash editor. */\n FLASH = \"FLASH\"\n }\n enum Namespace {\n UNKNOWN_NAMESPACE = \"UNKNOWN_NAMESPACE\",\n /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */\n WIX = \"WIX\",\n /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n SHOUT_OUT = \"SHOUT_OUT\",\n /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ALBUMS = \"ALBUMS\",\n /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n WIX_STORES_TEST_DRIVE = \"WIX_STORES_TEST_DRIVE\",\n /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n HOTELS = \"HOTELS\",\n /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n CLUBS = \"CLUBS\",\n /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ONBOARDING_DRAFT = \"ONBOARDING_DRAFT\",\n /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_SITE = \"DEV_SITE\",\n /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n LOGOS = \"LOGOS\",\n /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n VIDEO_MAKER = \"VIDEO_MAKER\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n PARTNER_DASHBOARD = \"PARTNER_DASHBOARD\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_CENTER_COMPANY = \"DEV_CENTER_COMPANY\",\n /**\n * A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n *\n * Meta site with this namespace will *not* be shown in a user's site list by default.\n */\n HTML_DRAFT = \"HTML_DRAFT\",\n /**\n * the user-journey for Fitness users who want to start from managing their business instead of designing their website.\n * Will be accessible from Site List and will not have a website app.\n * Once the user attaches a site, the site will become a regular wixsite.\n */\n SITELESS_BUSINESS = \"SITELESS_BUSINESS\",\n /** Belongs to \"strategic products\" company. Supports new product in the creator's economy space. */\n CREATOR_ECONOMY = \"CREATOR_ECONOMY\",\n /** It is to be used in the Business First efforts. */\n DASHBOARD_FIRST = \"DASHBOARD_FIRST\",\n /** Bookings business flow with no site. */\n ANYWHERE = \"ANYWHERE\",\n /** Namespace for Headless Backoffice with no editor */\n HEADLESS = \"HEADLESS\",\n /**\n * Namespace for master site that will exist in parent account that will be referenced by subaccounts\n * The site will be used for account level CSM feature for enterprise\n */\n ACCOUNT_MASTER_CMS = \"ACCOUNT_MASTER_CMS\",\n /** Rise.ai Siteless account management for Gift Cards and Store Credit. */\n RISE = \"RISE\",\n /**\n * As part of the branded app new funnel, users now can create a meta site that will be branded app first.\n * There's a blank site behind the scene but it's blank).\n * The Mobile company will be the owner of this namespace.\n */\n BRANDED_FIRST = \"BRANDED_FIRST\",\n /** Nownia.com Siteless account management for Ai Scheduling Assistant. */\n NOWNIA = \"NOWNIA\",\n /**\n * UGC Templates are templates that are created by users for personal use and to sale to other users.\n * The Partners company owns this namespace.\n */\n UGC_TEMPLATE = \"UGC_TEMPLATE\",\n /** Codux Headless Sites */\n CODUX = \"CODUX\",\n /** Bobb - AI Design Creator. */\n MEDIA_DESIGN_CREATOR = \"MEDIA_DESIGN_CREATOR\",\n /**\n * Shared Blog Site is a unique single site across Enterprise account,\n * This site will hold all Blog posts related to the Marketing product.\n */\n SHARED_BLOG_ENTERPRISE = \"SHARED_BLOG_ENTERPRISE\"\n }\n /** Site transferred to another user. */\n interface SiteTransferred {\n /** A previous owner id (user that transfers meta site). */\n oldOwnerId?: string;\n /** A new owner id (user that accepts meta site). */\n newOwnerId?: string;\n }\n /** Soft deletion of the meta site. Could be restored. */\n interface SiteDeleted {\n /** A deletion context. */\n deleteContext?: DeleteContext;\n }\n interface DeleteContext {\n /** When the meta site was deleted. */\n dateDeleted?: Date | null;\n /** A status. */\n deleteStatus?: DeleteStatus;\n /** A reason (flow). */\n deleteOrigin?: string;\n /** A service that deleted it. */\n initiatorId?: string | null;\n }\n enum DeleteStatus {\n UNKNOWN = \"UNKNOWN\",\n TRASH = \"TRASH\",\n DELETED = \"DELETED\",\n PENDING_PURGE = \"PENDING_PURGE\"\n }\n /** Restoration of the meta site. */\n interface SiteUndeleted {\n }\n /** First publish of a meta site. Or subsequent publish after unpublish. */\n interface SitePublished {\n }\n interface SiteUnpublished {\n /** A list of URLs previously associated with the meta site. */\n urls?: string[];\n }\n interface SiteMarkedAsTemplate {\n }\n interface SiteMarkedAsWixSite {\n }\n /**\n * Represents a service provisioned a site.\n *\n * Note on `origin_instance_id`:\n * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.\n * This is because of the following scenario:\n *\n * Imagine you have a template where a third-party application (TPA) includes some stub data,\n * such as a product catalog. When you create a site from this template, you inherit this\n * default product catalog. However, if the template's product catalog is modified,\n * your site will retain the catalog as it was at the time of site creation. This ensures that\n * your site remains consistent with what you initially received and does not include any\n * changes made to the original template afterward.\n * To ensure this, the TPA on the template gets a new instance_id.\n */\n interface ServiceProvisioned {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** An instance id from which this instance is originated. */\n originInstanceId?: string;\n /** A version. */\n version?: string | null;\n /** The origin meta site id */\n originMetaSiteId?: string | null;\n }\n interface ServiceRemoved {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** A version. */\n version?: string | null;\n }\n /** Rename of the site. Meaning, free public url has been changed as well. */\n interface SiteRenamed {\n /** A new meta site name (URL slug). */\n newSiteName?: string;\n /** A previous meta site name (URL slug). */\n oldSiteName?: string;\n }\n /**\n * Hard deletion of the meta site.\n *\n * Could not be restored. Therefore it's desirable to cleanup data.\n */\n interface SiteHardDeleted {\n /** A deletion context. */\n deleteContext?: DeleteContext;\n }\n interface NamespaceChanged {\n /** A previous namespace. */\n oldNamespace?: Namespace;\n /** A new namespace. */\n newNamespace?: Namespace;\n }\n /** Assigned Studio editor */\n interface StudioAssigned {\n }\n /** Unassigned Studio editor */\n interface StudioUnassigned {\n }\n interface Empty$3 {\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n }\n interface RestoreInfo$3 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$3;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a tier.\n *\n * The name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.\n * Attempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.\n *\n * To create up to 20 tiers at once, use [`bulkCreateTiers()`](#bulkcreatetiers).\n *\n * >**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.\n * @param tier - Tier to create.\n * @public\n * @requiredField tier\n * @permissionId LOYALTY.MANAGE_TIERS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created loyalty tier.\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.CreateTier\n */\n function createTier(tier: Tier$1): Promise;\n /**\n * Creates up to 20 tiers.\n *\n * The name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.\n * Attempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.\n *\n * To create a single tier, use [`createTier()`](#createtier).\n *\n * >**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.\n * @param tiers - Tiers to create.\n * @public\n * @requiredField tiers\n * @permissionId LOYALTY.MANAGE_TIERS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.BulkCreateTiers\n */\n function bulkCreateTiers(tiers: Tier$1[]): Promise;\n /**\n * Retrieves a loyalty tier.\n *\n * To retrieve a list of all of a site's tiers, use [`listTiers()`](#listtiers).\n * @param tierId - ID of the tier to retrieve.\n * @public\n * @requiredField tierId\n * @permissionId LOYALTY.READ_TIERS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Retrieved loyalty tier.\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.GetTier\n */\n function getTier(tierId: string): Promise;\n /**\n * Updates a loyalty tier.\n *\n * Use this endpoint to update tier-specific settings, such as the name and the required points\n * threshold of an individual loyalty tier. To update global settings that apply to all of a site's loyalty tiers,\n * use [`updateTiersProgramSettings()`](#updatetiersprogramsettings).\n * @param _id - Tier ID.\n * @public\n * @requiredField _id\n * @requiredField tier\n * @requiredField tier.revision\n * @param tier - Tier info to update.\n * @permissionId LOYALTY.MANAGE_TIERS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated loyalty tier.\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.UpdateTier\n */\n function updateTier(_id: string | null, tier: UpdateTier): Promise;\n interface UpdateTier {\n /**\n * Tier ID.\n * @readonly\n */\n _id?: string | null;\n /** Information about the tier. */\n tierDefinition?: TierDefinition$1;\n /** The amount of points required to be in this tier. */\n requiredPoints?: number;\n /**\n * Revision number, which increments by 1 each time the loyalty tier is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty tier.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the tier was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the tier was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n /**\n * Deletes a loyalty tier.\n * @param tierId - ID of the tier to delete.\n * @param revision - Current `revision` of the tier to delete.\n * @public\n * @requiredField revision\n * @requiredField tierId\n * @permissionId LOYALTY.MANAGE_TIERS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.DeleteTier\n */\n function deleteTier(tierId: string, revision: string): Promise;\n /**\n * Retrieves a list of a site's tiers.\n *\n * To retrieve a specific tier, use [`getTier()`](#gettier).\n * @public\n * @permissionId LOYALTY.READ_TIERS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.ListTiers\n */\n function listTiers(): Promise;\n /**\n * Create tiers program settings.\n *\n * Tiers program settings apply globally to all tiers in the program.\n * @param programSettings - Tiers program settings.\n * @public\n * @requiredField programSettings\n * @permissionId LOYALTY.MANAGE_TIERS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.CreateTiersProgramSettings\n */\n function createTiersProgramSettings(programSettings: TiersProgramSettings$1): Promise;\n /**\n * Returns `Tiers` and `ProgramSettings` in a single response.\n *\n * If `TiersProgramSettings` doesn't exist, default `TiersProgramSettings` are created.\n * @public\n * @permissionId LOYALTY.READ_TIERS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.GetTiersProgram\n */\n function getTiersProgram(): Promise;\n /**\n * Retrieves the settings for the tiers program.\n *\n * Tiers program settings apply globally to all tiers in the program.\n * @public\n * @permissionId LOYALTY.READ_TIERS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.GetTiersProgramSettings\n */\n function getTiersProgramSettings(): Promise;\n /**\n * Updates the global settings of a loyalty tier program.\n *\n * Use this endpoint to update settings that apply to all of a site's loyalty tiers.\n * To update tier-specific settings for an individual tier, use\n * [`updateTier()`](#updatetier).\n *\n * By default, the `status` of a tiers program is set to `\"DISABLED\"` and must be manually updated to `\"ACTIVE\"` using\n * this endpoint or through a site owner's [dashboard](https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).\n *\n * >**Note:** The `status`, `revision`, and `rollingWindow` parameters must be passed to update the tiers program settings. The `baseTierDefinition` fields are not required, however, if you don't pass them they will reset to their default values of empty fields.\n * @param programSettings - Settings for the tiers program.\n * @public\n * @requiredField programSettings\n * @requiredField programSettings.revision\n * @requiredField programSettings.status\n * @permissionId LOYALTY.MANAGE_TIERS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.loyalty.tier.LoyaltyTiers.UpdateTiersProgramSettings\n */\n function updateTiersProgramSettings(programSettings: TiersProgramSettings$1): Promise;\n type loyaltyV1TierTiers_universal_d_CreateTierRequest = CreateTierRequest;\n type loyaltyV1TierTiers_universal_d_CreateTierResponse = CreateTierResponse;\n type loyaltyV1TierTiers_universal_d_BulkCreateTiersRequest = BulkCreateTiersRequest;\n type loyaltyV1TierTiers_universal_d_BulkCreateTiersResponse = BulkCreateTiersResponse;\n type loyaltyV1TierTiers_universal_d_BulkTierResult = BulkTierResult;\n type loyaltyV1TierTiers_universal_d_GetTierRequest = GetTierRequest;\n type loyaltyV1TierTiers_universal_d_GetTierResponse = GetTierResponse;\n type loyaltyV1TierTiers_universal_d_UpdateTierRequest = UpdateTierRequest;\n type loyaltyV1TierTiers_universal_d_UpdateTierResponse = UpdateTierResponse;\n type loyaltyV1TierTiers_universal_d_TierRequiredPointsChanged = TierRequiredPointsChanged;\n type loyaltyV1TierTiers_universal_d_DeleteTierRequest = DeleteTierRequest;\n type loyaltyV1TierTiers_universal_d_DeleteTierResponse = DeleteTierResponse;\n type loyaltyV1TierTiers_universal_d_ListTiersRequest = ListTiersRequest;\n type loyaltyV1TierTiers_universal_d_ListTiersResponse = ListTiersResponse;\n type loyaltyV1TierTiers_universal_d_CreateTiersProgramSettingsRequest = CreateTiersProgramSettingsRequest;\n type loyaltyV1TierTiers_universal_d_CreateTiersProgramSettingsResponse = CreateTiersProgramSettingsResponse;\n type loyaltyV1TierTiers_universal_d_GetTiersProgramRequest = GetTiersProgramRequest;\n type loyaltyV1TierTiers_universal_d_GetTiersProgramResponse = GetTiersProgramResponse;\n type loyaltyV1TierTiers_universal_d_GetTiersProgramSettingsRequest = GetTiersProgramSettingsRequest;\n type loyaltyV1TierTiers_universal_d_GetTiersProgramSettingsResponse = GetTiersProgramSettingsResponse;\n type loyaltyV1TierTiers_universal_d_UpdateTiersProgramSettingsRequest = UpdateTiersProgramSettingsRequest;\n type loyaltyV1TierTiers_universal_d_UpdateTiersProgramSettingsResponse = UpdateTiersProgramSettingsResponse;\n type loyaltyV1TierTiers_universal_d_RecalculateAllTiersRequest = RecalculateAllTiersRequest;\n type loyaltyV1TierTiers_universal_d_RecalculateAllTiersResponse = RecalculateAllTiersResponse;\n type loyaltyV1TierTiers_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type loyaltyV1TierTiers_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type loyaltyV1TierTiers_universal_d_Asset = Asset;\n type loyaltyV1TierTiers_universal_d_State = State;\n const loyaltyV1TierTiers_universal_d_State: typeof State;\n type loyaltyV1TierTiers_universal_d_SiteCreated = SiteCreated;\n type loyaltyV1TierTiers_universal_d_SiteCreatedContext = SiteCreatedContext;\n const loyaltyV1TierTiers_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type loyaltyV1TierTiers_universal_d_Namespace = Namespace;\n const loyaltyV1TierTiers_universal_d_Namespace: typeof Namespace;\n type loyaltyV1TierTiers_universal_d_SiteTransferred = SiteTransferred;\n type loyaltyV1TierTiers_universal_d_SiteDeleted = SiteDeleted;\n type loyaltyV1TierTiers_universal_d_DeleteContext = DeleteContext;\n type loyaltyV1TierTiers_universal_d_DeleteStatus = DeleteStatus;\n const loyaltyV1TierTiers_universal_d_DeleteStatus: typeof DeleteStatus;\n type loyaltyV1TierTiers_universal_d_SiteUndeleted = SiteUndeleted;\n type loyaltyV1TierTiers_universal_d_SitePublished = SitePublished;\n type loyaltyV1TierTiers_universal_d_SiteUnpublished = SiteUnpublished;\n type loyaltyV1TierTiers_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type loyaltyV1TierTiers_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type loyaltyV1TierTiers_universal_d_ServiceProvisioned = ServiceProvisioned;\n type loyaltyV1TierTiers_universal_d_ServiceRemoved = ServiceRemoved;\n type loyaltyV1TierTiers_universal_d_SiteRenamed = SiteRenamed;\n type loyaltyV1TierTiers_universal_d_SiteHardDeleted = SiteHardDeleted;\n type loyaltyV1TierTiers_universal_d_NamespaceChanged = NamespaceChanged;\n type loyaltyV1TierTiers_universal_d_StudioAssigned = StudioAssigned;\n type loyaltyV1TierTiers_universal_d_StudioUnassigned = StudioUnassigned;\n const loyaltyV1TierTiers_universal_d_createTier: typeof createTier;\n const loyaltyV1TierTiers_universal_d_bulkCreateTiers: typeof bulkCreateTiers;\n const loyaltyV1TierTiers_universal_d_getTier: typeof getTier;\n const loyaltyV1TierTiers_universal_d_updateTier: typeof updateTier;\n type loyaltyV1TierTiers_universal_d_UpdateTier = UpdateTier;\n const loyaltyV1TierTiers_universal_d_deleteTier: typeof deleteTier;\n const loyaltyV1TierTiers_universal_d_listTiers: typeof listTiers;\n const loyaltyV1TierTiers_universal_d_createTiersProgramSettings: typeof createTiersProgramSettings;\n const loyaltyV1TierTiers_universal_d_getTiersProgram: typeof getTiersProgram;\n const loyaltyV1TierTiers_universal_d_getTiersProgramSettings: typeof getTiersProgramSettings;\n const loyaltyV1TierTiers_universal_d_updateTiersProgramSettings: typeof updateTiersProgramSettings;\n namespace loyaltyV1TierTiers_universal_d {\n export { Tier$1 as Tier, TierDefinition$1 as TierDefinition, FocalPoint$1 as FocalPoint, TiersProgramSettingsChanged$1 as TiersProgramSettingsChanged, TiersProgramSettings$1 as TiersProgramSettings, TiersProgramSettingsPeriodOneOf$1 as TiersProgramSettingsPeriodOneOf, Status$2 as Status, RollingWindow$1 as RollingWindow, TiersRollingUpdate$1 as TiersRollingUpdate, loyaltyV1TierTiers_universal_d_CreateTierRequest as CreateTierRequest, loyaltyV1TierTiers_universal_d_CreateTierResponse as CreateTierResponse, loyaltyV1TierTiers_universal_d_BulkCreateTiersRequest as BulkCreateTiersRequest, loyaltyV1TierTiers_universal_d_BulkCreateTiersResponse as BulkCreateTiersResponse, loyaltyV1TierTiers_universal_d_BulkTierResult as BulkTierResult, ItemMetadata$2 as ItemMetadata, ApplicationError$2 as ApplicationError, BulkActionMetadata$2 as BulkActionMetadata, loyaltyV1TierTiers_universal_d_GetTierRequest as GetTierRequest, loyaltyV1TierTiers_universal_d_GetTierResponse as GetTierResponse, loyaltyV1TierTiers_universal_d_UpdateTierRequest as UpdateTierRequest, loyaltyV1TierTiers_universal_d_UpdateTierResponse as UpdateTierResponse, loyaltyV1TierTiers_universal_d_TierRequiredPointsChanged as TierRequiredPointsChanged, loyaltyV1TierTiers_universal_d_DeleteTierRequest as DeleteTierRequest, loyaltyV1TierTiers_universal_d_DeleteTierResponse as DeleteTierResponse, loyaltyV1TierTiers_universal_d_ListTiersRequest as ListTiersRequest, loyaltyV1TierTiers_universal_d_ListTiersResponse as ListTiersResponse, loyaltyV1TierTiers_universal_d_CreateTiersProgramSettingsRequest as CreateTiersProgramSettingsRequest, loyaltyV1TierTiers_universal_d_CreateTiersProgramSettingsResponse as CreateTiersProgramSettingsResponse, loyaltyV1TierTiers_universal_d_GetTiersProgramRequest as GetTiersProgramRequest, loyaltyV1TierTiers_universal_d_GetTiersProgramResponse as GetTiersProgramResponse, loyaltyV1TierTiers_universal_d_GetTiersProgramSettingsRequest as GetTiersProgramSettingsRequest, loyaltyV1TierTiers_universal_d_GetTiersProgramSettingsResponse as GetTiersProgramSettingsResponse, loyaltyV1TierTiers_universal_d_UpdateTiersProgramSettingsRequest as UpdateTiersProgramSettingsRequest, loyaltyV1TierTiers_universal_d_UpdateTiersProgramSettingsResponse as UpdateTiersProgramSettingsResponse, loyaltyV1TierTiers_universal_d_RecalculateAllTiersRequest as RecalculateAllTiersRequest, loyaltyV1TierTiers_universal_d_RecalculateAllTiersResponse as RecalculateAllTiersResponse, loyaltyV1TierTiers_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, loyaltyV1TierTiers_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, loyaltyV1TierTiers_universal_d_Asset as Asset, loyaltyV1TierTiers_universal_d_State as State, loyaltyV1TierTiers_universal_d_SiteCreated as SiteCreated, loyaltyV1TierTiers_universal_d_SiteCreatedContext as SiteCreatedContext, loyaltyV1TierTiers_universal_d_Namespace as Namespace, loyaltyV1TierTiers_universal_d_SiteTransferred as SiteTransferred, loyaltyV1TierTiers_universal_d_SiteDeleted as SiteDeleted, loyaltyV1TierTiers_universal_d_DeleteContext as DeleteContext, loyaltyV1TierTiers_universal_d_DeleteStatus as DeleteStatus, loyaltyV1TierTiers_universal_d_SiteUndeleted as SiteUndeleted, loyaltyV1TierTiers_universal_d_SitePublished as SitePublished, loyaltyV1TierTiers_universal_d_SiteUnpublished as SiteUnpublished, loyaltyV1TierTiers_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, loyaltyV1TierTiers_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, loyaltyV1TierTiers_universal_d_ServiceProvisioned as ServiceProvisioned, loyaltyV1TierTiers_universal_d_ServiceRemoved as ServiceRemoved, loyaltyV1TierTiers_universal_d_SiteRenamed as SiteRenamed, loyaltyV1TierTiers_universal_d_SiteHardDeleted as SiteHardDeleted, loyaltyV1TierTiers_universal_d_NamespaceChanged as NamespaceChanged, loyaltyV1TierTiers_universal_d_StudioAssigned as StudioAssigned, loyaltyV1TierTiers_universal_d_StudioUnassigned as StudioUnassigned, Empty$3 as Empty, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$3 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, MessageEnvelope$3 as MessageEnvelope, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, loyaltyV1TierTiers_universal_d_createTier as createTier, loyaltyV1TierTiers_universal_d_bulkCreateTiers as bulkCreateTiers, loyaltyV1TierTiers_universal_d_getTier as getTier, loyaltyV1TierTiers_universal_d_updateTier as updateTier, loyaltyV1TierTiers_universal_d_UpdateTier as UpdateTier, loyaltyV1TierTiers_universal_d_deleteTier as deleteTier, loyaltyV1TierTiers_universal_d_listTiers as listTiers, loyaltyV1TierTiers_universal_d_createTiersProgramSettings as createTiersProgramSettings, loyaltyV1TierTiers_universal_d_getTiersProgram as getTiersProgram, loyaltyV1TierTiers_universal_d_getTiersProgramSettings as getTiersProgramSettings, loyaltyV1TierTiers_universal_d_updateTiersProgramSettings as updateTiersProgramSettings, };\n }\n /**\n * A loyalty coupon is created when a customer redeems their loyalty points for a reward. Creating a loyalty coupon\n * also creates a corresponding \"reference\" coupon with the [Coupons API](https://dev.wix.com/api/rest/coupons/about-wix-coupons).\n */\n interface LoyaltyCoupon {\n /**\n * Loyalty coupon ID.\n * @readonly\n */\n _id?: string;\n /**\n * [Loyalty account ID](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/account-object) of the customer that redeemed points for a coupon.\n * @readonly\n */\n accountId?: string;\n /**\n * [Member ID](https://dev.wix.com/api/rest/members/members/member-object) of the customer that redeemed points for a coupon.\n * @readonly\n * @deprecated [Member ID](https://dev.wix.com/api/rest/members/members/member-object) of the customer that redeemed points for a coupon.\n * @replacedBy member_id\n * @targetRemovalDate 2024-06-01\n */\n memberIdDeprecated?: string;\n /**\n * [Member ID](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object) of the customer that redeemed points for a coupon.\n * @readonly\n */\n memberId?: string | null;\n /**\n * Transaction ID for the transaction that created a coupon.\n * @readonly\n */\n transactionId?: string | null;\n /**\n * Reference coupon information for the corresponding [coupon](https://dev.wix.com/api/rest/coupons/about-wix-coupons)\n * that is created along with the loyalty coupon.\n * @readonly\n */\n couponReference?: CouponReference;\n /**\n * Loyalty coupon status.\n *\n * This status relates to the corresponding coupon that is created\n * at the same time as the loyalty coupon and is included in `couponReference`.\n *\n * + `ACTIVE`: The reference coupon is active and available to the customer.\n * + `APPLIED`: The reference coupon was applied and is no longer available for use.\n * + `ARCHIVED`: The reference coupon was deleted.\n * + `FAILED`: The reference coupon was created but something went wrong when redeeming points from the loyalty account.\n * + `PENDING`: The refence coupon was created but the loyalty points have not been redeemed yet.\n * @readonly\n */\n status?: Status$1;\n /**\n * Name of reward that was redeemed to create this coupon.\n * @readonly\n */\n rewardName?: string;\n /**\n * Revision number, which increments by 1 each time the loyalty coupon is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty coupon.\n */\n revision?: string | null;\n /**\n * Date and time the loyalty coupon was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the loyalty coupon was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface CouponReference {\n /**\n * Coupon ID.\n * @readonly\n */\n couponId?: string;\n /**\n * Coupon code.\n *\n * Unique code entered by a customer to apply the coupon.\n * @readonly\n */\n code?: string;\n /**\n * Name of coupon.\n * @readonly\n */\n name?: string | null;\n /**\n * The information to use when creating the coupon.\n * @readonly\n */\n specification?: Specification;\n /**\n * Whether the referenced coupon was deleted.\n * @readonly\n */\n deleted?: boolean | null;\n }\n interface Specification extends SpecificationTypeDetailsOneOf, SpecificationScopeOrMinSubtotalOneOf {\n /** Fixed price discount. */\n moneyOffAmount?: number;\n /** Discount as a percentage. */\n percentOffRate?: number;\n /** Free shipping. If true, the coupon applies to all items in all `namespaces` in the site. */\n freeShipping?: boolean;\n /** Specific sale price. Currently only supported for coupons with a `stores` `namespace`. */\n fixedPriceAmount?: number;\n /**\n * Free products when making a purchase. `buyXGetY` is an object that specifies `x` and `y` in the\n * following scenario: if a visitor purchases x number of products, they receive y number of products for free. C\n * urrently only supported for coupons with a `stores` `namespace`.\n */\n buyXGetY?: BuyXGetY;\n /**\n * Scope of the coupon. When no scope is defined, the coupon applies to all\n * items in all `namespaces` in the site.\n */\n scope?: Scope;\n /** The coupon is only applicable when the order subtotal is over this amount. */\n minimumSubtotal?: number | null;\n /** Name of coupon. */\n name?: string | null;\n type?: Type;\n /**\n * Whether the coupon is limited to 1 discount per order. If true and a customer pays for multiple items\n * that the coupon applies to, only the lowest priced item is discounted.\n * Coupons with a `bookings` `namespace` are always limited to 1 item.\n */\n limitedToOneItem?: boolean | null;\n /** Whether the coupon also applies to subscriptions. */\n appliesToSubscriptions?: boolean | null;\n /**\n * Specifies the amount of cycles to apply the discount to for a subscription item.\n *\n * Can only be set when `appliesToSubscriptions` is `TRUE` and `specification.scope.namespace` is `pricingPlans`.\n * If `discountedCycleCount` is empty, the coupon applies to all available cycles.\n *\n * Min: `1`\n *\n * Max: `999`\n */\n discountedCycleCount?: number | null;\n }\n /** @oneof */\n interface SpecificationTypeDetailsOneOf {\n /** Fixed price discount. */\n moneyOffAmount?: number;\n /** Discount as a percentage. */\n percentOffRate?: number;\n /** Free shipping. If true, the coupon applies to all items in all `namespaces` in the site. */\n freeShipping?: boolean;\n /** Specific sale price. Currently only supported for coupons with a `stores` `namespace`. */\n fixedPriceAmount?: number;\n /**\n * Free products when making a purchase. `buyXGetY` is an object that specifies `x` and `y` in the\n * following scenario: if a visitor purchases x number of products, they receive y number of products for free. C\n * urrently only supported for coupons with a `stores` `namespace`.\n */\n buyXGetY?: BuyXGetY;\n }\n /** @oneof */\n interface SpecificationScopeOrMinSubtotalOneOf {\n /**\n * Scope of the coupon. When no scope is defined, the coupon applies to all\n * items in all `namespaces` in the site.\n */\n scope?: Scope;\n /** The coupon is only applicable when the order subtotal is over this amount. */\n minimumSubtotal?: number | null;\n }\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n MONEY_OFF_AMOUNT = \"MONEY_OFF_AMOUNT\",\n PERCENT_OFF_RATE = \"PERCENT_OFF_RATE\",\n FREE_SHIPPING = \"FREE_SHIPPING\",\n FIXED_PRICE_AMOUNT = \"FIXED_PRICE_AMOUNT\",\n BUY_X_GET_Y = \"BUY_X_GET_Y\"\n }\n interface BuyXGetY {\n /** Number of purchased items required to receive free items. */\n x?: number;\n /** Number of items received for free if required number of items were purchased. */\n y?: number;\n }\n interface Scope {\n /**\n * Group within a `namespace` for which the coupon is applicable.\n *\n * If no group is specified, the coupon applies to all items in the namespace.\n * `group` is required in some namespaces. See [Scope Values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values)\n * for a list of currently supported groups for each namespace.\n */\n name?: string | null;\n /**\n * ID of the specific entity in the group for which the coupon is applicable.\n *\n * If no `entityId` is specified, the coupon applies to all entities in the group. In some cases when a group is specified,\n * an `entityId` is required. See [Scope Values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values)\n * for a list of currently supported entities for each namespace and group.\n */\n entityId?: string | null;\n /**\n * Wix application for which the coupon is applicable.\n *\n * One of the following:\n * + `\"stores\"`\n * + `\"bookings\"`\n * + `\"events\"`\n * + `\"pricingPlans\"`\n */\n namespace?: string;\n }\n enum Status$1 {\n UNKNOWN = \"UNKNOWN\",\n /** coupon created but points haven't been redeemed yet (ideally coupons should stay in this state for a very short time (seconds/minutes)) */\n PENDING = \"PENDING\",\n /** coupon is active and can be applied */\n ACTIVE = \"ACTIVE\",\n /** coupon was already applied and can not be used anymore */\n APPLIED = \"APPLIED\",\n /** coupon was created but something went wrong when redeeming points from the account */\n FAILED = \"FAILED\",\n /** reference coupon was deleted */\n ARCHIVED = \"ARCHIVED\"\n }\n interface RedeemPointsForCouponRequest {\n /** ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem. */\n rewardId: string;\n /** ID of the [loyalty account](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/account-object) of the customer redeeming points. */\n loyaltyAccountId: string;\n }\n interface RedeemPointsForCouponResponse {\n /** Created loyalty coupon. */\n coupon?: LoyaltyCoupon;\n }\n interface RedeemCurrentMemberPointsForCouponRequest {\n /** ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem. */\n rewardId: string;\n }\n interface RedeemCurrentMemberPointsForCouponResponse {\n /** Created loyalty coupon. */\n coupon?: LoyaltyCoupon;\n }\n interface RedeemMemberPointsForDiscountAmountCouponRequest {\n /** ID of the [loyalty reward](https://dev.wix.com/api/rest/wix-loyalty-program/rewards) to redeem. */\n rewardId: string;\n /** Loyalty account id. */\n loyaltyAccountId: string;\n /** Number of points to redeem. */\n pointsToRedeem: number;\n /** Coupon specification. */\n specification: Specification;\n }\n interface RedeemMemberPointsForDiscountAmountCouponResponse {\n /** Created loyalty coupon. */\n coupon?: LoyaltyCoupon;\n /** Transaction id of the coupon redemption */\n transactionId?: string;\n }\n interface GetLoyaltyCouponRequest {\n /** ID of the loyalty coupon to retrieve. */\n loyaltyCouponId: string;\n }\n interface GetLoyaltyCouponResponse {\n /** Retrieved loyalty coupon. */\n loyaltyCoupon?: LoyaltyCoupon;\n }\n interface GetCurrentMemberCouponsRequest {\n }\n interface GetCurrentMemberCouponsResponse {\n /** Retrieved loyalty coupons. */\n loyaltyCoupons?: LoyaltyCoupon[];\n }\n interface QueryLoyaltyCouponRequest {\n /** Query options. */\n query: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$2[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$2;\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging$2 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryLoyaltyCouponResponse {\n /** Retrieved loyalty coupons. */\n loyaltyCoupons?: LoyaltyCoupon[];\n /** Metadata. */\n metadata?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$2;\n }\n interface Cursors$2 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryCouponTemplateRequest {\n /** Query options. */\n query: Query;\n }\n interface Query {\n /** Optional pagination parameters */\n paging?: V2Paging;\n /** Filter string (e.g., when {\"expired\":\"true\"}, expired coupons will be returned). */\n filter?: string | null;\n /** Sort string. */\n sort?: string | null;\n }\n interface V2Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Offset since the beginning of the collection. */\n offset?: number | null;\n }\n interface QueryCouponTemplateResponse {\n /** The retrieved CouponReferences */\n couponReferences?: CouponReference[];\n totalResults?: number | null;\n }\n interface DeleteLoyaltyCouponRequest {\n /** ID of the loyalty coupon to delete. */\n _id: string;\n /**\n * Revision number, which increments by 1 each time the loyalty coupon is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty coupon.\n */\n revision?: string;\n }\n interface DeleteLoyaltyCouponResponse {\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n }\n interface RestoreInfo$2 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$2 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$2 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface Empty$2 {\n }\n interface MessageEnvelope$2 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$2;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$2;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Redeems a customer's loyalty points for a loyalty reward and creates a loyalty coupon.\n *\n * Creating a loyalty coupon also creates a corresponding \"reference\" coupon with the [Coupons API](https://dev.wix.com/api/rest/coupons/about-wix-coupons).\n * The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon\n * are linked and the loyalty coupon's `status` reflects the current state of the reference coupon.\n *\n * Check which loyalty rewards a site has available with [List Rewards](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/list-rewards).\n * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.\n * @public\n * @requiredField options\n * @requiredField options.loyaltyAccountId\n * @requiredField rewardId\n * @adminMethod\n */\n function redeemPointsForCoupon(rewardId: string, options: RedeemPointsForCouponOptions): Promise;\n interface RedeemPointsForCouponOptions {\n /** ID of the [loyalty account](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/account-object) of the customer redeeming points. */\n loyaltyAccountId: string;\n }\n /**\n * Redeems a current customer's loyalty points for a loyalty reward and creates a loyalty coupon.\n *\n * Creating a loyalty coupon also creates a corresponding \"reference\" coupon with the [Coupons API](https://dev.wix.com/api/rest/coupons/about-wix-coupons).\n * The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon\n * are linked and the loyalty coupon's `status` reflects the current state of the reference coupon.\n *\n * Check which loyalty rewards a site has available with [List Rewards](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/list-rewards).\n * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.\n * @public\n * @requiredField rewardId\n * @applicableIdentity MEMBER\n */\n function redeemCurrentMemberPointsForCoupon(rewardId: string): Promise;\n interface RedeemMemberPointsForDiscountAmountCouponOptions {\n /** Loyalty account id. */\n loyaltyAccountId: string;\n /** Number of points to redeem. */\n pointsToRedeem: number;\n /** Coupon specification. */\n specification: Specification;\n }\n /**\n * Retrieves a loyalty coupon.\n * @param loyaltyCouponId - ID of the loyalty coupon to retrieve.\n * @public\n * @requiredField loyaltyCouponId\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved loyalty coupon.\n */\n function getLoyaltyCoupon(loyaltyCouponId: string): Promise;\n /**\n * Retrieves the loyalty coupons for the currently logged-in member.\n * @public\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n */\n function getCurrentMemberCoupons(): Promise;\n /**\n * Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.\n * @public\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryLoyaltyCoupons(): LoyaltyCouponsQueryBuilder;\n interface QueryCursorResult$2 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyCouponsQueryResult extends QueryCursorResult$2 {\n items: LoyaltyCoupon[];\n query: LoyaltyCouponsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LoyaltyCouponsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"accountId\" | \"memberId\" | \"transactionId\" | \"rewardName\", value: string) => LoyaltyCouponsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\", value: any[]) => LoyaltyCouponsQueryBuilder;\n in: (propertyName: \"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\", value: any) => LoyaltyCouponsQueryBuilder;\n exists: (propertyName: \"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\", value: boolean) => LoyaltyCouponsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\">) => LoyaltyCouponsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"accountId\" | \"memberId\" | \"transactionId\" | \"couponReference\" | \"status\" | \"rewardName\" | \"_createdDate\" | \"_updatedDate\">) => LoyaltyCouponsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => LoyaltyCouponsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => LoyaltyCouponsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Deletes a loyalty coupon.\n *\n * The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.\n * @param _id - ID of the loyalty coupon to delete.\n * @param revision - Revision number, which increments by 1 each time the loyalty coupon is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty coupon.\n * @public\n * @requiredField _id\n * @requiredField revision\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteLoyaltyCoupon(_id: string, revision: string): Promise;\n type loyaltyV1CouponCoupons_universal_d_LoyaltyCoupon = LoyaltyCoupon;\n type loyaltyV1CouponCoupons_universal_d_CouponReference = CouponReference;\n type loyaltyV1CouponCoupons_universal_d_Specification = Specification;\n type loyaltyV1CouponCoupons_universal_d_SpecificationTypeDetailsOneOf = SpecificationTypeDetailsOneOf;\n type loyaltyV1CouponCoupons_universal_d_SpecificationScopeOrMinSubtotalOneOf = SpecificationScopeOrMinSubtotalOneOf;\n type loyaltyV1CouponCoupons_universal_d_Type = Type;\n const loyaltyV1CouponCoupons_universal_d_Type: typeof Type;\n type loyaltyV1CouponCoupons_universal_d_BuyXGetY = BuyXGetY;\n type loyaltyV1CouponCoupons_universal_d_Scope = Scope;\n type loyaltyV1CouponCoupons_universal_d_RedeemPointsForCouponRequest = RedeemPointsForCouponRequest;\n type loyaltyV1CouponCoupons_universal_d_RedeemPointsForCouponResponse = RedeemPointsForCouponResponse;\n type loyaltyV1CouponCoupons_universal_d_RedeemCurrentMemberPointsForCouponRequest = RedeemCurrentMemberPointsForCouponRequest;\n type loyaltyV1CouponCoupons_universal_d_RedeemCurrentMemberPointsForCouponResponse = RedeemCurrentMemberPointsForCouponResponse;\n type loyaltyV1CouponCoupons_universal_d_RedeemMemberPointsForDiscountAmountCouponRequest = RedeemMemberPointsForDiscountAmountCouponRequest;\n type loyaltyV1CouponCoupons_universal_d_RedeemMemberPointsForDiscountAmountCouponResponse = RedeemMemberPointsForDiscountAmountCouponResponse;\n type loyaltyV1CouponCoupons_universal_d_GetLoyaltyCouponRequest = GetLoyaltyCouponRequest;\n type loyaltyV1CouponCoupons_universal_d_GetLoyaltyCouponResponse = GetLoyaltyCouponResponse;\n type loyaltyV1CouponCoupons_universal_d_GetCurrentMemberCouponsRequest = GetCurrentMemberCouponsRequest;\n type loyaltyV1CouponCoupons_universal_d_GetCurrentMemberCouponsResponse = GetCurrentMemberCouponsResponse;\n type loyaltyV1CouponCoupons_universal_d_QueryLoyaltyCouponRequest = QueryLoyaltyCouponRequest;\n type loyaltyV1CouponCoupons_universal_d_QueryLoyaltyCouponResponse = QueryLoyaltyCouponResponse;\n type loyaltyV1CouponCoupons_universal_d_QueryCouponTemplateRequest = QueryCouponTemplateRequest;\n type loyaltyV1CouponCoupons_universal_d_Query = Query;\n type loyaltyV1CouponCoupons_universal_d_V2Paging = V2Paging;\n type loyaltyV1CouponCoupons_universal_d_QueryCouponTemplateResponse = QueryCouponTemplateResponse;\n type loyaltyV1CouponCoupons_universal_d_DeleteLoyaltyCouponRequest = DeleteLoyaltyCouponRequest;\n type loyaltyV1CouponCoupons_universal_d_DeleteLoyaltyCouponResponse = DeleteLoyaltyCouponResponse;\n const loyaltyV1CouponCoupons_universal_d_redeemPointsForCoupon: typeof redeemPointsForCoupon;\n type loyaltyV1CouponCoupons_universal_d_RedeemPointsForCouponOptions = RedeemPointsForCouponOptions;\n const loyaltyV1CouponCoupons_universal_d_redeemCurrentMemberPointsForCoupon: typeof redeemCurrentMemberPointsForCoupon;\n type loyaltyV1CouponCoupons_universal_d_RedeemMemberPointsForDiscountAmountCouponOptions = RedeemMemberPointsForDiscountAmountCouponOptions;\n const loyaltyV1CouponCoupons_universal_d_getLoyaltyCoupon: typeof getLoyaltyCoupon;\n const loyaltyV1CouponCoupons_universal_d_getCurrentMemberCoupons: typeof getCurrentMemberCoupons;\n const loyaltyV1CouponCoupons_universal_d_queryLoyaltyCoupons: typeof queryLoyaltyCoupons;\n type loyaltyV1CouponCoupons_universal_d_LoyaltyCouponsQueryResult = LoyaltyCouponsQueryResult;\n type loyaltyV1CouponCoupons_universal_d_LoyaltyCouponsQueryBuilder = LoyaltyCouponsQueryBuilder;\n const loyaltyV1CouponCoupons_universal_d_deleteLoyaltyCoupon: typeof deleteLoyaltyCoupon;\n namespace loyaltyV1CouponCoupons_universal_d {\n export { loyaltyV1CouponCoupons_universal_d_LoyaltyCoupon as LoyaltyCoupon, loyaltyV1CouponCoupons_universal_d_CouponReference as CouponReference, loyaltyV1CouponCoupons_universal_d_Specification as Specification, loyaltyV1CouponCoupons_universal_d_SpecificationTypeDetailsOneOf as SpecificationTypeDetailsOneOf, loyaltyV1CouponCoupons_universal_d_SpecificationScopeOrMinSubtotalOneOf as SpecificationScopeOrMinSubtotalOneOf, loyaltyV1CouponCoupons_universal_d_Type as Type, loyaltyV1CouponCoupons_universal_d_BuyXGetY as BuyXGetY, loyaltyV1CouponCoupons_universal_d_Scope as Scope, Status$1 as Status, loyaltyV1CouponCoupons_universal_d_RedeemPointsForCouponRequest as RedeemPointsForCouponRequest, loyaltyV1CouponCoupons_universal_d_RedeemPointsForCouponResponse as RedeemPointsForCouponResponse, loyaltyV1CouponCoupons_universal_d_RedeemCurrentMemberPointsForCouponRequest as RedeemCurrentMemberPointsForCouponRequest, loyaltyV1CouponCoupons_universal_d_RedeemCurrentMemberPointsForCouponResponse as RedeemCurrentMemberPointsForCouponResponse, loyaltyV1CouponCoupons_universal_d_RedeemMemberPointsForDiscountAmountCouponRequest as RedeemMemberPointsForDiscountAmountCouponRequest, loyaltyV1CouponCoupons_universal_d_RedeemMemberPointsForDiscountAmountCouponResponse as RedeemMemberPointsForDiscountAmountCouponResponse, loyaltyV1CouponCoupons_universal_d_GetLoyaltyCouponRequest as GetLoyaltyCouponRequest, loyaltyV1CouponCoupons_universal_d_GetLoyaltyCouponResponse as GetLoyaltyCouponResponse, loyaltyV1CouponCoupons_universal_d_GetCurrentMemberCouponsRequest as GetCurrentMemberCouponsRequest, loyaltyV1CouponCoupons_universal_d_GetCurrentMemberCouponsResponse as GetCurrentMemberCouponsResponse, loyaltyV1CouponCoupons_universal_d_QueryLoyaltyCouponRequest as QueryLoyaltyCouponRequest, QueryV2$1 as QueryV2, QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf, Sorting$2 as Sorting, SortOrder$2 as SortOrder, Paging$1 as Paging, CursorPaging$2 as CursorPaging, loyaltyV1CouponCoupons_universal_d_QueryLoyaltyCouponResponse as QueryLoyaltyCouponResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$2 as Cursors, loyaltyV1CouponCoupons_universal_d_QueryCouponTemplateRequest as QueryCouponTemplateRequest, loyaltyV1CouponCoupons_universal_d_Query as Query, loyaltyV1CouponCoupons_universal_d_V2Paging as V2Paging, loyaltyV1CouponCoupons_universal_d_QueryCouponTemplateResponse as QueryCouponTemplateResponse, loyaltyV1CouponCoupons_universal_d_DeleteLoyaltyCouponRequest as DeleteLoyaltyCouponRequest, loyaltyV1CouponCoupons_universal_d_DeleteLoyaltyCouponResponse as DeleteLoyaltyCouponResponse, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, RestoreInfo$2 as RestoreInfo, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, Empty$2 as Empty, MessageEnvelope$2 as MessageEnvelope, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, loyaltyV1CouponCoupons_universal_d_redeemPointsForCoupon as redeemPointsForCoupon, loyaltyV1CouponCoupons_universal_d_RedeemPointsForCouponOptions as RedeemPointsForCouponOptions, loyaltyV1CouponCoupons_universal_d_redeemCurrentMemberPointsForCoupon as redeemCurrentMemberPointsForCoupon, loyaltyV1CouponCoupons_universal_d_RedeemMemberPointsForDiscountAmountCouponOptions as RedeemMemberPointsForDiscountAmountCouponOptions, loyaltyV1CouponCoupons_universal_d_getLoyaltyCoupon as getLoyaltyCoupon, loyaltyV1CouponCoupons_universal_d_getCurrentMemberCoupons as getCurrentMemberCoupons, loyaltyV1CouponCoupons_universal_d_queryLoyaltyCoupons as queryLoyaltyCoupons, loyaltyV1CouponCoupons_universal_d_LoyaltyCouponsQueryResult as LoyaltyCouponsQueryResult, loyaltyV1CouponCoupons_universal_d_LoyaltyCouponsQueryBuilder as LoyaltyCouponsQueryBuilder, loyaltyV1CouponCoupons_universal_d_deleteLoyaltyCoupon as deleteLoyaltyCoupon, };\n }\n /** Loyalty transaction. */\n interface LoyaltyTransaction extends LoyaltyTransactionTransactionTypeInfoOneOf {\n /** Information on points earned. */\n earnInfo?: EarnInfo;\n /** Information on points redeemed. */\n redeemInfo?: RedeemInfo;\n /** Information on points adjusted. */\n adjustInfo?: AdjustInfo;\n /** Information on points refunded. */\n refundInfo?: RefundInfo;\n /** Information on points expired. */\n expireInfo?: ExpireInfo;\n /** Transaction ID. */\n _id?: string | null;\n /** Account ID. */\n accountId?: string;\n /**\n * Date and time the transaction was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * The number of points earned, adjusted, redeemed, or expired in the transaction.\n *\n * + `EARN`: Number of points earned by the customer taking an action. Example: `20`\n * + `REDEEM`: The number of points redeemed by the customer for a reward. Example: `-50`\n * + `ADJUST`: The number of points refunded for a previously redeemed reward. Examples: `20`, `-30`\n * + `REFUND`: The number of points refunded for a previously redeemed reward. Example: `60`\n * + `EXPIRE`: The number of points that expired due to customer inactivity for a configured period. Example: `-70`\n */\n amount?: number;\n /**\n * Transaction types.\n *\n * + `EARN`: Number of points earned by the customer taking an action. See [Earn points](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/earn-points) for more information.\n * + `REDEEM`: The number of points redeemed by the customer for a reward.\n * + `ADJUST`: The number of points refunded for a previously redeemed reward. See [Adjust Points](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/adjust-points) for more information.\n * + `REFUND`: The number of points refunded for a previously redeemed reward.\n * + `EXPIRE`: The number of points that expired due to customer inactivity for a configured period.\n */\n transactionType?: TransactionType;\n /** Transaction description. */\n description?: string;\n /** Unique identifier, generated by the client. Used to recognize repeated attempts of the same request. Only present when manually adding points using the [Earn Points](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/earn-points) endpoint. */\n idempotencyKey?: string;\n }\n /** @oneof */\n interface LoyaltyTransactionTransactionTypeInfoOneOf {\n /** Information on points earned. */\n earnInfo?: EarnInfo;\n /** Information on points redeemed. */\n redeemInfo?: RedeemInfo;\n /** Information on points adjusted. */\n adjustInfo?: AdjustInfo;\n /** Information on points refunded. */\n refundInfo?: RefundInfo;\n /** Information on points expired. */\n expireInfo?: ExpireInfo;\n }\n enum TransactionType {\n UNKNOWN = \"UNKNOWN\",\n EARN = \"EARN\",\n REDEEM = \"REDEEM\",\n ADJUST = \"ADJUST\",\n REFUND = \"REFUND\",\n EXPIRE = \"EXPIRE\"\n }\n interface EarnInfo {\n /**\n * ID of the the app responsible for providing the earning points data.\n * @readonly\n */\n appId?: string;\n /** Activity type. */\n activityType?: string;\n /** Order ID. */\n orderId?: string | null;\n }\n interface RedeemInfo {\n /**\n * ID of the reward that was redeemed.\n * @readonly\n */\n rewardId?: string;\n /**\n * Type of reward that was redeemed.\n * @readonly\n */\n rewardType?: string | null;\n /**\n * ID of the specific item that was redeemed in this transaction.\n *\n * Each reward that is redeemed has a unique `referenceEntityId`.\n * @readonly\n */\n referenceEntityId?: string | null;\n }\n interface AdjustInfo {\n /**\n * App ID of application that initiated this points adjust.\n * @readonly\n */\n appId?: string;\n /** Amount before adjust. */\n amountBefore?: number;\n /** Amount after adjust. */\n amountAfter?: number;\n }\n interface RefundInfo {\n /**\n * ID of the app responsible for providing the refund points data.\n * @readonly\n */\n appId?: string;\n /**\n * ID of the transaction that was refunded.\n * @readonly\n */\n refundedTransactionId?: string | null;\n }\n interface ExpireInfo {\n /** Amount before expiration. */\n amountBefore?: number;\n /** Amount after expiration. */\n amountAfter?: number;\n }\n interface CreateLoyaltyTransactionRequest {\n /** LoyaltyTransaction to be created. */\n loyaltyTransaction: LoyaltyTransaction;\n }\n interface CreateLoyaltyTransactionResponse {\n /** The created LoyaltyTransaction. */\n loyaltyTransaction?: LoyaltyTransaction;\n }\n interface BulkCreateLoyaltyTransactionsRequest {\n /** Transactions to create. */\n loyaltyTransactions?: LoyaltyTransaction[];\n /** Determines if entities must be returned in response. */\n returnEntity?: boolean;\n }\n interface BulkCreateLoyaltyTransactionsResponse {\n /** Results of bulk creation. */\n results?: BulkLoyaltyTransactionResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface ItemMetadata$1 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$1;\n }\n interface ApplicationError$1 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkLoyaltyTransactionResult {\n /** Individual loyalty transaction metadata. */\n itemMetadata?: ItemMetadata$1;\n /** Only exists if `returnEntity` was set to true in the request. */\n item?: LoyaltyTransaction;\n }\n interface BulkActionMetadata$1 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetLoyaltyTransactionRequest {\n /** ID of the loyalty transaction to be retrieved. */\n loyaltyTransactionId: string;\n }\n interface GetLoyaltyTransactionResponse {\n /** Requested `Loyalty Transaction` object. */\n loyaltyTransaction?: LoyaltyTransaction;\n }\n interface QueryLoyaltyTransactionsRequest {\n /** Loyalty transaction query parameters. */\n query?: CursorQuery$1;\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging$1;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting$1[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$1 {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging$1;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$1 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryLoyaltyTransactionsResponse {\n /** List of loyalty transactions. */\n loyaltyTransactions?: LoyaltyTransaction[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$1;\n }\n interface CursorPagingMetadata$1 {\n /** Number of items returned in current page. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors$1;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface Empty$1 {\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface BulkCreateLoyaltyTransactionsOptions {\n /** Transactions to create. */\n loyaltyTransactions?: LoyaltyTransaction[];\n /** Determines if entities must be returned in response. */\n returnEntity?: boolean;\n }\n /**\n * Retrieves a transaction.\n * @param loyaltyTransactionId - ID of the loyalty transaction to be retrieved.\n * @public\n * @documentationMaturity preview\n * @requiredField loyaltyTransactionId\n * @permissionId LOYALTY.READ_TRANSACTIONS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Requested `Loyalty Transaction` object.\n */\n function getLoyaltyTransaction(loyaltyTransactionId: string): Promise;\n /**\n * Retrieves a list of loyalty transactions, given the provided [paging, filtering, and sorting][1].\n *\n * Supported fields for filtering and sorting:\n * `id`, `accountId`, `idempotencyKey`, `transactionType`, `amount`, `description`\n *\n * To learn how to query Loyalty Transactions, see [API Query Language][2].\n *\n * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging\n * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionId LOYALTY.READ_TRANSACTIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryLoyaltyTransactions(): LoyaltyTransactionsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyTransactionsQueryResult extends QueryCursorResult$1 {\n items: LoyaltyTransaction[];\n query: LoyaltyTransactionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LoyaltyTransactionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"amount\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"amount\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"amount\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"amount\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"accountId\" | \"description\" | \"idempotencyKey\", value: string) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\", value: any[]) => LoyaltyTransactionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\", value: any) => LoyaltyTransactionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\", value: boolean) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\">) => LoyaltyTransactionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"accountId\" | \"amount\" | \"transactionType\" | \"description\" | \"idempotencyKey\">) => LoyaltyTransactionsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => LoyaltyTransactionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => LoyaltyTransactionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransaction = LoyaltyTransaction;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransactionTransactionTypeInfoOneOf = LoyaltyTransactionTransactionTypeInfoOneOf;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_TransactionType = TransactionType;\n const loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_TransactionType: typeof TransactionType;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_EarnInfo = EarnInfo;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_RedeemInfo = RedeemInfo;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_AdjustInfo = AdjustInfo;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_RefundInfo = RefundInfo;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_ExpireInfo = ExpireInfo;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_CreateLoyaltyTransactionRequest = CreateLoyaltyTransactionRequest;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_CreateLoyaltyTransactionResponse = CreateLoyaltyTransactionResponse;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkCreateLoyaltyTransactionsRequest = BulkCreateLoyaltyTransactionsRequest;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkCreateLoyaltyTransactionsResponse = BulkCreateLoyaltyTransactionsResponse;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkLoyaltyTransactionResult = BulkLoyaltyTransactionResult;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_GetLoyaltyTransactionRequest = GetLoyaltyTransactionRequest;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_GetLoyaltyTransactionResponse = GetLoyaltyTransactionResponse;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_QueryLoyaltyTransactionsRequest = QueryLoyaltyTransactionsRequest;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_QueryLoyaltyTransactionsResponse = QueryLoyaltyTransactionsResponse;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkCreateLoyaltyTransactionsOptions = BulkCreateLoyaltyTransactionsOptions;\n const loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_getLoyaltyTransaction: typeof getLoyaltyTransaction;\n const loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_queryLoyaltyTransactions: typeof queryLoyaltyTransactions;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransactionsQueryResult = LoyaltyTransactionsQueryResult;\n type loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransactionsQueryBuilder = LoyaltyTransactionsQueryBuilder;\n namespace loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d {\n export { loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransaction as LoyaltyTransaction, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransactionTransactionTypeInfoOneOf as LoyaltyTransactionTransactionTypeInfoOneOf, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_TransactionType as TransactionType, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_EarnInfo as EarnInfo, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_RedeemInfo as RedeemInfo, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_AdjustInfo as AdjustInfo, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_RefundInfo as RefundInfo, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_ExpireInfo as ExpireInfo, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_CreateLoyaltyTransactionRequest as CreateLoyaltyTransactionRequest, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_CreateLoyaltyTransactionResponse as CreateLoyaltyTransactionResponse, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkCreateLoyaltyTransactionsRequest as BulkCreateLoyaltyTransactionsRequest, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkCreateLoyaltyTransactionsResponse as BulkCreateLoyaltyTransactionsResponse, ItemMetadata$1 as ItemMetadata, ApplicationError$1 as ApplicationError, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkLoyaltyTransactionResult as BulkLoyaltyTransactionResult, BulkActionMetadata$1 as BulkActionMetadata, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_GetLoyaltyTransactionRequest as GetLoyaltyTransactionRequest, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_GetLoyaltyTransactionResponse as GetLoyaltyTransactionResponse, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_QueryLoyaltyTransactionsRequest as QueryLoyaltyTransactionsRequest, CursorQuery$1 as CursorQuery, CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, Sorting$1 as Sorting, SortOrder$1 as SortOrder, CursorPaging$1 as CursorPaging, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_QueryLoyaltyTransactionsResponse as QueryLoyaltyTransactionsResponse, CursorPagingMetadata$1 as CursorPagingMetadata, Cursors$1 as Cursors, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, Empty$1 as Empty, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_BulkCreateLoyaltyTransactionsOptions as BulkCreateLoyaltyTransactionsOptions, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_getLoyaltyTransaction as getLoyaltyTransaction, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_queryLoyaltyTransactions as queryLoyaltyTransactions, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransactionsQueryResult as LoyaltyTransactionsQueryResult, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d_LoyaltyTransactionsQueryBuilder as LoyaltyTransactionsQueryBuilder, };\n }\n /**\n * A loyalty account stores a customer's loyalty points balance. A site's customers can earn points to their account\n * and redeem those points for rewards.\n */\n interface LoyaltyAccount {\n /**\n * Account ID.\n * @readonly\n */\n _id?: string;\n /**\n * Account owner's contact ID. See the [Contacts API](wix-crm-backend/contacts) to learn more.\n * @readonly\n */\n contactId?: string;\n /**\n * Account owner's member ID. See the [Members API](wix-members-backend/introduction) to learn more.\n * @readonly\n */\n memberId?: string | null;\n /**\n * Information about the account totals.\n * @readonly\n */\n points?: Points;\n /**\n * Whether the account has a reward available. `true` if the amount of points in `points.balance` are enough to redeem for a reward.\n * @readonly\n */\n rewardAvailable?: boolean;\n /**\n * Date and time the account was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the account was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Account's last activity date and time.\n * @readonly\n */\n lastActivityDate?: Date | null;\n /**\n * Revision number, which increments by 1 each time the loyalty account is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty account.\n *\n * Ignored when creating an account.\n */\n revision?: string;\n /**\n * Tier information.\n * @readonly\n */\n tier?: Tier;\n /**\n * Contact information.\n * @readonly\n */\n contact?: Contact;\n /**\n * Points expiration information\n * @readonly\n */\n pointsExpiration?: PointsExpiration;\n }\n interface Points {\n /**\n * Current point balance.\n *\n * Equal to the sum of `earned` and `adjusted` points, minus `redeemed` points.\n * @readonly\n */\n balance?: number;\n /**\n * Total earned points.\n * @readonly\n */\n earned?: number;\n /**\n * Total adjusted points.\n * @readonly\n */\n adjusted?: number;\n /**\n * Total redeemed points.\n * @readonly\n */\n redeemed?: number;\n /**\n * Total expired points.\n * @readonly\n */\n expired?: number;\n }\n /**\n * Tier information.\n *\n * The Tiers API is currently unavailable, but the program may be activated and managed from a site's\n * [loyalty dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/).\n */\n interface Tier {\n /**\n * Tier ID.\n *\n * This field will not be returned if the account belongs to the base tier.\n * @readonly\n */\n _id?: string | null;\n /**\n * Date and time the tier information was last recalculated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Points earned and adjusted over the tier's current rolling window.\n * @readonly\n */\n points?: number;\n }\n /** Loyalty account's contact information */\n interface Contact {\n /**\n * Contact ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Contact's first and last name.\n * @readonly\n */\n name?: string | null;\n /**\n * Contact's profile picture.\n * @readonly\n */\n picture?: Image;\n /**\n * Contact's email addresses.\n * @readonly\n */\n email?: string | null;\n /**\n * Contact's first and last name. If no name is provided, uses contact's email.\n * @readonly\n */\n displayName?: string | null;\n }\n interface Image {\n /** WixMedia image ID. */\n _id?: string;\n /** Image URL. */\n url?: string;\n /**\n * Original image height.\n * @readonly\n */\n height?: number;\n /**\n * Original image width.\n * @readonly\n */\n width?: number;\n }\n interface PointsExpiration {\n /**\n * Date at which points are expiring.\n * @readonly\n */\n expirationDate?: Date | null;\n /**\n * Amount of points that are going to expire at that date.\n * @readonly\n */\n expiringPointsAmount?: number;\n }\n interface RewardAvailabilityUpdated {\n /** True if rewards is available. */\n rewardAvailable?: boolean;\n /** Source of this change. */\n updateTrigger?: UpdateTrigger;\n }\n enum UpdateTrigger {\n /** Undefined trigger. */\n UNDEFINED = \"UNDEFINED\",\n /** Reward was updated. */\n REWARD_UPDATED = \"REWARD_UPDATED\",\n /** Balance was updated. */\n BALANCE_UPDATED = \"BALANCE_UPDATED\",\n /** Tiers were recalculated. */\n TIERS_RECALCULATED = \"TIERS_RECALCULATED\"\n }\n interface CreateAccountRequest {\n /**\n * Contact ID for a Wix site contact. See the [Contacts API](wix-crm-backend/contacts) to learn more.\n *\n */\n contactId: string;\n }\n interface CreateAccountResponse {\n /** Created loyalty account. */\n account?: LoyaltyAccount;\n }\n interface EarnPointsRequest extends EarnPointsRequestActivityDetailsOneOf {\n /** Followed social media details. */\n followedSocialMedia?: FollowedSocialMedia;\n /** Loyalty account ID. */\n accountId: string;\n /**\n * Amount of points to earn. Must be a positive, whole number.\n *\n * Min: `1`\n *\n * Max: `9999999`\n */\n amount?: number;\n /**\n * Description of how the points were earned.\n *\n * Max: 100 characters\n */\n description?: string;\n /**\n * ID of the app that initiated the transaction.\n *\n * If points were earned manually, then the `appId` is the Loyalty app's\n * `wixAppId` of `553c79f3-5625-4f38-b14b-ef7c0d1e87df`. If points were earned in an automatic event,\n * then the `appId` is from that automation's `sourceAppId`.\n */\n appId: string;\n /**\n * Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request.\n *\n * Please use `GUID` format.\n */\n idempotencyKey: string;\n /**\n * Activity type.\n *\n * If points were earned through automation it should be set to trigger key.\n */\n activityType?: string | null;\n /** Order id which was source of this transaction. */\n orderId?: string | null;\n }\n /** @oneof */\n interface EarnPointsRequestActivityDetailsOneOf {\n /** Followed social media details. */\n followedSocialMedia?: FollowedSocialMedia;\n }\n interface FollowedSocialMedia {\n /**\n * Social media channel.\n * Example: `FACEBOOK`, `INSTAGRAM`.\n */\n channel?: string;\n }\n interface EarnPointsResponse {\n /** Updated loyalty account. */\n account?: LoyaltyAccount;\n /**\n * Transaction ID associated with the points earned.\n * @readonly\n */\n transactionId?: string;\n }\n interface PointsUpdated {\n /** Updated account. */\n account?: LoyaltyAccount;\n }\n interface FirstTransaction {\n /** Updated account. */\n account?: LoyaltyAccount;\n }\n interface AdjustPointsRequest extends AdjustPointsRequestTypeOneOf {\n /**\n * Sets the account's point balance to this amount. Must be a positive, whole number or zero.\n *\n * The net difference between this new balance and the previous balance will be reflected in the `adjusted` field of the customer's account.\n *\n * Min: `0`\n *\n * Max: `999999999`\n */\n balance?: number;\n /**\n * Adjusts the account's point balance by this amount. Must be a whole number with a maximum of 7 digits.\n * The amount can be negative, but cannot be `0`.\n *\n * Min: `-9999999`\n *\n * Max: `9999999`\n */\n amount?: number;\n /** Loyalty account ID. */\n accountId: string;\n /** Description to explain the reason for the points adjustment. */\n description?: string | null;\n /**\n * Each time the loyalty account is updated, `revision` increments by 1.\n *\n * The current `revision` must be passed when adjusting points in the loyalty account. This\n * ensures you're working with the latest version of the loyalty account and prevents unintended overwrites.\n */\n revision?: string;\n }\n /** @oneof */\n interface AdjustPointsRequestTypeOneOf {\n /**\n * Sets the account's point balance to this amount. Must be a positive, whole number or zero.\n *\n * The net difference between this new balance and the previous balance will be reflected in the `adjusted` field of the customer's account.\n *\n * Min: `0`\n *\n * Max: `999999999`\n */\n balance?: number;\n /**\n * Adjusts the account's point balance by this amount. Must be a whole number with a maximum of 7 digits.\n * The amount can be negative, but cannot be `0`.\n *\n * Min: `-9999999`\n *\n * Max: `9999999`\n */\n amount?: number;\n }\n interface AdjustPointsResponse {\n /** Adjusted loyalty account. */\n account?: LoyaltyAccount;\n /**\n * Transaction ID associated with the points adjustment.\n * @readonly\n */\n transactionId?: string;\n }\n interface RedeemPointsRequest {\n /** Loyalty account ID. */\n accountId: string;\n /** Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details. */\n rewardId: string;\n /** Number of times the given reward will be redeemed. Must be a positive whole number. */\n count?: number;\n /**\n * Revision number, which increments by 1 each time points are redeemed.\n * To prevent conflicting changes, the existing `revision` must be used when redeeming points.\n */\n revision?: string;\n /** Id of the entity that is being redeemed (e.g. orderId for order discount, couponId for coupon reward). */\n referenceEntityId?: string | null;\n }\n interface RedeemPointsResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n /**\n * Transaction ID associated with the redemption.\n * @readonly\n */\n transactionId?: string;\n }\n interface RedeemDeterminedAmountOfPointsRequest {\n /** Loyalty account ID. */\n accountId: string;\n /** Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details. */\n rewardId: string;\n /** Number of points to be redeemed off the account. */\n points?: number;\n /**\n * Revision number, which increments by 1 each time points are redeemed.\n * To prevent conflicting changes, the existing `revision` must be used when redeeming points.\n */\n revision?: string;\n /** Id of the entity that is being redeemed (e.g. orderId for order discount, couponId for coupon reward). */\n referenceEntityId?: string | null;\n }\n interface RedeemDeterminedAmountOfPointsResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n /**\n * Transaction ID associated with the redemption.\n * @readonly\n */\n transactionId?: string;\n }\n interface RefundTransactionRequest {\n /**\n * Transaction ID associated with the refund.\n * @readonly\n */\n transactionId: string;\n }\n interface RefundTransactionResponse {\n }\n interface GetAccountRequest {\n /** ID of the account to retrieve. */\n _id: string;\n }\n interface GetAccountResponse {\n /** Retrieved loyalty account. */\n account?: LoyaltyAccount;\n }\n interface QueryLoyaltyAccountsRequest {\n /**\n * Filter object.\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.\n */\n query: CursorQuery;\n }\n interface CursorQuery extends CursorQueryPagingMethodOneOf {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryLoyaltyAccountsResponse {\n /** Loyalty accounts. */\n loyaltyAccounts?: LoyaltyAccount[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata;\n }\n interface CursorPagingMetadata {\n /** Number of items returned in current page. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface ListUserAccountsRequest {\n /** Number of items to load. Minimum `1`, maximum `50`. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListUserAccountsResponse {\n /** Loyalty accounts. */\n accounts?: LoyaltyAccountForMetaSite[];\n }\n interface LoyaltyAccountForMetaSite {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n /** Metasite ID. */\n metaSiteId?: string;\n }\n interface GetProgramTotalsRequest {\n }\n interface GetProgramTotalsResponse {\n /** Point totals for the entire program. */\n points?: Points;\n /** Tier total for the entire program. */\n tierTotals?: TierTotal[];\n }\n interface TierTotal {\n /**\n * Tier ID. If no Tier ID provided, the ID is null. See [Base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction)for more information.\n * @readonly\n */\n _id?: string | null;\n /** Total number of loyalty account that belong to a particular Tier. */\n numberOfAccounts?: number;\n }\n interface GetCurrentMemberAccountRequest {\n }\n interface GetCurrentMemberAccountResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n }\n interface GetMyAccountRequest {\n }\n interface GetMyAccountResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n }\n interface GetAccountBySecondaryIdRequest extends GetAccountBySecondaryIdRequestIdOneOf {\n /** Account owner's contact ID. See the [Contacts API](wix-crm-backend/contacts) to learn more. */\n contactId?: string;\n /** Account owner's member ID. See the [Members API](wix-members-backend/introduction) to learn more. */\n memberId?: string;\n }\n /** @oneof */\n interface GetAccountBySecondaryIdRequestIdOneOf {\n /** Account owner's contact ID. See the [Contacts API](wix-crm-backend/contacts) to learn more. */\n contactId?: string;\n /** Account owner's member ID/ See the [Members API](wix-members-backend/introduction) to learn more. */\n memberId?: string;\n }\n interface GetAccountBySecondaryIdResponse {\n /** Retrieved loyalty account. */\n account?: LoyaltyAccount;\n }\n /** Options to use when retrieving a list of loyalty accounts. */\n interface ListAccountsRequest {\n /** List of contact IDs. See the [Contacts API](wix-crm-backend/contacts) to learn more. */\n contactIds?: string[];\n /** Pagination options. */\n cursorPaging?: CursorPaging;\n }\n interface ListAccountsResponse {\n /** Retrieved loyalty accounts. */\n accounts?: LoyaltyAccount[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n /** Options to use when search for loyalty accounts. */\n interface SearchAccountsRequest {\n /** Search options. */\n search?: CursorSearch;\n }\n interface CursorSearch extends CursorSearchPagingMethodOneOf {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * List of sort objects.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting[];\n /** Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */\n aggregations?: Aggregation[];\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n /**\n * UTC offset or IANA time zone. Valid values are\n * ISO 8601 UTC offsets, such as +02:00 or -06:00,\n * and IANA time zone IDs, such as Europe/Rome.\n *\n * Affects all filters and aggregations returned values.\n * You may override this behavior in a specific filter by providing\n * timestamps including time zone. For example, `\"2023-12-20T10:52:34.795Z\"`.\n */\n timeZone?: string | null;\n }\n /** @oneof */\n interface CursorSearchPagingMethodOneOf {\n /**\n * Cursor paging options.\n *\n * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).\n */\n cursorPaging?: CursorPaging;\n }\n interface Aggregation extends AggregationKindOneOf {\n /** Value aggregation. */\n value?: ValueAggregation;\n /** Range aggregation. */\n range?: RangeAggregation;\n /** Scalar aggregation. */\n scalar?: ScalarAggregation;\n /** Date histogram aggregation. */\n dateHistogram?: DateHistogramAggregation;\n /** Nested aggregation. */\n nested?: NestedAggregation;\n /** User-defined name of aggregation, should be unique, will appear in aggregation results. */\n name?: string | null;\n /** Type of aggregation, client must provide matching aggregation field below. */\n type?: AggregationType;\n /** Field to aggregate by, use dot notation to specify json path. */\n fieldPath?: string;\n /**\n * Deprecated. Use `nested` instead.\n * @deprecated Deprecated. Use `nested` instead.\n * @replacedBy kind.nested\n * @targetRemovalDate 2024-03-30\n */\n groupBy?: GroupByAggregation;\n }\n /** @oneof */\n interface AggregationKindOneOf {\n /** Value aggregation. */\n value?: ValueAggregation;\n /** Range aggregation. */\n range?: RangeAggregation;\n /** Scalar aggregation. */\n scalar?: ScalarAggregation;\n /** Date histogram aggregation. */\n dateHistogram?: DateHistogramAggregation;\n /** Nested aggregation. */\n nested?: NestedAggregation;\n }\n interface RangeBucket {\n /** Inclusive lower bound of the range. Required if `to` is not provided. */\n from?: number | null;\n /** Exclusive upper bound of the range. Required if `from` is not provided. */\n to?: number | null;\n }\n enum SortType {\n /** Sort by number of matches. */\n COUNT = \"COUNT\",\n /** Sort by value of the field alphabetically. */\n VALUE = \"VALUE\"\n }\n enum SortDirection {\n /** Sort in descending order. */\n DESC = \"DESC\",\n /** Sort in ascending order. */\n ASC = \"ASC\"\n }\n enum MissingValues {\n /** Exclude missing values from the aggregation results. */\n EXCLUDE = \"EXCLUDE\",\n /** Include missing values in the aggregation results. */\n INCLUDE = \"INCLUDE\"\n }\n interface IncludeMissingValuesOptions {\n /** Specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ... */\n addToBucket?: string;\n }\n enum ScalarType {\n UNKNOWN_SCALAR_TYPE = \"UNKNOWN_SCALAR_TYPE\",\n /** Count of distinct values. */\n COUNT_DISTINCT = \"COUNT_DISTINCT\",\n /** Minimum value. */\n MIN = \"MIN\",\n /** Maximum value. */\n MAX = \"MAX\",\n /** Sum of values. */\n SUM = \"SUM\",\n /** Average of values. */\n AVG = \"AVG\"\n }\n interface ValueAggregation extends ValueAggregationOptionsOneOf {\n /** Options for including missing values. */\n includeOptions?: IncludeMissingValuesOptions;\n /** Whether to sort by number of matches or value of the field. */\n sortType?: SortType;\n /** Whether to sort in ascending or descending order. */\n sortDirection?: SortDirection;\n /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */\n limit?: number | null;\n /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */\n missingValues?: MissingValues;\n }\n /** @oneof */\n interface ValueAggregationOptionsOneOf {\n /** Options for including missing values. */\n includeOptions?: IncludeMissingValuesOptions;\n }\n enum NestedAggregationType {\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n /** An aggregation where result buckets are dynamically built - one per unique value. */\n VALUE = \"VALUE\",\n /** An aggregation, where user can define set of ranges - each representing a bucket. */\n RANGE = \"RANGE\",\n /** A single-value metric aggregation. For example, min, max, sum, avg. */\n SCALAR = \"SCALAR\",\n /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */\n DATE_HISTOGRAM = \"DATE_HISTOGRAM\"\n }\n interface RangeAggregation {\n /** List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds. */\n buckets?: RangeBucket[];\n }\n interface ScalarAggregation {\n /** Define the operator for the scalar aggregation. */\n type?: ScalarType;\n }\n interface DateHistogramAggregation {\n /** Interval for date histogram aggregation. */\n interval?: DateHistogramAggregationInterval;\n }\n enum DateHistogramAggregationInterval {\n UNKNOWN_INTERVAL = \"UNKNOWN_INTERVAL\",\n /** Yearly interval */\n YEAR = \"YEAR\",\n /** Monthly interval */\n MONTH = \"MONTH\",\n /** Weekly interval */\n WEEK = \"WEEK\",\n /** Daily interval */\n DAY = \"DAY\",\n /** Hourly interval */\n HOUR = \"HOUR\",\n /** Minute interval */\n MINUTE = \"MINUTE\",\n /** Second interval */\n SECOND = \"SECOND\"\n }\n interface NestedAggregationItem extends NestedAggregationItemKindOneOf {\n /** Value aggregation. */\n value?: ValueAggregation;\n /** Range aggregation. */\n range?: RangeAggregation;\n /** Scalar aggregation. */\n scalar?: ScalarAggregation;\n /** Date histogram aggregation. */\n dateHistogram?: DateHistogramAggregation;\n /** User-defined name of aggregation, should be unique, will appear in aggregation results. */\n name?: string | null;\n /** Type of aggregation, client must provide matching aggregation field below. */\n type?: NestedAggregationType;\n /** Field to aggregate by, use dot notation to specify json path. */\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationItemKindOneOf {\n /** Value aggregation. */\n value?: ValueAggregation;\n /** Range aggregation. */\n range?: RangeAggregation;\n /** Scalar aggregation. */\n scalar?: ScalarAggregation;\n /** Date histogram aggregation. */\n dateHistogram?: DateHistogramAggregation;\n }\n enum AggregationType {\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n /** An aggregation where result buckets are dynamically built - one per unique value. */\n VALUE = \"VALUE\",\n /** An aggregation, where user can define set of ranges - each representing a bucket. */\n RANGE = \"RANGE\",\n /** A single-value metric aggregation. For example, min, max, sum, avg. */\n SCALAR = \"SCALAR\",\n /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */\n DATE_HISTOGRAM = \"DATE_HISTOGRAM\",\n /** Multi-level aggregation, where each next aggregation is nested within previous one. */\n NESTED = \"NESTED\"\n }\n /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */\n interface NestedAggregation {\n /** Flattened list of aggregations, where each next aggregation is nested within previous one. */\n nestedAggregations?: NestedAggregationItem[];\n }\n interface GroupByAggregation extends GroupByAggregationKindOneOf {\n /** Value aggregation configuration. */\n value?: ValueAggregation;\n /** User-defined name of aggregation, should be unique, will appear in aggregation results. */\n name?: string | null;\n /** Field to aggregate by. */\n fieldPath?: string;\n }\n /** @oneof */\n interface GroupByAggregationKindOneOf {\n /** Value aggregation configuration. */\n value?: ValueAggregation;\n }\n interface SearchDetails {\n /** Defines how separate search terms in `expression` are combined. */\n mode?: Mode;\n /** Search term or expression. */\n expression?: string | null;\n /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. */\n fields?: string[];\n /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */\n fuzzy?: boolean;\n }\n enum Mode {\n /** Any of the search terms must be present. */\n OR = \"OR\",\n /** All search terms must be present. */\n AND = \"AND\"\n }\n /** Accounts found through provided search capabilities, along with paging and aggregation data of the results. */\n interface SearchAccountsResponse {\n /** Found accounts. */\n accounts?: LoyaltyAccount[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata;\n /** Aggregation data */\n aggregationData?: AggregationData;\n }\n interface AggregationData {\n /** key = aggregation name (as derived from search request). */\n results?: AggregationResults[];\n }\n interface ValueAggregationResult {\n /** Value of the field. */\n value?: string;\n /** Count of entities with this value. */\n count?: number;\n }\n interface RangeAggregationResult {\n /** Inclusive lower bound of the range. */\n from?: number | null;\n /** Exclusive upper bound of the range. */\n to?: number | null;\n /** Count of entities in this range. */\n count?: number;\n }\n interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {\n /** Value aggregation results. */\n values?: ValueResults;\n /** Range aggregation results. */\n ranges?: RangeResults;\n /** Scalar aggregation results. */\n scalar?: AggregationResultsScalarResult;\n /** User-defined name of aggregation, matches the one provided in request. */\n name?: string;\n /** Type of aggregation that matches result. */\n type?: AggregationType;\n /** Field to aggregate by, matches the one provided in request. */\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationResultsResultOneOf {\n /** Value aggregation results. */\n values?: ValueResults;\n /** Range aggregation results. */\n ranges?: RangeResults;\n /** Scalar aggregation results. */\n scalar?: AggregationResultsScalarResult;\n }\n interface ValueResults {\n /** List of value aggregations. */\n results?: ValueAggregationResult[];\n }\n interface RangeResults {\n /** List of ranges returned in same order as requested. */\n results?: RangeAggregationResult[];\n }\n interface AggregationResultsScalarResult {\n /** Type of scalar aggregation. */\n type?: ScalarType;\n /** Value of the scalar aggregation. */\n value?: number;\n }\n interface NestedValueAggregationResult {\n /** Value of the field. */\n value?: string;\n /** Nested aggregations. */\n nestedResults?: NestedAggregationResults;\n }\n interface ValueResult {\n /** Value of the field. */\n value?: string;\n /** Count of entities with this value. */\n count?: number | null;\n }\n interface RangeResult {\n /** Inclusive lower bound of the range. */\n from?: number | null;\n /** Exclusive upper bound of the range. */\n to?: number | null;\n /** Count of entities in this range. */\n count?: number | null;\n }\n interface ScalarResult {\n /** Value of the scalar aggregation. */\n value?: number;\n }\n interface NestedResultValue extends NestedResultValueResultOneOf {\n /** Value aggregation result. */\n value?: ValueResult;\n /** Range aggregation result. */\n range?: RangeResult;\n /** Scalar aggregation result. */\n scalar?: ScalarResult;\n /** Date histogram aggregation result. */\n dateHistogram?: ValueResult;\n }\n /** @oneof */\n interface NestedResultValueResultOneOf {\n /** Value aggregation result. */\n value?: ValueResult;\n /** Range aggregation result. */\n range?: RangeResult;\n /** Scalar aggregation result. */\n scalar?: ScalarResult;\n /** Date histogram aggregation result. */\n dateHistogram?: ValueResult;\n }\n interface Results {\n /** List of nested aggregations. */\n results?: Record;\n }\n interface DateHistogramResult {\n /** Date in ISO 8601 format. */\n value?: string;\n /** Count of documents in the bucket. */\n count?: number;\n }\n interface GroupByValueResults {\n /** List of value aggregations. */\n results?: NestedValueAggregationResult[];\n }\n interface DateHistogramResults {\n /** List of date histogram aggregations. */\n results?: DateHistogramResult[];\n }\n /**\n * Results of `NESTED` aggregation type in a flattened form.\n * Aggregations in resulting array are keyed by requested aggregation `name`.\n */\n interface NestedResults {\n /** List of nested aggregations. */\n results?: Results[];\n }\n interface AggregationResults extends AggregationResultsResultOneOf {\n /** Value aggregation results. */\n values?: ValueResults;\n /** Range aggregation results. */\n ranges?: RangeResults;\n /** Scalar aggregation results. */\n scalar?: AggregationResultsScalarResult;\n /** Group by value aggregation results. */\n groupedByValue?: GroupByValueResults;\n /** Date histogram aggregation results. */\n dateHistogram?: DateHistogramResults;\n /** Nested aggregation results. */\n nested?: NestedResults;\n /** User-defined name of aggregation as derived from search request. */\n name?: string;\n /** Type of aggregation that must match provided kind as derived from search request. */\n type?: AggregationType;\n /** Field to aggregate by as derived from search request. */\n fieldPath?: string;\n }\n /** @oneof */\n interface AggregationResultsResultOneOf {\n /** Value aggregation results. */\n values?: ValueResults;\n /** Range aggregation results. */\n ranges?: RangeResults;\n /** Scalar aggregation results. */\n scalar?: AggregationResultsScalarResult;\n /** Group by value aggregation results. */\n groupedByValue?: GroupByValueResults;\n /** Date histogram aggregation results. */\n dateHistogram?: DateHistogramResults;\n /** Nested aggregation results. */\n nested?: NestedResults;\n }\n interface ExportAccountsRequest {\n query?: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ExportAccountsResponse {\n accounts?: LoyaltyAccount[];\n pagingMetadata?: CursorPagingMetadata;\n }\n /** Options to use when looking up count of loyalty accounts. */\n interface CountAccountsRequest {\n /** Filter object. */\n filter?: Record | null;\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n }\n /** Count of accounts found for given search query */\n interface CountAccountsResponse {\n count?: number;\n }\n interface BulkAdjustPointsRequest extends BulkAdjustPointsRequestTypeOneOf {\n balance?: number;\n amount?: number;\n search?: CursorSearch;\n }\n /** @oneof */\n interface BulkAdjustPointsRequestTypeOneOf {\n balance?: number;\n amount?: number;\n }\n interface BulkAdjustPointsResponse {\n /** @readonly */\n asyncJobId?: string | null;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface TiersRollingUpdate {\n }\n interface TiersProgramSettingsChanged {\n /** Settings for the tiers program. */\n programSettings?: TiersProgramSettings;\n }\n /** There can be single TiersSettings per site and it's global (i.e. applies to all program's tiers) */\n interface TiersProgramSettings extends TiersProgramSettingsPeriodOneOf {\n /**\n * *Required.**\n * Period of time used to calculate loyalty points for tier assignment.\n *\n * The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.\n */\n rollingWindow?: RollingWindow;\n /** Tiers program status. */\n status?: Status;\n /**\n * Revision number, which increments by 1 each time the loyalty tiers settings are updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty tiers settings.\n */\n revision?: string | null;\n /**\n * Date and time the loyalty tiers program was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the loyalty tiers program was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Information about the base loyalty tier.\n *\n * The base tier is the default tier for any account that is unassigned for not meeting\n * the required points threshold of any other tier.\n */\n baseTierDefinition?: TierDefinition;\n }\n /** @oneof */\n interface TiersProgramSettingsPeriodOneOf {\n /**\n * *Required.**\n * Period of time used to calculate loyalty points for tier assignment.\n *\n * The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.\n */\n rollingWindow?: RollingWindow;\n }\n enum Status {\n /** Unknown status. */\n UNKNOWN = \"UNKNOWN\",\n /** Tiers are disabled. */\n DISABLED = \"DISABLED\",\n /** Tiers are enabled but not yet active. */\n DRAFT = \"DRAFT\",\n /** Tiers are active. */\n ACTIVE = \"ACTIVE\",\n /** Tiers are paused. */\n PAUSED = \"PAUSED\"\n }\n /** Information about the tier. */\n interface TierDefinition {\n /** Details about the tier icon. */\n icon?: string;\n /** Tier name. */\n name?: string | null;\n /** Tier description. */\n description?: string | null;\n }\n interface FocalPoint {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n /** crop by height */\n height?: number | null;\n /** crop by width */\n width?: number | null;\n }\n /**\n * *Required.** Period of time used to calculate loyalty points for tier assignment.\n *\n * The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.\n */\n interface RollingWindow {\n /**\n * Number of months to use for the rolling window period.\n *\n * Min: `12`\n *\n * Max: `36`\n */\n durationInMonths?: number;\n }\n interface SubscriptionEvent extends SubscriptionEventEventOneOf {\n /** Triggered when a subscription is created. */\n created?: SubscriptionCreated;\n /**\n * Triggered when a subscription is assigned to a Wix site, including the initial\n * assignment of a floating subscription or a re-assignement from a different site.\n */\n assigned?: SubscriptionAssigned;\n /** Triggered when a subscription is canceled. */\n cancelled?: SubscriptionCancelled;\n /** Triggered when the subscription's auto renew is turned on. */\n autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;\n /** Triggered when the subscription's auto renew is turned off. */\n autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;\n /**\n * Triggered when a subscription is unassigned from a Wix site and becomes\n * floating.\n */\n unassigned?: SubscriptionUnassigned;\n /**\n * Triggered when a subscription is transferred from one Wix account to another.\n * A transfer includes cancelling the original subscription and creating a new\n * subscription for the target account. The event returns both the original\n * and the new subscription.\n */\n transferred?: SubscriptionTransferred;\n /** Triggered when a recurring charge succeeds for a subscription. */\n recurringChargeSucceeded?: RecurringChargeSucceeded;\n /**\n * Triggered when a subscription was updated including when its product has been\n * up- or downgraded or the billing cycle is changed.\n */\n contractSwitched?: ContractSwitched;\n /**\n * Triggered when a subscription gets close to the end of its billing cycle.\n * The exact number of days is defined in the billing system.\n */\n nearEndOfPeriod?: SubscriptionNearEndOfPeriod;\n /**\n * Triggered when a subscription is updated and the change doesn't happen\n * immediately but at the end of the current billing cycle.\n */\n pendingChange?: SubscriptionPendingChange;\n /** ID of the subscription's event. */\n eventId?: string | null;\n /**\n * Date and time of the event in\n * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n eventDate?: Date | null;\n }\n /** @oneof */\n interface SubscriptionEventEventOneOf {\n /** Triggered when a subscription is created. */\n created?: SubscriptionCreated;\n /**\n * Triggered when a subscription is assigned to a Wix site, including the initial\n * assignment of a floating subscription or a re-assignement from a different site.\n */\n assigned?: SubscriptionAssigned;\n /** Triggered when a subscription is canceled. */\n cancelled?: SubscriptionCancelled;\n /** Triggered when the subscription's auto renew is turned on. */\n autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;\n /** Triggered when the subscription's auto renew is turned off. */\n autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;\n /**\n * Triggered when a subscription is unassigned from a Wix site and becomes\n * floating.\n */\n unassigned?: SubscriptionUnassigned;\n /**\n * Triggered when a subscription is transferred from one Wix account to another.\n * A transfer includes cancelling the original subscription and creating a new\n * subscription for the target account. The event returns both the original\n * and the new subscription.\n */\n transferred?: SubscriptionTransferred;\n /** Triggered when a recurring charge succeeds for a subscription. */\n recurringChargeSucceeded?: RecurringChargeSucceeded;\n /**\n * Triggered when a subscription was updated including when its product has been\n * up- or downgraded or the billing cycle is changed.\n */\n contractSwitched?: ContractSwitched;\n /**\n * Triggered when a subscription gets close to the end of its billing cycle.\n * The exact number of days is defined in the billing system.\n */\n nearEndOfPeriod?: SubscriptionNearEndOfPeriod;\n /**\n * Triggered when a subscription is updated and the change doesn't happen\n * immediately but at the end of the current billing cycle.\n */\n pendingChange?: SubscriptionPendingChange;\n }\n /** Triggered when a subscription is created. */\n interface SubscriptionCreated {\n /** Created subscription. */\n subscription?: Subscription;\n /** Metadata for the `created` event. */\n metadata?: Record;\n /**\n * Subscription reactivation data.\n * A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated\n * by the billing system\n */\n reactivationData?: ReactivationData;\n }\n /**\n * A subscription holds information about a Premium product that a Wix account\n * owner has purchased including details about the billing.\n */\n interface Subscription {\n /** ID of the subscription. */\n _id?: string;\n /** ID of the Wix account that purchased the subscription. */\n userId?: string;\n /**\n * ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)\n * for which the subscription was purchased.\n */\n productId?: string;\n /**\n * Date and time the subscription was created in\n * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n createdAt?: Date | null;\n /**\n * Date and time the subscription was last updated in\n * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n updatedAt?: Date | null;\n /**\n * ID of the metasite that the subscription is assigned to.\n * Available only when the subscription is assigned to a Wix site.\n * Subscriptions for account level products can't be assigned to a Wix site.\n */\n metaSiteId?: string | null;\n /** Information about the system that manages the subscription's billing. */\n billingReference?: BillingReference;\n /** Information about the billing cycle of the subscription. */\n cycle?: Cycle;\n /**\n * Subscription status.\n *\n * + `UNKNOWN`: Default status.\n * + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.\n * + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.\n * + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.\n * + `CANCELLED`: Subscription isn't active because it has been canceled.\n * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.\n */\n status?: SubscriptionStatus;\n /**\n * Date and time the subscription was last transferred from one Wix account to\n * another in\n * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n transferredAt?: Date | null;\n /**\n * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)\n * that the product, for which the subscription was purchased, belongs to.\n */\n productTypeId?: string;\n /** Version number, which increments by 1 each time the subscription is updated. */\n version?: number;\n /**\n * Whether the subscription is active. Includes the statuses\n * `\"AUTO_RENEW_ON\"`, `\"AUTO_RENEW_OFF\"`, and `\"MANUAL_RECURRING\"`.\n */\n active?: boolean;\n /**\n * Date and time the subscription was originally created in\n * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.\n */\n originalCreationDate?: Date | null;\n /** Custom metadata about the subscription. */\n metadata?: Record;\n /**\n * 2-letter country code in\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)\n * format.\n */\n countryCode?: string | null;\n }\n interface BillingReference {\n /**\n * Name of the billing system that manages the subscription.\n *\n * + `\"UNKNOWN\"`: Default value.\n * + `\"SBS\"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).\n * + `\"LICENSER\"`:\n * + `\"BASS\"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).\n * + `\"RESELLER\"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).\n */\n providerName?: ProviderName;\n /** Current provider reference ID. */\n providerReferenceId?: string | null;\n /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */\n previousProviderReferenceIds?: string[];\n }\n enum ProviderName {\n UNKNOWN = \"UNKNOWN\",\n SBS = \"SBS\",\n LICENSER = \"LICENSER\",\n BASS = \"BASS\",\n RESELLER = \"RESELLER\",\n RECURRING_INVOICES = \"RECURRING_INVOICES\"\n }\n interface Cycle extends CycleCycleSelectorOneOf {\n /** repetitive interval */\n interval?: Interval;\n /** one time */\n oneTime?: OneTime;\n }\n /** @oneof */\n interface CycleCycleSelectorOneOf {\n /** repetitive interval */\n interval?: Interval;\n /** one time */\n oneTime?: OneTime;\n }\n interface Interval {\n /** interval unit of measure */\n unit?: IntervalUnit;\n /** number of interval */\n count?: number;\n }\n enum IntervalUnit {\n /** unknown interval unit */\n UNKNOWN = \"UNKNOWN\",\n /** day */\n DAY = \"DAY\",\n /** week */\n WEEK = \"WEEK\",\n /** month */\n MONTH = \"MONTH\",\n /** year */\n YEAR = \"YEAR\"\n }\n interface OneTime {\n }\n enum SubscriptionStatus {\n UNKNOWN = \"UNKNOWN\",\n AUTO_RENEW_ON = \"AUTO_RENEW_ON\",\n AUTO_RENEW_OFF = \"AUTO_RENEW_OFF\",\n MANUAL_RECURRING = \"MANUAL_RECURRING\",\n CANCELLED = \"CANCELLED\",\n TRANSFERRED = \"TRANSFERRED\"\n }\n /** Triggered when a subscription is reactivated. */\n interface ReactivationData {\n reactivationReason?: ReactivationReasonEnum;\n /**\n * In the event of reactivation after chargeback dispute, the subscription may be extended according to the\n * number of days it was inactive during the time of resolving the dispute\n */\n newEndOfPeriod?: Date | null;\n /** The original end date, before the inactive period. */\n oldEndOfPeriod?: Date | null;\n /** The difference in days between the new new_end_of_period and old_end_of_period */\n differenceInDays?: number | null;\n }\n /** Reason for subscription reactivation */\n enum ReactivationReasonEnum {\n UNKNOWN = \"UNKNOWN\",\n /**\n * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly\n * canceled because of suspicion of fraud\n */\n BILLING_STATUS_CHANGE = \"BILLING_STATUS_CHANGE\",\n /** Subscription was reactivated after a chargeback dispute */\n REACTIVATED_AFTER_CHARGEBACK = \"REACTIVATED_AFTER_CHARGEBACK\"\n }\n /**\n * Triggered when a subscription is assigned to a Wix site, including the initial\n * assignment of a floating subscription or a re-assignement from a different site.\n */\n interface SubscriptionAssigned {\n /** Assigned subscription. */\n subscription?: Subscription;\n /** ID of the metasite that the subscription has been assigned to before the update. */\n previousMetaSiteId?: string | null;\n }\n /** Triggered when a subscription is canceled. */\n interface SubscriptionCancelled {\n /** Canceled subscription. */\n subscription?: Subscription;\n /** Details about the cancellation including who canceled the subscription and why. */\n cancellationDetails?: CancellationDetails;\n /**\n * Whether the subscription is canceled immediately or expires at the end of the current billing cycle.\n *\n * Default: `false`\n */\n immediateCancel?: boolean;\n /** Whether the subscription was canceled during the free trial period. */\n canceledInFreeTrial?: boolean;\n }\n /** Information about the cancellation flow including who canceled the subscription and why it was canceled. */\n interface CancellationDetails {\n /**\n * Cancellation code.\n *\n * Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.\n * For cancellations on behalf of the site owner or the service provider `cancellationCode`\n * is taken from the request of\n * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).\n *\n * + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.\n * + `-2`: There were payment problems.\n * + `-3`: There was a chargeback.\n * + `-4`: Customer support has canceled the subscription and issued a refund.\n * + `-5`: The site owner has changed their existing subscription.\n * + `-6`: The subscription has been transferred to a different Wix account.\n * + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.\n * + `-8`: The Wix account that the subscription belonged to has been deleted.\n */\n cancellationCode?: number | null;\n /**\n * Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`\n * is taken from the request of\n * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).\n * For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.\n */\n cancellationReason?: string | null;\n /**\n * Initiator of the cancellation. For `\"USER_REQUESTED\"` and `\"APP_MANAGED\"`,\n * `cancellationCode` and `cancellationReason` are taken from the request of\n * [Cancel Immediately](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately)\n * or [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).\n * For `\"PASSIVE\"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`\n * is `null` or an empty string.\n *\n * + `\"UNKNOWN`: Default value.\n * + `\"USER_REQUESTED\"`: The Wix account owner has canceled the subscription.\n * + `\"APP_MANAGED\"`: The service provider has canceled the subscription.\n * + `\"PASSIVE\"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.\n */\n initiator?: Initiator;\n }\n enum Initiator {\n UNKNOWN = \"UNKNOWN\",\n USER_REQUESTED = \"USER_REQUESTED\",\n APP_MANAGED = \"APP_MANAGED\",\n PASSIVE = \"PASSIVE\"\n }\n /** Triggered when the subscription's auto renew is turned on. */\n interface SubscriptionAutoRenewTurnedOn {\n /** Subscription for which auto renew is turned on. */\n subscription?: Subscription;\n /**\n * Supported values: `USER`, `APP`.\n *\n * Information about who turned auto renew on.\n * + `\"USER\"`: The site owner who purchased the subscription has turned auto renew on.\n * + `\"APP\"`: The service provider has turned auto renew on.\n */\n initiator?: string | null;\n }\n /** Triggered when the subscription's auto renew is turned off. */\n interface SubscriptionAutoRenewTurnedOff {\n /** Subscription for which auto renew is turned off. */\n subscription?: Subscription;\n /** Details about the cancellation including who canceled the subscription and why. */\n cancellationDetails?: CancellationDetails;\n /**\n * Whether the subscription is immediately canceled or expires at the end of the current billing cycle.\n *\n * Default: `false`\n */\n immediateCancel?: boolean;\n }\n /**\n * Triggered when a subscription is unassigned from a Wix site and becomes\n * floating.\n */\n interface SubscriptionUnassigned {\n /** Unassigned subscription. */\n subscription?: Subscription;\n /** ID of the metasite that the subscription has been assigned to before the event. */\n previousMetaSiteId?: string;\n /**\n * Reason why the subscription is unassigned.\n *\n * + `\"UNKNOWN\"`: Default value.\n * + `\"USER_REQUESTED\"`: The Wix account owner has unassigned the subscription.\n * + `\"REPLACED_BY_ANOTHER_SUBSCRIPTION\"`: A different subscription that replaces this subscription is assigned to the site.\n */\n unassignReason?: UnassignReason;\n }\n enum UnassignReason {\n UNKNOWN = \"UNKNOWN\",\n USER_REQUESTED = \"USER_REQUESTED\",\n REPLACED_BY_ANOTHER_SUBSCRIPTION = \"REPLACED_BY_ANOTHER_SUBSCRIPTION\"\n }\n /**\n * Triggered when a subscription is transferred from one Wix account to another.\n * A transfer includes cancelling the original subscription and creating a new\n * subscription for the target account. The event returns both the original\n * and the new subscription.\n */\n interface SubscriptionTransferred {\n /** Original subscription that was canceled for the transfer. */\n originSubscription?: Subscription;\n /** Newly created subscription for the target account. */\n targetSubscription?: Subscription;\n }\n /** Triggered when a recurring charge succeeds for a subscription. */\n interface RecurringChargeSucceeded {\n /** Subscription for which the recurring charge has succeeded. */\n subscription?: Subscription;\n /** Indication that there was a successful charge at the end of the free trial period */\n freeTrialPeriodEnd?: boolean;\n }\n /**\n * Triggered when a subscription was updated including when its product has been\n * up- or downgraded or the billing cycle is changed.\n */\n interface ContractSwitched {\n /** Updated subscription. */\n subscription?: Subscription;\n /** Billing cycle before the update. */\n previousCycle?: Cycle;\n /** ID of the product belonging to the subscription before the update. */\n previousProductId?: string;\n /** ID of the product type that the subscription's original product belonged to before the update. */\n previousProductTypeId?: string;\n /**\n * Update type. __Note__: Doesn't include information about a product adjustment.\n * For that purpose, see `productAdjustment`.\n *\n * + `\"NOT_APPLICABLE\"`: Default value.\n * + `\"ADDITIONAL_QUANTITY\"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.\n * + `\"CREDIT_UNUSED_PERIOD\"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.\n * + `\"REFUND_PRICE_DIFF\"`: Not implemented.\n * + `\"ADJUST_PERIOD_END\"`: Not implemented.\n * + `\"DOWNGRADE_GRACE_PERIOD\"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.\n * + `\"FULL_AMOUNT_PERIOD\"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.\n * + `\"END_OF_PERIOD\"`: The subscription's billing current cycle is extended because of a downgrade.\n * + `\"PENDING_CHANGES\"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.\n * + `\"DOWNGRADE_RENEWAL\"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.\n */\n contractSwitchType?: ContractSwitchType;\n /**\n * ID of the metasite the subscription has been assigned to previously.\n * Available only in case the subscription is assigned to a different site.\n */\n previousMetaSiteId?: string | null;\n /**\n * Update reason.\n *\n * + `\"PRICE_INCREASE\"`: The subscription's price has been increased.\n * + `\"EXTERNAL_PROVIDER_TRIGGER\"`: Any reason other than a price increase.\n */\n contractSwitchReason?: ContractSwitchReason;\n /** Information about the price update. Available only for updates with a price increase. */\n productPriceIncreaseData?: ProductPriceIncreaseData;\n /**\n * Information about a product adjustment. For example, a downgrade.\n * __Note__: This isn't the same as `contractSwitchType`.\n *\n * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.\n * + `DOWNGRADE`: The product has been downgraded.\n */\n productAdjustment?: ProductAdjustment;\n }\n /** Copied from SBS */\n enum ContractSwitchType {\n NOT_APPLICABLE = \"NOT_APPLICABLE\",\n ADDITIONAL_QUANTITY = \"ADDITIONAL_QUANTITY\",\n CREDIT_UNUSED_PERIOD = \"CREDIT_UNUSED_PERIOD\",\n REFUND_PRICE_DIFF = \"REFUND_PRICE_DIFF\",\n ADJUST_PERIOD_END = \"ADJUST_PERIOD_END\",\n DOWNGRADE_GRACE_PERIOD = \"DOWNGRADE_GRACE_PERIOD\",\n FULL_AMOUNT_PERIOD = \"FULL_AMOUNT_PERIOD\",\n END_OF_PERIOD = \"END_OF_PERIOD\",\n PENDING_CHANGES = \"PENDING_CHANGES\",\n DOWNGRADE_RENEWAL = \"DOWNGRADE_RENEWAL\"\n }\n enum ContractSwitchReason {\n EXTERNAL_PROVIDER_TRIGGER = \"EXTERNAL_PROVIDER_TRIGGER\",\n PRICE_INCREASE = \"PRICE_INCREASE\"\n }\n /** Triggered when a subscription's price is increased. */\n interface ProductPriceIncreaseData {\n /** Price of the subscription before the update. */\n previousPrice?: string | null;\n /** A value that is used in order to select the correct email template to send the user regarding the price increase. */\n emailTemplateSelector?: string | null;\n /** Used to differentiate between migration segments. Does not have to be unique per segment. */\n segmentName?: string | null;\n /** Used to determine how the price increase was triggered. */\n priceIncreaseTrigger?: PriceIncreaseTrigger;\n }\n /** Reason for Price Increase Trigger */\n enum PriceIncreaseTrigger {\n NEAR_RENEWAL = \"NEAR_RENEWAL\",\n RECURRING_SUCCESS = \"RECURRING_SUCCESS\",\n MANUAL = \"MANUAL\"\n }\n /** Triggered when a subscription's product is adusted. */\n enum ProductAdjustment {\n /** flag to show that the ContractSwitchedEvent is not applicable / needed */\n NOT_APPLICABLE = \"NOT_APPLICABLE\",\n /** flag to show that the ContractSwitchedEvent is a Downgrade */\n DOWNGRADE = \"DOWNGRADE\"\n }\n /**\n * Triggered when a subscription gets close to the end of its billing cycle.\n * The exact number of days is defined in the billing system.\n */\n interface SubscriptionNearEndOfPeriod {\n /** Subscription that got close to the end of its billing cycle. */\n subscription?: Subscription;\n /** Whether the subscription is within the free trial period. */\n inFreeTrial?: boolean;\n }\n /**\n * Triggered when a subscription is updated and the change doesn't happen\n * immediately but at the end of the current billing cycle.\n */\n interface SubscriptionPendingChange {\n /** Subscription for which a pending update is triggered. */\n subscription?: Subscription;\n }\n interface ContactSyncRequest {\n contactIds?: string[];\n contactId?: string | null;\n }\n interface BulkUpsertAccountsRequest {\n /** List of contactIds + points to either insert as new loyalty accounts, or update if contacts already exist as loyalty accounts */\n accounts: AccountToUpsert[];\n /**\n * If true, the upserted accounts are returned in response\n * @deprecated If true, the upserted accounts are returned in response\n * @targetRemovalDate 2024-02-01\n */\n returnAccounts?: boolean;\n /** Description of the action */\n description?: string | null;\n }\n interface AccountToUpsert {\n contactId?: string;\n pointsBalance?: number;\n }\n interface BulkUpsertAccountsResponse {\n /** Loyalty accounts that were created or updated */\n result?: BulkAccountResult[];\n /** Numbers of successes and failures */\n metadata?: BulkActionMetadata;\n }\n interface BulkAccountResult {\n /** The created/updated account is returned if specified so in request message. */\n account?: LoyaltyAccount;\n /** LoyaltyAccount metadata. */\n metadata?: ItemMetadata;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface SetMissingMemberIdRequest {\n /** ID of the account to retrieve. */\n accountId: string;\n }\n interface SetMissingMemberIdResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a loyalty account for one of a site's contacts.\n *\n * The `createAccount()` function returns a Promise that resolves to the new loyalty account when it is created.\n *\n * To create a new loyalty account, the customer must first be a site contact with a contact ID. The site must also have an active loyalty program before loyalty accounts can be created.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can create a loyalty account. \n * @public\n * @requiredField contactId\n * @param contactId - Contact ID for a Wix site contact. See the [Contacts API](wix-crm-backend/contacts) to learn more.\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function createAccount(contactId: string): Promise;\n /**\n * Adds points to a loyalty account.\n *\n * The `earnPoints()` function returns a Promise that resolves to the updated loyalty account.\n *\n * Only a positive amount can be added using the `earnPoints()` function, to manually adjust an account's balance for a negative amount, use [`adjustPoints()`](wix-loyalty-v2/accounts/adjustpoints).\n *\n * The `earnPoints()` function allows customers to manually earn points to their loyalty accounts. To use this function you must include an `appId` and an `idempotencyKey`. Any string can be set as the `appId` or `idempotencyKey`. In contrast to when an account earns points through an action taken on your site, the `appId` automatically sets to the source app that generates the points. The transaction `type` is `\"EARN\"` for points earned this way.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can earn loyalty points. \n * @param accountId - Loyalty account ID.\n * @public\n * @requiredField accountId\n * @requiredField options.appId\n * @requiredField options.idempotencyKey\n * @param options - Earn points info.\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function earnPoints(accountId: string, options?: EarnPointsOptions): Promise;\n interface EarnPointsOptions extends EarnPointsRequestActivityDetailsOneOf {\n /**\n * Amount of points to earn. Must be a positive, whole number.\n *\n * Min: `1`\n *\n * Max: `9999999`\n */\n amount?: number;\n /**\n * Description of how the points were earned.\n *\n * Max: 100 characters\n */\n description?: string;\n /**\n * ID of the app that initiated the transaction.\n *\n * If points were earned manually, then the `appId` is the Loyalty app's\n * `wixAppId` of `553c79f3-5625-4f38-b14b-ef7c0d1e87df`. If points were earned in an automatic event,\n * then the `appId` is from that automation's `sourceAppId`.\n */\n appId: string;\n /**\n * Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request.\n *\n * Please use `GUID` format.\n */\n idempotencyKey: string;\n /**\n * Activity type.\n *\n * If points were earned through automation it should be set to trigger key.\n */\n activityType?: string | null;\n /** Order id which was source of this transaction. */\n orderId?: string | null;\n /** Followed social media details. */\n followedSocialMedia?: FollowedSocialMedia;\n }\n /**\n * Adjusts the point balance of a loyalty account.\n *\n * The `adjustPoints()` function returns a Promise that resolves to the updated loyalty account.\n *\n * To adjust the points balance of an account you must include an `accountId`, a `revision` number, and the adjustment to make. You can also leave a description to explain the reason for the points adjustment.\n *\n * There are two ways to adjust the points of a loyalty account:\n * - `balance` allows you to set the total points balance to this new amount. The transaction `type` will return as `\"ADJUST\"`.\n * - `amount` allows you to alter the points balance by this amount. This amount can be a positive number to increase the points balance or a negative number to decrease the balance. The transaction type will return as `\"GIVE\"`.\n *\n * An account may not be adjusted to a negative balance. If you pass values in both the `balance` and the `amount` parameters then the `balance` adjustment takes effect and the `amount` adjustment is ignored.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can manually adjust points in a loyalty account. \n * @param accountId - Loyalty account ID.\n * @public\n * @requiredField accountId\n * @param options - Options to use when adjusting points.\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function adjustPoints(accountId: string, options?: AdjustPointsOptions): Promise;\n interface AdjustPointsOptions extends AdjustPointsRequestTypeOneOf {\n /** Description to explain the reason for the points adjustment. */\n description?: string | null;\n /**\n * Sets the account's point balance to this amount. Must be a positive, whole number or zero.\n *\n * The net difference between this new balance and the previous balance will be reflected in the `adjusted` field of the customer's account.\n *\n * Min: `0`\n *\n * Max: `999999999`\n */\n balance?: number;\n /**\n * Adjusts the account's point balance by this amount. Must be a whole number with a maximum of 7 digits.\n * The amount can be negative, but cannot be `0`.\n *\n * Min: `-9999999`\n *\n * Max: `9999999`\n */\n amount?: number;\n /**\n * Each time the loyalty account is updated, `revision` increments by 1.\n *\n * The current `revision` must be passed when adjusting points in the loyalty account. This\n * ensures you're working with the latest version of the loyalty account and prevents unintended overwrites.\n */\n revision?: string;\n }\n interface RedeemPointsOptions {\n /** Number of times the given reward will be redeemed. Must be a positive whole number. */\n count?: number;\n /**\n * Revision number, which increments by 1 each time points are redeemed.\n * To prevent conflicting changes, the existing `revision` must be used when redeeming points.\n */\n revision?: string;\n /** Id of the entity that is being redeemed (e.g. orderId for order discount, couponId for coupon reward). */\n referenceEntityId?: string | null;\n }\n interface RedeemDeterminedAmountOfPointsOptions {\n /** Number of points to be redeemed off the account. */\n points?: number;\n /**\n * Revision number, which increments by 1 each time points are redeemed.\n * To prevent conflicting changes, the existing `revision` must be used when redeeming points.\n */\n revision?: string;\n /** Id of the entity that is being redeemed (e.g. orderId for order discount, couponId for coupon reward). */\n referenceEntityId?: string | null;\n }\n /**\n * Retrieves an account using the loyalty account ID.\n *\n * The `getAccount()` function returns a Promise that resolves to the specified loyalty account when it is retrieved.\n *\n * You can also get an account using a secondary ID, such as a contact ID or a member ID with the [`getAccountBySecondaryId()`](wix-loyalty-v2/accounts/getaccountbysecondaryid) function.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can retrieve a loyalty account. \n * @param _id - ID of the account to retrieve.\n * @public\n * @requiredField _id\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved loyalty account.\n */\n function getAccount(_id: string): Promise;\n /**\n * Creates a query to retrieve a list of accounts.\n *\n * The `queryLoyaltyAccounts()` function builds a query to retrieve a list of events and returns a `LoyaltyAccountsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `LoyaltyAccountsQueryBuilder` functions onto the query. `LoyaltyAccountsQueryBuilder` functions enable you to sort, filter, and control the results `queryLoyaltyAccounts()` returns.\n *\n * `queryLoyaltyAccounts()` runs with these `LoyaltyAccountsQueryBuilder` defaults, which you can override:\n *\n * - skip(0)\n * - limit(50)\n * - descending(\"_createdDate\")\n *\n * The functions that are chained to `queryLoyaltyAccounts()` are applied in the order they're called. For example, if you apply ascending('points.balance') and then descending('points.earned'), the results are sorted first by the balance, and then, if there are multiple results with the same balance, the items are sorted by earned points.\n * @public\n * @documentationMaturity preview\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryLoyaltyAccounts(): LoyaltyAccountsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyAccountsQueryResult extends QueryCursorResult {\n items: LoyaltyAccount[];\n query: LoyaltyAccountsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LoyaltyAccountsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"contactId\" | \"memberId\" | \"tier.id\" | \"contact.id\", value: string) => LoyaltyAccountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any[]) => LoyaltyAccountsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: any) => LoyaltyAccountsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\", value: boolean) => LoyaltyAccountsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\">) => LoyaltyAccountsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"contactId\" | \"memberId\" | \"points.balance\" | \"points.earned\" | \"points.adjusted\" | \"points.redeemed\" | \"points.expired\" | \"_createdDate\" | \"lastActivityDate\" | \"tier.id\" | \"contact.id\" | \"pointsExpiration.expirationDate\" | \"pointsExpiration.expiringPointsAmount\">) => LoyaltyAccountsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => LoyaltyAccountsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => LoyaltyAccountsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n interface ListUserAccountsOptions {\n /** Number of items to load. Minimum `1`, maximum `50`. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n /**\n * Retrieves the total amount of points earned, redeemed, and adjusted for the entire loyalty program.\n *\n * The `getProgramTotals()` function returns a Promise that resolves to the combined total points for all loyalty accounts in the program.\n *\n * The `balance` is the current total of points outstanding, while the `earned`, `adjusted`, and `redeemed` amounts are the all-time accumulated amounts. The totals include the amounts for all loyalty accounts.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can retrieve the loyalty program totals. \n * @public\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function getProgramTotals(): Promise;\n /**\n * Retrieves the currently logged-in member's account.\n * @public\n * @permissionId LOYALTY.READ_OWN_ACCOUNT\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n */\n function getCurrentMemberAccount(): Promise;\n /**\n * Retrieves the loyalty account of the specified site contact or member.\n *\n * The `getAccountBySecondaryId()` function returns a Promise that resolves to the specified loyalty account when it is retrieved.\n *\n * This function gets a loyalty account using either a customer's contact ID or member ID. You can also get an account using the loyalty account ID with the [`getAccount()`](wix-loyalty-v2/accounts/getaccount) function.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can retrieve a loyalty account. \n * @public\n * @param options - ID of the customer to retrieve loyalty account for.\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function getAccountBySecondaryId(options?: GetAccountBySecondaryIdOptions): Promise;\n interface GetAccountBySecondaryIdOptions extends GetAccountBySecondaryIdRequestIdOneOf {\n /** Account owner's contact ID. See the [Contacts API](wix-crm-backend/contacts) to learn more. */\n contactId?: string;\n /** Account owner's member ID. See the [Members API](wix-members-backend/introduction) to learn more. */\n memberId?: string;\n }\n /**\n * > **Deprecation Notice**\n * >\n * > **This method has been replaced with [Query Loyalty Accounts](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/query-loyalty-accounts) and will be removed on June 30, 2025. If your app uses this method, we recommend updating your code as soon as possible.**\n *\n * Retrieves a list of loyalty accounts, given the provided filters.\n *\n * The `listAccounts()` function returns a Promise that resolves to a list of loyalty accounts.\n *\n * You can retrieve selected loyalty accounts with an array of `contactIds` or retrieve a list of all of a site's loyalty accounts\n * with an empty request parameter. Use the `cursorPaging` parameters to limit how many items load at a time.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can retrieve loyalty accounts. \n * @public\n * @param options - Options to use when retrieving a list of loyalty accounts.\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @deprecated\n * @replacedBy QueryLoyaltyAccounts\n * @targetRemovalDate 2025-06-01\n */\n function listAccounts(options?: ListAccountsOptions): Promise;\n interface ListAccountsOptions {\n /** List of contact IDs. See the [Contacts API](wix-crm-backend/contacts) to learn more. */\n contactIds?: string[];\n /** Pagination options. */\n cursorPaging?: CursorPaging;\n }\n /**\n * Retrieves a list of accounts, given the provided filters and search capabilities.\n * Search is executed on the account's name and email values.\n * @public\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Accounts found through provided search capabilities, along with paging and aggregation data of the results.\n */\n function searchAccounts(options?: SearchAccountsOptions): Promise;\n interface SearchAccountsOptions {\n /** Search options. */\n search?: CursorSearch;\n }\n interface ExportAccountsOptions {\n query?: QueryV2;\n }\n /**\n * Retrieves the count of found accounts, given the provided filters and search capabilities.\n *\n * This endpoint can help find the total count of accounts when used alongside [Search Accounts](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/search-accounts).\n * @public\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @permissionScope Read Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n * @returns Count of accounts found for given search query\n */\n function countAccounts(options?: CountAccountsOptions): Promise;\n interface CountAccountsOptions {\n /** Filter object. */\n filter?: Record | null;\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n }\n /**\n * Updates points balance of multiple accounts.\n * Depending on the BulkAdjustPointsRequest.type:\n * amount - provided amount of points is appended to the accounts balance\n * balance - accounts balance is set to the provided amount\n *\n * Returns id of the asyncInfra job that takes care of the points adjustment.\n * @public\n * @documentationMaturity preview\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @permissionScope Manage Loyalty\n * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkAdjustPoints(options?: BulkAdjustPointsOptions): Promise;\n interface BulkAdjustPointsOptions extends BulkAdjustPointsRequestTypeOneOf {\n search?: CursorSearch;\n balance?: number;\n amount?: number;\n }\n interface BulkUpsertAccountsOptions {\n /**\n * If true, the upserted accounts are returned in response\n * @deprecated If true, the upserted accounts are returned in response\n * @targetRemovalDate 2024-02-01\n */\n returnAccounts?: boolean;\n /** Description of the action */\n description?: string | null;\n }\n type loyaltyV1AccountAccounts_universal_d_LoyaltyAccount = LoyaltyAccount;\n type loyaltyV1AccountAccounts_universal_d_Points = Points;\n type loyaltyV1AccountAccounts_universal_d_Tier = Tier;\n type loyaltyV1AccountAccounts_universal_d_Contact = Contact;\n type loyaltyV1AccountAccounts_universal_d_Image = Image;\n type loyaltyV1AccountAccounts_universal_d_PointsExpiration = PointsExpiration;\n type loyaltyV1AccountAccounts_universal_d_RewardAvailabilityUpdated = RewardAvailabilityUpdated;\n type loyaltyV1AccountAccounts_universal_d_UpdateTrigger = UpdateTrigger;\n const loyaltyV1AccountAccounts_universal_d_UpdateTrigger: typeof UpdateTrigger;\n type loyaltyV1AccountAccounts_universal_d_CreateAccountRequest = CreateAccountRequest;\n type loyaltyV1AccountAccounts_universal_d_CreateAccountResponse = CreateAccountResponse;\n type loyaltyV1AccountAccounts_universal_d_EarnPointsRequest = EarnPointsRequest;\n type loyaltyV1AccountAccounts_universal_d_EarnPointsRequestActivityDetailsOneOf = EarnPointsRequestActivityDetailsOneOf;\n type loyaltyV1AccountAccounts_universal_d_FollowedSocialMedia = FollowedSocialMedia;\n type loyaltyV1AccountAccounts_universal_d_EarnPointsResponse = EarnPointsResponse;\n type loyaltyV1AccountAccounts_universal_d_PointsUpdated = PointsUpdated;\n type loyaltyV1AccountAccounts_universal_d_FirstTransaction = FirstTransaction;\n type loyaltyV1AccountAccounts_universal_d_AdjustPointsRequest = AdjustPointsRequest;\n type loyaltyV1AccountAccounts_universal_d_AdjustPointsRequestTypeOneOf = AdjustPointsRequestTypeOneOf;\n type loyaltyV1AccountAccounts_universal_d_AdjustPointsResponse = AdjustPointsResponse;\n type loyaltyV1AccountAccounts_universal_d_RedeemPointsRequest = RedeemPointsRequest;\n type loyaltyV1AccountAccounts_universal_d_RedeemPointsResponse = RedeemPointsResponse;\n type loyaltyV1AccountAccounts_universal_d_RedeemDeterminedAmountOfPointsRequest = RedeemDeterminedAmountOfPointsRequest;\n type loyaltyV1AccountAccounts_universal_d_RedeemDeterminedAmountOfPointsResponse = RedeemDeterminedAmountOfPointsResponse;\n type loyaltyV1AccountAccounts_universal_d_RefundTransactionRequest = RefundTransactionRequest;\n type loyaltyV1AccountAccounts_universal_d_RefundTransactionResponse = RefundTransactionResponse;\n type loyaltyV1AccountAccounts_universal_d_GetAccountRequest = GetAccountRequest;\n type loyaltyV1AccountAccounts_universal_d_GetAccountResponse = GetAccountResponse;\n type loyaltyV1AccountAccounts_universal_d_QueryLoyaltyAccountsRequest = QueryLoyaltyAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_CursorQuery = CursorQuery;\n type loyaltyV1AccountAccounts_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type loyaltyV1AccountAccounts_universal_d_Sorting = Sorting;\n type loyaltyV1AccountAccounts_universal_d_SortOrder = SortOrder;\n const loyaltyV1AccountAccounts_universal_d_SortOrder: typeof SortOrder;\n type loyaltyV1AccountAccounts_universal_d_CursorPaging = CursorPaging;\n type loyaltyV1AccountAccounts_universal_d_QueryLoyaltyAccountsResponse = QueryLoyaltyAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type loyaltyV1AccountAccounts_universal_d_Cursors = Cursors;\n type loyaltyV1AccountAccounts_universal_d_ListUserAccountsRequest = ListUserAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_ListUserAccountsResponse = ListUserAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_LoyaltyAccountForMetaSite = LoyaltyAccountForMetaSite;\n type loyaltyV1AccountAccounts_universal_d_GetProgramTotalsRequest = GetProgramTotalsRequest;\n type loyaltyV1AccountAccounts_universal_d_GetProgramTotalsResponse = GetProgramTotalsResponse;\n type loyaltyV1AccountAccounts_universal_d_TierTotal = TierTotal;\n type loyaltyV1AccountAccounts_universal_d_GetCurrentMemberAccountRequest = GetCurrentMemberAccountRequest;\n type loyaltyV1AccountAccounts_universal_d_GetCurrentMemberAccountResponse = GetCurrentMemberAccountResponse;\n type loyaltyV1AccountAccounts_universal_d_GetMyAccountRequest = GetMyAccountRequest;\n type loyaltyV1AccountAccounts_universal_d_GetMyAccountResponse = GetMyAccountResponse;\n type loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdRequest = GetAccountBySecondaryIdRequest;\n type loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdRequestIdOneOf = GetAccountBySecondaryIdRequestIdOneOf;\n type loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdResponse = GetAccountBySecondaryIdResponse;\n type loyaltyV1AccountAccounts_universal_d_ListAccountsRequest = ListAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_ListAccountsResponse = ListAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type loyaltyV1AccountAccounts_universal_d_SearchAccountsRequest = SearchAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_CursorSearch = CursorSearch;\n type loyaltyV1AccountAccounts_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type loyaltyV1AccountAccounts_universal_d_Aggregation = Aggregation;\n type loyaltyV1AccountAccounts_universal_d_AggregationKindOneOf = AggregationKindOneOf;\n type loyaltyV1AccountAccounts_universal_d_RangeBucket = RangeBucket;\n type loyaltyV1AccountAccounts_universal_d_SortType = SortType;\n const loyaltyV1AccountAccounts_universal_d_SortType: typeof SortType;\n type loyaltyV1AccountAccounts_universal_d_SortDirection = SortDirection;\n const loyaltyV1AccountAccounts_universal_d_SortDirection: typeof SortDirection;\n type loyaltyV1AccountAccounts_universal_d_MissingValues = MissingValues;\n const loyaltyV1AccountAccounts_universal_d_MissingValues: typeof MissingValues;\n type loyaltyV1AccountAccounts_universal_d_IncludeMissingValuesOptions = IncludeMissingValuesOptions;\n type loyaltyV1AccountAccounts_universal_d_ScalarType = ScalarType;\n const loyaltyV1AccountAccounts_universal_d_ScalarType: typeof ScalarType;\n type loyaltyV1AccountAccounts_universal_d_ValueAggregation = ValueAggregation;\n type loyaltyV1AccountAccounts_universal_d_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;\n type loyaltyV1AccountAccounts_universal_d_NestedAggregationType = NestedAggregationType;\n const loyaltyV1AccountAccounts_universal_d_NestedAggregationType: typeof NestedAggregationType;\n type loyaltyV1AccountAccounts_universal_d_RangeAggregation = RangeAggregation;\n type loyaltyV1AccountAccounts_universal_d_ScalarAggregation = ScalarAggregation;\n type loyaltyV1AccountAccounts_universal_d_DateHistogramAggregation = DateHistogramAggregation;\n type loyaltyV1AccountAccounts_universal_d_DateHistogramAggregationInterval = DateHistogramAggregationInterval;\n const loyaltyV1AccountAccounts_universal_d_DateHistogramAggregationInterval: typeof DateHistogramAggregationInterval;\n type loyaltyV1AccountAccounts_universal_d_NestedAggregationItem = NestedAggregationItem;\n type loyaltyV1AccountAccounts_universal_d_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;\n type loyaltyV1AccountAccounts_universal_d_AggregationType = AggregationType;\n const loyaltyV1AccountAccounts_universal_d_AggregationType: typeof AggregationType;\n type loyaltyV1AccountAccounts_universal_d_NestedAggregation = NestedAggregation;\n type loyaltyV1AccountAccounts_universal_d_GroupByAggregation = GroupByAggregation;\n type loyaltyV1AccountAccounts_universal_d_GroupByAggregationKindOneOf = GroupByAggregationKindOneOf;\n type loyaltyV1AccountAccounts_universal_d_SearchDetails = SearchDetails;\n type loyaltyV1AccountAccounts_universal_d_Mode = Mode;\n const loyaltyV1AccountAccounts_universal_d_Mode: typeof Mode;\n type loyaltyV1AccountAccounts_universal_d_SearchAccountsResponse = SearchAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_AggregationData = AggregationData;\n type loyaltyV1AccountAccounts_universal_d_ValueAggregationResult = ValueAggregationResult;\n type loyaltyV1AccountAccounts_universal_d_RangeAggregationResult = RangeAggregationResult;\n type loyaltyV1AccountAccounts_universal_d_NestedAggregationResults = NestedAggregationResults;\n type loyaltyV1AccountAccounts_universal_d_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;\n type loyaltyV1AccountAccounts_universal_d_ValueResults = ValueResults;\n type loyaltyV1AccountAccounts_universal_d_RangeResults = RangeResults;\n type loyaltyV1AccountAccounts_universal_d_AggregationResultsScalarResult = AggregationResultsScalarResult;\n type loyaltyV1AccountAccounts_universal_d_NestedValueAggregationResult = NestedValueAggregationResult;\n type loyaltyV1AccountAccounts_universal_d_ValueResult = ValueResult;\n type loyaltyV1AccountAccounts_universal_d_RangeResult = RangeResult;\n type loyaltyV1AccountAccounts_universal_d_ScalarResult = ScalarResult;\n type loyaltyV1AccountAccounts_universal_d_NestedResultValue = NestedResultValue;\n type loyaltyV1AccountAccounts_universal_d_NestedResultValueResultOneOf = NestedResultValueResultOneOf;\n type loyaltyV1AccountAccounts_universal_d_Results = Results;\n type loyaltyV1AccountAccounts_universal_d_DateHistogramResult = DateHistogramResult;\n type loyaltyV1AccountAccounts_universal_d_GroupByValueResults = GroupByValueResults;\n type loyaltyV1AccountAccounts_universal_d_DateHistogramResults = DateHistogramResults;\n type loyaltyV1AccountAccounts_universal_d_NestedResults = NestedResults;\n type loyaltyV1AccountAccounts_universal_d_AggregationResults = AggregationResults;\n type loyaltyV1AccountAccounts_universal_d_AggregationResultsResultOneOf = AggregationResultsResultOneOf;\n type loyaltyV1AccountAccounts_universal_d_ExportAccountsRequest = ExportAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_QueryV2 = QueryV2;\n type loyaltyV1AccountAccounts_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type loyaltyV1AccountAccounts_universal_d_Paging = Paging;\n type loyaltyV1AccountAccounts_universal_d_ExportAccountsResponse = ExportAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_CountAccountsRequest = CountAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_CountAccountsResponse = CountAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsRequest = BulkAdjustPointsRequest;\n type loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsRequestTypeOneOf = BulkAdjustPointsRequestTypeOneOf;\n type loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsResponse = BulkAdjustPointsResponse;\n type loyaltyV1AccountAccounts_universal_d_DomainEvent = DomainEvent;\n type loyaltyV1AccountAccounts_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type loyaltyV1AccountAccounts_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type loyaltyV1AccountAccounts_universal_d_RestoreInfo = RestoreInfo;\n type loyaltyV1AccountAccounts_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type loyaltyV1AccountAccounts_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type loyaltyV1AccountAccounts_universal_d_ActionEvent = ActionEvent;\n type loyaltyV1AccountAccounts_universal_d_Empty = Empty;\n type loyaltyV1AccountAccounts_universal_d_TiersRollingUpdate = TiersRollingUpdate;\n type loyaltyV1AccountAccounts_universal_d_TiersProgramSettingsChanged = TiersProgramSettingsChanged;\n type loyaltyV1AccountAccounts_universal_d_TiersProgramSettings = TiersProgramSettings;\n type loyaltyV1AccountAccounts_universal_d_TiersProgramSettingsPeriodOneOf = TiersProgramSettingsPeriodOneOf;\n type loyaltyV1AccountAccounts_universal_d_Status = Status;\n const loyaltyV1AccountAccounts_universal_d_Status: typeof Status;\n type loyaltyV1AccountAccounts_universal_d_TierDefinition = TierDefinition;\n type loyaltyV1AccountAccounts_universal_d_FocalPoint = FocalPoint;\n type loyaltyV1AccountAccounts_universal_d_RollingWindow = RollingWindow;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionEvent = SubscriptionEvent;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionEventEventOneOf = SubscriptionEventEventOneOf;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionCreated = SubscriptionCreated;\n type loyaltyV1AccountAccounts_universal_d_Subscription = Subscription;\n type loyaltyV1AccountAccounts_universal_d_BillingReference = BillingReference;\n type loyaltyV1AccountAccounts_universal_d_ProviderName = ProviderName;\n const loyaltyV1AccountAccounts_universal_d_ProviderName: typeof ProviderName;\n type loyaltyV1AccountAccounts_universal_d_Cycle = Cycle;\n type loyaltyV1AccountAccounts_universal_d_CycleCycleSelectorOneOf = CycleCycleSelectorOneOf;\n type loyaltyV1AccountAccounts_universal_d_Interval = Interval;\n type loyaltyV1AccountAccounts_universal_d_IntervalUnit = IntervalUnit;\n const loyaltyV1AccountAccounts_universal_d_IntervalUnit: typeof IntervalUnit;\n type loyaltyV1AccountAccounts_universal_d_OneTime = OneTime;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionStatus = SubscriptionStatus;\n const loyaltyV1AccountAccounts_universal_d_SubscriptionStatus: typeof SubscriptionStatus;\n type loyaltyV1AccountAccounts_universal_d_ReactivationData = ReactivationData;\n type loyaltyV1AccountAccounts_universal_d_ReactivationReasonEnum = ReactivationReasonEnum;\n const loyaltyV1AccountAccounts_universal_d_ReactivationReasonEnum: typeof ReactivationReasonEnum;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionAssigned = SubscriptionAssigned;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionCancelled = SubscriptionCancelled;\n type loyaltyV1AccountAccounts_universal_d_CancellationDetails = CancellationDetails;\n type loyaltyV1AccountAccounts_universal_d_Initiator = Initiator;\n const loyaltyV1AccountAccounts_universal_d_Initiator: typeof Initiator;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionAutoRenewTurnedOn = SubscriptionAutoRenewTurnedOn;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionAutoRenewTurnedOff = SubscriptionAutoRenewTurnedOff;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionUnassigned = SubscriptionUnassigned;\n type loyaltyV1AccountAccounts_universal_d_UnassignReason = UnassignReason;\n const loyaltyV1AccountAccounts_universal_d_UnassignReason: typeof UnassignReason;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionTransferred = SubscriptionTransferred;\n type loyaltyV1AccountAccounts_universal_d_RecurringChargeSucceeded = RecurringChargeSucceeded;\n type loyaltyV1AccountAccounts_universal_d_ContractSwitched = ContractSwitched;\n type loyaltyV1AccountAccounts_universal_d_ContractSwitchType = ContractSwitchType;\n const loyaltyV1AccountAccounts_universal_d_ContractSwitchType: typeof ContractSwitchType;\n type loyaltyV1AccountAccounts_universal_d_ContractSwitchReason = ContractSwitchReason;\n const loyaltyV1AccountAccounts_universal_d_ContractSwitchReason: typeof ContractSwitchReason;\n type loyaltyV1AccountAccounts_universal_d_ProductPriceIncreaseData = ProductPriceIncreaseData;\n type loyaltyV1AccountAccounts_universal_d_PriceIncreaseTrigger = PriceIncreaseTrigger;\n const loyaltyV1AccountAccounts_universal_d_PriceIncreaseTrigger: typeof PriceIncreaseTrigger;\n type loyaltyV1AccountAccounts_universal_d_ProductAdjustment = ProductAdjustment;\n const loyaltyV1AccountAccounts_universal_d_ProductAdjustment: typeof ProductAdjustment;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionNearEndOfPeriod = SubscriptionNearEndOfPeriod;\n type loyaltyV1AccountAccounts_universal_d_SubscriptionPendingChange = SubscriptionPendingChange;\n type loyaltyV1AccountAccounts_universal_d_ContactSyncRequest = ContactSyncRequest;\n type loyaltyV1AccountAccounts_universal_d_BulkUpsertAccountsRequest = BulkUpsertAccountsRequest;\n type loyaltyV1AccountAccounts_universal_d_AccountToUpsert = AccountToUpsert;\n type loyaltyV1AccountAccounts_universal_d_BulkUpsertAccountsResponse = BulkUpsertAccountsResponse;\n type loyaltyV1AccountAccounts_universal_d_BulkAccountResult = BulkAccountResult;\n type loyaltyV1AccountAccounts_universal_d_ItemMetadata = ItemMetadata;\n type loyaltyV1AccountAccounts_universal_d_ApplicationError = ApplicationError;\n type loyaltyV1AccountAccounts_universal_d_BulkActionMetadata = BulkActionMetadata;\n type loyaltyV1AccountAccounts_universal_d_SetMissingMemberIdRequest = SetMissingMemberIdRequest;\n type loyaltyV1AccountAccounts_universal_d_SetMissingMemberIdResponse = SetMissingMemberIdResponse;\n type loyaltyV1AccountAccounts_universal_d_MessageEnvelope = MessageEnvelope;\n type loyaltyV1AccountAccounts_universal_d_IdentificationData = IdentificationData;\n type loyaltyV1AccountAccounts_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type loyaltyV1AccountAccounts_universal_d_WebhookIdentityType = WebhookIdentityType;\n const loyaltyV1AccountAccounts_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const loyaltyV1AccountAccounts_universal_d_createAccount: typeof createAccount;\n const loyaltyV1AccountAccounts_universal_d_earnPoints: typeof earnPoints;\n type loyaltyV1AccountAccounts_universal_d_EarnPointsOptions = EarnPointsOptions;\n const loyaltyV1AccountAccounts_universal_d_adjustPoints: typeof adjustPoints;\n type loyaltyV1AccountAccounts_universal_d_AdjustPointsOptions = AdjustPointsOptions;\n type loyaltyV1AccountAccounts_universal_d_RedeemPointsOptions = RedeemPointsOptions;\n type loyaltyV1AccountAccounts_universal_d_RedeemDeterminedAmountOfPointsOptions = RedeemDeterminedAmountOfPointsOptions;\n const loyaltyV1AccountAccounts_universal_d_getAccount: typeof getAccount;\n const loyaltyV1AccountAccounts_universal_d_queryLoyaltyAccounts: typeof queryLoyaltyAccounts;\n type loyaltyV1AccountAccounts_universal_d_LoyaltyAccountsQueryResult = LoyaltyAccountsQueryResult;\n type loyaltyV1AccountAccounts_universal_d_LoyaltyAccountsQueryBuilder = LoyaltyAccountsQueryBuilder;\n type loyaltyV1AccountAccounts_universal_d_ListUserAccountsOptions = ListUserAccountsOptions;\n const loyaltyV1AccountAccounts_universal_d_getProgramTotals: typeof getProgramTotals;\n const loyaltyV1AccountAccounts_universal_d_getCurrentMemberAccount: typeof getCurrentMemberAccount;\n const loyaltyV1AccountAccounts_universal_d_getAccountBySecondaryId: typeof getAccountBySecondaryId;\n type loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdOptions = GetAccountBySecondaryIdOptions;\n const loyaltyV1AccountAccounts_universal_d_listAccounts: typeof listAccounts;\n type loyaltyV1AccountAccounts_universal_d_ListAccountsOptions = ListAccountsOptions;\n const loyaltyV1AccountAccounts_universal_d_searchAccounts: typeof searchAccounts;\n type loyaltyV1AccountAccounts_universal_d_SearchAccountsOptions = SearchAccountsOptions;\n type loyaltyV1AccountAccounts_universal_d_ExportAccountsOptions = ExportAccountsOptions;\n const loyaltyV1AccountAccounts_universal_d_countAccounts: typeof countAccounts;\n type loyaltyV1AccountAccounts_universal_d_CountAccountsOptions = CountAccountsOptions;\n const loyaltyV1AccountAccounts_universal_d_bulkAdjustPoints: typeof bulkAdjustPoints;\n type loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsOptions = BulkAdjustPointsOptions;\n type loyaltyV1AccountAccounts_universal_d_BulkUpsertAccountsOptions = BulkUpsertAccountsOptions;\n namespace loyaltyV1AccountAccounts_universal_d {\n export { loyaltyV1AccountAccounts_universal_d_LoyaltyAccount as LoyaltyAccount, loyaltyV1AccountAccounts_universal_d_Points as Points, loyaltyV1AccountAccounts_universal_d_Tier as Tier, loyaltyV1AccountAccounts_universal_d_Contact as Contact, loyaltyV1AccountAccounts_universal_d_Image as Image, loyaltyV1AccountAccounts_universal_d_PointsExpiration as PointsExpiration, loyaltyV1AccountAccounts_universal_d_RewardAvailabilityUpdated as RewardAvailabilityUpdated, loyaltyV1AccountAccounts_universal_d_UpdateTrigger as UpdateTrigger, loyaltyV1AccountAccounts_universal_d_CreateAccountRequest as CreateAccountRequest, loyaltyV1AccountAccounts_universal_d_CreateAccountResponse as CreateAccountResponse, loyaltyV1AccountAccounts_universal_d_EarnPointsRequest as EarnPointsRequest, loyaltyV1AccountAccounts_universal_d_EarnPointsRequestActivityDetailsOneOf as EarnPointsRequestActivityDetailsOneOf, loyaltyV1AccountAccounts_universal_d_FollowedSocialMedia as FollowedSocialMedia, loyaltyV1AccountAccounts_universal_d_EarnPointsResponse as EarnPointsResponse, loyaltyV1AccountAccounts_universal_d_PointsUpdated as PointsUpdated, loyaltyV1AccountAccounts_universal_d_FirstTransaction as FirstTransaction, loyaltyV1AccountAccounts_universal_d_AdjustPointsRequest as AdjustPointsRequest, loyaltyV1AccountAccounts_universal_d_AdjustPointsRequestTypeOneOf as AdjustPointsRequestTypeOneOf, loyaltyV1AccountAccounts_universal_d_AdjustPointsResponse as AdjustPointsResponse, loyaltyV1AccountAccounts_universal_d_RedeemPointsRequest as RedeemPointsRequest, loyaltyV1AccountAccounts_universal_d_RedeemPointsResponse as RedeemPointsResponse, loyaltyV1AccountAccounts_universal_d_RedeemDeterminedAmountOfPointsRequest as RedeemDeterminedAmountOfPointsRequest, loyaltyV1AccountAccounts_universal_d_RedeemDeterminedAmountOfPointsResponse as RedeemDeterminedAmountOfPointsResponse, loyaltyV1AccountAccounts_universal_d_RefundTransactionRequest as RefundTransactionRequest, loyaltyV1AccountAccounts_universal_d_RefundTransactionResponse as RefundTransactionResponse, loyaltyV1AccountAccounts_universal_d_GetAccountRequest as GetAccountRequest, loyaltyV1AccountAccounts_universal_d_GetAccountResponse as GetAccountResponse, loyaltyV1AccountAccounts_universal_d_QueryLoyaltyAccountsRequest as QueryLoyaltyAccountsRequest, loyaltyV1AccountAccounts_universal_d_CursorQuery as CursorQuery, loyaltyV1AccountAccounts_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, loyaltyV1AccountAccounts_universal_d_Sorting as Sorting, loyaltyV1AccountAccounts_universal_d_SortOrder as SortOrder, loyaltyV1AccountAccounts_universal_d_CursorPaging as CursorPaging, loyaltyV1AccountAccounts_universal_d_QueryLoyaltyAccountsResponse as QueryLoyaltyAccountsResponse, loyaltyV1AccountAccounts_universal_d_CursorPagingMetadata as CursorPagingMetadata, loyaltyV1AccountAccounts_universal_d_Cursors as Cursors, loyaltyV1AccountAccounts_universal_d_ListUserAccountsRequest as ListUserAccountsRequest, loyaltyV1AccountAccounts_universal_d_ListUserAccountsResponse as ListUserAccountsResponse, loyaltyV1AccountAccounts_universal_d_LoyaltyAccountForMetaSite as LoyaltyAccountForMetaSite, loyaltyV1AccountAccounts_universal_d_GetProgramTotalsRequest as GetProgramTotalsRequest, loyaltyV1AccountAccounts_universal_d_GetProgramTotalsResponse as GetProgramTotalsResponse, loyaltyV1AccountAccounts_universal_d_TierTotal as TierTotal, loyaltyV1AccountAccounts_universal_d_GetCurrentMemberAccountRequest as GetCurrentMemberAccountRequest, loyaltyV1AccountAccounts_universal_d_GetCurrentMemberAccountResponse as GetCurrentMemberAccountResponse, loyaltyV1AccountAccounts_universal_d_GetMyAccountRequest as GetMyAccountRequest, loyaltyV1AccountAccounts_universal_d_GetMyAccountResponse as GetMyAccountResponse, loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdRequest as GetAccountBySecondaryIdRequest, loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdRequestIdOneOf as GetAccountBySecondaryIdRequestIdOneOf, loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdResponse as GetAccountBySecondaryIdResponse, loyaltyV1AccountAccounts_universal_d_ListAccountsRequest as ListAccountsRequest, loyaltyV1AccountAccounts_universal_d_ListAccountsResponse as ListAccountsResponse, loyaltyV1AccountAccounts_universal_d_PagingMetadataV2 as PagingMetadataV2, loyaltyV1AccountAccounts_universal_d_SearchAccountsRequest as SearchAccountsRequest, loyaltyV1AccountAccounts_universal_d_CursorSearch as CursorSearch, loyaltyV1AccountAccounts_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, loyaltyV1AccountAccounts_universal_d_Aggregation as Aggregation, loyaltyV1AccountAccounts_universal_d_AggregationKindOneOf as AggregationKindOneOf, loyaltyV1AccountAccounts_universal_d_RangeBucket as RangeBucket, loyaltyV1AccountAccounts_universal_d_SortType as SortType, loyaltyV1AccountAccounts_universal_d_SortDirection as SortDirection, loyaltyV1AccountAccounts_universal_d_MissingValues as MissingValues, loyaltyV1AccountAccounts_universal_d_IncludeMissingValuesOptions as IncludeMissingValuesOptions, loyaltyV1AccountAccounts_universal_d_ScalarType as ScalarType, loyaltyV1AccountAccounts_universal_d_ValueAggregation as ValueAggregation, loyaltyV1AccountAccounts_universal_d_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf, loyaltyV1AccountAccounts_universal_d_NestedAggregationType as NestedAggregationType, loyaltyV1AccountAccounts_universal_d_RangeAggregation as RangeAggregation, loyaltyV1AccountAccounts_universal_d_ScalarAggregation as ScalarAggregation, loyaltyV1AccountAccounts_universal_d_DateHistogramAggregation as DateHistogramAggregation, loyaltyV1AccountAccounts_universal_d_DateHistogramAggregationInterval as DateHistogramAggregationInterval, loyaltyV1AccountAccounts_universal_d_NestedAggregationItem as NestedAggregationItem, loyaltyV1AccountAccounts_universal_d_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, loyaltyV1AccountAccounts_universal_d_AggregationType as AggregationType, loyaltyV1AccountAccounts_universal_d_NestedAggregation as NestedAggregation, loyaltyV1AccountAccounts_universal_d_GroupByAggregation as GroupByAggregation, loyaltyV1AccountAccounts_universal_d_GroupByAggregationKindOneOf as GroupByAggregationKindOneOf, loyaltyV1AccountAccounts_universal_d_SearchDetails as SearchDetails, loyaltyV1AccountAccounts_universal_d_Mode as Mode, loyaltyV1AccountAccounts_universal_d_SearchAccountsResponse as SearchAccountsResponse, loyaltyV1AccountAccounts_universal_d_AggregationData as AggregationData, loyaltyV1AccountAccounts_universal_d_ValueAggregationResult as ValueAggregationResult, loyaltyV1AccountAccounts_universal_d_RangeAggregationResult as RangeAggregationResult, loyaltyV1AccountAccounts_universal_d_NestedAggregationResults as NestedAggregationResults, loyaltyV1AccountAccounts_universal_d_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf, loyaltyV1AccountAccounts_universal_d_ValueResults as ValueResults, loyaltyV1AccountAccounts_universal_d_RangeResults as RangeResults, loyaltyV1AccountAccounts_universal_d_AggregationResultsScalarResult as AggregationResultsScalarResult, loyaltyV1AccountAccounts_universal_d_NestedValueAggregationResult as NestedValueAggregationResult, loyaltyV1AccountAccounts_universal_d_ValueResult as ValueResult, loyaltyV1AccountAccounts_universal_d_RangeResult as RangeResult, loyaltyV1AccountAccounts_universal_d_ScalarResult as ScalarResult, loyaltyV1AccountAccounts_universal_d_NestedResultValue as NestedResultValue, loyaltyV1AccountAccounts_universal_d_NestedResultValueResultOneOf as NestedResultValueResultOneOf, loyaltyV1AccountAccounts_universal_d_Results as Results, loyaltyV1AccountAccounts_universal_d_DateHistogramResult as DateHistogramResult, loyaltyV1AccountAccounts_universal_d_GroupByValueResults as GroupByValueResults, loyaltyV1AccountAccounts_universal_d_DateHistogramResults as DateHistogramResults, loyaltyV1AccountAccounts_universal_d_NestedResults as NestedResults, loyaltyV1AccountAccounts_universal_d_AggregationResults as AggregationResults, loyaltyV1AccountAccounts_universal_d_AggregationResultsResultOneOf as AggregationResultsResultOneOf, loyaltyV1AccountAccounts_universal_d_ExportAccountsRequest as ExportAccountsRequest, loyaltyV1AccountAccounts_universal_d_QueryV2 as QueryV2, loyaltyV1AccountAccounts_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, loyaltyV1AccountAccounts_universal_d_Paging as Paging, loyaltyV1AccountAccounts_universal_d_ExportAccountsResponse as ExportAccountsResponse, loyaltyV1AccountAccounts_universal_d_CountAccountsRequest as CountAccountsRequest, loyaltyV1AccountAccounts_universal_d_CountAccountsResponse as CountAccountsResponse, loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsRequest as BulkAdjustPointsRequest, loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsRequestTypeOneOf as BulkAdjustPointsRequestTypeOneOf, loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsResponse as BulkAdjustPointsResponse, loyaltyV1AccountAccounts_universal_d_DomainEvent as DomainEvent, loyaltyV1AccountAccounts_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, loyaltyV1AccountAccounts_universal_d_EntityCreatedEvent as EntityCreatedEvent, loyaltyV1AccountAccounts_universal_d_RestoreInfo as RestoreInfo, loyaltyV1AccountAccounts_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, loyaltyV1AccountAccounts_universal_d_EntityDeletedEvent as EntityDeletedEvent, loyaltyV1AccountAccounts_universal_d_ActionEvent as ActionEvent, loyaltyV1AccountAccounts_universal_d_Empty as Empty, loyaltyV1AccountAccounts_universal_d_TiersRollingUpdate as TiersRollingUpdate, loyaltyV1AccountAccounts_universal_d_TiersProgramSettingsChanged as TiersProgramSettingsChanged, loyaltyV1AccountAccounts_universal_d_TiersProgramSettings as TiersProgramSettings, loyaltyV1AccountAccounts_universal_d_TiersProgramSettingsPeriodOneOf as TiersProgramSettingsPeriodOneOf, loyaltyV1AccountAccounts_universal_d_Status as Status, loyaltyV1AccountAccounts_universal_d_TierDefinition as TierDefinition, loyaltyV1AccountAccounts_universal_d_FocalPoint as FocalPoint, loyaltyV1AccountAccounts_universal_d_RollingWindow as RollingWindow, loyaltyV1AccountAccounts_universal_d_SubscriptionEvent as SubscriptionEvent, loyaltyV1AccountAccounts_universal_d_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, loyaltyV1AccountAccounts_universal_d_SubscriptionCreated as SubscriptionCreated, loyaltyV1AccountAccounts_universal_d_Subscription as Subscription, loyaltyV1AccountAccounts_universal_d_BillingReference as BillingReference, loyaltyV1AccountAccounts_universal_d_ProviderName as ProviderName, loyaltyV1AccountAccounts_universal_d_Cycle as Cycle, loyaltyV1AccountAccounts_universal_d_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, loyaltyV1AccountAccounts_universal_d_Interval as Interval, loyaltyV1AccountAccounts_universal_d_IntervalUnit as IntervalUnit, loyaltyV1AccountAccounts_universal_d_OneTime as OneTime, loyaltyV1AccountAccounts_universal_d_SubscriptionStatus as SubscriptionStatus, loyaltyV1AccountAccounts_universal_d_ReactivationData as ReactivationData, loyaltyV1AccountAccounts_universal_d_ReactivationReasonEnum as ReactivationReasonEnum, loyaltyV1AccountAccounts_universal_d_SubscriptionAssigned as SubscriptionAssigned, loyaltyV1AccountAccounts_universal_d_SubscriptionCancelled as SubscriptionCancelled, loyaltyV1AccountAccounts_universal_d_CancellationDetails as CancellationDetails, loyaltyV1AccountAccounts_universal_d_Initiator as Initiator, loyaltyV1AccountAccounts_universal_d_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, loyaltyV1AccountAccounts_universal_d_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, loyaltyV1AccountAccounts_universal_d_SubscriptionUnassigned as SubscriptionUnassigned, loyaltyV1AccountAccounts_universal_d_UnassignReason as UnassignReason, loyaltyV1AccountAccounts_universal_d_SubscriptionTransferred as SubscriptionTransferred, loyaltyV1AccountAccounts_universal_d_RecurringChargeSucceeded as RecurringChargeSucceeded, loyaltyV1AccountAccounts_universal_d_ContractSwitched as ContractSwitched, loyaltyV1AccountAccounts_universal_d_ContractSwitchType as ContractSwitchType, loyaltyV1AccountAccounts_universal_d_ContractSwitchReason as ContractSwitchReason, loyaltyV1AccountAccounts_universal_d_ProductPriceIncreaseData as ProductPriceIncreaseData, loyaltyV1AccountAccounts_universal_d_PriceIncreaseTrigger as PriceIncreaseTrigger, loyaltyV1AccountAccounts_universal_d_ProductAdjustment as ProductAdjustment, loyaltyV1AccountAccounts_universal_d_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, loyaltyV1AccountAccounts_universal_d_SubscriptionPendingChange as SubscriptionPendingChange, loyaltyV1AccountAccounts_universal_d_ContactSyncRequest as ContactSyncRequest, loyaltyV1AccountAccounts_universal_d_BulkUpsertAccountsRequest as BulkUpsertAccountsRequest, loyaltyV1AccountAccounts_universal_d_AccountToUpsert as AccountToUpsert, loyaltyV1AccountAccounts_universal_d_BulkUpsertAccountsResponse as BulkUpsertAccountsResponse, loyaltyV1AccountAccounts_universal_d_BulkAccountResult as BulkAccountResult, loyaltyV1AccountAccounts_universal_d_ItemMetadata as ItemMetadata, loyaltyV1AccountAccounts_universal_d_ApplicationError as ApplicationError, loyaltyV1AccountAccounts_universal_d_BulkActionMetadata as BulkActionMetadata, loyaltyV1AccountAccounts_universal_d_SetMissingMemberIdRequest as SetMissingMemberIdRequest, loyaltyV1AccountAccounts_universal_d_SetMissingMemberIdResponse as SetMissingMemberIdResponse, loyaltyV1AccountAccounts_universal_d_MessageEnvelope as MessageEnvelope, loyaltyV1AccountAccounts_universal_d_IdentificationData as IdentificationData, loyaltyV1AccountAccounts_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, loyaltyV1AccountAccounts_universal_d_WebhookIdentityType as WebhookIdentityType, loyaltyV1AccountAccounts_universal_d_createAccount as createAccount, loyaltyV1AccountAccounts_universal_d_earnPoints as earnPoints, loyaltyV1AccountAccounts_universal_d_EarnPointsOptions as EarnPointsOptions, loyaltyV1AccountAccounts_universal_d_adjustPoints as adjustPoints, loyaltyV1AccountAccounts_universal_d_AdjustPointsOptions as AdjustPointsOptions, loyaltyV1AccountAccounts_universal_d_RedeemPointsOptions as RedeemPointsOptions, loyaltyV1AccountAccounts_universal_d_RedeemDeterminedAmountOfPointsOptions as RedeemDeterminedAmountOfPointsOptions, loyaltyV1AccountAccounts_universal_d_getAccount as getAccount, loyaltyV1AccountAccounts_universal_d_queryLoyaltyAccounts as queryLoyaltyAccounts, loyaltyV1AccountAccounts_universal_d_LoyaltyAccountsQueryResult as LoyaltyAccountsQueryResult, loyaltyV1AccountAccounts_universal_d_LoyaltyAccountsQueryBuilder as LoyaltyAccountsQueryBuilder, loyaltyV1AccountAccounts_universal_d_ListUserAccountsOptions as ListUserAccountsOptions, loyaltyV1AccountAccounts_universal_d_getProgramTotals as getProgramTotals, loyaltyV1AccountAccounts_universal_d_getCurrentMemberAccount as getCurrentMemberAccount, loyaltyV1AccountAccounts_universal_d_getAccountBySecondaryId as getAccountBySecondaryId, loyaltyV1AccountAccounts_universal_d_GetAccountBySecondaryIdOptions as GetAccountBySecondaryIdOptions, loyaltyV1AccountAccounts_universal_d_listAccounts as listAccounts, loyaltyV1AccountAccounts_universal_d_ListAccountsOptions as ListAccountsOptions, loyaltyV1AccountAccounts_universal_d_searchAccounts as searchAccounts, loyaltyV1AccountAccounts_universal_d_SearchAccountsOptions as SearchAccountsOptions, loyaltyV1AccountAccounts_universal_d_ExportAccountsOptions as ExportAccountsOptions, loyaltyV1AccountAccounts_universal_d_countAccounts as countAccounts, loyaltyV1AccountAccounts_universal_d_CountAccountsOptions as CountAccountsOptions, loyaltyV1AccountAccounts_universal_d_bulkAdjustPoints as bulkAdjustPoints, loyaltyV1AccountAccounts_universal_d_BulkAdjustPointsOptions as BulkAdjustPointsOptions, loyaltyV1AccountAccounts_universal_d_BulkUpsertAccountsOptions as BulkUpsertAccountsOptions, };\n }\n export { loyaltyV1AccountAccounts_universal_d as accounts, loyaltyV1CouponCoupons_universal_d as coupons, loyaltyV1ProgramPrograms_universal_d as programs, loyaltyV1RewardRewards_universal_d as rewards, loyaltyV1TierTiers_universal_d as tiers, loyaltyTransactionV1LoyaltyTransactionTransactions_universal_d as transactions };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-business-tools.v2.d.ts", "content": "declare module \"wix-business-tools.v2\" {\n interface Location {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Notes:__\n * - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status.\n * - `INACTIVE` status is currently not supported.\n */\n status?: LocationStatus;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n * @deprecated\n */\n locationType?: LocationType;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: Address$1;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$1;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationType[];\n }\n /** For future use */\n enum LocationStatus {\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n /** For future use */\n enum LocationType {\n UNKNOWN = \"UNKNOWN\",\n BRANCH = \"BRANCH\",\n OFFICES = \"OFFICES\",\n RECEPTION = \"RECEPTION\",\n HEADQUARTERS = \"HEADQUARTERS\",\n INVENTORY = \"INVENTORY\"\n }\n interface Address$1 {\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n streetAddress?: StreetAddress;\n /** Full address of the location. */\n formatted?: string | null;\n /** Geographic coordinates of location. */\n location?: AddressLocation;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /** Apartment number. */\n apt?: string;\n }\n /** Address Geolocation */\n interface AddressLocation {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number | null;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number | null;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$1 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$1[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$1[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$1 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$1;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$1;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$1 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$1 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface CreateLocationRequest {\n /** Location to create. */\n location: Location;\n }\n interface CreateLocationResponse {\n /** Created location. */\n location?: Location;\n }\n interface BulkCreateLocationRequest {\n /** Locations to create. */\n locations: Location[];\n }\n interface BulkCreateLocationResponse {\n /** Locations that were created. */\n successfulLocations?: Location[];\n /** Locations that failed. */\n failedLocations?: FailedCreateLocation[];\n }\n interface FailedCreateLocation {\n /** Location that couldn't be created. */\n location?: Location;\n /** Error message. */\n errorMessage?: string;\n }\n interface GetLocationRequest {\n /** ID of the location to retrieve. */\n _id: string;\n }\n interface GetLocationResponse {\n /** Retrieved location. */\n location?: Location;\n }\n interface ListLocationsRequest {\n /** Sort order. */\n sort?: Sorting;\n /**\n * Pagination.\n *\n * Default values:\n * `offset`: 0\n * `limit`: 50 (Max: 1000)\n */\n paging?: Paging;\n /**\n * Whether to include `archived` locations in the response.\n *\n * Default: `false`\n */\n includeArchived?: boolean;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /**\n * Number of items to load.\n *\n * Default: `50`\n *\n * Max: `1000`\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Default: `0`\n */\n offset?: number | null;\n }\n interface ListLocationsResponse {\n /** Retrieved locations. */\n locations?: Location[];\n /** Paging info. */\n pagingMetadata?: PagingMetadata;\n }\n interface PagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface UpdateLocationRequest {\n /** Location to update. */\n location: Location;\n }\n interface UpdateLocationResponse {\n /** Updated location. */\n location?: Location;\n }\n interface BulkUpdateLocationRequest {\n /** Locations to update. */\n locations: Location[];\n }\n interface BulkUpdateLocationResponse {\n /** Locations that were updated. */\n successfulLocations?: Location[];\n /** Locations that failed. */\n failedLocations?: FailedUpdateLocation[];\n }\n interface FailedUpdateLocation {\n /** Location that couldn't be updated. */\n _id?: string;\n /** Error message. */\n errorMessage?: string;\n }\n interface QueryLocationsRequest {\n /** Information about the filters, sorting, and paging. */\n query?: Query;\n }\n interface Query {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface QueryLocationsResponse {\n /** Retrieved locations. */\n locations?: Location[];\n /** Paging info. */\n pagingMetadata?: PagingMetadata;\n }\n interface SetDefaultLocationRequest {\n /** ID of the location to set as the default location. */\n _id: string;\n }\n interface SetDefaultLocationResponse {\n /** New default location. */\n location?: Location;\n }\n interface SetDefaultLocation {\n /** Previous default location id. */\n prevDefaultLocationId?: string;\n /** Current default location id. */\n currDefaultLocationId?: string;\n }\n interface ArchiveLocationRequest {\n /** ID of the location to archive. */\n _id: string;\n }\n interface ArchiveLocationResponse {\n /** Archived location. */\n location?: Location;\n }\n interface ArchiveLocation {\n _id?: string;\n }\n interface AddTypeToLocationRequest {\n /** ID of the location where the type will be added. */\n _id: string;\n /** Location type to add. */\n locationType: LocationType;\n }\n interface AddTypeToLocationResponse {\n /** Updated location. */\n location?: Location;\n }\n interface RemoveTypeFromLocationRequest {\n /** ID of the location where the type will be removed. */\n _id: string;\n /** Location type to remove. */\n locationType: LocationType;\n }\n interface RemoveTypeFromLocationResponse {\n /** Updated location. */\n location?: Location;\n }\n interface AddLocationTypeRequest {\n /** Location id to add type */\n _id: string;\n locationType: LocationType;\n }\n interface AddLocationTypeResponse {\n /** Full location with the new type */\n location?: Location;\n }\n interface RemoveLocationTypeRequest {\n /** Location id to add type */\n _id: string;\n locationType: LocationType;\n }\n interface RemoveLocationTypeResponse {\n /** Full location with the new type */\n location?: Location;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a location.\n * @param location - Location to create.\n * @public\n * @documentationMaturity preview\n * @requiredField location\n * @requiredField location.address\n * @requiredField location.name\n * @requiredField location.timeZone\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created location.\n * @fqn com.wixpress.locations.LocationsService.CreateLocation\n */\n function createLocation(location: Location): Promise;\n /**\n * Retrieves a location.\n * @param _id - ID of the location to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId LOCATIONS.READ\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Calendars\n * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Read Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.READ-LOCATIONS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @adminMethod\n * @returns Retrieved location.\n * @fqn com.wixpress.locations.LocationsService.GetLocation\n */\n function getLocation(_id: string): Promise;\n /**\n * Retrieves locations, given the specified filters, sorting, and paging.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when retrieving a list of locations.\n * @permissionId LOCATIONS.READ\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Calendars\n * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Read Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.READ-LOCATIONS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.ListLocations\n */\n function listLocations(options?: ListLocationsOptions): Promise;\n interface ListLocationsOptions {\n /** Sort order. */\n sort?: Sorting;\n /**\n * Pagination.\n *\n * Default values:\n * `offset`: 0\n * `limit`: 50 (Max: 1000)\n */\n paging?: Paging;\n /**\n * Whether to include `archived` locations in the response.\n *\n * Default: `false`\n */\n includeArchived?: boolean;\n }\n /**\n * Overrides an existing location.\n *\n *\n * > **Note:** Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call.\n * @param _id - Location ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField location\n * @requiredField location.address\n * @requiredField location.name\n * @requiredField location.timeZone\n * @param location - Updated location details.\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated location.\n * @fqn com.wixpress.locations.LocationsService.UpdateLocation\n */\n function updateLocation(_id: string | null, location: UpdateLocation): Promise;\n interface UpdateLocation {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /** Location name. */\n name?: string;\n /** Location description. */\n description?: string | null;\n /**\n * Whether this is the default location. There can only be one default location per site. The default location can't be archived.\n * @readonly\n */\n default?: boolean;\n /**\n * Location status. Defaults to `ACTIVE`.\n * __Notes:__\n * - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect the location's status.\n * - `INACTIVE` status is currently not supported.\n */\n status?: LocationStatus;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n * @deprecated\n */\n locationType?: LocationType;\n /** Fax number. */\n fax?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Address. */\n address?: Address$1;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$1;\n /**\n * Revision number, which increments by 1 each time the location is updated.\n * To prevent conflicting changes, the existing revision must be used when updating a location.\n */\n revision?: string | null;\n /**\n * Whether the location is archived. Archived locations can't be updated.\n * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)\n * doesn't affect its `status`.\n * @readonly\n */\n archived?: boolean;\n /** Location types. */\n locationTypes?: LocationType[];\n }\n /**\n * Creates a query to retrieve a list of locations.\n *\n *\n * The `queryLocations()` function builds a query to retrieve a list of up to 1,000 locations and returns a `LocationsQueryBuilder` object.\n *\n * The returned object contains the query definition which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `LocationsQueryBuilder` functions onto the query. `LocationsQueryBuilder` functions enable you to sort, filter, and control the results that `queryLocations()` returns. The functions that are chained to `queryLocations()` are applied in the order they are called.\n *\n * `queryLocations()` runs with the following `LocationsQueryBuilder` defaults that you can override:\n * - `skip`: `0`\n * - `limit`: `50`\n *\n * The following `QueryLocationsBuilder` functions are supported for the `queryLocations()` function. For a full description of the Locations object, see the object returned for the `items` property in `LocationsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when querying locations.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Calendars\n * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Read Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.READ-LOCATIONS\n * @permissionId LOCATIONS.READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.QueryLocations\n */\n function queryLocations(): LocationsQueryBuilder;\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LocationsQueryResult extends QueryOffsetResult {\n items: Location[];\n query: LocationsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LocationsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"name\" | \"description\" | \"default\" | \"status\" | \"locationType\" | \"fax\" | \"timeZone\" | \"email\" | \"phone\" | \"address.country\" | \"address.subdivision\" | \"address.city\" | \"address.postalCode\" | \"address.streetAddress.number\" | \"address.streetAddress.name\" | \"address.streetAddress.apt\" | \"address.formattedAddress\" | \"address.hint\" | \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"businessSchedule.periods.openDay\" | \"businessSchedule.periods.openTime\" | \"businessSchedule.periods.closeDay\" | \"businessSchedule.periods.closeTime\" | \"businessSchedule.specialHourPeriod.startDate\" | \"businessSchedule.specialHourPeriod.endDate\" | \"businessSchedule.specialHourPeriod.isClosed\" | \"businessSchedule.specialHourPeriod.comment\" | \"revision\" | \"archived\", value: any) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"name\" | \"description\" | \"default\" | \"status\" | \"locationType\" | \"fax\" | \"timeZone\" | \"email\" | \"phone\" | \"address.country\" | \"address.subdivision\" | \"address.city\" | \"address.postalCode\" | \"address.streetAddress.number\" | \"address.streetAddress.name\" | \"address.streetAddress.apt\" | \"address.formattedAddress\" | \"address.hint\" | \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"businessSchedule.periods.openDay\" | \"businessSchedule.periods.openTime\" | \"businessSchedule.periods.closeDay\" | \"businessSchedule.periods.closeTime\" | \"businessSchedule.specialHourPeriod.startDate\" | \"businessSchedule.specialHourPeriod.endDate\" | \"businessSchedule.specialHourPeriod.isClosed\" | \"businessSchedule.specialHourPeriod.comment\" | \"revision\" | \"archived\", value: any) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"revision\", value: any) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"revision\", value: any) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"revision\", value: any) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"revision\", value: any) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"name\" | \"description\" | \"fax\" | \"timeZone\" | \"email\" | \"phone\" | \"address.country\" | \"address.subdivision\" | \"address.city\" | \"address.postalCode\" | \"address.streetAddress.number\" | \"address.streetAddress.name\" | \"address.streetAddress.apt\" | \"address.formattedAddress\" | \"address.hint\" | \"businessSchedule.periods.openTime\" | \"businessSchedule.periods.closeTime\" | \"businessSchedule.specialHourPeriod.startDate\" | \"businessSchedule.specialHourPeriod.endDate\" | \"businessSchedule.specialHourPeriod.comment\", value: string) => LocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"name\" | \"description\" | \"default\" | \"status\" | \"locationType\" | \"fax\" | \"timeZone\" | \"email\" | \"phone\" | \"address.country\" | \"address.subdivision\" | \"address.city\" | \"address.postalCode\" | \"address.streetAddress.number\" | \"address.streetAddress.name\" | \"address.streetAddress.apt\" | \"address.formattedAddress\" | \"address.hint\" | \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"businessSchedule.periods.openDay\" | \"businessSchedule.periods.openTime\" | \"businessSchedule.periods.closeDay\" | \"businessSchedule.periods.closeTime\" | \"businessSchedule.specialHourPeriod.startDate\" | \"businessSchedule.specialHourPeriod.endDate\" | \"businessSchedule.specialHourPeriod.isClosed\" | \"businessSchedule.specialHourPeriod.comment\" | \"revision\" | \"archived\", value: any[]) => LocationsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"name\" | \"description\" | \"default\" | \"status\" | \"locationType\" | \"fax\" | \"timeZone\" | \"email\" | \"phone\" | \"address.country\" | \"address.subdivision\" | \"address.city\" | \"address.postalCode\" | \"address.streetAddress.number\" | \"address.streetAddress.name\" | \"address.streetAddress.apt\" | \"address.formattedAddress\" | \"address.hint\" | \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"businessSchedule.periods.openDay\" | \"businessSchedule.periods.openTime\" | \"businessSchedule.periods.closeDay\" | \"businessSchedule.periods.closeTime\" | \"businessSchedule.specialHourPeriod.startDate\" | \"businessSchedule.specialHourPeriod.endDate\" | \"businessSchedule.specialHourPeriod.isClosed\" | \"businessSchedule.specialHourPeriod.comment\" | \"revision\" | \"archived\", value: any) => LocationsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"name\" | \"description\" | \"default\" | \"status\" | \"locationType\" | \"fax\" | \"timeZone\" | \"email\" | \"phone\" | \"address.country\" | \"address.subdivision\" | \"address.city\" | \"address.postalCode\" | \"address.streetAddress.number\" | \"address.streetAddress.name\" | \"address.streetAddress.apt\" | \"address.formattedAddress\" | \"address.hint\" | \"address.geocode.latitude\" | \"address.geocode.longitude\" | \"businessSchedule.periods.openDay\" | \"businessSchedule.periods.openTime\" | \"businessSchedule.periods.closeDay\" | \"businessSchedule.periods.closeTime\" | \"businessSchedule.specialHourPeriod.startDate\" | \"businessSchedule.specialHourPeriod.endDate\" | \"businessSchedule.specialHourPeriod.isClosed\" | \"businessSchedule.specialHourPeriod.comment\" | \"revision\" | \"archived\", value: boolean) => LocationsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => LocationsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => LocationsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Sets a new default location.\n *\n *\n * > **Notes:**\n * > + There can only be one default location per site.\n * > + The default location can't be archived.\n * @param _id - ID of the location to set as the default location.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.SetDefaultLocation\n */\n function setDefaultLocation(_id: string): Promise;\n /**\n * Archives a location.\n *\n *\n * > **Notes:**\n * > + Changes the `archived` boolean of a location to `true`.\n * > + You can't change a location's `status` using this endpoint.\n * > + Archived locations can't be updated.\n * > + Currently, it isn't possible to unarchive locations.\n * > + The `default` location can't be archived.\n * @param _id - ID of the location to archive.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.ArchiveLocation\n */\n function archiveLocation(_id: string): Promise;\n /**\n * Adds a location type to the specified location.\n * @param _id - ID of the location where the type will be added.\n * @param locationType - Location type to add.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField locationType\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.AddTypeToLocation\n */\n function addTypeToLocation(_id: string, locationType: LocationType): Promise;\n /**\n * Removes a location type from the specified location.\n * @param _id - ID of the location where the type will be removed.\n * @param locationType - Location type to remove.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField locationType\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.RemoveTypeFromLocation\n */\n function removeTypeFromLocation(_id: string, locationType: LocationType): Promise;\n /**\n * Add location type to a specific location.\n *\n * > **Notes:**\n * > + Add one the location type (UNKNOWN, BRANCH, OFFICES, RECEPTION, HEADQUARTERS, INVENTORY) to a specific location by id.\n * > + This EP is deprecated - Please use AddTypeFromLocation instead.\n * @param _id - Location id to add type\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField locationType\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.AddLocationType\n * @deprecated\n */\n function addLocationType(_id: string, locationType: LocationType): Promise;\n /**\n * Remove location type from a specific location.\n *\n * > **Notes:**\n * > + Remove location type (UNKNOWN, BRANCH, OFFICES, RECEPTION, HEADQUARTERS, INVENTORY) from a specific location by id.\n * > + This EP is deprecated - Please use RemoveTypeFromLocation instead.\n * @param _id - Location id to add type\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField locationType\n * @permissionId LOCATIONS.MANAGE\n * @permissionScope Manage Locations\n * @permissionScopeId SCOPE.DC-MULTILOCATION.MANAGE-LOCATIONS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.locations.LocationsService.RemoveLocationType\n * @deprecated\n */\n function removeLocationType(_id: string, locationType: LocationType): Promise;\n type locationsV1LocationLocations_universal_d_Location = Location;\n type locationsV1LocationLocations_universal_d_LocationStatus = LocationStatus;\n const locationsV1LocationLocations_universal_d_LocationStatus: typeof LocationStatus;\n type locationsV1LocationLocations_universal_d_LocationType = LocationType;\n const locationsV1LocationLocations_universal_d_LocationType: typeof LocationType;\n type locationsV1LocationLocations_universal_d_StreetAddress = StreetAddress;\n type locationsV1LocationLocations_universal_d_AddressLocation = AddressLocation;\n type locationsV1LocationLocations_universal_d_CreateLocationRequest = CreateLocationRequest;\n type locationsV1LocationLocations_universal_d_CreateLocationResponse = CreateLocationResponse;\n type locationsV1LocationLocations_universal_d_BulkCreateLocationRequest = BulkCreateLocationRequest;\n type locationsV1LocationLocations_universal_d_BulkCreateLocationResponse = BulkCreateLocationResponse;\n type locationsV1LocationLocations_universal_d_FailedCreateLocation = FailedCreateLocation;\n type locationsV1LocationLocations_universal_d_GetLocationRequest = GetLocationRequest;\n type locationsV1LocationLocations_universal_d_GetLocationResponse = GetLocationResponse;\n type locationsV1LocationLocations_universal_d_ListLocationsRequest = ListLocationsRequest;\n type locationsV1LocationLocations_universal_d_Sorting = Sorting;\n type locationsV1LocationLocations_universal_d_SortOrder = SortOrder;\n const locationsV1LocationLocations_universal_d_SortOrder: typeof SortOrder;\n type locationsV1LocationLocations_universal_d_Paging = Paging;\n type locationsV1LocationLocations_universal_d_ListLocationsResponse = ListLocationsResponse;\n type locationsV1LocationLocations_universal_d_PagingMetadata = PagingMetadata;\n type locationsV1LocationLocations_universal_d_UpdateLocationRequest = UpdateLocationRequest;\n type locationsV1LocationLocations_universal_d_UpdateLocationResponse = UpdateLocationResponse;\n type locationsV1LocationLocations_universal_d_BulkUpdateLocationRequest = BulkUpdateLocationRequest;\n type locationsV1LocationLocations_universal_d_BulkUpdateLocationResponse = BulkUpdateLocationResponse;\n type locationsV1LocationLocations_universal_d_FailedUpdateLocation = FailedUpdateLocation;\n type locationsV1LocationLocations_universal_d_QueryLocationsRequest = QueryLocationsRequest;\n type locationsV1LocationLocations_universal_d_Query = Query;\n type locationsV1LocationLocations_universal_d_QueryLocationsResponse = QueryLocationsResponse;\n type locationsV1LocationLocations_universal_d_SetDefaultLocationRequest = SetDefaultLocationRequest;\n type locationsV1LocationLocations_universal_d_SetDefaultLocationResponse = SetDefaultLocationResponse;\n type locationsV1LocationLocations_universal_d_SetDefaultLocation = SetDefaultLocation;\n type locationsV1LocationLocations_universal_d_ArchiveLocationRequest = ArchiveLocationRequest;\n type locationsV1LocationLocations_universal_d_ArchiveLocationResponse = ArchiveLocationResponse;\n type locationsV1LocationLocations_universal_d_ArchiveLocation = ArchiveLocation;\n type locationsV1LocationLocations_universal_d_AddTypeToLocationRequest = AddTypeToLocationRequest;\n type locationsV1LocationLocations_universal_d_AddTypeToLocationResponse = AddTypeToLocationResponse;\n type locationsV1LocationLocations_universal_d_RemoveTypeFromLocationRequest = RemoveTypeFromLocationRequest;\n type locationsV1LocationLocations_universal_d_RemoveTypeFromLocationResponse = RemoveTypeFromLocationResponse;\n type locationsV1LocationLocations_universal_d_AddLocationTypeRequest = AddLocationTypeRequest;\n type locationsV1LocationLocations_universal_d_AddLocationTypeResponse = AddLocationTypeResponse;\n type locationsV1LocationLocations_universal_d_RemoveLocationTypeRequest = RemoveLocationTypeRequest;\n type locationsV1LocationLocations_universal_d_RemoveLocationTypeResponse = RemoveLocationTypeResponse;\n type locationsV1LocationLocations_universal_d_DomainEvent = DomainEvent;\n type locationsV1LocationLocations_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type locationsV1LocationLocations_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type locationsV1LocationLocations_universal_d_RestoreInfo = RestoreInfo;\n type locationsV1LocationLocations_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type locationsV1LocationLocations_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type locationsV1LocationLocations_universal_d_ActionEvent = ActionEvent;\n const locationsV1LocationLocations_universal_d_createLocation: typeof createLocation;\n const locationsV1LocationLocations_universal_d_getLocation: typeof getLocation;\n const locationsV1LocationLocations_universal_d_listLocations: typeof listLocations;\n type locationsV1LocationLocations_universal_d_ListLocationsOptions = ListLocationsOptions;\n const locationsV1LocationLocations_universal_d_updateLocation: typeof updateLocation;\n type locationsV1LocationLocations_universal_d_UpdateLocation = UpdateLocation;\n const locationsV1LocationLocations_universal_d_queryLocations: typeof queryLocations;\n type locationsV1LocationLocations_universal_d_LocationsQueryResult = LocationsQueryResult;\n type locationsV1LocationLocations_universal_d_LocationsQueryBuilder = LocationsQueryBuilder;\n const locationsV1LocationLocations_universal_d_setDefaultLocation: typeof setDefaultLocation;\n const locationsV1LocationLocations_universal_d_archiveLocation: typeof archiveLocation;\n const locationsV1LocationLocations_universal_d_addTypeToLocation: typeof addTypeToLocation;\n const locationsV1LocationLocations_universal_d_removeTypeFromLocation: typeof removeTypeFromLocation;\n const locationsV1LocationLocations_universal_d_addLocationType: typeof addLocationType;\n const locationsV1LocationLocations_universal_d_removeLocationType: typeof removeLocationType;\n namespace locationsV1LocationLocations_universal_d {\n export { locationsV1LocationLocations_universal_d_Location as Location, locationsV1LocationLocations_universal_d_LocationStatus as LocationStatus, locationsV1LocationLocations_universal_d_LocationType as LocationType, Address$1 as Address, locationsV1LocationLocations_universal_d_StreetAddress as StreetAddress, locationsV1LocationLocations_universal_d_AddressLocation as AddressLocation, BusinessSchedule$1 as BusinessSchedule, TimePeriod$1 as TimePeriod, DayOfWeek$1 as DayOfWeek, SpecialHourPeriod$1 as SpecialHourPeriod, locationsV1LocationLocations_universal_d_CreateLocationRequest as CreateLocationRequest, locationsV1LocationLocations_universal_d_CreateLocationResponse as CreateLocationResponse, locationsV1LocationLocations_universal_d_BulkCreateLocationRequest as BulkCreateLocationRequest, locationsV1LocationLocations_universal_d_BulkCreateLocationResponse as BulkCreateLocationResponse, locationsV1LocationLocations_universal_d_FailedCreateLocation as FailedCreateLocation, locationsV1LocationLocations_universal_d_GetLocationRequest as GetLocationRequest, locationsV1LocationLocations_universal_d_GetLocationResponse as GetLocationResponse, locationsV1LocationLocations_universal_d_ListLocationsRequest as ListLocationsRequest, locationsV1LocationLocations_universal_d_Sorting as Sorting, locationsV1LocationLocations_universal_d_SortOrder as SortOrder, locationsV1LocationLocations_universal_d_Paging as Paging, locationsV1LocationLocations_universal_d_ListLocationsResponse as ListLocationsResponse, locationsV1LocationLocations_universal_d_PagingMetadata as PagingMetadata, locationsV1LocationLocations_universal_d_UpdateLocationRequest as UpdateLocationRequest, locationsV1LocationLocations_universal_d_UpdateLocationResponse as UpdateLocationResponse, locationsV1LocationLocations_universal_d_BulkUpdateLocationRequest as BulkUpdateLocationRequest, locationsV1LocationLocations_universal_d_BulkUpdateLocationResponse as BulkUpdateLocationResponse, locationsV1LocationLocations_universal_d_FailedUpdateLocation as FailedUpdateLocation, locationsV1LocationLocations_universal_d_QueryLocationsRequest as QueryLocationsRequest, locationsV1LocationLocations_universal_d_Query as Query, locationsV1LocationLocations_universal_d_QueryLocationsResponse as QueryLocationsResponse, locationsV1LocationLocations_universal_d_SetDefaultLocationRequest as SetDefaultLocationRequest, locationsV1LocationLocations_universal_d_SetDefaultLocationResponse as SetDefaultLocationResponse, locationsV1LocationLocations_universal_d_SetDefaultLocation as SetDefaultLocation, locationsV1LocationLocations_universal_d_ArchiveLocationRequest as ArchiveLocationRequest, locationsV1LocationLocations_universal_d_ArchiveLocationResponse as ArchiveLocationResponse, locationsV1LocationLocations_universal_d_ArchiveLocation as ArchiveLocation, locationsV1LocationLocations_universal_d_AddTypeToLocationRequest as AddTypeToLocationRequest, locationsV1LocationLocations_universal_d_AddTypeToLocationResponse as AddTypeToLocationResponse, locationsV1LocationLocations_universal_d_RemoveTypeFromLocationRequest as RemoveTypeFromLocationRequest, locationsV1LocationLocations_universal_d_RemoveTypeFromLocationResponse as RemoveTypeFromLocationResponse, locationsV1LocationLocations_universal_d_AddLocationTypeRequest as AddLocationTypeRequest, locationsV1LocationLocations_universal_d_AddLocationTypeResponse as AddLocationTypeResponse, locationsV1LocationLocations_universal_d_RemoveLocationTypeRequest as RemoveLocationTypeRequest, locationsV1LocationLocations_universal_d_RemoveLocationTypeResponse as RemoveLocationTypeResponse, locationsV1LocationLocations_universal_d_DomainEvent as DomainEvent, locationsV1LocationLocations_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, locationsV1LocationLocations_universal_d_EntityCreatedEvent as EntityCreatedEvent, locationsV1LocationLocations_universal_d_RestoreInfo as RestoreInfo, locationsV1LocationLocations_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, locationsV1LocationLocations_universal_d_EntityDeletedEvent as EntityDeletedEvent, locationsV1LocationLocations_universal_d_ActionEvent as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, locationsV1LocationLocations_universal_d_createLocation as createLocation, locationsV1LocationLocations_universal_d_getLocation as getLocation, locationsV1LocationLocations_universal_d_listLocations as listLocations, locationsV1LocationLocations_universal_d_ListLocationsOptions as ListLocationsOptions, locationsV1LocationLocations_universal_d_updateLocation as updateLocation, locationsV1LocationLocations_universal_d_UpdateLocation as UpdateLocation, locationsV1LocationLocations_universal_d_queryLocations as queryLocations, locationsV1LocationLocations_universal_d_LocationsQueryResult as LocationsQueryResult, locationsV1LocationLocations_universal_d_LocationsQueryBuilder as LocationsQueryBuilder, locationsV1LocationLocations_universal_d_setDefaultLocation as setDefaultLocation, locationsV1LocationLocations_universal_d_archiveLocation as archiveLocation, locationsV1LocationLocations_universal_d_addTypeToLocation as addTypeToLocation, locationsV1LocationLocations_universal_d_removeTypeFromLocation as removeTypeFromLocation, locationsV1LocationLocations_universal_d_addLocationType as addLocationType, locationsV1LocationLocations_universal_d_removeLocationType as removeLocationType, };\n }\n interface Properties {\n /** Site categories. */\n categories?: Categories;\n /** Site locale. */\n locale?: Locale;\n /**\n * Site language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Site currency format used to bill customers.\n *\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n paymentCurrency?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Fax number. */\n fax?: string | null;\n /** Address. */\n address?: Address;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n /**\n * Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule;\n /** Supported languages of a site and the primary language. */\n multilingual?: Multilingual;\n /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */\n consentPolicy?: ConsentPolicy;\n /**\n * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n *\n * Site business type.\n */\n businessConfig?: string | null;\n /** External site url that uses Wix as its headless business solution */\n externalSiteUrl?: string | null;\n /** Track clicks analytics */\n trackClicksAnalytics?: boolean;\n }\n interface Categories {\n /** Primary site category. */\n primary?: string;\n /** Secondary site category. */\n secondary?: string[];\n /** Business Term Id */\n businessTermId?: string | null;\n }\n interface Locale {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string;\n }\n interface Address {\n /** Street name. */\n street?: string;\n /** City name. */\n city?: string;\n /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string;\n /** State. */\n state?: string;\n /** Zip or postal code. */\n zip?: string;\n /** Extra information to be displayed in the address. */\n hint?: AddressHint;\n /** Whether this address represents a physical location. */\n isPhysical?: boolean;\n /** Google-formatted version of this address. */\n googleFormattedAddress?: string;\n /** Street number. */\n streetNumber?: string;\n /** Apartment number. */\n apartmentNumber?: string;\n /** Geographic coordinates of location. */\n coordinates?: GeoCoordinates;\n }\n /**\n * Extra information on displayed addresses.\n * This is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\n * Free text. In addition the user can state where he wants that additional description - before, after, or instead\n * the address string.\n */\n interface AddressHint {\n /** Extra text displayed next to, or instead of, the actual address. */\n text?: string;\n /** Where the extra text should be displayed. */\n placement?: PlacementType;\n }\n /** Where the extra text should be displayed: before, after or instead of the actual address. */\n enum PlacementType {\n BEFORE = \"BEFORE\",\n AFTER = \"AFTER\",\n REPLACE = \"REPLACE\"\n }\n /** Geocoordinates for a particular address. */\n interface GeoCoordinates {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Multilingual {\n /** Supported languages list. */\n supportedLanguages?: SupportedLanguage[];\n /** Whether to redirect to user language. */\n autoRedirect?: boolean;\n }\n interface SupportedLanguage {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Locale. */\n locale?: Locale;\n /** Whether the supported language is the primary language for the site. */\n isPrimary?: boolean;\n /** Language icon. */\n countryCode?: string;\n /** How the language will be resolved. For internal use. */\n resolutionMethod?: ResolutionMethod;\n }\n enum ResolutionMethod {\n QUERY_PARAM = \"QUERY_PARAM\",\n SUBDOMAIN = \"SUBDOMAIN\",\n SUBDIRECTORY = \"SUBDIRECTORY\"\n }\n interface ConsentPolicy {\n /** Whether the site uses cookies that are essential to site operation. */\n essential?: boolean | null;\n /** Whether the site uses cookies that affect site performance and other functional measurements. */\n functional?: boolean | null;\n /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */\n analytics?: boolean | null;\n /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */\n advertising?: boolean | null;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean | null;\n }\n /** The parameters of a site properties read request. */\n interface PropertiesReadRequest {\n }\n /** The resulting properties for the requested site. */\n interface PropertiesReadResponse {\n /** Current version of the stored property site. For internal use. */\n version?: string;\n /** Properties for the requested site. */\n properties?: Properties;\n }\n /** The request used to update a site's properties. */\n interface PropertiesUpdateRequest {\n properties?: Properties;\n }\n /** The details resulting from an update operation. */\n interface PropertiesUpdateResponse {\n /** The new version of the stored properties after the update. For internal use. */\n version?: string;\n }\n /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */\n interface SitePropertiesNotification {\n /** The site ID for which this update notification applies. */\n metasiteId?: string;\n /** The actual update event. */\n event?: SitePropertiesEvent;\n /** A convenience set of mappings from the MetaSite ID to its constituent services. */\n translations?: Translation[];\n /** Context of the notification */\n changeContext?: ChangeContext;\n }\n /** The actual update event for a particular notification. */\n interface SitePropertiesEvent {\n /** Version of the site's properties represented by this update. */\n version?: number;\n /** Updated properties. */\n properties?: Properties;\n }\n /** A single mapping from the MetaSite ID to a particular service. */\n interface Translation {\n /** The service type. */\n serviceType?: string;\n /** The application definition ID; this only applies to services of type ThirdPartyApps. */\n appDefId?: string;\n /** The instance ID of the service. */\n instanceId?: string;\n }\n interface ChangeContext extends ChangeContextPayloadOneOf {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned;\n }\n /** @oneof */\n interface ChangeContextPayloadOneOf {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned;\n }\n interface PropertiesChange {\n }\n interface SiteCreated {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned {\n /** Origin site id. */\n originMetaSiteId?: string;\n }\n /** Encapsulates all changes when site properties are updated */\n interface SitePropertiesUpdated {\n /** ID of the Wix site that has been updated. */\n metasiteId?: string;\n /** Update details. */\n event?: SitePropertiesEvent;\n }\n /** Snapshot of latest site properties. */\n interface SitePropertiesFullNotification {\n /** The site ID for which this snapshot applies. */\n metaSiteId?: string;\n /** Version of the site's properties current snapshot. */\n version?: number;\n /** Snapshot properties. */\n properties?: Properties;\n /** Context of the notification */\n changeContext?: ChangeContext;\n }\n interface UpdateBusinessProfileRequest {\n /** The site's business profile. */\n businessProfile?: BusinessProfileData;\n }\n interface BusinessProfileData {\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n }\n interface UpdateBusinessProfileResponse {\n }\n interface UpdateBusinessContactRequest {\n /** The site's business contact information. */\n businessContact?: BusinessContactData;\n }\n interface BusinessContactData {\n /** Publicly-available business email address. */\n email?: string | null;\n /** Publicly-available business phone number. */\n phone?: string | null;\n /** Publicly-available business fax number. */\n fax?: string | null;\n /** Publicly-available business address. */\n address?: Address;\n }\n interface UpdateBusinessContactResponse {\n }\n interface UpdateBusinessScheduleRequest {\n /** The site's business schedule in the site time zone. */\n businessSchedule?: BusinessSchedule;\n }\n interface UpdateBusinessScheduleResponse {\n }\n /** The request used to update site's default consent policy */\n interface UpdateConsentPolicyRequest {\n /** Default consent policy defined by the site owner. Can be further limited by site visitors. */\n consentPolicy?: ConsentPolicy;\n }\n interface UpdateConsentPolicyResponse {\n }\n interface BulkPropertiesReadRequest {\n /** Sites ids. */\n sites?: string[];\n }\n /** The resulting properties for the requested site. */\n interface BulkPropertiesReadResponse {\n /** The ID of the resolved MetaSite for the request. */\n sites?: Record;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves site properties\n *\n *\n * The `getSiteProperties()` function returns a promise that resolves to the site properties.\n * @public\n * @documentationMaturity preview\n * @param options - Field options.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @applicableIdentity APP\n * @adminMethod\n * @returns The resulting properties for the requested site.\n */\n function getSiteProperties(options?: GetSitePropertiesOptions): Promise;\n interface GetSitePropertiesOptions {\n }\n interface UpdateOptions {\n properties?: Properties;\n }\n /**\n * Updates a site's business profile information.\n *\n *\n * The `updateBusinessProfile()` function returns a Promise that resolves when the site's business profile information is updated.\n *\n * **Note:**\n * > + Only the fields included in the `fields` parameter are updated, even if they are included in the `businessProfile` parameter.\n * @param businessProfile - The site's business profile.\n * @public\n * @documentationMaturity preview\n * @requiredField businessProfile\n * @permissionScope Manage Business Profile\n * @permissionScopeId SCOPE.DC-SITEPROP.MANAGE-BUSINESS-PROFILE\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateBusinessProfile(businessProfile: BusinessProfileData, options?: UpdateBusinessProfileOptions): Promise;\n interface UpdateBusinessProfileOptions {\n }\n /**\n * Updates a site's business contact information.\n *\n *\n * The `updateBusinessContact()` function returns a Promise that resolves when the site's contact information is updated.\n *\n * **Note:**\n * > + Only the fields included in the `fields` parameter will be updated, even if they are included in the `businessContact` parameter.\n * @param businessContact - The site's business contact information.\n * @public\n * @documentationMaturity preview\n * @requiredField businessContact\n * @permissionScope Manage Business Contact\n * @permissionScopeId SCOPE.DC-SITEPROP.MANAGE-BUSINESS-CONTACT\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateBusinessContact(businessContact: BusinessContactData, options?: UpdateBusinessContactOptions): Promise;\n interface UpdateBusinessContactOptions {\n }\n /**\n * Updates the default location's business schedule.\n *\n *\n * The `updateBusinessSchedule()` function returns a Promise that resolves when the site's business schedule is updated.\n *\n * **Note:**\n * > + The `updateBusinessSchedule()` function overwrites the current business schedule. `businessSchedule` is an array, so it must be written in its entirety. Therefore, you must modify the existing array and pass it in the function call.\n * @param businessSchedule - The site's business schedule in the site time zone.\n * @public\n * @documentationMaturity preview\n * @requiredField businessSchedule\n * @permissionScope Manage Business Schedule\n * @permissionScopeId SCOPE.DC-SITEPROP.MANAGE-BUSINESS-SCHEDULE\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateBusinessSchedule(businessSchedule: BusinessSchedule): Promise;\n /**\n * Updates a site's consent policy.\n *\n *\n * The `updateConsentPolicy()` function returns a Promise that resolves when the site's consent policy is updated.\n * @param consentPolicy - Default consent policy defined by the site owner. Can be further limited by site visitors.\n * @public\n * @documentationMaturity preview\n * @requiredField consentPolicy\n * @permissionScope Manage Consent Policy\n * @permissionScopeId SCOPE.DC-SITEPROP.MANAGE-PROPERTIES\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateConsentPolicy(consentPolicy: ConsentPolicy): Promise;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_Properties = Properties;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_Categories = Categories;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_Locale = Locale;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_Address = Address;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_AddressHint = AddressHint;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_PlacementType = PlacementType;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_PlacementType: typeof PlacementType;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_GeoCoordinates = GeoCoordinates;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_BusinessSchedule = BusinessSchedule;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_TimePeriod = TimePeriod;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_DayOfWeek = DayOfWeek;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_DayOfWeek: typeof DayOfWeek;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_Multilingual = Multilingual;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SupportedLanguage = SupportedLanguage;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_ResolutionMethod = ResolutionMethod;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_ResolutionMethod: typeof ResolutionMethod;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_ConsentPolicy = ConsentPolicy;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesReadRequest = PropertiesReadRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesReadResponse = PropertiesReadResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesUpdateRequest = PropertiesUpdateRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesUpdateResponse = PropertiesUpdateResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesNotification = SitePropertiesNotification;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesEvent = SitePropertiesEvent;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_Translation = Translation;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_ChangeContext = ChangeContext;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesChange = PropertiesChange;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SiteCreated = SiteCreated;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SiteCloned = SiteCloned;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesUpdated = SitePropertiesUpdated;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesFullNotification = SitePropertiesFullNotification;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessProfileRequest = UpdateBusinessProfileRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_BusinessProfileData = BusinessProfileData;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessProfileResponse = UpdateBusinessProfileResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessContactRequest = UpdateBusinessContactRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_BusinessContactData = BusinessContactData;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessContactResponse = UpdateBusinessContactResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessScheduleRequest = UpdateBusinessScheduleRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessScheduleResponse = UpdateBusinessScheduleResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateConsentPolicyRequest = UpdateConsentPolicyRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateConsentPolicyResponse = UpdateConsentPolicyResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_BulkPropertiesReadRequest = BulkPropertiesReadRequest;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_BulkPropertiesReadResponse = BulkPropertiesReadResponse;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_MessageEnvelope = MessageEnvelope;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_IdentificationData = IdentificationData;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_WebhookIdentityType = WebhookIdentityType;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_getSiteProperties: typeof getSiteProperties;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_GetSitePropertiesOptions = GetSitePropertiesOptions;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateOptions = UpdateOptions;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_updateBusinessProfile: typeof updateBusinessProfile;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessProfileOptions = UpdateBusinessProfileOptions;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_updateBusinessContact: typeof updateBusinessContact;\n type sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessContactOptions = UpdateBusinessContactOptions;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_updateBusinessSchedule: typeof updateBusinessSchedule;\n const sitepropertiesV4PropertiesSiteProperties_universal_d_updateConsentPolicy: typeof updateConsentPolicy;\n namespace sitepropertiesV4PropertiesSiteProperties_universal_d {\n export { sitepropertiesV4PropertiesSiteProperties_universal_d_Properties as Properties, sitepropertiesV4PropertiesSiteProperties_universal_d_Categories as Categories, sitepropertiesV4PropertiesSiteProperties_universal_d_Locale as Locale, sitepropertiesV4PropertiesSiteProperties_universal_d_Address as Address, sitepropertiesV4PropertiesSiteProperties_universal_d_AddressHint as AddressHint, sitepropertiesV4PropertiesSiteProperties_universal_d_PlacementType as PlacementType, sitepropertiesV4PropertiesSiteProperties_universal_d_GeoCoordinates as GeoCoordinates, sitepropertiesV4PropertiesSiteProperties_universal_d_BusinessSchedule as BusinessSchedule, sitepropertiesV4PropertiesSiteProperties_universal_d_TimePeriod as TimePeriod, sitepropertiesV4PropertiesSiteProperties_universal_d_DayOfWeek as DayOfWeek, sitepropertiesV4PropertiesSiteProperties_universal_d_SpecialHourPeriod as SpecialHourPeriod, sitepropertiesV4PropertiesSiteProperties_universal_d_Multilingual as Multilingual, sitepropertiesV4PropertiesSiteProperties_universal_d_SupportedLanguage as SupportedLanguage, sitepropertiesV4PropertiesSiteProperties_universal_d_ResolutionMethod as ResolutionMethod, sitepropertiesV4PropertiesSiteProperties_universal_d_ConsentPolicy as ConsentPolicy, sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesReadRequest as PropertiesReadRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesReadResponse as PropertiesReadResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesUpdateRequest as PropertiesUpdateRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesUpdateResponse as PropertiesUpdateResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesNotification as SitePropertiesNotification, sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesEvent as SitePropertiesEvent, sitepropertiesV4PropertiesSiteProperties_universal_d_Translation as Translation, sitepropertiesV4PropertiesSiteProperties_universal_d_ChangeContext as ChangeContext, sitepropertiesV4PropertiesSiteProperties_universal_d_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf, sitepropertiesV4PropertiesSiteProperties_universal_d_PropertiesChange as PropertiesChange, sitepropertiesV4PropertiesSiteProperties_universal_d_SiteCreated as SiteCreated, sitepropertiesV4PropertiesSiteProperties_universal_d_SiteCloned as SiteCloned, sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesUpdated as SitePropertiesUpdated, sitepropertiesV4PropertiesSiteProperties_universal_d_SitePropertiesFullNotification as SitePropertiesFullNotification, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessProfileRequest as UpdateBusinessProfileRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_BusinessProfileData as BusinessProfileData, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessProfileResponse as UpdateBusinessProfileResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessContactRequest as UpdateBusinessContactRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_BusinessContactData as BusinessContactData, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessContactResponse as UpdateBusinessContactResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessScheduleRequest as UpdateBusinessScheduleRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessScheduleResponse as UpdateBusinessScheduleResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateConsentPolicyRequest as UpdateConsentPolicyRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateConsentPolicyResponse as UpdateConsentPolicyResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_BulkPropertiesReadRequest as BulkPropertiesReadRequest, sitepropertiesV4PropertiesSiteProperties_universal_d_BulkPropertiesReadResponse as BulkPropertiesReadResponse, sitepropertiesV4PropertiesSiteProperties_universal_d_MessageEnvelope as MessageEnvelope, sitepropertiesV4PropertiesSiteProperties_universal_d_IdentificationData as IdentificationData, sitepropertiesV4PropertiesSiteProperties_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, sitepropertiesV4PropertiesSiteProperties_universal_d_WebhookIdentityType as WebhookIdentityType, sitepropertiesV4PropertiesSiteProperties_universal_d_getSiteProperties as getSiteProperties, sitepropertiesV4PropertiesSiteProperties_universal_d_GetSitePropertiesOptions as GetSitePropertiesOptions, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateOptions as UpdateOptions, sitepropertiesV4PropertiesSiteProperties_universal_d_updateBusinessProfile as updateBusinessProfile, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessProfileOptions as UpdateBusinessProfileOptions, sitepropertiesV4PropertiesSiteProperties_universal_d_updateBusinessContact as updateBusinessContact, sitepropertiesV4PropertiesSiteProperties_universal_d_UpdateBusinessContactOptions as UpdateBusinessContactOptions, sitepropertiesV4PropertiesSiteProperties_universal_d_updateBusinessSchedule as updateBusinessSchedule, sitepropertiesV4PropertiesSiteProperties_universal_d_updateConsentPolicy as updateConsentPolicy, };\n }\n export { locationsV1LocationLocations_universal_d as locations, sitepropertiesV4PropertiesSiteProperties_universal_d as siteProperties };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-marketing-tags.v2.d.ts", "content": "declare module \"wix-marketing-tags.v2\" {\n interface MarketingTag extends MarketingTagParamsOneOf {\n /**\n * A [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091)\n * lets site owners analyze what a visitor does after clicking on a Google ad.\n */\n googleAds?: GoogleAds;\n /**\n * A [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579)\n * lets site owners track page views, where visitors are coming from, how long they stay, and\n * what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310)\n * and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310)\n * are supported.\n */\n googleAnalytics?: GoogleAnalytics;\n /**\n * A [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) lets site\n * owners build visual reports of visitor activity that helps them evaluate the\n * performance of their marketing campaigns.\n */\n yandexMetrica?: YandexMetrica;\n /**\n * A [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/)\n * allows site owners to track Facebook ad-driven visitor activity on their site.\n */\n facebookPixel?: FacebookPixel;\n /**\n * A [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)\n * lets site owners implement a quick and easy tag management system that keeps\n * 3rd party code snippets organized.\n */\n googleTagManager?: GoogleTagManager;\n /**\n * A [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663)\n * allows site owners to share visitor events to TikTok on their site.\n */\n tikTokPixel?: TikTokPixel;\n /**\n * This consent mode tag uses [Google Tag Manager](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530),\n * which allows site owners to implement a quick and easy tag management system that keeps\n * 3rd party code snippets organized.\n */\n googleTagManagerConsentMode?: GoogleTagManagerConsentMode;\n /**\n * This consent mode tag uses the [Google Tag API](https://developers.google.com/tag-platform/gtagjs/reference), which allows site owners to track:\n * - Page views\n * - Where visitors are coming from\n * - How long visitors stay on the site\n * - What keywords visitors used to find the site\n */\n googleAnalyticsConsentMode?: GoogleAnalyticsConsentMode;\n /**\n * Marketing tag ID.\n * @readonly\n */\n _id?: string;\n /**\n * Marketing tag type.\n * @readonly\n */\n type?: Type;\n /**\n * Whether this tag is enabled.\n * Defaults to `true`.\n */\n enabled?: boolean | null;\n }\n /** @oneof */\n interface MarketingTagParamsOneOf {\n /**\n * A [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091)\n * lets site owners analyze what a visitor does after clicking on a Google ad.\n */\n googleAds?: GoogleAds;\n /**\n * A [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579)\n * lets site owners track page views, where visitors are coming from, how long they stay, and\n * what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310)\n * and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310)\n * are supported.\n */\n googleAnalytics?: GoogleAnalytics;\n /**\n * A [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) lets site\n * owners build visual reports of visitor activity that helps them evaluate the\n * performance of their marketing campaigns.\n */\n yandexMetrica?: YandexMetrica;\n /**\n * A [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/)\n * allows site owners to track Facebook ad-driven visitor activity on their site.\n */\n facebookPixel?: FacebookPixel;\n /**\n * A [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)\n * lets site owners implement a quick and easy tag management system that keeps\n * 3rd party code snippets organized.\n */\n googleTagManager?: GoogleTagManager;\n /**\n * A [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663)\n * allows site owners to share visitor events to TikTok on their site.\n */\n tikTokPixel?: TikTokPixel;\n /**\n * This consent mode tag uses [Google Tag Manager](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530),\n * which allows site owners to implement a quick and easy tag management system that keeps\n * 3rd party code snippets organized.\n */\n googleTagManagerConsentMode?: GoogleTagManagerConsentMode;\n /**\n * This consent mode tag uses the [Google Tag API](https://developers.google.com/tag-platform/gtagjs/reference), which allows site owners to track:\n * - Page views\n * - Where visitors are coming from\n * - How long visitors stay on the site\n * - What keywords visitors used to find the site\n */\n googleAnalyticsConsentMode?: GoogleAnalyticsConsentMode;\n }\n /** Enum value `UNKNOWN`: Illegal default value, exception will be thrown if used. */\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n GOOGLE_ADS = \"GOOGLE_ADS\",\n GOOGLE_ANALYTICS = \"GOOGLE_ANALYTICS\",\n YANDEX_METRICA = \"YANDEX_METRICA\",\n FACEBOOK_PIXEL = \"FACEBOOK_PIXEL\",\n GOOGLE_TAG_MANAGER = \"GOOGLE_TAG_MANAGER\",\n TIKTOK_PIXEL = \"TIKTOK_PIXEL\",\n GOOGLE_TAG_MANAGER_CONSENT_MODE = \"GOOGLE_TAG_MANAGER_CONSENT_MODE\",\n GOOGLE_ANALYTICS_CONSENT_MODE = \"GOOGLE_ANALYTICS_CONSENT_MODE\"\n }\n interface GoogleAds {\n /** Domain associated with the Google Ads Conversion tag. */\n domain?: string;\n /**\n * Conversion ID in AW-123456789 format.\n * Specifies which Google property is associated with the site owner.\n */\n trackingId?: string;\n }\n interface GoogleAnalytics {\n /** Domain associated with the Google Analytics tag. */\n domain?: string;\n /**\n * Measurement ID for Google Analytics 4 tags in G-12345 format,\n * or Analytics ID for Google Universal Analytics tags in UA-12345-1 format.\n * Specifies which Google property is associated with the site owner.\n */\n trackingId?: string;\n /** Whether IP addresses of site visitors are hidden from Google. */\n ipAnonymization?: boolean | null;\n }\n interface YandexMetrica {\n /** Domain associated with the Yandex Metrica tag. */\n domain?: string;\n /**\n * Yandex Tag Number in 123456789 format.\n * Specifies which Yandex tag is associated with the site owner.\n */\n trackingId?: string;\n }\n interface FacebookPixel {\n /** Domain associated with the Facebook Pixel tag. */\n domain?: string;\n /**\n * Pixel ID in 123456789 format.\n * Specifies which Facebook Pixel is associated with the site owner.\n */\n trackingId?: string;\n }\n interface GoogleTagManager {\n /** Domain associated with the Google tag. */\n domain?: string;\n /**\n * Tag Manager Container ID in GTM-12345 format.\n * Specifies which Google Tag Manager Container is associated with the site owner.\n */\n trackingId?: string;\n }\n interface TikTokPixel {\n /** Domain associated with the TikTok Pixel. */\n domain?: string;\n /** Specifies which TikTok Pixel is associated with the site owner. */\n trackingId?: string;\n }\n interface GoogleTagManagerConsentMode {\n /** Domain associated with the Google tag. */\n domain?: string;\n /**\n * Tag Manager Container ID.\n * Specifies which Google Tag Manager Container is associated with the site owner.\n */\n trackingId?: string;\n }\n interface GoogleAnalyticsConsentMode {\n /** Domain associated with the Google Analytics tag. */\n domain?: string;\n /**\n * Specifies which Google property is associated with the site owner.\n * It is either Measurement ID for [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4) tags in the `G-12345` format,\n * or Analytics ID for Google Universal Analytics tags in the `UA-12345-1` format.\n */\n trackingId?: string;\n /** Whether the IP addresses of site visitors are hidden from Google. */\n ipAnonymization?: boolean | null;\n }\n interface HtmlEmbedUpdateMessage {\n /** Site's id */\n siteId?: string;\n }\n interface UpsertMarketingTagRequest {\n /** Marketing tag to create or update. */\n tag: MarketingTag;\n }\n interface UpsertMarketingTagResponse {\n /** Created or updated marketing tag. */\n tag?: MarketingTag;\n }\n interface ListMarketingTagsRequest {\n /** Information about which tags to retrieve. */\n filter?: Filter;\n }\n /** Information about which marketing tags to retrieve. */\n interface Filter {\n /** Filter by tag type. */\n byType?: Type;\n }\n interface ListMarketingTagsResponse {\n /** List of marketing tags. */\n tags?: MarketingTag[];\n }\n interface DeleteMarketingTagRequest {\n /** Marketing tag to delete. */\n type?: Type;\n }\n interface DeleteMarketingTagResponse {\n }\n interface DeleteMarketingTagV2Request {\n /** Marketing tag to delete. */\n tagType?: Type;\n }\n interface DeleteMarketingTagV2Response {\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates or updates a marketing tag.\n * \n * @param tag - Marketing tag to create or update.\n * @public\n * @documentationMaturity preview\n * @requiredField tag\n * @permissionId MARKETING_TAGS.MANAGE\n * @permissionScope Manage Marketing Tags\n * @permissionScopeId SCOPE.DC-MARKETING.MANAGE-TAGS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.marketing.tags.api.v1.MarketingTagsService.UpsertMarketingTag\n */\n function upsertMarketingTag(tag: MarketingTag): Promise;\n /**\n * Retrieves marketing tags given the provided filter.\n * \n * @public\n * @documentationMaturity preview\n * @param options - Information about the marketing tags to retrieve.\n * @permissionId MARKETING_TAGS.READ\n * @permissionScope Manage Marketing Tags\n * @permissionScopeId SCOPE.DC-MARKETING.MANAGE-TAGS\n * @permissionScope Read Marketing Tags\n * @permissionScopeId SCOPE.DC-MARKETING.READ-TAGS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.marketing.tags.api.v1.MarketingTagsService.ListMarketingTags\n */\n function listMarketingTags(options?: ListMarketingTagsOptions): Promise;\n interface ListMarketingTagsOptions {\n /** Information about which tags to retrieve. */\n filter?: Filter;\n }\n /**\n * Deletes a marketing tag.\n * \n * @public\n * @documentationMaturity preview\n * @param options - Options to use when deleting a marketing tag.\n * @permissionId MARKETING_TAGS.MANAGE\n * @permissionScope Manage Marketing Tags\n * @permissionScopeId SCOPE.DC-MARKETING.MANAGE-TAGS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.marketing.tags.api.v1.MarketingTagsService.DeleteMarketingTag\n * @deprecated method is deprecated due to a problem occurred when using it via REST.\n * @replacedBy com.wixpress.marketing.tags.api.v1.DeleteMarketingTagV2\n * @targetRemovalDate 2022-10-01\n */\n function deleteMarketingTag(options?: DeleteMarketingTagOptions): Promise;\n interface DeleteMarketingTagOptions {\n /** Information about the marketing tag to delete. */\n type?: Type;\n }\n interface DeleteMarketingTagV2Options {\n /** Marketing tag to delete. */\n tagType?: Type;\n }\n type marketingV1TagMarketingTags_universal_d_MarketingTag = MarketingTag;\n type marketingV1TagMarketingTags_universal_d_MarketingTagParamsOneOf = MarketingTagParamsOneOf;\n type marketingV1TagMarketingTags_universal_d_Type = Type;\n const marketingV1TagMarketingTags_universal_d_Type: typeof Type;\n type marketingV1TagMarketingTags_universal_d_GoogleAds = GoogleAds;\n type marketingV1TagMarketingTags_universal_d_GoogleAnalytics = GoogleAnalytics;\n type marketingV1TagMarketingTags_universal_d_YandexMetrica = YandexMetrica;\n type marketingV1TagMarketingTags_universal_d_FacebookPixel = FacebookPixel;\n type marketingV1TagMarketingTags_universal_d_GoogleTagManager = GoogleTagManager;\n type marketingV1TagMarketingTags_universal_d_TikTokPixel = TikTokPixel;\n type marketingV1TagMarketingTags_universal_d_GoogleTagManagerConsentMode = GoogleTagManagerConsentMode;\n type marketingV1TagMarketingTags_universal_d_GoogleAnalyticsConsentMode = GoogleAnalyticsConsentMode;\n type marketingV1TagMarketingTags_universal_d_HtmlEmbedUpdateMessage = HtmlEmbedUpdateMessage;\n type marketingV1TagMarketingTags_universal_d_UpsertMarketingTagRequest = UpsertMarketingTagRequest;\n type marketingV1TagMarketingTags_universal_d_UpsertMarketingTagResponse = UpsertMarketingTagResponse;\n type marketingV1TagMarketingTags_universal_d_ListMarketingTagsRequest = ListMarketingTagsRequest;\n type marketingV1TagMarketingTags_universal_d_Filter = Filter;\n type marketingV1TagMarketingTags_universal_d_ListMarketingTagsResponse = ListMarketingTagsResponse;\n type marketingV1TagMarketingTags_universal_d_DeleteMarketingTagRequest = DeleteMarketingTagRequest;\n type marketingV1TagMarketingTags_universal_d_DeleteMarketingTagResponse = DeleteMarketingTagResponse;\n type marketingV1TagMarketingTags_universal_d_DeleteMarketingTagV2Request = DeleteMarketingTagV2Request;\n type marketingV1TagMarketingTags_universal_d_DeleteMarketingTagV2Response = DeleteMarketingTagV2Response;\n type marketingV1TagMarketingTags_universal_d_DomainEvent = DomainEvent;\n type marketingV1TagMarketingTags_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type marketingV1TagMarketingTags_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type marketingV1TagMarketingTags_universal_d_RestoreInfo = RestoreInfo;\n type marketingV1TagMarketingTags_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type marketingV1TagMarketingTags_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type marketingV1TagMarketingTags_universal_d_ActionEvent = ActionEvent;\n type marketingV1TagMarketingTags_universal_d_MessageEnvelope = MessageEnvelope;\n type marketingV1TagMarketingTags_universal_d_IdentificationData = IdentificationData;\n type marketingV1TagMarketingTags_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type marketingV1TagMarketingTags_universal_d_WebhookIdentityType = WebhookIdentityType;\n const marketingV1TagMarketingTags_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const marketingV1TagMarketingTags_universal_d_upsertMarketingTag: typeof upsertMarketingTag;\n const marketingV1TagMarketingTags_universal_d_listMarketingTags: typeof listMarketingTags;\n type marketingV1TagMarketingTags_universal_d_ListMarketingTagsOptions = ListMarketingTagsOptions;\n const marketingV1TagMarketingTags_universal_d_deleteMarketingTag: typeof deleteMarketingTag;\n type marketingV1TagMarketingTags_universal_d_DeleteMarketingTagOptions = DeleteMarketingTagOptions;\n type marketingV1TagMarketingTags_universal_d_DeleteMarketingTagV2Options = DeleteMarketingTagV2Options;\n namespace marketingV1TagMarketingTags_universal_d {\n export { marketingV1TagMarketingTags_universal_d_MarketingTag as MarketingTag, marketingV1TagMarketingTags_universal_d_MarketingTagParamsOneOf as MarketingTagParamsOneOf, marketingV1TagMarketingTags_universal_d_Type as Type, marketingV1TagMarketingTags_universal_d_GoogleAds as GoogleAds, marketingV1TagMarketingTags_universal_d_GoogleAnalytics as GoogleAnalytics, marketingV1TagMarketingTags_universal_d_YandexMetrica as YandexMetrica, marketingV1TagMarketingTags_universal_d_FacebookPixel as FacebookPixel, marketingV1TagMarketingTags_universal_d_GoogleTagManager as GoogleTagManager, marketingV1TagMarketingTags_universal_d_TikTokPixel as TikTokPixel, marketingV1TagMarketingTags_universal_d_GoogleTagManagerConsentMode as GoogleTagManagerConsentMode, marketingV1TagMarketingTags_universal_d_GoogleAnalyticsConsentMode as GoogleAnalyticsConsentMode, marketingV1TagMarketingTags_universal_d_HtmlEmbedUpdateMessage as HtmlEmbedUpdateMessage, marketingV1TagMarketingTags_universal_d_UpsertMarketingTagRequest as UpsertMarketingTagRequest, marketingV1TagMarketingTags_universal_d_UpsertMarketingTagResponse as UpsertMarketingTagResponse, marketingV1TagMarketingTags_universal_d_ListMarketingTagsRequest as ListMarketingTagsRequest, marketingV1TagMarketingTags_universal_d_Filter as Filter, marketingV1TagMarketingTags_universal_d_ListMarketingTagsResponse as ListMarketingTagsResponse, marketingV1TagMarketingTags_universal_d_DeleteMarketingTagRequest as DeleteMarketingTagRequest, marketingV1TagMarketingTags_universal_d_DeleteMarketingTagResponse as DeleteMarketingTagResponse, marketingV1TagMarketingTags_universal_d_DeleteMarketingTagV2Request as DeleteMarketingTagV2Request, marketingV1TagMarketingTags_universal_d_DeleteMarketingTagV2Response as DeleteMarketingTagV2Response, marketingV1TagMarketingTags_universal_d_DomainEvent as DomainEvent, marketingV1TagMarketingTags_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, marketingV1TagMarketingTags_universal_d_EntityCreatedEvent as EntityCreatedEvent, marketingV1TagMarketingTags_universal_d_RestoreInfo as RestoreInfo, marketingV1TagMarketingTags_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, marketingV1TagMarketingTags_universal_d_EntityDeletedEvent as EntityDeletedEvent, marketingV1TagMarketingTags_universal_d_ActionEvent as ActionEvent, marketingV1TagMarketingTags_universal_d_MessageEnvelope as MessageEnvelope, marketingV1TagMarketingTags_universal_d_IdentificationData as IdentificationData, marketingV1TagMarketingTags_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, marketingV1TagMarketingTags_universal_d_WebhookIdentityType as WebhookIdentityType, marketingV1TagMarketingTags_universal_d_upsertMarketingTag as upsertMarketingTag, marketingV1TagMarketingTags_universal_d_listMarketingTags as listMarketingTags, marketingV1TagMarketingTags_universal_d_ListMarketingTagsOptions as ListMarketingTagsOptions, marketingV1TagMarketingTags_universal_d_deleteMarketingTag as deleteMarketingTag, marketingV1TagMarketingTags_universal_d_DeleteMarketingTagOptions as DeleteMarketingTagOptions, marketingV1TagMarketingTags_universal_d_DeleteMarketingTagV2Options as DeleteMarketingTagV2Options, };\n }\n export { marketingV1TagMarketingTags_universal_d as marketingTags };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-stores.v2.d.ts", "content": "declare module \"wix-stores.v2\" {\n interface InventoryItemV2 {\n /** Inventory item ID. */\n _id?: string | null;\n /**\n * Product ID.\n * @readonly\n */\n productId?: string | null;\n /** Whether quantity is being tracked. */\n trackQuantity?: boolean | null;\n /** Variants associated with this inventory item. */\n variants?: InventoryVariantV2[];\n /**\n * Last updated timestamp.\n * @readonly\n */\n lastUpdated?: Date | null;\n /**\n * Inventory’s unique numeric ID (assigned in ascending order).\n * Primarily for sorting and filtering when crawling all inventories.\n * @readonly\n */\n numericId?: string;\n /** Preorder information. */\n preorderInfo?: PreorderInfo$1;\n }\n interface InventoryVariantV2 {\n /** Variant ID. */\n variantId?: string;\n /** Whether the product is listed as in stock. */\n inStock?: boolean | null;\n /** Quantity currently left in inventory. */\n quantity?: number | null;\n /**\n * Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.\n * @readonly\n */\n availableForPreorder?: boolean;\n }\n interface PreorderInfo$1 {\n /** Whether the item is available for preorder. */\n enabled?: boolean;\n /** A message the buyer will see when the item is out of stock and preorder is enabled. */\n message?: string | null;\n /** Number of products that can be preordered after stock reaches zero. */\n limit?: number | null;\n }\n interface InventoryItemChanged {\n /** Inventory item ID. */\n inventoryItemId?: string;\n /** Product ID. */\n productId?: string;\n /** Whether inventory is being tracked. */\n trackInventory?: boolean;\n /** Preorder information. */\n preorderInfo?: PreorderInfo$1;\n /** Field mask of updated fields. */\n fieldMask?: string[];\n /** Date and time the inventory item was last updated. */\n _updatedDate?: Date | null;\n }\n interface InventoryVariantsChanged {\n /** Inventory item ID. */\n inventoryItemId?: string;\n /** Product ID. */\n productId?: string;\n /** Information about changed variants. */\n variants?: ChangedInventoryVariant[];\n /** Date and time the inventory variant item was last updated. */\n _updatedDate?: Date | null;\n }\n interface ChangedInventoryVariant {\n /** Variant ID. */\n _id?: string;\n /** Previous inventory variant data. */\n oldValue?: ChangedInventoryVariantData;\n /** Current inventory variant data. */\n newValue?: ChangedInventoryVariantData;\n }\n interface ChangedInventoryVariantData {\n /** Inventory variant quantity. */\n quantity?: number | null;\n /** Whether the product variant is in stock. */\n inStock?: boolean;\n /** Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level. */\n availableForPreorder?: boolean;\n }\n enum ReasonType {\n /** Unknown reason. */\n UNKNOWN = \"UNKNOWN\",\n /** Order related. */\n ORDER = \"ORDER\",\n /** Manual adjustment. */\n MANUAL = \"MANUAL\",\n /** Reverting an inventory change. */\n REVERT_INVENTORY_CHANGE = \"REVERT_INVENTORY_CHANGE\"\n }\n interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {\n /** Inventory item ID. */\n inventoryId: string;\n /** Product ID. */\n productId?: string;\n /** Variant IDs to query for this inventory item (optional). */\n variantIds?: string[];\n }\n /** @oneof */\n interface GetInventoryVariantsRequestIdOneOf {\n /** Inventory item ID. */\n inventoryId?: string;\n /** Product ID. */\n productId?: string;\n }\n interface GetInventoryVariantsResponse {\n /** Inventory item. */\n inventoryItem?: InventoryItemV2;\n }\n interface GetInventoryItemsRequest {\n /** Product IDs */\n productIds?: string[];\n }\n interface GetInventoryItemsResponse {\n /** Inventory items. */\n inventoryItems?: InventoryItemV2[];\n }\n interface QueryInventoryRequest {\n /** Information about paging, filters, sorting. */\n query?: Query$1;\n }\n interface Query$1 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Filter string */\n filter?: string | null;\n /** Sort string */\n sort?: string | null;\n }\n interface Paging$1 {\n /** Amount of items to load per page */\n limit?: number | null;\n /** Number of items to skip in the display (relevant for all pages after the first) */\n offset?: number | null;\n }\n interface QueryInventoryResponse {\n /** Inventory items. */\n inventoryItems?: InventoryItemV2[];\n /** Display metadata. */\n metadata?: PagingMetadata$1;\n /** Number of total results. */\n totalResults?: number;\n }\n interface PagingMetadata$1 {\n /** Amount of items to load per page */\n items?: number;\n /** Number of items to skip in the display (relevant for all pages after the first) */\n offset?: number;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface UpdateInventoryVariantsRequest {\n /** Inventory item. */\n inventoryItem: InventoryItemV2;\n }\n interface UpdateInventoryVariantsResponse {\n }\n interface BulkUpdateInventoryVariantsRequest extends BulkUpdateInventoryVariantsRequestActionOneOf {\n /** Change availability. */\n setInStock?: boolean | null;\n /** Set new quantity. */\n setQuantity?: number | null;\n /** Number to increment inventory by. */\n incrementBy?: number | null;\n /** Number to decrement inventory by. */\n decrementBy?: number | null;\n /** Variants filter. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */\n filter: Record | null;\n }\n /** @oneof */\n interface BulkUpdateInventoryVariantsRequestActionOneOf {\n /** Change availability. */\n setInStock?: boolean | null;\n /** Set new quantity. */\n setQuantity?: number | null;\n /** Number to increment inventory by. */\n incrementBy?: number | null;\n /** Number to decrement inventory by. */\n decrementBy?: number | null;\n }\n interface BulkUpdateInventoryVariantsResponse {\n }\n interface BulkUpdateInventoryItemsRequest {\n /** Variants filter */\n variantsFilter: Record | null;\n /** Whether inventory is being tracked. */\n trackInventory: boolean | null;\n }\n interface BulkUpdateInventoryItemsResponse {\n }\n interface DecrementInventoryRequest {\n /** Item or product to decrement. */\n decrementData?: DecrementData[];\n }\n interface DecrementData extends DecrementDataIdOneOf {\n /** Inventory item ID. */\n inventoryId?: string;\n /** Product ID. */\n productId?: string;\n /** Variant ID. */\n variantId?: string;\n /** Number to decrement inventory by. */\n decrementBy?: number;\n /**\n * Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.\n * If true and the item is available for preorder, we allow negative inventory.\n * If false and the item is not available for preorder, we allow regular buy flow (no negative inventory).\n */\n preorderRequest?: boolean;\n }\n /** @oneof */\n interface DecrementDataIdOneOf {\n /** Inventory item ID. */\n inventoryId?: string;\n /** Product ID. */\n productId?: string;\n }\n interface DecrementInventoryResponse {\n }\n interface IncrementInventoryRequest {\n /** Item or product to increment. */\n incrementData?: IncrementData[];\n }\n interface IncrementData extends IncrementDataIdOneOf {\n /** Inventory item ID. */\n inventoryId?: string;\n /** Product ID. */\n productId?: string;\n /** Variant ID. */\n variantId?: string;\n /** Number to increment inventory by. */\n incrementBy?: number;\n }\n /** @oneof */\n interface IncrementDataIdOneOf {\n /** Inventory item ID. */\n inventoryId?: string;\n /** Product ID. */\n productId?: string;\n }\n interface IncrementInventoryResponse {\n }\n /**\n * Gets inventory variant information based on the specified option choices.\n *\n *\n * The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.\n * @param inventoryId - Inventory item ID.\n * @public\n * @requiredField inventoryId\n * @permissionId WIX_STORES.READ_INVENTORY\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants\n */\n function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise;\n interface GetInventoryVariantsOptions extends GetInventoryVariantsRequestIdOneOf {\n /** Product ID. */\n productId?: string;\n /** Variant IDs to query for this inventory item (optional). */\n variantIds?: string[];\n }\n /**\n * Returns a list of inventory items, given the provided paging, sorting and filtering.\n * @public\n * @permissionId WIX_STORES.READ_INVENTORY\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.inventory.api.v1.InventoryReadApi.QueryInventory\n */\n function queryInventory(options?: QueryInventoryOptions): Promise;\n interface QueryInventoryOptions {\n /** Information about paging, filters, sorting. */\n query?: Query$1;\n }\n /**\n * Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.\n *\n *\n * The `updateInventoryVariants()` function is a Promise that resolves to the updated inventory variant data.\n * @param productId - Product ID.\n * @public\n * @requiredField inventoryItem\n * @requiredField productId\n * @param inventoryItem - Inventory item to update.\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.inventory.api.v1.InventoryWriteApi.UpdateInventoryVariants\n */\n function updateInventoryVariants(productId: string | null, inventoryItem: UpdateInventoryVariantsInventoryItem, options?: UpdateInventoryVariantsOptions): Promise;\n interface UpdateInventoryVariantsInventoryItem {\n /** Inventory item ID. */\n _id?: string | null;\n /** Whether quantity is being tracked. */\n trackQuantity?: boolean | null;\n /** Variants associated with this inventory item. */\n variants?: InventoryVariantV2[];\n /**\n * Last updated timestamp.\n * @readonly\n */\n lastUpdated?: Date | null;\n /**\n * Inventory’s unique numeric ID (assigned in ascending order).\n * Primarily for sorting and filtering when crawling all inventories.\n * @readonly\n */\n numericId?: string;\n /** Preorder information. */\n preorderInfo?: PreorderInfo$1;\n }\n interface UpdateInventoryVariantsOptions {\n }\n interface BulkUpdateInventoryVariantsOptions extends BulkUpdateInventoryVariantsRequestActionOneOf {\n /** Change availability. */\n setInStock?: boolean | null;\n /** Set new quantity. */\n setQuantity?: number | null;\n /** Number to increment inventory by. */\n incrementBy?: number | null;\n /** Number to decrement inventory by. */\n decrementBy?: number | null;\n }\n interface BulkUpdateInventoryItemsOptions {\n /** Whether inventory is being tracked. */\n trackInventory: boolean | null;\n }\n /**\n * Subtracts a set number of items from inventory.\n *\n *\n * The `decrementInventory()` function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.\n * @param decrementData - Item or product to decrement.\n * @public\n * @documentationMaturity preview\n * @requiredField decrementData\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.inventory.api.v1.InventoryWriteApi.DecrementInventory\n */\n function decrementInventory(decrementData: DecrementData[], options?: DecrementInventoryOptions): Promise;\n interface DecrementInventoryOptions {\n }\n /**\n * Adds a set number of items to inventory.\n *\n *\n * The `incrementInventory()` function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.\n * @param incrementData - Item or product to increment.\n * @public\n * @documentationMaturity preview\n * @requiredField incrementData\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.inventory.api.v1.InventoryWriteApi.IncrementInventory\n */\n function incrementInventory(incrementData: IncrementData[], options?: IncrementInventoryOptions): Promise;\n interface IncrementInventoryOptions {\n }\n type storesV2InventoryInventory_universal_d_InventoryItemV2 = InventoryItemV2;\n type storesV2InventoryInventory_universal_d_InventoryVariantV2 = InventoryVariantV2;\n type storesV2InventoryInventory_universal_d_InventoryItemChanged = InventoryItemChanged;\n type storesV2InventoryInventory_universal_d_InventoryVariantsChanged = InventoryVariantsChanged;\n type storesV2InventoryInventory_universal_d_ChangedInventoryVariant = ChangedInventoryVariant;\n type storesV2InventoryInventory_universal_d_ChangedInventoryVariantData = ChangedInventoryVariantData;\n type storesV2InventoryInventory_universal_d_ReasonType = ReasonType;\n const storesV2InventoryInventory_universal_d_ReasonType: typeof ReasonType;\n type storesV2InventoryInventory_universal_d_GetInventoryVariantsRequest = GetInventoryVariantsRequest;\n type storesV2InventoryInventory_universal_d_GetInventoryVariantsRequestIdOneOf = GetInventoryVariantsRequestIdOneOf;\n type storesV2InventoryInventory_universal_d_GetInventoryVariantsResponse = GetInventoryVariantsResponse;\n type storesV2InventoryInventory_universal_d_GetInventoryItemsRequest = GetInventoryItemsRequest;\n type storesV2InventoryInventory_universal_d_GetInventoryItemsResponse = GetInventoryItemsResponse;\n type storesV2InventoryInventory_universal_d_QueryInventoryRequest = QueryInventoryRequest;\n type storesV2InventoryInventory_universal_d_QueryInventoryResponse = QueryInventoryResponse;\n type storesV2InventoryInventory_universal_d_UpdateInventoryVariantsRequest = UpdateInventoryVariantsRequest;\n type storesV2InventoryInventory_universal_d_UpdateInventoryVariantsResponse = UpdateInventoryVariantsResponse;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsRequest = BulkUpdateInventoryVariantsRequest;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsRequestActionOneOf = BulkUpdateInventoryVariantsRequestActionOneOf;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsResponse = BulkUpdateInventoryVariantsResponse;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryItemsRequest = BulkUpdateInventoryItemsRequest;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryItemsResponse = BulkUpdateInventoryItemsResponse;\n type storesV2InventoryInventory_universal_d_DecrementInventoryRequest = DecrementInventoryRequest;\n type storesV2InventoryInventory_universal_d_DecrementData = DecrementData;\n type storesV2InventoryInventory_universal_d_DecrementDataIdOneOf = DecrementDataIdOneOf;\n type storesV2InventoryInventory_universal_d_DecrementInventoryResponse = DecrementInventoryResponse;\n type storesV2InventoryInventory_universal_d_IncrementInventoryRequest = IncrementInventoryRequest;\n type storesV2InventoryInventory_universal_d_IncrementData = IncrementData;\n type storesV2InventoryInventory_universal_d_IncrementDataIdOneOf = IncrementDataIdOneOf;\n type storesV2InventoryInventory_universal_d_IncrementInventoryResponse = IncrementInventoryResponse;\n const storesV2InventoryInventory_universal_d_getInventoryVariants: typeof getInventoryVariants;\n type storesV2InventoryInventory_universal_d_GetInventoryVariantsOptions = GetInventoryVariantsOptions;\n const storesV2InventoryInventory_universal_d_queryInventory: typeof queryInventory;\n type storesV2InventoryInventory_universal_d_QueryInventoryOptions = QueryInventoryOptions;\n const storesV2InventoryInventory_universal_d_updateInventoryVariants: typeof updateInventoryVariants;\n type storesV2InventoryInventory_universal_d_UpdateInventoryVariantsInventoryItem = UpdateInventoryVariantsInventoryItem;\n type storesV2InventoryInventory_universal_d_UpdateInventoryVariantsOptions = UpdateInventoryVariantsOptions;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsOptions = BulkUpdateInventoryVariantsOptions;\n type storesV2InventoryInventory_universal_d_BulkUpdateInventoryItemsOptions = BulkUpdateInventoryItemsOptions;\n const storesV2InventoryInventory_universal_d_decrementInventory: typeof decrementInventory;\n type storesV2InventoryInventory_universal_d_DecrementInventoryOptions = DecrementInventoryOptions;\n const storesV2InventoryInventory_universal_d_incrementInventory: typeof incrementInventory;\n type storesV2InventoryInventory_universal_d_IncrementInventoryOptions = IncrementInventoryOptions;\n namespace storesV2InventoryInventory_universal_d {\n export { storesV2InventoryInventory_universal_d_InventoryItemV2 as InventoryItemV2, storesV2InventoryInventory_universal_d_InventoryVariantV2 as InventoryVariantV2, PreorderInfo$1 as PreorderInfo, storesV2InventoryInventory_universal_d_InventoryItemChanged as InventoryItemChanged, storesV2InventoryInventory_universal_d_InventoryVariantsChanged as InventoryVariantsChanged, storesV2InventoryInventory_universal_d_ChangedInventoryVariant as ChangedInventoryVariant, storesV2InventoryInventory_universal_d_ChangedInventoryVariantData as ChangedInventoryVariantData, storesV2InventoryInventory_universal_d_ReasonType as ReasonType, storesV2InventoryInventory_universal_d_GetInventoryVariantsRequest as GetInventoryVariantsRequest, storesV2InventoryInventory_universal_d_GetInventoryVariantsRequestIdOneOf as GetInventoryVariantsRequestIdOneOf, storesV2InventoryInventory_universal_d_GetInventoryVariantsResponse as GetInventoryVariantsResponse, storesV2InventoryInventory_universal_d_GetInventoryItemsRequest as GetInventoryItemsRequest, storesV2InventoryInventory_universal_d_GetInventoryItemsResponse as GetInventoryItemsResponse, storesV2InventoryInventory_universal_d_QueryInventoryRequest as QueryInventoryRequest, Query$1 as Query, Paging$1 as Paging, storesV2InventoryInventory_universal_d_QueryInventoryResponse as QueryInventoryResponse, PagingMetadata$1 as PagingMetadata, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, storesV2InventoryInventory_universal_d_UpdateInventoryVariantsRequest as UpdateInventoryVariantsRequest, storesV2InventoryInventory_universal_d_UpdateInventoryVariantsResponse as UpdateInventoryVariantsResponse, storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsRequest as BulkUpdateInventoryVariantsRequest, storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsRequestActionOneOf as BulkUpdateInventoryVariantsRequestActionOneOf, storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsResponse as BulkUpdateInventoryVariantsResponse, storesV2InventoryInventory_universal_d_BulkUpdateInventoryItemsRequest as BulkUpdateInventoryItemsRequest, storesV2InventoryInventory_universal_d_BulkUpdateInventoryItemsResponse as BulkUpdateInventoryItemsResponse, storesV2InventoryInventory_universal_d_DecrementInventoryRequest as DecrementInventoryRequest, storesV2InventoryInventory_universal_d_DecrementData as DecrementData, storesV2InventoryInventory_universal_d_DecrementDataIdOneOf as DecrementDataIdOneOf, storesV2InventoryInventory_universal_d_DecrementInventoryResponse as DecrementInventoryResponse, storesV2InventoryInventory_universal_d_IncrementInventoryRequest as IncrementInventoryRequest, storesV2InventoryInventory_universal_d_IncrementData as IncrementData, storesV2InventoryInventory_universal_d_IncrementDataIdOneOf as IncrementDataIdOneOf, storesV2InventoryInventory_universal_d_IncrementInventoryResponse as IncrementInventoryResponse, storesV2InventoryInventory_universal_d_getInventoryVariants as getInventoryVariants, storesV2InventoryInventory_universal_d_GetInventoryVariantsOptions as GetInventoryVariantsOptions, storesV2InventoryInventory_universal_d_queryInventory as queryInventory, storesV2InventoryInventory_universal_d_QueryInventoryOptions as QueryInventoryOptions, storesV2InventoryInventory_universal_d_updateInventoryVariants as updateInventoryVariants, storesV2InventoryInventory_universal_d_UpdateInventoryVariantsInventoryItem as UpdateInventoryVariantsInventoryItem, storesV2InventoryInventory_universal_d_UpdateInventoryVariantsOptions as UpdateInventoryVariantsOptions, storesV2InventoryInventory_universal_d_BulkUpdateInventoryVariantsOptions as BulkUpdateInventoryVariantsOptions, storesV2InventoryInventory_universal_d_BulkUpdateInventoryItemsOptions as BulkUpdateInventoryItemsOptions, storesV2InventoryInventory_universal_d_decrementInventory as decrementInventory, storesV2InventoryInventory_universal_d_DecrementInventoryOptions as DecrementInventoryOptions, storesV2InventoryInventory_universal_d_incrementInventory as incrementInventory, storesV2InventoryInventory_universal_d_IncrementInventoryOptions as IncrementInventoryOptions, };\n }\n interface Product {\n /**\n * Product ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string;\n /**\n * Product name.\n *\n * Min: 1 character\n * Max: 80 characters\n */\n name?: string | null;\n /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */\n slug?: string;\n /** Whether the product is visible to site visitors. */\n visible?: boolean | null;\n /** Currently, only creating physical products ( `\"productType\": \"physical\"` ) is supported via the API. */\n productType?: ProductType;\n /** Product description. */\n description?: string | null;\n /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */\n sku?: string | null;\n /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */\n weight?: number | null;\n /**\n * Product weight range. The minimum and maximum weights of all the variants.\n * @readonly\n */\n weightRange?: NumericPropertyRange;\n /**\n * Product inventory status (in future this will be writable via Inventory API).\n * @readonly\n */\n stock?: Stock;\n /**\n * Deprecated (use `priceData` instead).\n * @readonly\n * @deprecated\n */\n price?: PriceData;\n /** Price data. */\n priceData?: PriceData;\n /**\n * Price data, converted to the currency specified in request header.\n * @readonly\n */\n convertedPriceData?: PriceData;\n /**\n * Product price range. The minimum and maximum prices of all the variants.\n * @readonly\n */\n priceRange?: NumericPropertyRange;\n /** Cost and profit data. */\n costAndProfitData?: CostAndProfitData;\n /**\n * Product cost range. The minimum and maximum costs of all the variants.\n * @readonly\n */\n costRange?: NumericPropertyRange;\n /** Price per unit data. */\n pricePerUnitData?: PricePerUnitData;\n /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */\n additionalInfoSections?: AdditionalInfoSection[];\n /**\n * Deprecated (use `ribbon` instead).\n * @readonly\n * @deprecated\n */\n ribbons?: Ribbon[];\n /**\n * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).\n * @readonly\n */\n media?: Media;\n /**\n * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.\n * @readonly\n */\n customTextFields?: CustomTextField[];\n /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */\n manageVariants?: boolean | null;\n /** Options for this product. */\n productOptions?: ProductOption[];\n /**\n * Product page URL for this product (generated automatically by the server).\n * @readonly\n */\n productPageUrl?: PageUrl;\n /**\n * Product’s unique numeric ID (assigned in ascending order).\n * Primarily used for sorting and filtering when crawling all products.\n * @readonly\n */\n numericId?: string;\n /**\n * Inventory item ID - ID referencing the inventory system.\n * @readonly\n */\n inventoryItemId?: string;\n /** Discount deducted from the product's original price. */\n discount?: Discount;\n /**\n * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).\n * @readonly\n */\n collectionIds?: string[];\n /**\n * Product variants, will be provided if the the request was sent with the `includeVariants: true`.\n *\n * Max: 1,000 variants\n * @readonly\n */\n variants?: Variant[];\n /**\n * Date and time the product was last updated.\n * @readonly\n */\n lastUpdated?: Date | null;\n /**\n * Date and time the product was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** Custom SEO data for the product. */\n seoData?: SeoSchema;\n /** Product ribbon. Used to highlight relevant information about a product. For example, \"Sale\", \"New Arrival\", \"Sold Out\". */\n ribbon?: string | null;\n /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */\n brand?: string | null;\n }\n enum ProductType {\n unspecified_product_type = \"unspecified_product_type\",\n physical = \"physical\",\n digital = \"digital\"\n }\n interface NumericPropertyRange {\n /** Minimum value. */\n minValue?: number;\n /** Maximum value. */\n maxValue?: number;\n }\n interface Stock {\n /** Whether inventory is being tracked */\n trackInventory?: boolean;\n /** Quantity currently left in inventory */\n quantity?: number | null;\n /**\n * Whether the product is currently in stock (relevant only when tracking manually)\n * Deprecated (use `inventoryStatus` instead)\n * @deprecated\n */\n inStock?: boolean;\n /**\n * The current status of the inventory\n * + `IN_STOCK` - In stock\n * + `OUT_OF_STOCK` - Not in stock\n * + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock\n */\n inventoryStatus?: InventoryStatus;\n }\n enum InventoryStatus {\n /** In stock */\n IN_STOCK = \"IN_STOCK\",\n /** Not in stock */\n OUT_OF_STOCK = \"OUT_OF_STOCK\",\n /** Some of the variants are not in stock */\n PARTIALLY_OUT_OF_STOCK = \"PARTIALLY_OUT_OF_STOCK\"\n }\n interface PriceData {\n /**\n * Product price currency\n * @readonly\n */\n currency?: string;\n /** Product price */\n price?: number | null;\n /**\n * Discounted product price (if no discounted price is set, the product price is returned)\n * @readonly\n */\n discountedPrice?: number;\n /**\n * The product price and discounted price, formatted with the currency\n * @readonly\n */\n formatted?: FormattedPrice;\n /**\n * Price per unit\n * @readonly\n */\n pricePerUnit?: number | null;\n }\n interface FormattedPrice {\n /** Product price formatted with the currency */\n price?: string;\n /** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */\n discountedPrice?: string;\n /**\n * Price per unit\n * @readonly\n */\n pricePerUnit?: string | null;\n }\n interface CostAndProfitData {\n /** Item cost. */\n itemCost?: number | null;\n /**\n * Item cost formatted with currency symbol.\n * @readonly\n */\n formattedItemCost?: string;\n /**\n * Profit. Calculated by reducing `cost` from `discounted_price`.\n * @readonly\n */\n profit?: number;\n /**\n * Profit formatted with currency symbol.\n * @readonly\n */\n formattedProfit?: string;\n /**\n * Profit Margin. Calculated by dividing `profit` by `discounted_price`.\n * The result is rounded to 4 decimal places.\n * @readonly\n */\n profitMargin?: number;\n }\n interface PricePerUnitData {\n /** Total quantity */\n totalQuantity?: number;\n /** Total measurement unit */\n totalMeasurementUnit?: MeasurementUnit;\n /** Base quantity */\n baseQuantity?: number;\n /** Base measurement unit */\n baseMeasurementUnit?: MeasurementUnit;\n }\n enum MeasurementUnit {\n UNSPECIFIED = \"UNSPECIFIED\",\n ML = \"ML\",\n CL = \"CL\",\n L = \"L\",\n CBM = \"CBM\",\n MG = \"MG\",\n G = \"G\",\n KG = \"KG\",\n MM = \"MM\",\n CM = \"CM\",\n M = \"M\",\n SQM = \"SQM\",\n OZ = \"OZ\",\n LB = \"LB\",\n FLOZ = \"FLOZ\",\n PT = \"PT\",\n QT = \"QT\",\n GAL = \"GAL\",\n IN = \"IN\",\n FT = \"FT\",\n YD = \"YD\",\n SQFT = \"SQFT\"\n }\n interface AdditionalInfoSection {\n /** Product info section title */\n title?: string;\n /** Product info section description */\n description?: string;\n }\n interface Ribbon {\n /** Ribbon text */\n text?: string;\n }\n interface Media {\n /** Primary media (image, video etc) associated with this product. */\n mainMedia?: MediaItem;\n /** Media (images, videos etc) associated with this product. */\n items?: MediaItem[];\n }\n interface MediaItem extends MediaItemItemOneOf {\n /** Image data (URL, size). */\n image?: MediaItemUrlAndSize;\n /** Video data (URL, size). */\n video?: MediaItemVideo;\n /** Media item thumbnail details. */\n thumbnail?: MediaItemUrlAndSize;\n /** Media item type (image, video, etc.). */\n mediaType?: MediaItemType;\n /** Media item title. */\n title?: string;\n /** Media ID (for example, `\"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"`). */\n _id?: string;\n }\n /** @oneof */\n interface MediaItemItemOneOf {\n /** Image data (URL, size). */\n image?: MediaItemUrlAndSize;\n /** Video data (URL, size). */\n video?: MediaItemVideo;\n }\n interface MediaItemUrlAndSize {\n /** Media item URL. */\n url?: string;\n /** Media item width. */\n width?: number;\n /** Media item height. */\n height?: number;\n /** Media format (mp4, png, etc.). */\n format?: string | null;\n /** Alt text. This text will be shown in case the image is not available. */\n altText?: string | null;\n }\n enum MediaItemType {\n unspecified_media_item_type = \"unspecified_media_item_type\",\n /** Image media type. */\n image = \"image\",\n /** Video media type. */\n video = \"video\",\n /** Audio media type. */\n audio = \"audio\",\n /** Document media type. */\n document = \"document\",\n /** Zip media type. */\n zip = \"zip\"\n }\n interface MediaItemVideo {\n /** Data (URL, size) about each resolution for which this video is available. */\n files?: MediaItemUrlAndSize[];\n /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `\"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"`. */\n stillFrameMediaId?: string;\n }\n interface CustomTextField {\n /** Text box title */\n title?: string;\n /** Text box input max length */\n maxLength?: number;\n /** Whether this text box is mandatory */\n mandatory?: boolean;\n }\n interface ProductOption {\n /**\n * Option type.\n * @readonly\n */\n optionType?: OptionType;\n /** Option name. */\n name?: string;\n /** Choices available for this option. */\n choices?: Choice[];\n }\n enum OptionType {\n /** Unspecified option type. */\n unspecified_option_type = \"unspecified_option_type\",\n /** Drop down. */\n drop_down = \"drop_down\",\n /** Color. */\n color = \"color\"\n }\n interface Choice {\n /** Choice value. */\n value?: string;\n /** Choice description. */\n description?: string;\n /**\n * Media items (images, videos) associated with this choice\n * @readonly\n */\n media?: Media;\n /**\n * Based on the customer’s choices, which (if any) variants that include the selected choices are in stock\n * @readonly\n */\n inStock?: boolean;\n /**\n * Based on the customer’s choices, which (if any) variants that include the selected choices are visible\n * @readonly\n */\n visible?: boolean;\n }\n interface PageUrl {\n /** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */\n base?: string;\n /** Path to the product page - e.g /product-page/a-product. */\n path?: string;\n }\n interface Discount {\n /**\n * Discount type:\n * + `\"AMOUNT\"`\n * + `\"PERCENT\"`\n */\n type?: DiscountType;\n /** Discount value */\n value?: number;\n }\n enum DiscountType {\n UNDEFINED = \"UNDEFINED\",\n /** No discount */\n NONE = \"NONE\",\n /** Discount by a fixed amount */\n AMOUNT = \"AMOUNT\",\n /** Discount by a percentage */\n PERCENT = \"PERCENT\"\n }\n interface Variant {\n /** Requested Variant ID */\n _id?: string;\n /** Specific choices within a selection, as option-choice key-value pairs */\n choices?: Record;\n variant?: VariantDataWithNoStock;\n /**\n * Variant inventory status.\n * @readonly\n */\n stock?: VariantStock;\n }\n interface VariantDataWithNoStock {\n /** Variant price. */\n priceData?: PriceData;\n /**\n * Variant price data, converted to currency requested in header.\n * @readonly\n */\n convertedPriceData?: PriceData;\n /** Cost and profit data. */\n costAndProfitData?: CostAndProfitData;\n /** Variant weight. */\n weight?: number;\n /** Variant SKU (stock keeping unit). */\n sku?: string;\n /** Whether the variant is visible to customers. */\n visible?: boolean;\n }\n interface VariantStock {\n /** Whether inventory is being tracked. */\n trackQuantity?: boolean;\n /** Quantity currently left in inventory. */\n quantity?: number | null;\n /** Whether the product is currently in stock (relevant only when tracking manually). */\n inStock?: boolean;\n }\n /**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself.\n */\n interface SeoSchema {\n /** SEO tag information. */\n tags?: Tag[];\n /** SEO general settings. */\n settings?: Settings;\n }\n interface Keyword {\n /** Keyword value. */\n term?: string;\n /** Whether the keyword is the main focus keyword. */\n isMain?: boolean;\n /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\n }\n interface Tag {\n /**\n * SEO tag type.\n *\n *\n * Supported values: `title`, `meta`, `script`, `link`.\n */\n type?: string;\n /**\n * A `{\"key\": \"value\"}` pair object where each SEO tag property (`\"name\"`, `\"content\"`, `\"rel\"`, `\"href\"`) contains a value.\n * For example: `{\"name\": \"description\", \"content\": \"the description itself\"}`.\n */\n props?: Record | null;\n /** SEO tag meta data. For example, `{\"height\": 300, \"width\": 240}`. */\n meta?: Record | null;\n /** SEO tag inner content. For example, ` inner content `. */\n children?: string;\n /** Whether the tag is a custom tag. */\n custom?: boolean;\n /** Whether the tag is disabled. */\n disabled?: boolean;\n }\n interface Settings {\n /**\n * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n *\n *\n * Default: `false` (Auto Redirect is enabled.)\n */\n preventAutoRedirect?: boolean;\n /** User-selected keyword terms for a specific page. */\n keywords?: Keyword[];\n }\n interface SecuredMedia {\n /** Media ID in Wix Media Manager. */\n _id?: string;\n /** Original filename. */\n fileName?: string;\n /** File type. */\n fileType?: FileType;\n }\n enum FileType {\n UNSPECIFIED = \"UNSPECIFIED\",\n SECURE_PICTURE = \"SECURE_PICTURE\",\n SECURE_VIDEO = \"SECURE_VIDEO\",\n SECURE_DOCUMENT = \"SECURE_DOCUMENT\",\n SECURE_MUSIC = \"SECURE_MUSIC\",\n SECURE_ARCHIVE = \"SECURE_ARCHIVE\"\n }\n interface CreateProductRequest {\n /** Product information. */\n product?: Product;\n }\n interface CreateProductResponse {\n product?: Product;\n }\n interface CreateProductPlatformizedRequest {\n /** Product information. */\n product?: Product;\n }\n interface CreateProductPlatformizedResponse {\n product?: Product;\n }\n interface CreateDigitalProductRequest {\n /** Product information. */\n product?: Product;\n }\n interface CreateDigitalProductResponse {\n /** Created product. */\n product?: Product;\n }\n interface UpdateProductRequest {\n product: Product;\n }\n interface UpdateProductResponse {\n product?: Product;\n }\n interface UpdateProductPlatformizedRequest {\n product: Product;\n }\n interface UpdateProductPlatformizedResponse {\n product?: Product;\n }\n interface DeleteProductRequest {\n /** ID of the product to delete. */\n _id: string;\n }\n interface DeleteProductResponse {\n }\n interface DeleteProductPlatformizedRequest {\n /** ID of the product to delete. */\n _id: string;\n }\n interface DeleteProductPlatformizedResponse {\n }\n interface BulkDeleteProductsRequest {\n /** IDs of the products to be deleted. */\n ids: string[];\n }\n interface BulkDeleteProductsResponse {\n }\n interface UpdateVariantsRequest {\n /** ID of the product with managed variants. */\n _id: string;\n /** Variant info to update. */\n variants?: VariantOverride[];\n }\n interface VariantOverride {\n /** The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice). You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (Not relevant when passing variant IDs) */\n choices?: Record;\n /**\n * List of variant IDs\n * (Not relevant when passing choices)\n */\n variantIds?: string[];\n /** Variant price */\n price?: number | null;\n /** Variant cost of goods */\n cost?: number | null;\n /** Variant weight */\n weight?: number | null;\n /** Variant SKU (stock keeping unit) */\n sku?: string | null;\n /** Whether the variant is visible to customers */\n visible?: boolean | null;\n }\n interface UpdateVariantsResponse {\n /** List of the product's variants. */\n variants?: Variant[];\n }\n interface ResetAllVariantDataRequest {\n /** Product ID. */\n _id: string;\n }\n interface ResetAllVariantDataResponse {\n }\n interface AddProductsToCollectionRequest {\n /** Collection ID. */\n _id: string;\n /** IDs of the products to add to the collection, separated by commas. */\n productIds?: string[];\n }\n interface AddProductsToCollectionResponse {\n }\n interface RemoveProductsFromCollectionRequest {\n /** ID of the collection from which to remove products. */\n _id: string;\n /** IDs of the products to remove from the collection. */\n productIds: string[];\n }\n interface RemoveProductsFromCollectionResponse {\n }\n interface AddProductMediaRequest {\n /** Product ID. */\n _id: string;\n /** Sources of media items already uploaded to the Wix site. */\n media?: MediaDataForWrite[];\n }\n interface MediaDataForWrite extends MediaDataForWriteMediaSourceOneOf {\n /** Media ID. */\n mediaId?: string;\n /** Media external URL (for new media items). */\n url?: string;\n /** Assign this media item to a specific product choice. Note that you may set media items for choices under only one option (e.g., if Colors blue, green, and red have media items, Sizes S, M, and L can't have media items assigned to them). You may clear existing media from choices with the [Remove Product Media From Choices](#removeproductmediafromchoices). */\n choice?: OptionAndChoice;\n }\n /** @oneof */\n interface MediaDataForWriteMediaSourceOneOf {\n /** Media ID. */\n mediaId?: string;\n /** Media external URL (for new media items). */\n url?: string;\n }\n interface OptionAndChoice {\n /** Option to add the media to. */\n option?: string;\n /** Choice to add the media to. */\n choice?: string;\n }\n interface AddProductMediaResponse {\n }\n interface RemoveProductMediaRequest {\n /** Product ID. */\n _id: string;\n /** List of media IDs to remove. Pass an empty array to delete all media items for the product. */\n mediaIds?: string[];\n }\n interface RemoveProductMediaResponse {\n }\n interface AddProductMediaToChoicesRequest {\n /** Product ID. */\n _id: string;\n /** Product media items and the choices to add the media to. */\n media?: MediaAssignmentToChoice[];\n }\n interface MediaAssignmentToChoice {\n /** Option name. */\n option?: string;\n /** Choice name. */\n choice?: string;\n /** Media IDs (available via the Query Product endpoint). */\n mediaIds?: string[];\n }\n interface AddProductMediaToChoicesResponse {\n }\n interface RemoveProductMediaFromChoicesRequest {\n /** Product ID from whose choices to remove media items. */\n _id: string;\n /** Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product. */\n media?: MediaAssignmentToChoice[];\n }\n interface RemoveProductMediaFromChoicesResponse {\n }\n interface DeleteProductOptionsRequest {\n /** ID of the product with options to delete. */\n _id: string;\n }\n interface DeleteProductOptionsResponse {\n }\n interface SetCustomFieldsRequest {\n /** Product ID. */\n _id: string;\n /** Custom field that will be added, if a custom field with the same name already exists, the value of the custom field will be overridden. */\n customFields?: Record;\n }\n interface SetCustomFieldsResponse {\n }\n interface RemoveCustomFieldsRequest {\n /** Product ID. */\n _id: string;\n /** Custom fields to be removed (by name). */\n names?: string[];\n }\n interface RemoveCustomFieldsResponse {\n }\n interface RemoveProductBrandRequest {\n /** Product ID. */\n _id: string;\n }\n interface RemoveProductBrandResponse {\n }\n interface BulkSetCustomFieldsRequest {\n /** Filter string. */\n filter?: string | null;\n /** Custom field that will be added, if a custom field with same name already exists, the value of the custom field will be overridden. */\n customFields?: Record;\n }\n interface BulkSetCustomFieldsResponse {\n }\n interface BulkRemoveCustomFieldsRequest {\n /** Filter string. */\n filter?: string | null;\n /** Custom fields names. */\n names?: string[];\n }\n interface BulkRemoveCustomFieldsResponse {\n }\n interface CreateCollectionRequest {\n /** Collection info. */\n collection: Collection;\n }\n interface Collection {\n /**\n * Collection ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string | null;\n /** Collection name. */\n name?: string | null;\n /**\n * Media items (images, videos etc) associated with this collection. Read only.\n * @readonly\n */\n media?: Media;\n /**\n * Number of products in the collection. Read only.\n * @readonly\n */\n numberOfProducts?: number;\n /** Collection description. */\n description?: string | null;\n /** Collection slug. */\n slug?: string | null;\n /** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */\n visible?: boolean | null;\n }\n interface CreateCollectionResponse {\n /** Collection. */\n collection?: Collection;\n }\n interface UpdateCollectionRequest {\n /** Collection info. */\n collection: Collection;\n }\n interface UpdateCollectionResponse {\n /** Updated collection. */\n collection?: Collection;\n }\n interface DeleteCollectionRequest {\n /** ID of the collection to delete. */\n _id: string;\n }\n interface DeleteCollectionResponse {\n }\n interface RemoveProductRibbonRequest {\n /** Product ID. */\n _id: string;\n }\n interface RemoveProductRibbonResponse {\n }\n interface BulkUpdateProductsRequest {\n /** Product IDs. */\n ids: string[];\n /** Field to update. */\n set?: SetValue;\n }\n interface SetValue extends SetValueValueOneOf {\n /**\n * Set product price.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * variant prices will be calculated according to the set product price.\n * If variant price is negative after setting new price, the update will fail.\n */\n price?: number;\n /**\n * Set product cost of goods.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * cost of goods will be set per variant.\n */\n cost?: number;\n /**\n * Set product weight.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * weight will be set per variant.\n */\n weight?: number;\n /** Set product ribbon. Pass empty string to remove existing ribbon. */\n ribbon?: string;\n /** Set product brand. Pass empty string to remove existing brand. */\n brand?: string;\n }\n /** @oneof */\n interface SetValueValueOneOf {\n /**\n * Set product price.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * variant prices will be calculated according to the set product price.\n * If variant price is negative after setting new price, the update will fail.\n */\n price?: number;\n /**\n * Set product cost of goods.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * cost of goods will be set per variant.\n */\n cost?: number;\n /**\n * Set product weight.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * weight will be set per variant.\n */\n weight?: number;\n /** Set product ribbon. Pass empty string to remove existing ribbon. */\n ribbon?: string;\n /** Set product brand. Pass empty string to remove existing brand. */\n brand?: string;\n }\n interface BulkUpdateProductsResponse {\n /** Bulk action results. */\n results?: BulkProductResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkProductResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkUpdateProductsByFilterSyncRequest {\n /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort). */\n filter: Record | null;\n /** The field to update. */\n set?: SetValue;\n }\n interface BulkUpdateProductsByFilterSyncResponse {\n /** Items updated by bulk action. */\n results?: BulkProductResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface AllowedProductsCountLimitExceededErrorData {\n /** Total number of products */\n totalCount?: number;\n }\n interface BulkAdjustProductPropertiesRequest {\n /** Product IDs. */\n ids: string[];\n /** Numerical property to adjust. */\n adjust?: AdjustValue;\n }\n interface AdjustValue extends AdjustValueValueOneOf {\n /**\n * Adjust product price.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * variants prices will be calculated according to the adjusted price.\n * If variant price is negative after the adjustment, the update will fail.\n */\n price?: PropertyAdjustmentData;\n /**\n * Adjust product cost of goods.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * cost of goods will be adjusted per variant.\n */\n cost?: PropertyAdjustmentData;\n /**\n * Adjust product weight.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * weight will be adjusted per variant.\n */\n weight?: PropertyAdjustmentData;\n }\n /** @oneof */\n interface AdjustValueValueOneOf {\n /**\n * Adjust product price.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * variants prices will be calculated according to the adjusted price.\n * If variant price is negative after the adjustment, the update will fail.\n */\n price?: PropertyAdjustmentData;\n /**\n * Adjust product cost of goods.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * cost of goods will be adjusted per variant.\n */\n cost?: PropertyAdjustmentData;\n /**\n * Adjust product weight.\n * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,\n * weight will be adjusted per variant.\n */\n weight?: PropertyAdjustmentData;\n }\n interface PropertyAdjustmentData extends PropertyAdjustmentDataByOneOf {\n /** Adjust by percentage. */\n percentage?: PercentageData;\n /** Adjust by amount. */\n amount?: number;\n }\n /** @oneof */\n interface PropertyAdjustmentDataByOneOf {\n /** Adjust by percentage. */\n percentage?: PercentageData;\n /** Adjust by amount. */\n amount?: number;\n }\n interface PercentageData {\n /**\n * If `true`, result will be rounded to the nearest whole number.\n * If `false`, result will be rounded to 2 places after the decimal point.\n */\n roundToInt?: boolean;\n /**\n * Percentage value, as a whole number (integer) between `-100` and `1000`.\n *\n * For example:\n * + Pass `100` to increase value by 100% (multiply original value by 2).\n * + Pass `1000` to increase value by 1000% (multiply original value by 10).\n * + Pass `-50` to decrease value by 50% (original value is halved).\n */\n rate?: number;\n }\n interface BulkAdjustProductPropertiesResponse {\n /** Bulk action results. */\n results?: BulkProductResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkAdjustProductPropertiesByFilterSyncRequest {\n /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort). */\n filter: Record | null;\n /** Numerical property to adjust. */\n adjust?: AdjustValue;\n }\n interface BulkAdjustProductPropertiesByFilterSyncResponse {\n /** Items updated by bulk action. */\n results?: BulkProductResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ReCloneStoreRequest {\n /** Description of value */\n metasiteId: string | null;\n originalMetasiteId?: string | null;\n }\n interface ReCloneStoreResponse {\n }\n interface V1CreateProductPlatformizedRequest {\n /** Product information. */\n product?: Product;\n }\n interface V1CreateProductPlatformizedResponse {\n product?: Product;\n }\n interface V1UpdateProductPlatformizedRequest {\n product: Product;\n }\n interface V1UpdateProductPlatformizedResponse {\n product?: Product;\n }\n interface V1DeleteProductPlatformizedRequest {\n /** ID of the product to delete. */\n _id: string;\n }\n interface V1DeleteProductPlatformizedResponse {\n }\n interface ProductCreated {\n /** Product ID (generated automatically by the catalog). */\n productId?: string;\n /** Product name. */\n name?: string;\n /** Product price. */\n price?: PriceData;\n /** Whether the product is visible to customers. */\n visible?: boolean;\n /** Media items (images, videos, etc.) associated with this product. */\n media?: Media;\n /** Product stock keeping unit (SKU). If variants are being managed, this will be empty. */\n sku?: string;\n /** Product page URL for this product (generated automatically by the server). */\n productPageUrl?: PageUrl;\n /** Product brand. */\n brand?: string | null;\n /** Cost and profit data */\n costAndProfitData?: CostAndProfitData;\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n /** Event slug. A human readable identifier of the event. */\n slug?: string;\n }\n enum Version {\n /** Version 1 of the catalog. */\n V1_CATALOG = \"V1_CATALOG\",\n /** Version 3 of the catalog. */\n V3_CATALOG = \"V3_CATALOG\"\n }\n interface ProductChanged {\n /** Product ID. */\n productId?: string;\n /** List of product fields that were changed. */\n changedFields?: string[];\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface ProductDeleted {\n /** ID of the product that was deleted. */\n productId?: string;\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface CollectionCreated {\n /** Collection ID (generated automatically by the catalog). */\n collection_Id?: string;\n /** Collection name. */\n name?: string;\n /** Media items (images, videos, etc.) associated with this collection. */\n media?: Media;\n /** Collection slug */\n slug?: string;\n /** Collection visible status */\n visible?: boolean;\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface CollectionChanged {\n /** Collection ID (generated automatically by the catalog). */\n collection_Id?: string;\n /** List of collection fields that were changed. */\n changedFields?: string[];\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface CollectionDeleted {\n /** ID of the collection that was deleted. */\n collection_Id?: string;\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface VariantsChanged {\n /** Product ID. */\n productId?: string;\n /** List of variants that were changed. */\n variants?: VariantChanged[];\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface VariantChanged {\n /** Variant ID. */\n variantId?: string;\n choices?: Record;\n /** List of variant fields that were changed. */\n changedFields?: string[];\n /** Information about the version of the catalog from where this event was triggered. */\n originatedFromVersion?: Version;\n }\n interface QueryProductsRequest {\n query?: Query;\n /** Whether variants should be included in the response. */\n includeVariants?: boolean;\n /** Whether hidden products should be included in the response. Requires permissions to manage products. */\n includeHiddenProducts?: boolean;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface Query {\n paging?: Paging;\n /** Filter string */\n filter?: string | null;\n /** Sort string */\n sort?: string | null;\n }\n interface Paging {\n /** Amount of items to load per page */\n limit?: number | null;\n /** Number of items to skip in the display (relevant for all pages after the first) */\n offset?: number | null;\n }\n interface QueryProductsResponse {\n products?: Product[];\n metadata?: PagingMetadata;\n totalResults?: number;\n }\n interface PagingMetadata {\n /** Amount of items to load per page */\n items?: number;\n /** Number of items to skip in the display (relevant for all pages after the first) */\n offset?: number;\n }\n interface QueryProductsPlatformizedRequest {\n query?: PlatformQuery;\n }\n interface PlatformQuery extends PlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting[];\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformPaging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryProductsPlatformizedResponse {\n products?: Product[];\n metadata?: PlatformPagingMetadata;\n }\n interface PlatformPagingMetadata {\n /** The number of items returned in this response. */\n count?: number | null;\n /** The offset which was requested. Returned if offset paging was used. */\n offset?: number | null;\n /** The total number of items that match the query. Returned if offset paging was used. */\n total?: number | null;\n /** Cursors to navigate through result pages. Returned if cursor paging was used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryProductsWithBigPageLimitRequest {\n query?: QueryWithBigPageLimit;\n /** Whether variants should be included in the response. */\n includeVariants?: boolean;\n /** Whether hidden products should be included in the response. Requires permissions to manage products. */\n includeHiddenProducts?: boolean;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface QueryWithBigPageLimit {\n paging?: PagingWithBigLimit;\n /** Filter string */\n filter?: string | null;\n /** Sort string */\n sort?: string | null;\n }\n interface PagingWithBigLimit {\n /** Amount of items to load per page */\n limit?: number | null;\n /** Number of items to skip in the display (relevant for all pages after the first) */\n offset?: number | null;\n }\n interface GetProductsRequest {\n /** Requested product IDs. */\n ids?: string[];\n }\n interface GetProductsResponse {\n products?: Product[];\n }\n interface GetProductRequest {\n /** Requested product ID. */\n _id: string;\n /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface GetProductResponse {\n /** Requested product data. */\n product?: Product;\n }\n interface GetProductPlatformizedRequest {\n /** Requested product ID. */\n _id: string;\n /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface GetProductPlatformizedResponse {\n /** Requested product data. */\n product?: Product;\n }\n interface QueryCollectionsRequest {\n /** Query options. */\n query?: Query;\n /** Whether number of products should be included in the response. */\n includeNumberOfProducts?: boolean;\n /** Wether to include collection description in the response. When `false` is passed, `collection.description` will return null. */\n includeDescription?: boolean;\n }\n interface QueryCollectionsResponse {\n /** List of collections. */\n collections?: Collection[];\n /** Details on the paged set of results returned. */\n metadata?: PagingMetadata;\n /** Total number of results returned. */\n totalResults?: number;\n }\n interface QueryCollectionsPlatformizedRequest {\n query?: PlatformQuery;\n }\n interface QueryCollectionsPlatformizedResponse {\n collections?: Collection[];\n metadata?: PlatformPagingMetadata;\n }\n interface GetCollectionRequest {\n /** Requested collection ID. */\n _id: string;\n /**\n * Whether to return the `collection.numberOfProducts` field in the response.\n * Defaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.\n */\n includeNumberOfProducts?: boolean;\n }\n interface GetCollectionResponse {\n /** The requested collection. */\n collection?: Collection;\n }\n interface GetCollectionBySlugRequest {\n /** Slug of the collection to retrieve. */\n slug: string;\n }\n interface GetCollectionBySlugResponse {\n /** The requested collection. */\n collection?: Collection;\n }\n interface ProductOptionsAvailabilityRequest {\n /** Requested product ID. */\n _id: string;\n /** Array containing the selected options. For example, `[\"color\": \"Blue\", \"size\": \"Large\"]`. */\n options?: Record;\n }\n interface ProductOptionsAvailabilityResponse {\n /** Variant information, given that all the choices were provided. */\n selectedVariant?: VariantData;\n /** Information about media items (images, videos, etc.) associated with this choice. */\n media?: Media;\n /** Options information (color, size, etc.) for this product, with the inventory and visibility fields updated based on the provided choices. */\n productOptions?: ProductOption[];\n /** Whether all the selected choices result in a visible, in-stock variant. */\n availableForPurchase?: boolean;\n }\n interface VariantData {\n /** Variant price. */\n price?: PriceData;\n /**\n * Variant price data converted to currency provided in header.\n * @readonly\n */\n convertedPriceData?: PriceData;\n /** Variant weight. */\n weight?: number | null;\n /** Variant SKU (stock keeping unit). */\n sku?: string;\n /** Quantity currently in inventory (relevant only when tracking by inventory). */\n quantity?: number | null;\n /** Whether the product is currently in stock (relevant only when tracking manually). */\n inStock?: boolean;\n /** Whether the variant is visible to customers. */\n visible?: boolean;\n }\n interface QueryProductVariantsRequest {\n /** Requested product ID. */\n _id: string;\n /**\n * The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice).\n * You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (not relevant when passing variant IDs).\n */\n choices?: Record;\n /** List of variant IDs (not relevant when passing choices). */\n variantIds?: string[];\n paging?: Paging;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface QueryProductVariantsResponse {\n /** List of variants based on the specified filters and sorting. */\n variants?: Variant[];\n metadata?: PagingMetadata;\n totalResults?: number;\n }\n interface QueryStoreVariantsRequest {\n /** Query options. */\n query?: PlatformQuery;\n }\n interface QueryStoreVariantsResponse {\n /** List of variants based on the specified filters and sorting. */\n variants?: StoreVariant[];\n /** Details on the paged set of results returned. */\n metadata?: PlatformPagingMetadata;\n }\n interface StoreVariant {\n /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}. */\n _id?: string;\n /** Variant ID. */\n variantId?: string;\n /** Product ID. */\n productId?: string;\n /** Variant name. */\n variantName?: string;\n /** Product name. */\n productName?: string;\n /** Whether the variant is managed or represents a product. */\n managedVariant?: boolean;\n /** Variant SKU (stock keeping unit). */\n sku?: string;\n /** Variant inventory status. */\n stock?: VariantStock;\n /** The selected options of this variant. For example, `{\"Color\": \"Blue\", \"Size\": \"Large\"}`. */\n choices?: Record;\n /** Collections that include this variant. */\n collectionIds?: string[];\n /**\n * Media items (images, videos) associated with this variant.\n * @readonly\n */\n media?: PlatformMedia;\n /** Preorder information. */\n preorderInfo?: PreorderInfo;\n }\n interface PlatformMedia extends PlatformMediaMediaOneOf {\n image?: string;\n video?: string;\n }\n /** @oneof */\n interface PlatformMediaMediaOneOf {\n image?: string;\n video?: string;\n }\n interface FocalPoint {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n /** crop by height */\n height?: number | null;\n /** crop by width */\n width?: number | null;\n }\n interface VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /** Video format for example, mp4, hls. */\n format?: string;\n }\n interface PreorderInfo {\n /** Whether the item is available for preorder. */\n enabled?: boolean;\n /** A message the buyer will see when the item is out of stock and preorder is enabled. */\n message?: string | null;\n /** Number of products that can be preordered after stock reaches zero. */\n limit?: number | null;\n }\n interface QueryStoreVariantsWithBigLimitRequest {\n /** Query options. */\n query?: UnlimitedPlatformQuery;\n }\n /**\n * Don't use it unless you have to and know what you do. Prefer PlatformQuery other than this.\n * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.\n */\n interface UnlimitedPlatformQuery extends UnlimitedPlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: UnlimitedPlatformPaging;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: UnlimitedPlatformCursorPaging;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting[];\n }\n /** @oneof */\n interface UnlimitedPlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: UnlimitedPlatformPaging;\n /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n cursorPaging?: UnlimitedPlatformCursorPaging;\n }\n /**\n * Don't use it unless you have to and know what you do. Prefer PlatformPaging or wix.common.Paging other than this.\n * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.\n */\n interface UnlimitedPlatformPaging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n /**\n * Don't use it unless you have to and know what you do. Prefer PlatformCursorPaging or wix.common.CursorPaging other than this.\n * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.\n */\n interface UnlimitedPlatformCursorPaging {\n /**\n * The number of items to load.\n * Cursor token returned in the query response. To be used on the next query request, but not the first query request.\n */\n limit?: number | null;\n /** Cursor returned in last query response. Should not be provided on first page request */\n cursor?: string | null;\n }\n interface GetStoreVariantRequest {\n /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`. */\n _id: string;\n }\n interface GetStoreVariantResponse {\n /** The requested store variant. */\n variant?: StoreVariant;\n }\n interface QueryCustomFieldsRequest {\n /** Requested product ID. */\n _id?: string;\n /** Requested field names. */\n names?: string[];\n }\n interface QueryCustomFieldsResponse {\n customFields?: Record;\n }\n interface BulkQueryCustomFieldsRequest {\n /** Filter string. */\n query?: Query;\n /** Requested field names. */\n names?: string[];\n }\n interface BulkQueryCustomFieldsResponse {\n /** ProductId to Custom Fields Map packed in container. */\n productIdToCustomFields?: Record;\n metadata?: PagingMetadata;\n totalResults?: number;\n }\n interface CustomFieldsContainer {\n customFields?: Record;\n }\n interface AggregateProductsRequest {\n /** Filter applied to original data */\n filter?: Record | null;\n /** This is an object defining aggregation itself */\n aggregation: Record | null;\n /** Whether hidden products should be considered. Requires permissions to manage products. */\n includeHiddenProducts?: boolean;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface AggregateProductsResponse {\n aggregates?: Record | null;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new product.\n * @param product - Product information.\n * @public\n * @requiredField product\n * @requiredField product.costAndProfitData.itemCost\n * @requiredField product.name\n * @requiredField product.priceData\n * @requiredField product.priceData.price\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.CreateProduct\n */\n function createProduct(product: Product): Promise;\n interface CreateDigitalProductOptions {\n /** Product information. */\n product?: Product;\n }\n /**\n * Updates specified fields in a product.\n * @param _id - Product ID (generated automatically by the catalog).\n * @public\n * @requiredField _id\n * @requiredField product\n * @param product - Product info to update.\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.UpdateProduct\n */\n function updateProduct(_id: string, product: UpdateProduct): Promise;\n interface UpdateProduct {\n /**\n * Product ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string;\n /**\n * Product name.\n *\n * Min: 1 character\n * Max: 80 characters\n */\n name?: string | null;\n /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */\n slug?: string;\n /** Whether the product is visible to site visitors. */\n visible?: boolean | null;\n /** Currently, only creating physical products ( `\"productType\": \"physical\"` ) is supported via the API. */\n productType?: ProductType;\n /** Product description. */\n description?: string | null;\n /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */\n sku?: string | null;\n /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */\n weight?: number | null;\n /**\n * Product weight range. The minimum and maximum weights of all the variants.\n * @readonly\n */\n weightRange?: NumericPropertyRange;\n /**\n * Product inventory status (in future this will be writable via Inventory API).\n * @readonly\n */\n stock?: Stock;\n /**\n * Deprecated (use `priceData` instead).\n * @readonly\n * @deprecated\n */\n price?: PriceData;\n /** Price data. */\n priceData?: PriceData;\n /**\n * Price data, converted to the currency specified in request header.\n * @readonly\n */\n convertedPriceData?: PriceData;\n /**\n * Product price range. The minimum and maximum prices of all the variants.\n * @readonly\n */\n priceRange?: NumericPropertyRange;\n /** Cost and profit data. */\n costAndProfitData?: CostAndProfitData;\n /**\n * Product cost range. The minimum and maximum costs of all the variants.\n * @readonly\n */\n costRange?: NumericPropertyRange;\n /** Price per unit data. */\n pricePerUnitData?: PricePerUnitData;\n /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */\n additionalInfoSections?: AdditionalInfoSection[];\n /**\n * Deprecated (use `ribbon` instead).\n * @readonly\n * @deprecated\n */\n ribbons?: Ribbon[];\n /**\n * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).\n * @readonly\n */\n media?: Media;\n /**\n * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.\n * @readonly\n */\n customTextFields?: CustomTextField[];\n /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */\n manageVariants?: boolean | null;\n /** Options for this product. */\n productOptions?: ProductOption[];\n /**\n * Product page URL for this product (generated automatically by the server).\n * @readonly\n */\n productPageUrl?: PageUrl;\n /**\n * Product’s unique numeric ID (assigned in ascending order).\n * Primarily used for sorting and filtering when crawling all products.\n * @readonly\n */\n numericId?: string;\n /**\n * Inventory item ID - ID referencing the inventory system.\n * @readonly\n */\n inventoryItemId?: string;\n /** Discount deducted from the product's original price. */\n discount?: Discount;\n /**\n * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).\n * @readonly\n */\n collectionIds?: string[];\n /**\n * Product variants, will be provided if the the request was sent with the `includeVariants: true`.\n *\n * Max: 1,000 variants\n * @readonly\n */\n variants?: Variant[];\n /**\n * Date and time the product was last updated.\n * @readonly\n */\n lastUpdated?: Date | null;\n /**\n * Date and time the product was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** Custom SEO data for the product. */\n seoData?: SeoSchema;\n /** Product ribbon. Used to highlight relevant information about a product. For example, \"Sale\", \"New Arrival\", \"Sold Out\". */\n ribbon?: string | null;\n /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */\n brand?: string | null;\n }\n interface UpdateProductPlatformizedProduct {\n /**\n * Product ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string;\n /**\n * Product name.\n *\n * Min: 1 character\n * Max: 80 characters\n */\n name?: string | null;\n /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */\n slug?: string;\n /** Whether the product is visible to site visitors. */\n visible?: boolean | null;\n /** Currently, only creating physical products ( `\"productType\": \"physical\"` ) is supported via the API. */\n productType?: ProductType;\n /** Product description. */\n description?: string | null;\n /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */\n sku?: string | null;\n /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */\n weight?: number | null;\n /**\n * Product weight range. The minimum and maximum weights of all the variants.\n * @readonly\n */\n weightRange?: NumericPropertyRange;\n /**\n * Product inventory status (in future this will be writable via Inventory API).\n * @readonly\n */\n stock?: Stock;\n /**\n * Deprecated (use `priceData` instead).\n * @readonly\n * @deprecated\n */\n price?: PriceData;\n /** Price data. */\n priceData?: PriceData;\n /**\n * Price data, converted to the currency specified in request header.\n * @readonly\n */\n convertedPriceData?: PriceData;\n /**\n * Product price range. The minimum and maximum prices of all the variants.\n * @readonly\n */\n priceRange?: NumericPropertyRange;\n /** Cost and profit data. */\n costAndProfitData?: CostAndProfitData;\n /**\n * Product cost range. The minimum and maximum costs of all the variants.\n * @readonly\n */\n costRange?: NumericPropertyRange;\n /** Price per unit data. */\n pricePerUnitData?: PricePerUnitData;\n /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */\n additionalInfoSections?: AdditionalInfoSection[];\n /**\n * Deprecated (use `ribbon` instead).\n * @readonly\n * @deprecated\n */\n ribbons?: Ribbon[];\n /**\n * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).\n * @readonly\n */\n media?: Media;\n /**\n * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.\n * @readonly\n */\n customTextFields?: CustomTextField[];\n /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */\n manageVariants?: boolean | null;\n /** Options for this product. */\n productOptions?: ProductOption[];\n /**\n * Product page URL for this product (generated automatically by the server).\n * @readonly\n */\n productPageUrl?: PageUrl;\n /**\n * Product’s unique numeric ID (assigned in ascending order).\n * Primarily used for sorting and filtering when crawling all products.\n * @readonly\n */\n numericId?: string;\n /**\n * Inventory item ID - ID referencing the inventory system.\n * @readonly\n */\n inventoryItemId?: string;\n /** Discount deducted from the product's original price. */\n discount?: Discount;\n /**\n * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).\n * @readonly\n */\n collectionIds?: string[];\n /**\n * Product variants, will be provided if the the request was sent with the `includeVariants: true`.\n *\n * Max: 1,000 variants\n * @readonly\n */\n variants?: Variant[];\n /**\n * Date and time the product was last updated.\n * @readonly\n */\n lastUpdated?: Date | null;\n /**\n * Date and time the product was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** Custom SEO data for the product. */\n seoData?: SeoSchema;\n /** Product ribbon. Used to highlight relevant information about a product. For example, \"Sale\", \"New Arrival\", \"Sold Out\". */\n ribbon?: string | null;\n /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */\n brand?: string | null;\n }\n /**\n * Deletes a product.\n * @param _id - ID of the product to delete.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.DeleteProduct\n */\n function deleteProduct(_id: string): Promise;\n /**\n * Updates variants of a specified product.\n * @param _id - ID of the product with managed variants.\n * @param variants - Variant info to update.\n * @public\n * @requiredField _id\n * @requiredField variants\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.UpdateVariants\n */\n function updateProductVariants(_id: string, variants: VariantOverride[]): Promise;\n /**\n * Resets the data (such as the price and the weight) of all variants for a given product to their default values.\n * @param _id - Product ID.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.ResetAllVariantData\n */\n function resetAllProductVariantData(_id: string): Promise;\n /**\n * Adds products to a specified collection.\n * @param _id - Collection ID.\n * @param productIds - IDs of the products to add to the collection, separated by commas.\n * @public\n * @requiredField _id\n * @requiredField productIds\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.AddProductsToCollection\n */\n function addProductsToCollection(_id: string, productIds: string[]): Promise;\n /**\n * Deletes products from a specified collection.\n * @param _id - ID of the collection from which to remove products.\n * @param productIds - IDs of the products to remove from the collection.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField productIds\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveProductsFromCollection\n */\n function removeProductsFromCollection(_id: string, productIds: string[]): Promise;\n /**\n * Adds media items to a specified product, either via URL or existing media ID.\n *\n * > **NOTE:** The URL is not validated and no event is triggered to indicate if the media was added successfully.\n * @param _id - Product ID.\n * @param media - Sources of media items already uploaded to the Wix site.\n * @public\n * @requiredField _id\n * @requiredField media\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.AddProductMedia\n */\n function addProductMedia(_id: string, media: MediaDataForWrite[]): Promise;\n /**\n * Removes specified media items from a product.\n * Pass an empty array to remove all media items.\n * @param _id - Product ID.\n * @param mediaIds - List of media IDs to remove. Pass an empty array to delete all media items for the product.\n * @public\n * @requiredField _id\n * @requiredField mediaIds\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveProductMedia\n */\n function removeProductMedia(_id: string, mediaIds: string[]): Promise;\n /**\n * Links media items that are already associated with a specific product to a choice within the same product.\n *\n * Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).\n *\n * To remove all existing media items, call the [Remove Product Media From Choices](https://dev.wix.com/api/rest/wix-stores/catalog/products/remove-product-media-from-choices) endpoint.\n * @param _id - Product ID.\n * @param media - Product media items and the choices to add the media to.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField media\n * @requiredField media.choice\n * @requiredField media.option\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.AddProductMediaToChoices\n */\n function addProductMediaToChoices(_id: string, media: MediaAssignmentToChoice[]): Promise;\n /**\n * Removes media items from all or some of a product's choices.\n * (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)\n * @param _id - Product ID from whose choices to remove media items.\n * @param media - Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField media\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveProductMediaFromChoices\n */\n function removeProductMediaFromChoices(_id: string, media: MediaAssignmentToChoice[]): Promise;\n /**\n * Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.\n * @param _id - ID of the product with options to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.DeleteProductOptions\n */\n function deleteProductOptions(_id: string): Promise;\n interface SetCustomFieldsOptions {\n /** Custom field that will be added, if a custom field with the same name already exists, the value of the custom field will be overridden. */\n customFields?: Record;\n }\n interface RemoveCustomFieldsOptions {\n /** Custom fields to be removed (by name). */\n names?: string[];\n }\n /**\n * Deletes a product's brand.\n * @param _id - Product ID.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveBrand\n */\n function removeBrand(_id: string): Promise;\n interface BulkSetCustomFieldsOptions {\n /** Filter string. */\n filter?: string | null;\n /** Custom field that will be added, if a custom field with same name already exists, the value of the custom field will be overridden. */\n customFields?: Record;\n }\n interface BulkRemoveCustomFieldsOptions {\n /** Filter string. */\n filter?: string | null;\n /** Custom fields names. */\n names?: string[];\n }\n /**\n * Creates a new collection.\n * @param collection - Collection info.\n * @public\n * @requiredField collection\n * @requiredField collection.name\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.CreateCollection\n */\n function createCollection(collection: Collection): Promise;\n /**\n * Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.\n * @param _id - Collection ID (generated automatically by the catalog).\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField collection\n * @param collection - Collection info to update.\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.UpdateCollection\n */\n function updateCollection(_id: string | null, collection: UpdateCollection): Promise;\n interface UpdateCollection {\n /**\n * Collection ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string | null;\n /** Collection name. */\n name?: string | null;\n /**\n * Media items (images, videos etc) associated with this collection. Read only.\n * @readonly\n */\n media?: Media;\n /**\n * Number of products in the collection. Read only.\n * @readonly\n */\n numberOfProducts?: number;\n /** Collection description. */\n description?: string | null;\n /** Collection slug. */\n slug?: string | null;\n /** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */\n visible?: boolean | null;\n }\n /**\n * Deletes a collection.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @param _id - ID of the collection to delete.\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.DeleteCollection\n */\n function deleteCollection(_id: string): Promise;\n /**\n * Deletes a product's ribbon.\n * @param _id - Product ID.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.RemoveRibbon\n */\n function removeRibbon(_id: string): Promise;\n /**\n * Updates a specified property for up to 100 products at a time.\n * @param ids - Product IDs.\n * @param set - Field to update.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @requiredField set\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.BulkUpdateProducts\n */\n function bulkUpdateProductsProperty(ids: string[], set: SetValue): Promise;\n interface BulkUpdateProductsByFilterSyncOptions {\n /** The field to update. */\n set?: SetValue;\n }\n /**\n * Adjusts a specified numerical property for up to 100 products at a time.\n * The property can be increased or decreased either by percentage or amount.\n * @param adjust - Numerical property to adjust.\n * @param ids - Product IDs.\n * @public\n * @documentationMaturity preview\n * @requiredField adjust\n * @requiredField ids\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.catalog.api.v1.CatalogWriteApi.BulkAdjustProductProperties\n */\n function bulkAdjustProductProperty(adjust: AdjustValue, ids: string[]): Promise;\n interface BulkAdjustProductPropertiesByFilterSyncOptions {\n /** Numerical property to adjust. */\n adjust?: AdjustValue;\n }\n interface ReCloneStoreOptions {\n originalMetasiteId?: string | null;\n }\n interface WriteProxyUpdateProductPlatformizedProduct {\n /**\n * Product ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string;\n /**\n * Product name.\n *\n * Min: 1 character\n * Max: 80 characters\n */\n name?: string | null;\n /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */\n slug?: string;\n /** Whether the product is visible to site visitors. */\n visible?: boolean | null;\n /** Currently, only creating physical products ( `\"productType\": \"physical\"` ) is supported via the API. */\n productType?: ProductType;\n /** Product description. */\n description?: string | null;\n /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */\n sku?: string | null;\n /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */\n weight?: number | null;\n /**\n * Product weight range. The minimum and maximum weights of all the variants.\n * @readonly\n */\n weightRange?: NumericPropertyRange;\n /**\n * Product inventory status (in future this will be writable via Inventory API).\n * @readonly\n */\n stock?: Stock;\n /**\n * Deprecated (use `priceData` instead).\n * @readonly\n * @deprecated\n */\n price?: PriceData;\n /** Price data. */\n priceData?: PriceData;\n /**\n * Price data, converted to the currency specified in request header.\n * @readonly\n */\n convertedPriceData?: PriceData;\n /**\n * Product price range. The minimum and maximum prices of all the variants.\n * @readonly\n */\n priceRange?: NumericPropertyRange;\n /** Cost and profit data. */\n costAndProfitData?: CostAndProfitData;\n /**\n * Product cost range. The minimum and maximum costs of all the variants.\n * @readonly\n */\n costRange?: NumericPropertyRange;\n /** Price per unit data. */\n pricePerUnitData?: PricePerUnitData;\n /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */\n additionalInfoSections?: AdditionalInfoSection[];\n /**\n * Deprecated (use `ribbon` instead).\n * @readonly\n * @deprecated\n */\n ribbons?: Ribbon[];\n /**\n * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).\n * @readonly\n */\n media?: Media;\n /**\n * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.\n * @readonly\n */\n customTextFields?: CustomTextField[];\n /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */\n manageVariants?: boolean | null;\n /** Options for this product. */\n productOptions?: ProductOption[];\n /**\n * Product page URL for this product (generated automatically by the server).\n * @readonly\n */\n productPageUrl?: PageUrl;\n /**\n * Product’s unique numeric ID (assigned in ascending order).\n * Primarily used for sorting and filtering when crawling all products.\n * @readonly\n */\n numericId?: string;\n /**\n * Inventory item ID - ID referencing the inventory system.\n * @readonly\n */\n inventoryItemId?: string;\n /** Discount deducted from the product's original price. */\n discount?: Discount;\n /**\n * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).\n * @readonly\n */\n collectionIds?: string[];\n /**\n * Product variants, will be provided if the the request was sent with the `includeVariants: true`.\n *\n * Max: 1,000 variants\n * @readonly\n */\n variants?: Variant[];\n /**\n * Date and time the product was last updated.\n * @readonly\n */\n lastUpdated?: Date | null;\n /**\n * Date and time the product was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** Custom SEO data for the product. */\n seoData?: SeoSchema;\n /** Product ribbon. Used to highlight relevant information about a product. For example, \"Sale\", \"New Arrival\", \"Sold Out\". */\n ribbon?: string | null;\n /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */\n brand?: string | null;\n }\n interface QueryProductsNonPlatformizedOptions {\n query?: Query;\n /** Whether variants should be included in the response. */\n includeVariants?: boolean;\n /** Whether hidden products should be included in the response. Requires permissions to manage products. */\n includeHiddenProducts?: boolean;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n /**\n * Returns a list of up to 100 products, given the provided paging, sorting and filtering.\n * @public\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.QueryProductsPlatformized\n */\n function queryProducts(): ProductsQueryBuilder;\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProductsQueryResult extends QueryOffsetResult {\n items: Product[];\n query: ProductsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ProductsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"name\" | \"slug\" | \"productType\" | \"description\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"collectionIds\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"name\" | \"slug\" | \"productType\" | \"description\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"collectionIds\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"priceData.price\" | \"numericId\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"priceData.price\" | \"numericId\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"priceData.price\" | \"numericId\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"priceData.price\" | \"numericId\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"_id\" | \"name\" | \"slug\" | \"description\" | \"sku\", value: string) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"_id\" | \"name\" | \"slug\" | \"productType\" | \"description\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"collectionIds\" | \"lastUpdated\" | \"_createdDate\", value: any[]) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasAll: (propertyName: \"collectionIds\", value: any[]) => ProductsQueryBuilder;\n in: (propertyName: \"_id\" | \"name\" | \"slug\" | \"productType\" | \"description\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"collectionIds\" | \"lastUpdated\" | \"_createdDate\", value: any) => ProductsQueryBuilder;\n exists: (propertyName: \"_id\" | \"name\" | \"slug\" | \"productType\" | \"description\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"collectionIds\" | \"lastUpdated\" | \"_createdDate\", value: boolean) => ProductsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"name\" | \"slug\" | \"productType\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"lastUpdated\">) => ProductsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"name\" | \"slug\" | \"productType\" | \"sku\" | \"price\" | \"priceData.price\" | \"numericId\" | \"lastUpdated\">) => ProductsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => ProductsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => ProductsQueryBuilder;\n find: () => Promise;\n }\n interface QueryProductsWithBigPageLimitOptions {\n query?: QueryWithBigPageLimit;\n /** Whether variants should be included in the response. */\n includeVariants?: boolean;\n /** Whether hidden products should be included in the response. Requires permissions to manage products. */\n includeHiddenProducts?: boolean;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n /**\n * Retrieves a product with the provided ID.\n * @param _id - Requested product ID.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.GetProduct\n */\n function getProduct(_id: string, options?: GetProductOptions): Promise;\n interface GetProductOptions {\n /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface GetProductPlatformizedOptions {\n /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n interface QueryCollectionsOptions {\n /** Query options. */\n query?: Query;\n /** Whether number of products should be included in the response. */\n includeNumberOfProducts?: boolean;\n /** Wether to include collection description in the response. When `false` is passed, `collection.description` will return null. */\n includeDescription?: boolean;\n }\n interface GetCollectionOptions {\n /**\n * Whether to return the `collection.numberOfProducts` field in the response.\n * Defaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.\n */\n includeNumberOfProducts?: boolean;\n }\n /**\n * Retrieves a collection with the provided slug.\n * @param slug - Slug of the collection to retrieve.\n * @public\n * @requiredField slug\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.GetCollectionBySlug\n */\n function getCollectionBySlug(slug: string): Promise;\n /**\n * Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.\n * @param _id - Requested product ID.\n * @param options - Array containing the selected options. For example, `[\"color\": \"Blue\", \"size\": \"Large\"]`.\n * @public\n * @requiredField _id\n * @requiredField options\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.ProductOptionsAvailability\n */\n function getProductOptionsAvailability(_id: string, options: Record): Promise;\n /**\n * Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @param _id - Requested product ID.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.QueryProductVariants\n */\n function queryProductVariants(_id: string, options?: QueryProductVariantsOptions): Promise;\n interface QueryProductVariantsOptions {\n /**\n * The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice).\n * You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (not relevant when passing variant IDs).\n */\n choices?: Record;\n /** List of variant IDs (not relevant when passing choices). */\n variantIds?: string[];\n paging?: Paging;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n /**\n * Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.\n * @param query - Query options.\n * @public\n * @requiredField query\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.QueryStoreVariants\n */\n function queryStoreVariants(query: PlatformQuery, options?: QueryStoreVariantsOptions): Promise;\n interface QueryStoreVariantsOptions {\n }\n interface QueryStoreVariantsWithBigLimitOptions {\n /** Query options. */\n query?: UnlimitedPlatformQuery;\n }\n /**\n * Retrieves a store variant with the provided ID.\n * @param _id - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.\n * @public\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @permissionScope Manage Products\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS\n * @permissionScope Read Stores - all read permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES\n * @permissionScope Read Products\n * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.catalog.api.v1.CatalogReadApi.GetStoreVariant\n */\n function getStoreVariant(_id: string): Promise;\n interface AggregateProductsOptions {\n /** Filter applied to original data */\n filter?: Record | null;\n /** This is an object defining aggregation itself */\n aggregation: Record | null;\n /** Whether hidden products should be considered. Requires permissions to manage products. */\n includeHiddenProducts?: boolean;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n type storesCatalogV1ProductProducts_universal_d_Product = Product;\n type storesCatalogV1ProductProducts_universal_d_ProductType = ProductType;\n const storesCatalogV1ProductProducts_universal_d_ProductType: typeof ProductType;\n type storesCatalogV1ProductProducts_universal_d_NumericPropertyRange = NumericPropertyRange;\n type storesCatalogV1ProductProducts_universal_d_Stock = Stock;\n type storesCatalogV1ProductProducts_universal_d_InventoryStatus = InventoryStatus;\n const storesCatalogV1ProductProducts_universal_d_InventoryStatus: typeof InventoryStatus;\n type storesCatalogV1ProductProducts_universal_d_PriceData = PriceData;\n type storesCatalogV1ProductProducts_universal_d_FormattedPrice = FormattedPrice;\n type storesCatalogV1ProductProducts_universal_d_CostAndProfitData = CostAndProfitData;\n type storesCatalogV1ProductProducts_universal_d_PricePerUnitData = PricePerUnitData;\n type storesCatalogV1ProductProducts_universal_d_MeasurementUnit = MeasurementUnit;\n const storesCatalogV1ProductProducts_universal_d_MeasurementUnit: typeof MeasurementUnit;\n type storesCatalogV1ProductProducts_universal_d_AdditionalInfoSection = AdditionalInfoSection;\n type storesCatalogV1ProductProducts_universal_d_Ribbon = Ribbon;\n type storesCatalogV1ProductProducts_universal_d_Media = Media;\n type storesCatalogV1ProductProducts_universal_d_MediaItem = MediaItem;\n type storesCatalogV1ProductProducts_universal_d_MediaItemItemOneOf = MediaItemItemOneOf;\n type storesCatalogV1ProductProducts_universal_d_MediaItemUrlAndSize = MediaItemUrlAndSize;\n type storesCatalogV1ProductProducts_universal_d_MediaItemType = MediaItemType;\n const storesCatalogV1ProductProducts_universal_d_MediaItemType: typeof MediaItemType;\n type storesCatalogV1ProductProducts_universal_d_MediaItemVideo = MediaItemVideo;\n type storesCatalogV1ProductProducts_universal_d_CustomTextField = CustomTextField;\n type storesCatalogV1ProductProducts_universal_d_ProductOption = ProductOption;\n type storesCatalogV1ProductProducts_universal_d_OptionType = OptionType;\n const storesCatalogV1ProductProducts_universal_d_OptionType: typeof OptionType;\n type storesCatalogV1ProductProducts_universal_d_Choice = Choice;\n type storesCatalogV1ProductProducts_universal_d_PageUrl = PageUrl;\n type storesCatalogV1ProductProducts_universal_d_Discount = Discount;\n type storesCatalogV1ProductProducts_universal_d_DiscountType = DiscountType;\n const storesCatalogV1ProductProducts_universal_d_DiscountType: typeof DiscountType;\n type storesCatalogV1ProductProducts_universal_d_Variant = Variant;\n type storesCatalogV1ProductProducts_universal_d_VariantDataWithNoStock = VariantDataWithNoStock;\n type storesCatalogV1ProductProducts_universal_d_VariantStock = VariantStock;\n type storesCatalogV1ProductProducts_universal_d_SeoSchema = SeoSchema;\n type storesCatalogV1ProductProducts_universal_d_Keyword = Keyword;\n type storesCatalogV1ProductProducts_universal_d_Tag = Tag;\n type storesCatalogV1ProductProducts_universal_d_Settings = Settings;\n type storesCatalogV1ProductProducts_universal_d_SecuredMedia = SecuredMedia;\n type storesCatalogV1ProductProducts_universal_d_FileType = FileType;\n const storesCatalogV1ProductProducts_universal_d_FileType: typeof FileType;\n type storesCatalogV1ProductProducts_universal_d_CreateProductRequest = CreateProductRequest;\n type storesCatalogV1ProductProducts_universal_d_CreateProductResponse = CreateProductResponse;\n type storesCatalogV1ProductProducts_universal_d_CreateProductPlatformizedRequest = CreateProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_CreateProductPlatformizedResponse = CreateProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_CreateDigitalProductRequest = CreateDigitalProductRequest;\n type storesCatalogV1ProductProducts_universal_d_CreateDigitalProductResponse = CreateDigitalProductResponse;\n type storesCatalogV1ProductProducts_universal_d_UpdateProductRequest = UpdateProductRequest;\n type storesCatalogV1ProductProducts_universal_d_UpdateProductResponse = UpdateProductResponse;\n type storesCatalogV1ProductProducts_universal_d_UpdateProductPlatformizedRequest = UpdateProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_UpdateProductPlatformizedResponse = UpdateProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_DeleteProductRequest = DeleteProductRequest;\n type storesCatalogV1ProductProducts_universal_d_DeleteProductResponse = DeleteProductResponse;\n type storesCatalogV1ProductProducts_universal_d_DeleteProductPlatformizedRequest = DeleteProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_DeleteProductPlatformizedResponse = DeleteProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkDeleteProductsRequest = BulkDeleteProductsRequest;\n type storesCatalogV1ProductProducts_universal_d_BulkDeleteProductsResponse = BulkDeleteProductsResponse;\n type storesCatalogV1ProductProducts_universal_d_UpdateVariantsRequest = UpdateVariantsRequest;\n type storesCatalogV1ProductProducts_universal_d_VariantOverride = VariantOverride;\n type storesCatalogV1ProductProducts_universal_d_UpdateVariantsResponse = UpdateVariantsResponse;\n type storesCatalogV1ProductProducts_universal_d_ResetAllVariantDataRequest = ResetAllVariantDataRequest;\n type storesCatalogV1ProductProducts_universal_d_ResetAllVariantDataResponse = ResetAllVariantDataResponse;\n type storesCatalogV1ProductProducts_universal_d_AddProductsToCollectionRequest = AddProductsToCollectionRequest;\n type storesCatalogV1ProductProducts_universal_d_AddProductsToCollectionResponse = AddProductsToCollectionResponse;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductsFromCollectionRequest = RemoveProductsFromCollectionRequest;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductsFromCollectionResponse = RemoveProductsFromCollectionResponse;\n type storesCatalogV1ProductProducts_universal_d_AddProductMediaRequest = AddProductMediaRequest;\n type storesCatalogV1ProductProducts_universal_d_MediaDataForWrite = MediaDataForWrite;\n type storesCatalogV1ProductProducts_universal_d_MediaDataForWriteMediaSourceOneOf = MediaDataForWriteMediaSourceOneOf;\n type storesCatalogV1ProductProducts_universal_d_OptionAndChoice = OptionAndChoice;\n type storesCatalogV1ProductProducts_universal_d_AddProductMediaResponse = AddProductMediaResponse;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductMediaRequest = RemoveProductMediaRequest;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductMediaResponse = RemoveProductMediaResponse;\n type storesCatalogV1ProductProducts_universal_d_AddProductMediaToChoicesRequest = AddProductMediaToChoicesRequest;\n type storesCatalogV1ProductProducts_universal_d_MediaAssignmentToChoice = MediaAssignmentToChoice;\n type storesCatalogV1ProductProducts_universal_d_AddProductMediaToChoicesResponse = AddProductMediaToChoicesResponse;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductMediaFromChoicesRequest = RemoveProductMediaFromChoicesRequest;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductMediaFromChoicesResponse = RemoveProductMediaFromChoicesResponse;\n type storesCatalogV1ProductProducts_universal_d_DeleteProductOptionsRequest = DeleteProductOptionsRequest;\n type storesCatalogV1ProductProducts_universal_d_DeleteProductOptionsResponse = DeleteProductOptionsResponse;\n type storesCatalogV1ProductProducts_universal_d_SetCustomFieldsRequest = SetCustomFieldsRequest;\n type storesCatalogV1ProductProducts_universal_d_SetCustomFieldsResponse = SetCustomFieldsResponse;\n type storesCatalogV1ProductProducts_universal_d_RemoveCustomFieldsRequest = RemoveCustomFieldsRequest;\n type storesCatalogV1ProductProducts_universal_d_RemoveCustomFieldsResponse = RemoveCustomFieldsResponse;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductBrandRequest = RemoveProductBrandRequest;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductBrandResponse = RemoveProductBrandResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkSetCustomFieldsRequest = BulkSetCustomFieldsRequest;\n type storesCatalogV1ProductProducts_universal_d_BulkSetCustomFieldsResponse = BulkSetCustomFieldsResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkRemoveCustomFieldsRequest = BulkRemoveCustomFieldsRequest;\n type storesCatalogV1ProductProducts_universal_d_BulkRemoveCustomFieldsResponse = BulkRemoveCustomFieldsResponse;\n type storesCatalogV1ProductProducts_universal_d_CreateCollectionRequest = CreateCollectionRequest;\n type storesCatalogV1ProductProducts_universal_d_Collection = Collection;\n type storesCatalogV1ProductProducts_universal_d_CreateCollectionResponse = CreateCollectionResponse;\n type storesCatalogV1ProductProducts_universal_d_UpdateCollectionRequest = UpdateCollectionRequest;\n type storesCatalogV1ProductProducts_universal_d_UpdateCollectionResponse = UpdateCollectionResponse;\n type storesCatalogV1ProductProducts_universal_d_DeleteCollectionRequest = DeleteCollectionRequest;\n type storesCatalogV1ProductProducts_universal_d_DeleteCollectionResponse = DeleteCollectionResponse;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductRibbonRequest = RemoveProductRibbonRequest;\n type storesCatalogV1ProductProducts_universal_d_RemoveProductRibbonResponse = RemoveProductRibbonResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsRequest = BulkUpdateProductsRequest;\n type storesCatalogV1ProductProducts_universal_d_SetValue = SetValue;\n type storesCatalogV1ProductProducts_universal_d_SetValueValueOneOf = SetValueValueOneOf;\n type storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsResponse = BulkUpdateProductsResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkProductResult = BulkProductResult;\n type storesCatalogV1ProductProducts_universal_d_ItemMetadata = ItemMetadata;\n type storesCatalogV1ProductProducts_universal_d_ApplicationError = ApplicationError;\n type storesCatalogV1ProductProducts_universal_d_BulkActionMetadata = BulkActionMetadata;\n type storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsByFilterSyncRequest = BulkUpdateProductsByFilterSyncRequest;\n type storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsByFilterSyncResponse = BulkUpdateProductsByFilterSyncResponse;\n type storesCatalogV1ProductProducts_universal_d_AllowedProductsCountLimitExceededErrorData = AllowedProductsCountLimitExceededErrorData;\n type storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesRequest = BulkAdjustProductPropertiesRequest;\n type storesCatalogV1ProductProducts_universal_d_AdjustValue = AdjustValue;\n type storesCatalogV1ProductProducts_universal_d_AdjustValueValueOneOf = AdjustValueValueOneOf;\n type storesCatalogV1ProductProducts_universal_d_PropertyAdjustmentData = PropertyAdjustmentData;\n type storesCatalogV1ProductProducts_universal_d_PropertyAdjustmentDataByOneOf = PropertyAdjustmentDataByOneOf;\n type storesCatalogV1ProductProducts_universal_d_PercentageData = PercentageData;\n type storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesResponse = BulkAdjustProductPropertiesResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesByFilterSyncRequest = BulkAdjustProductPropertiesByFilterSyncRequest;\n type storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesByFilterSyncResponse = BulkAdjustProductPropertiesByFilterSyncResponse;\n type storesCatalogV1ProductProducts_universal_d_ReCloneStoreRequest = ReCloneStoreRequest;\n type storesCatalogV1ProductProducts_universal_d_ReCloneStoreResponse = ReCloneStoreResponse;\n type storesCatalogV1ProductProducts_universal_d_V1CreateProductPlatformizedRequest = V1CreateProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_V1CreateProductPlatformizedResponse = V1CreateProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_V1UpdateProductPlatformizedRequest = V1UpdateProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_V1UpdateProductPlatformizedResponse = V1UpdateProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_V1DeleteProductPlatformizedRequest = V1DeleteProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_V1DeleteProductPlatformizedResponse = V1DeleteProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_ProductCreated = ProductCreated;\n type storesCatalogV1ProductProducts_universal_d_Version = Version;\n const storesCatalogV1ProductProducts_universal_d_Version: typeof Version;\n type storesCatalogV1ProductProducts_universal_d_ProductChanged = ProductChanged;\n type storesCatalogV1ProductProducts_universal_d_ProductDeleted = ProductDeleted;\n type storesCatalogV1ProductProducts_universal_d_CollectionCreated = CollectionCreated;\n type storesCatalogV1ProductProducts_universal_d_CollectionChanged = CollectionChanged;\n type storesCatalogV1ProductProducts_universal_d_CollectionDeleted = CollectionDeleted;\n type storesCatalogV1ProductProducts_universal_d_VariantsChanged = VariantsChanged;\n type storesCatalogV1ProductProducts_universal_d_VariantChanged = VariantChanged;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsRequest = QueryProductsRequest;\n type storesCatalogV1ProductProducts_universal_d_Query = Query;\n type storesCatalogV1ProductProducts_universal_d_Paging = Paging;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsResponse = QueryProductsResponse;\n type storesCatalogV1ProductProducts_universal_d_PagingMetadata = PagingMetadata;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsPlatformizedRequest = QueryProductsPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_PlatformQuery = PlatformQuery;\n type storesCatalogV1ProductProducts_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type storesCatalogV1ProductProducts_universal_d_Sorting = Sorting;\n type storesCatalogV1ProductProducts_universal_d_SortOrder = SortOrder;\n const storesCatalogV1ProductProducts_universal_d_SortOrder: typeof SortOrder;\n type storesCatalogV1ProductProducts_universal_d_PlatformPaging = PlatformPaging;\n type storesCatalogV1ProductProducts_universal_d_CursorPaging = CursorPaging;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsPlatformizedResponse = QueryProductsPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_PlatformPagingMetadata = PlatformPagingMetadata;\n type storesCatalogV1ProductProducts_universal_d_Cursors = Cursors;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsWithBigPageLimitRequest = QueryProductsWithBigPageLimitRequest;\n type storesCatalogV1ProductProducts_universal_d_QueryWithBigPageLimit = QueryWithBigPageLimit;\n type storesCatalogV1ProductProducts_universal_d_PagingWithBigLimit = PagingWithBigLimit;\n type storesCatalogV1ProductProducts_universal_d_GetProductsRequest = GetProductsRequest;\n type storesCatalogV1ProductProducts_universal_d_GetProductsResponse = GetProductsResponse;\n type storesCatalogV1ProductProducts_universal_d_GetProductRequest = GetProductRequest;\n type storesCatalogV1ProductProducts_universal_d_GetProductResponse = GetProductResponse;\n type storesCatalogV1ProductProducts_universal_d_GetProductPlatformizedRequest = GetProductPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_GetProductPlatformizedResponse = GetProductPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_QueryCollectionsRequest = QueryCollectionsRequest;\n type storesCatalogV1ProductProducts_universal_d_QueryCollectionsResponse = QueryCollectionsResponse;\n type storesCatalogV1ProductProducts_universal_d_QueryCollectionsPlatformizedRequest = QueryCollectionsPlatformizedRequest;\n type storesCatalogV1ProductProducts_universal_d_QueryCollectionsPlatformizedResponse = QueryCollectionsPlatformizedResponse;\n type storesCatalogV1ProductProducts_universal_d_GetCollectionRequest = GetCollectionRequest;\n type storesCatalogV1ProductProducts_universal_d_GetCollectionResponse = GetCollectionResponse;\n type storesCatalogV1ProductProducts_universal_d_GetCollectionBySlugRequest = GetCollectionBySlugRequest;\n type storesCatalogV1ProductProducts_universal_d_GetCollectionBySlugResponse = GetCollectionBySlugResponse;\n type storesCatalogV1ProductProducts_universal_d_ProductOptionsAvailabilityRequest = ProductOptionsAvailabilityRequest;\n type storesCatalogV1ProductProducts_universal_d_ProductOptionsAvailabilityResponse = ProductOptionsAvailabilityResponse;\n type storesCatalogV1ProductProducts_universal_d_VariantData = VariantData;\n type storesCatalogV1ProductProducts_universal_d_QueryProductVariantsRequest = QueryProductVariantsRequest;\n type storesCatalogV1ProductProducts_universal_d_QueryProductVariantsResponse = QueryProductVariantsResponse;\n type storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsRequest = QueryStoreVariantsRequest;\n type storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsResponse = QueryStoreVariantsResponse;\n type storesCatalogV1ProductProducts_universal_d_StoreVariant = StoreVariant;\n type storesCatalogV1ProductProducts_universal_d_PlatformMedia = PlatformMedia;\n type storesCatalogV1ProductProducts_universal_d_PlatformMediaMediaOneOf = PlatformMediaMediaOneOf;\n type storesCatalogV1ProductProducts_universal_d_FocalPoint = FocalPoint;\n type storesCatalogV1ProductProducts_universal_d_VideoResolution = VideoResolution;\n type storesCatalogV1ProductProducts_universal_d_PreorderInfo = PreorderInfo;\n type storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsWithBigLimitRequest = QueryStoreVariantsWithBigLimitRequest;\n type storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformQuery = UnlimitedPlatformQuery;\n type storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformQueryPagingMethodOneOf = UnlimitedPlatformQueryPagingMethodOneOf;\n type storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformPaging = UnlimitedPlatformPaging;\n type storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformCursorPaging = UnlimitedPlatformCursorPaging;\n type storesCatalogV1ProductProducts_universal_d_GetStoreVariantRequest = GetStoreVariantRequest;\n type storesCatalogV1ProductProducts_universal_d_GetStoreVariantResponse = GetStoreVariantResponse;\n type storesCatalogV1ProductProducts_universal_d_QueryCustomFieldsRequest = QueryCustomFieldsRequest;\n type storesCatalogV1ProductProducts_universal_d_QueryCustomFieldsResponse = QueryCustomFieldsResponse;\n type storesCatalogV1ProductProducts_universal_d_BulkQueryCustomFieldsRequest = BulkQueryCustomFieldsRequest;\n type storesCatalogV1ProductProducts_universal_d_BulkQueryCustomFieldsResponse = BulkQueryCustomFieldsResponse;\n type storesCatalogV1ProductProducts_universal_d_CustomFieldsContainer = CustomFieldsContainer;\n type storesCatalogV1ProductProducts_universal_d_AggregateProductsRequest = AggregateProductsRequest;\n type storesCatalogV1ProductProducts_universal_d_AggregateProductsResponse = AggregateProductsResponse;\n type storesCatalogV1ProductProducts_universal_d_MessageEnvelope = MessageEnvelope;\n type storesCatalogV1ProductProducts_universal_d_IdentificationData = IdentificationData;\n type storesCatalogV1ProductProducts_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type storesCatalogV1ProductProducts_universal_d_WebhookIdentityType = WebhookIdentityType;\n const storesCatalogV1ProductProducts_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const storesCatalogV1ProductProducts_universal_d_createProduct: typeof createProduct;\n type storesCatalogV1ProductProducts_universal_d_CreateDigitalProductOptions = CreateDigitalProductOptions;\n const storesCatalogV1ProductProducts_universal_d_updateProduct: typeof updateProduct;\n type storesCatalogV1ProductProducts_universal_d_UpdateProduct = UpdateProduct;\n type storesCatalogV1ProductProducts_universal_d_UpdateProductPlatformizedProduct = UpdateProductPlatformizedProduct;\n const storesCatalogV1ProductProducts_universal_d_deleteProduct: typeof deleteProduct;\n const storesCatalogV1ProductProducts_universal_d_updateProductVariants: typeof updateProductVariants;\n const storesCatalogV1ProductProducts_universal_d_resetAllProductVariantData: typeof resetAllProductVariantData;\n const storesCatalogV1ProductProducts_universal_d_addProductsToCollection: typeof addProductsToCollection;\n const storesCatalogV1ProductProducts_universal_d_removeProductsFromCollection: typeof removeProductsFromCollection;\n const storesCatalogV1ProductProducts_universal_d_addProductMedia: typeof addProductMedia;\n const storesCatalogV1ProductProducts_universal_d_removeProductMedia: typeof removeProductMedia;\n const storesCatalogV1ProductProducts_universal_d_addProductMediaToChoices: typeof addProductMediaToChoices;\n const storesCatalogV1ProductProducts_universal_d_removeProductMediaFromChoices: typeof removeProductMediaFromChoices;\n const storesCatalogV1ProductProducts_universal_d_deleteProductOptions: typeof deleteProductOptions;\n type storesCatalogV1ProductProducts_universal_d_SetCustomFieldsOptions = SetCustomFieldsOptions;\n type storesCatalogV1ProductProducts_universal_d_RemoveCustomFieldsOptions = RemoveCustomFieldsOptions;\n const storesCatalogV1ProductProducts_universal_d_removeBrand: typeof removeBrand;\n type storesCatalogV1ProductProducts_universal_d_BulkSetCustomFieldsOptions = BulkSetCustomFieldsOptions;\n type storesCatalogV1ProductProducts_universal_d_BulkRemoveCustomFieldsOptions = BulkRemoveCustomFieldsOptions;\n const storesCatalogV1ProductProducts_universal_d_createCollection: typeof createCollection;\n const storesCatalogV1ProductProducts_universal_d_updateCollection: typeof updateCollection;\n type storesCatalogV1ProductProducts_universal_d_UpdateCollection = UpdateCollection;\n const storesCatalogV1ProductProducts_universal_d_deleteCollection: typeof deleteCollection;\n const storesCatalogV1ProductProducts_universal_d_removeRibbon: typeof removeRibbon;\n const storesCatalogV1ProductProducts_universal_d_bulkUpdateProductsProperty: typeof bulkUpdateProductsProperty;\n type storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsByFilterSyncOptions = BulkUpdateProductsByFilterSyncOptions;\n const storesCatalogV1ProductProducts_universal_d_bulkAdjustProductProperty: typeof bulkAdjustProductProperty;\n type storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesByFilterSyncOptions = BulkAdjustProductPropertiesByFilterSyncOptions;\n type storesCatalogV1ProductProducts_universal_d_ReCloneStoreOptions = ReCloneStoreOptions;\n type storesCatalogV1ProductProducts_universal_d_WriteProxyUpdateProductPlatformizedProduct = WriteProxyUpdateProductPlatformizedProduct;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsNonPlatformizedOptions = QueryProductsNonPlatformizedOptions;\n const storesCatalogV1ProductProducts_universal_d_queryProducts: typeof queryProducts;\n type storesCatalogV1ProductProducts_universal_d_ProductsQueryResult = ProductsQueryResult;\n type storesCatalogV1ProductProducts_universal_d_ProductsQueryBuilder = ProductsQueryBuilder;\n type storesCatalogV1ProductProducts_universal_d_QueryProductsWithBigPageLimitOptions = QueryProductsWithBigPageLimitOptions;\n const storesCatalogV1ProductProducts_universal_d_getProduct: typeof getProduct;\n type storesCatalogV1ProductProducts_universal_d_GetProductOptions = GetProductOptions;\n type storesCatalogV1ProductProducts_universal_d_GetProductPlatformizedOptions = GetProductPlatformizedOptions;\n type storesCatalogV1ProductProducts_universal_d_QueryCollectionsOptions = QueryCollectionsOptions;\n type storesCatalogV1ProductProducts_universal_d_GetCollectionOptions = GetCollectionOptions;\n const storesCatalogV1ProductProducts_universal_d_getCollectionBySlug: typeof getCollectionBySlug;\n const storesCatalogV1ProductProducts_universal_d_getProductOptionsAvailability: typeof getProductOptionsAvailability;\n const storesCatalogV1ProductProducts_universal_d_queryProductVariants: typeof queryProductVariants;\n type storesCatalogV1ProductProducts_universal_d_QueryProductVariantsOptions = QueryProductVariantsOptions;\n const storesCatalogV1ProductProducts_universal_d_queryStoreVariants: typeof queryStoreVariants;\n type storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsOptions = QueryStoreVariantsOptions;\n type storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsWithBigLimitOptions = QueryStoreVariantsWithBigLimitOptions;\n const storesCatalogV1ProductProducts_universal_d_getStoreVariant: typeof getStoreVariant;\n type storesCatalogV1ProductProducts_universal_d_AggregateProductsOptions = AggregateProductsOptions;\n namespace storesCatalogV1ProductProducts_universal_d {\n export { storesCatalogV1ProductProducts_universal_d_Product as Product, storesCatalogV1ProductProducts_universal_d_ProductType as ProductType, storesCatalogV1ProductProducts_universal_d_NumericPropertyRange as NumericPropertyRange, storesCatalogV1ProductProducts_universal_d_Stock as Stock, storesCatalogV1ProductProducts_universal_d_InventoryStatus as InventoryStatus, storesCatalogV1ProductProducts_universal_d_PriceData as PriceData, storesCatalogV1ProductProducts_universal_d_FormattedPrice as FormattedPrice, storesCatalogV1ProductProducts_universal_d_CostAndProfitData as CostAndProfitData, storesCatalogV1ProductProducts_universal_d_PricePerUnitData as PricePerUnitData, storesCatalogV1ProductProducts_universal_d_MeasurementUnit as MeasurementUnit, storesCatalogV1ProductProducts_universal_d_AdditionalInfoSection as AdditionalInfoSection, storesCatalogV1ProductProducts_universal_d_Ribbon as Ribbon, storesCatalogV1ProductProducts_universal_d_Media as Media, storesCatalogV1ProductProducts_universal_d_MediaItem as MediaItem, storesCatalogV1ProductProducts_universal_d_MediaItemItemOneOf as MediaItemItemOneOf, storesCatalogV1ProductProducts_universal_d_MediaItemUrlAndSize as MediaItemUrlAndSize, storesCatalogV1ProductProducts_universal_d_MediaItemType as MediaItemType, storesCatalogV1ProductProducts_universal_d_MediaItemVideo as MediaItemVideo, storesCatalogV1ProductProducts_universal_d_CustomTextField as CustomTextField, storesCatalogV1ProductProducts_universal_d_ProductOption as ProductOption, storesCatalogV1ProductProducts_universal_d_OptionType as OptionType, storesCatalogV1ProductProducts_universal_d_Choice as Choice, storesCatalogV1ProductProducts_universal_d_PageUrl as PageUrl, storesCatalogV1ProductProducts_universal_d_Discount as Discount, storesCatalogV1ProductProducts_universal_d_DiscountType as DiscountType, storesCatalogV1ProductProducts_universal_d_Variant as Variant, storesCatalogV1ProductProducts_universal_d_VariantDataWithNoStock as VariantDataWithNoStock, storesCatalogV1ProductProducts_universal_d_VariantStock as VariantStock, storesCatalogV1ProductProducts_universal_d_SeoSchema as SeoSchema, storesCatalogV1ProductProducts_universal_d_Keyword as Keyword, storesCatalogV1ProductProducts_universal_d_Tag as Tag, storesCatalogV1ProductProducts_universal_d_Settings as Settings, storesCatalogV1ProductProducts_universal_d_SecuredMedia as SecuredMedia, storesCatalogV1ProductProducts_universal_d_FileType as FileType, storesCatalogV1ProductProducts_universal_d_CreateProductRequest as CreateProductRequest, storesCatalogV1ProductProducts_universal_d_CreateProductResponse as CreateProductResponse, storesCatalogV1ProductProducts_universal_d_CreateProductPlatformizedRequest as CreateProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_CreateProductPlatformizedResponse as CreateProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_CreateDigitalProductRequest as CreateDigitalProductRequest, storesCatalogV1ProductProducts_universal_d_CreateDigitalProductResponse as CreateDigitalProductResponse, storesCatalogV1ProductProducts_universal_d_UpdateProductRequest as UpdateProductRequest, storesCatalogV1ProductProducts_universal_d_UpdateProductResponse as UpdateProductResponse, storesCatalogV1ProductProducts_universal_d_UpdateProductPlatformizedRequest as UpdateProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_UpdateProductPlatformizedResponse as UpdateProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_DeleteProductRequest as DeleteProductRequest, storesCatalogV1ProductProducts_universal_d_DeleteProductResponse as DeleteProductResponse, storesCatalogV1ProductProducts_universal_d_DeleteProductPlatformizedRequest as DeleteProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_DeleteProductPlatformizedResponse as DeleteProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_BulkDeleteProductsRequest as BulkDeleteProductsRequest, storesCatalogV1ProductProducts_universal_d_BulkDeleteProductsResponse as BulkDeleteProductsResponse, storesCatalogV1ProductProducts_universal_d_UpdateVariantsRequest as UpdateVariantsRequest, storesCatalogV1ProductProducts_universal_d_VariantOverride as VariantOverride, storesCatalogV1ProductProducts_universal_d_UpdateVariantsResponse as UpdateVariantsResponse, storesCatalogV1ProductProducts_universal_d_ResetAllVariantDataRequest as ResetAllVariantDataRequest, storesCatalogV1ProductProducts_universal_d_ResetAllVariantDataResponse as ResetAllVariantDataResponse, storesCatalogV1ProductProducts_universal_d_AddProductsToCollectionRequest as AddProductsToCollectionRequest, storesCatalogV1ProductProducts_universal_d_AddProductsToCollectionResponse as AddProductsToCollectionResponse, storesCatalogV1ProductProducts_universal_d_RemoveProductsFromCollectionRequest as RemoveProductsFromCollectionRequest, storesCatalogV1ProductProducts_universal_d_RemoveProductsFromCollectionResponse as RemoveProductsFromCollectionResponse, storesCatalogV1ProductProducts_universal_d_AddProductMediaRequest as AddProductMediaRequest, storesCatalogV1ProductProducts_universal_d_MediaDataForWrite as MediaDataForWrite, storesCatalogV1ProductProducts_universal_d_MediaDataForWriteMediaSourceOneOf as MediaDataForWriteMediaSourceOneOf, storesCatalogV1ProductProducts_universal_d_OptionAndChoice as OptionAndChoice, storesCatalogV1ProductProducts_universal_d_AddProductMediaResponse as AddProductMediaResponse, storesCatalogV1ProductProducts_universal_d_RemoveProductMediaRequest as RemoveProductMediaRequest, storesCatalogV1ProductProducts_universal_d_RemoveProductMediaResponse as RemoveProductMediaResponse, storesCatalogV1ProductProducts_universal_d_AddProductMediaToChoicesRequest as AddProductMediaToChoicesRequest, storesCatalogV1ProductProducts_universal_d_MediaAssignmentToChoice as MediaAssignmentToChoice, storesCatalogV1ProductProducts_universal_d_AddProductMediaToChoicesResponse as AddProductMediaToChoicesResponse, storesCatalogV1ProductProducts_universal_d_RemoveProductMediaFromChoicesRequest as RemoveProductMediaFromChoicesRequest, storesCatalogV1ProductProducts_universal_d_RemoveProductMediaFromChoicesResponse as RemoveProductMediaFromChoicesResponse, storesCatalogV1ProductProducts_universal_d_DeleteProductOptionsRequest as DeleteProductOptionsRequest, storesCatalogV1ProductProducts_universal_d_DeleteProductOptionsResponse as DeleteProductOptionsResponse, storesCatalogV1ProductProducts_universal_d_SetCustomFieldsRequest as SetCustomFieldsRequest, storesCatalogV1ProductProducts_universal_d_SetCustomFieldsResponse as SetCustomFieldsResponse, storesCatalogV1ProductProducts_universal_d_RemoveCustomFieldsRequest as RemoveCustomFieldsRequest, storesCatalogV1ProductProducts_universal_d_RemoveCustomFieldsResponse as RemoveCustomFieldsResponse, storesCatalogV1ProductProducts_universal_d_RemoveProductBrandRequest as RemoveProductBrandRequest, storesCatalogV1ProductProducts_universal_d_RemoveProductBrandResponse as RemoveProductBrandResponse, storesCatalogV1ProductProducts_universal_d_BulkSetCustomFieldsRequest as BulkSetCustomFieldsRequest, storesCatalogV1ProductProducts_universal_d_BulkSetCustomFieldsResponse as BulkSetCustomFieldsResponse, storesCatalogV1ProductProducts_universal_d_BulkRemoveCustomFieldsRequest as BulkRemoveCustomFieldsRequest, storesCatalogV1ProductProducts_universal_d_BulkRemoveCustomFieldsResponse as BulkRemoveCustomFieldsResponse, storesCatalogV1ProductProducts_universal_d_CreateCollectionRequest as CreateCollectionRequest, storesCatalogV1ProductProducts_universal_d_Collection as Collection, storesCatalogV1ProductProducts_universal_d_CreateCollectionResponse as CreateCollectionResponse, storesCatalogV1ProductProducts_universal_d_UpdateCollectionRequest as UpdateCollectionRequest, storesCatalogV1ProductProducts_universal_d_UpdateCollectionResponse as UpdateCollectionResponse, storesCatalogV1ProductProducts_universal_d_DeleteCollectionRequest as DeleteCollectionRequest, storesCatalogV1ProductProducts_universal_d_DeleteCollectionResponse as DeleteCollectionResponse, storesCatalogV1ProductProducts_universal_d_RemoveProductRibbonRequest as RemoveProductRibbonRequest, storesCatalogV1ProductProducts_universal_d_RemoveProductRibbonResponse as RemoveProductRibbonResponse, storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsRequest as BulkUpdateProductsRequest, storesCatalogV1ProductProducts_universal_d_SetValue as SetValue, storesCatalogV1ProductProducts_universal_d_SetValueValueOneOf as SetValueValueOneOf, storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsResponse as BulkUpdateProductsResponse, storesCatalogV1ProductProducts_universal_d_BulkProductResult as BulkProductResult, storesCatalogV1ProductProducts_universal_d_ItemMetadata as ItemMetadata, storesCatalogV1ProductProducts_universal_d_ApplicationError as ApplicationError, storesCatalogV1ProductProducts_universal_d_BulkActionMetadata as BulkActionMetadata, storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsByFilterSyncRequest as BulkUpdateProductsByFilterSyncRequest, storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsByFilterSyncResponse as BulkUpdateProductsByFilterSyncResponse, storesCatalogV1ProductProducts_universal_d_AllowedProductsCountLimitExceededErrorData as AllowedProductsCountLimitExceededErrorData, storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesRequest as BulkAdjustProductPropertiesRequest, storesCatalogV1ProductProducts_universal_d_AdjustValue as AdjustValue, storesCatalogV1ProductProducts_universal_d_AdjustValueValueOneOf as AdjustValueValueOneOf, storesCatalogV1ProductProducts_universal_d_PropertyAdjustmentData as PropertyAdjustmentData, storesCatalogV1ProductProducts_universal_d_PropertyAdjustmentDataByOneOf as PropertyAdjustmentDataByOneOf, storesCatalogV1ProductProducts_universal_d_PercentageData as PercentageData, storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesResponse as BulkAdjustProductPropertiesResponse, storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesByFilterSyncRequest as BulkAdjustProductPropertiesByFilterSyncRequest, storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesByFilterSyncResponse as BulkAdjustProductPropertiesByFilterSyncResponse, storesCatalogV1ProductProducts_universal_d_ReCloneStoreRequest as ReCloneStoreRequest, storesCatalogV1ProductProducts_universal_d_ReCloneStoreResponse as ReCloneStoreResponse, storesCatalogV1ProductProducts_universal_d_V1CreateProductPlatformizedRequest as V1CreateProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_V1CreateProductPlatformizedResponse as V1CreateProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_V1UpdateProductPlatformizedRequest as V1UpdateProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_V1UpdateProductPlatformizedResponse as V1UpdateProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_V1DeleteProductPlatformizedRequest as V1DeleteProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_V1DeleteProductPlatformizedResponse as V1DeleteProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_ProductCreated as ProductCreated, storesCatalogV1ProductProducts_universal_d_Version as Version, storesCatalogV1ProductProducts_universal_d_ProductChanged as ProductChanged, storesCatalogV1ProductProducts_universal_d_ProductDeleted as ProductDeleted, storesCatalogV1ProductProducts_universal_d_CollectionCreated as CollectionCreated, storesCatalogV1ProductProducts_universal_d_CollectionChanged as CollectionChanged, storesCatalogV1ProductProducts_universal_d_CollectionDeleted as CollectionDeleted, storesCatalogV1ProductProducts_universal_d_VariantsChanged as VariantsChanged, storesCatalogV1ProductProducts_universal_d_VariantChanged as VariantChanged, storesCatalogV1ProductProducts_universal_d_QueryProductsRequest as QueryProductsRequest, storesCatalogV1ProductProducts_universal_d_Query as Query, storesCatalogV1ProductProducts_universal_d_Paging as Paging, storesCatalogV1ProductProducts_universal_d_QueryProductsResponse as QueryProductsResponse, storesCatalogV1ProductProducts_universal_d_PagingMetadata as PagingMetadata, storesCatalogV1ProductProducts_universal_d_QueryProductsPlatformizedRequest as QueryProductsPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_PlatformQuery as PlatformQuery, storesCatalogV1ProductProducts_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf, storesCatalogV1ProductProducts_universal_d_Sorting as Sorting, storesCatalogV1ProductProducts_universal_d_SortOrder as SortOrder, storesCatalogV1ProductProducts_universal_d_PlatformPaging as PlatformPaging, storesCatalogV1ProductProducts_universal_d_CursorPaging as CursorPaging, storesCatalogV1ProductProducts_universal_d_QueryProductsPlatformizedResponse as QueryProductsPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_PlatformPagingMetadata as PlatformPagingMetadata, storesCatalogV1ProductProducts_universal_d_Cursors as Cursors, storesCatalogV1ProductProducts_universal_d_QueryProductsWithBigPageLimitRequest as QueryProductsWithBigPageLimitRequest, storesCatalogV1ProductProducts_universal_d_QueryWithBigPageLimit as QueryWithBigPageLimit, storesCatalogV1ProductProducts_universal_d_PagingWithBigLimit as PagingWithBigLimit, storesCatalogV1ProductProducts_universal_d_GetProductsRequest as GetProductsRequest, storesCatalogV1ProductProducts_universal_d_GetProductsResponse as GetProductsResponse, storesCatalogV1ProductProducts_universal_d_GetProductRequest as GetProductRequest, storesCatalogV1ProductProducts_universal_d_GetProductResponse as GetProductResponse, storesCatalogV1ProductProducts_universal_d_GetProductPlatformizedRequest as GetProductPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_GetProductPlatformizedResponse as GetProductPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_QueryCollectionsRequest as QueryCollectionsRequest, storesCatalogV1ProductProducts_universal_d_QueryCollectionsResponse as QueryCollectionsResponse, storesCatalogV1ProductProducts_universal_d_QueryCollectionsPlatformizedRequest as QueryCollectionsPlatformizedRequest, storesCatalogV1ProductProducts_universal_d_QueryCollectionsPlatformizedResponse as QueryCollectionsPlatformizedResponse, storesCatalogV1ProductProducts_universal_d_GetCollectionRequest as GetCollectionRequest, storesCatalogV1ProductProducts_universal_d_GetCollectionResponse as GetCollectionResponse, storesCatalogV1ProductProducts_universal_d_GetCollectionBySlugRequest as GetCollectionBySlugRequest, storesCatalogV1ProductProducts_universal_d_GetCollectionBySlugResponse as GetCollectionBySlugResponse, storesCatalogV1ProductProducts_universal_d_ProductOptionsAvailabilityRequest as ProductOptionsAvailabilityRequest, storesCatalogV1ProductProducts_universal_d_ProductOptionsAvailabilityResponse as ProductOptionsAvailabilityResponse, storesCatalogV1ProductProducts_universal_d_VariantData as VariantData, storesCatalogV1ProductProducts_universal_d_QueryProductVariantsRequest as QueryProductVariantsRequest, storesCatalogV1ProductProducts_universal_d_QueryProductVariantsResponse as QueryProductVariantsResponse, storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsRequest as QueryStoreVariantsRequest, storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsResponse as QueryStoreVariantsResponse, storesCatalogV1ProductProducts_universal_d_StoreVariant as StoreVariant, storesCatalogV1ProductProducts_universal_d_PlatformMedia as PlatformMedia, storesCatalogV1ProductProducts_universal_d_PlatformMediaMediaOneOf as PlatformMediaMediaOneOf, storesCatalogV1ProductProducts_universal_d_FocalPoint as FocalPoint, storesCatalogV1ProductProducts_universal_d_VideoResolution as VideoResolution, storesCatalogV1ProductProducts_universal_d_PreorderInfo as PreorderInfo, storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsWithBigLimitRequest as QueryStoreVariantsWithBigLimitRequest, storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformQuery as UnlimitedPlatformQuery, storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformQueryPagingMethodOneOf as UnlimitedPlatformQueryPagingMethodOneOf, storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformPaging as UnlimitedPlatformPaging, storesCatalogV1ProductProducts_universal_d_UnlimitedPlatformCursorPaging as UnlimitedPlatformCursorPaging, storesCatalogV1ProductProducts_universal_d_GetStoreVariantRequest as GetStoreVariantRequest, storesCatalogV1ProductProducts_universal_d_GetStoreVariantResponse as GetStoreVariantResponse, storesCatalogV1ProductProducts_universal_d_QueryCustomFieldsRequest as QueryCustomFieldsRequest, storesCatalogV1ProductProducts_universal_d_QueryCustomFieldsResponse as QueryCustomFieldsResponse, storesCatalogV1ProductProducts_universal_d_BulkQueryCustomFieldsRequest as BulkQueryCustomFieldsRequest, storesCatalogV1ProductProducts_universal_d_BulkQueryCustomFieldsResponse as BulkQueryCustomFieldsResponse, storesCatalogV1ProductProducts_universal_d_CustomFieldsContainer as CustomFieldsContainer, storesCatalogV1ProductProducts_universal_d_AggregateProductsRequest as AggregateProductsRequest, storesCatalogV1ProductProducts_universal_d_AggregateProductsResponse as AggregateProductsResponse, storesCatalogV1ProductProducts_universal_d_MessageEnvelope as MessageEnvelope, storesCatalogV1ProductProducts_universal_d_IdentificationData as IdentificationData, storesCatalogV1ProductProducts_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, storesCatalogV1ProductProducts_universal_d_WebhookIdentityType as WebhookIdentityType, storesCatalogV1ProductProducts_universal_d_createProduct as createProduct, storesCatalogV1ProductProducts_universal_d_CreateDigitalProductOptions as CreateDigitalProductOptions, storesCatalogV1ProductProducts_universal_d_updateProduct as updateProduct, storesCatalogV1ProductProducts_universal_d_UpdateProduct as UpdateProduct, storesCatalogV1ProductProducts_universal_d_UpdateProductPlatformizedProduct as UpdateProductPlatformizedProduct, storesCatalogV1ProductProducts_universal_d_deleteProduct as deleteProduct, storesCatalogV1ProductProducts_universal_d_updateProductVariants as updateProductVariants, storesCatalogV1ProductProducts_universal_d_resetAllProductVariantData as resetAllProductVariantData, storesCatalogV1ProductProducts_universal_d_addProductsToCollection as addProductsToCollection, storesCatalogV1ProductProducts_universal_d_removeProductsFromCollection as removeProductsFromCollection, storesCatalogV1ProductProducts_universal_d_addProductMedia as addProductMedia, storesCatalogV1ProductProducts_universal_d_removeProductMedia as removeProductMedia, storesCatalogV1ProductProducts_universal_d_addProductMediaToChoices as addProductMediaToChoices, storesCatalogV1ProductProducts_universal_d_removeProductMediaFromChoices as removeProductMediaFromChoices, storesCatalogV1ProductProducts_universal_d_deleteProductOptions as deleteProductOptions, storesCatalogV1ProductProducts_universal_d_SetCustomFieldsOptions as SetCustomFieldsOptions, storesCatalogV1ProductProducts_universal_d_RemoveCustomFieldsOptions as RemoveCustomFieldsOptions, storesCatalogV1ProductProducts_universal_d_removeBrand as removeBrand, storesCatalogV1ProductProducts_universal_d_BulkSetCustomFieldsOptions as BulkSetCustomFieldsOptions, storesCatalogV1ProductProducts_universal_d_BulkRemoveCustomFieldsOptions as BulkRemoveCustomFieldsOptions, storesCatalogV1ProductProducts_universal_d_createCollection as createCollection, storesCatalogV1ProductProducts_universal_d_updateCollection as updateCollection, storesCatalogV1ProductProducts_universal_d_UpdateCollection as UpdateCollection, storesCatalogV1ProductProducts_universal_d_deleteCollection as deleteCollection, storesCatalogV1ProductProducts_universal_d_removeRibbon as removeRibbon, storesCatalogV1ProductProducts_universal_d_bulkUpdateProductsProperty as bulkUpdateProductsProperty, storesCatalogV1ProductProducts_universal_d_BulkUpdateProductsByFilterSyncOptions as BulkUpdateProductsByFilterSyncOptions, storesCatalogV1ProductProducts_universal_d_bulkAdjustProductProperty as bulkAdjustProductProperty, storesCatalogV1ProductProducts_universal_d_BulkAdjustProductPropertiesByFilterSyncOptions as BulkAdjustProductPropertiesByFilterSyncOptions, storesCatalogV1ProductProducts_universal_d_ReCloneStoreOptions as ReCloneStoreOptions, storesCatalogV1ProductProducts_universal_d_WriteProxyUpdateProductPlatformizedProduct as WriteProxyUpdateProductPlatformizedProduct, storesCatalogV1ProductProducts_universal_d_QueryProductsNonPlatformizedOptions as QueryProductsNonPlatformizedOptions, storesCatalogV1ProductProducts_universal_d_queryProducts as queryProducts, storesCatalogV1ProductProducts_universal_d_ProductsQueryResult as ProductsQueryResult, storesCatalogV1ProductProducts_universal_d_ProductsQueryBuilder as ProductsQueryBuilder, storesCatalogV1ProductProducts_universal_d_QueryProductsWithBigPageLimitOptions as QueryProductsWithBigPageLimitOptions, storesCatalogV1ProductProducts_universal_d_getProduct as getProduct, storesCatalogV1ProductProducts_universal_d_GetProductOptions as GetProductOptions, storesCatalogV1ProductProducts_universal_d_GetProductPlatformizedOptions as GetProductPlatformizedOptions, storesCatalogV1ProductProducts_universal_d_QueryCollectionsOptions as QueryCollectionsOptions, storesCatalogV1ProductProducts_universal_d_GetCollectionOptions as GetCollectionOptions, storesCatalogV1ProductProducts_universal_d_getCollectionBySlug as getCollectionBySlug, storesCatalogV1ProductProducts_universal_d_getProductOptionsAvailability as getProductOptionsAvailability, storesCatalogV1ProductProducts_universal_d_queryProductVariants as queryProductVariants, storesCatalogV1ProductProducts_universal_d_QueryProductVariantsOptions as QueryProductVariantsOptions, storesCatalogV1ProductProducts_universal_d_queryStoreVariants as queryStoreVariants, storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsOptions as QueryStoreVariantsOptions, storesCatalogV1ProductProducts_universal_d_QueryStoreVariantsWithBigLimitOptions as QueryStoreVariantsWithBigLimitOptions, storesCatalogV1ProductProducts_universal_d_getStoreVariant as getStoreVariant, storesCatalogV1ProductProducts_universal_d_AggregateProductsOptions as AggregateProductsOptions, };\n }\n export { storesV2InventoryInventory_universal_d as inventory, storesCatalogV1ProductProducts_universal_d as products };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-redirects-api.v1.d.ts", "content": "declare module \"wix-redirects-api.v1\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** WixUrl is the main entity of WixUrlService that can be used for lorem ipsum dolor */\n interface WixUrl {\n /**\n * The Wix URL to redirect into\n * @readonly\n */\n fullUrl?: string;\n }\n interface CreateWixUrlRequest extends CreateWixUrlRequestUrlParamsOneOf {\n /** The callbacks (URL) allowing the definition of the pages which should be redirected back to the original site during the flow initiated in Wix */\n callbacks?: CallbackParams;\n /** The parameters used in order to generate the URL into the Bookings checkout flow */\n bookingsCheckout?: WixUrlBookingsCheckoutParams;\n /** The parameters used in order to generate the URL into the Ecom checkout flow */\n ecomCheckout?: WixUrlEcomCheckoutParams;\n /** The parameters used in order to generate the URL into the events checkout flow */\n eventsCheckout?: WixUrlEventsCheckoutParams;\n /** The parameters used in order to generate the URL into the paid plans checkout flow */\n paidPlansCheckout?: WixUrlPaidPlansCheckoutParams;\n /** The parameters used in order to generate the URL into the Wix login page */\n login?: WixUrlLoginParams;\n }\n /** @oneof */\n interface CreateWixUrlRequestUrlParamsOneOf {\n /** The parameters used in order to generate the URL into the Bookings checkout flow */\n bookingsCheckout?: WixUrlBookingsCheckoutParams;\n /** The parameters used in order to generate the URL into the Ecom checkout flow */\n ecomCheckout?: WixUrlEcomCheckoutParams;\n /** The parameters used in order to generate the URL into the events checkout flow */\n eventsCheckout?: WixUrlEventsCheckoutParams;\n /** The parameters used in order to generate the URL into the paid plans checkout flow */\n paidPlansCheckout?: WixUrlPaidPlansCheckoutParams;\n /** The parameters used in order to generate the URL into the Wix login page */\n login?: WixUrlLoginParams;\n }\n interface WixUrlBookingsCheckoutParams {\n /** The selected calendar slots to checkout */\n slot?: SlotAvailability[];\n /** The timezone used for presentation and formatting when presenting the selected slot in a human readable format */\n timezone?: string;\n /** The ID of the service used in order to select the slot */\n serviceId?: string;\n }\n interface SlotAvailability {\n /**\n * The slot for the corresponding session, when the session is either a single session\n * or a specific session generated from a recurring session.\n */\n slot?: Slot;\n /**\n * Whether the slot is bookable. Bookability is determined by checking a\n * session's open slots and booking policies. Locks are not taken into\n * account.\n */\n bookable?: boolean;\n /**\n * Total number of spots for this slot.\n * For example, if a session has a total of 10 spots and 3 spots are booked,\n * `spotsTotal` is 10 and `openSpots` is 7.\n */\n totalSpots?: number | null;\n /** Number of open spots for this slot. */\n openSpots?: number | null;\n /** An object describing the slot's waitlist and its occupancy. */\n waitingList?: WaitingList;\n /** Booking policy violations for the slot. */\n bookingPolicyViolations?: BookingPolicyViolations;\n /**\n * Indicates whether the slot is locked because a waitlist exists.\n * When a slot frees up, the slot is offered to the next customer on the waitlist. Read-only.\n */\n locked?: boolean | null;\n }\n interface Slot {\n /**\n * ID for the slot's corresponding session, when the session is either a single session\n * or a specific session generated from a recurring session.\n */\n sessionId?: string | null;\n /** Service ID. */\n serviceId?: string;\n /** Schedule ID. */\n scheduleId?: string;\n /**\n * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)\n * format.\n *\n * If `timezone` is specified,\n * dates are based on the local date/time. This means that the timezone offset\n * in the `start_date` is ignored.\n */\n startDate?: string | null;\n /**\n * The end time of this slot in\n * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.\n *\n * If `timezone` is specified,\n * dates are based on the local date/time. This means that the timezone offset\n * in the `end_date` is ignored.\n */\n endDate?: string | null;\n /**\n * The timezone for which slot availability is to be calculated.\n *\n * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)\n * when calculating availability.\n */\n timezone?: string | null;\n /**\n * The resource required for this slot. Currently, the only supported resource\n * is the relevant staff member for the slot.\n */\n resource?: SlotResource;\n /** Geographic location of the slot. */\n location?: Location;\n }\n interface SlotResource {\n /**\n * Resource ID.\n * @readonly\n */\n _id?: string | null;\n /** Resource name. Read only. */\n name?: string | null;\n }\n interface Location {\n /**\n * Business location ID. Available only for locations that are business locations,\n * meaning the `location_type` is `\"OWNER_BUSINESS\"`.\n */\n _id?: string | null;\n /** Location name. */\n name?: string | null;\n /** The full address of this location. */\n formattedAddress?: string | null;\n /**\n * Location type.\n *\n * - `\"OWNER_BUSINESS\"`: The business address, as set in the site’s general settings.\n * - `\"OWNER_CUSTOM\"`: The address as set when creating the service.\n * - `\"CUSTOM\"`: The address as set for the individual session.\n */\n locationType?: LocationType;\n }\n enum LocationType {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface WaitingList {\n /**\n * Total number of spots and open spots for this waitlist.\n * For example, a Yoga class with 10 waitlist spots and 3 registered\n * on the waitlist has 10 `total_spots` and 7 `open_spots`.\n */\n totalSpots?: number | null;\n /** Number of open spots for this waitlist. */\n openSpots?: number | null;\n }\n interface BookingPolicyViolations {\n /** Bookings policy violation. Too early to book this slot. */\n tooEarlyToBook?: boolean | null;\n /** Bookings policy violation. Too late to book this slot. */\n tooLateToBook?: boolean | null;\n /** Bookings policy violation. Online booking is disabled for this slot. */\n bookOnlineDisabled?: boolean | null;\n }\n interface WixUrlEcomCheckoutParams {\n /** The ID of the checkout entity used in order to start the checkout with */\n checkoutId?: string;\n }\n interface WixUrlEventsCheckoutParams {\n /** The ID of the selected event */\n reservationId?: string;\n /** The slug of the selected event (url friendly name) */\n eventSlug?: string;\n }\n interface WixUrlPaidPlansCheckoutParams {\n /** The ID of the selected paid plan */\n planId?: string;\n /** The encoded string representing the navigation defined for the end of the flow, probably received by */\n navigateToSectionProps?: string;\n }\n interface WixUrlLoginParams {\n }\n interface CallbackParams {\n /** An external thank you page URL, used when the thank you page is implemented outside of Wix */\n thankYouPageUrl?: string;\n /** An external thank you page URL, used when the thank you page is implemented outside of Wix */\n postFlowUrl?: string;\n /** An external thank you page URL, used when the thank you page is implemented outside of Wix */\n plansListUrl?: string;\n /** An external thank you page URL, used when the thank you page is implemented outside of Wix */\n loginUrl?: string;\n }\n interface CreateWixUrlResponse {\n /** The Wix URL details to redirect into */\n wixUrl?: WixUrl;\n }\n /**\n * Creates a new WixUrl\n * @public\n * @documentationMaturity preview\n * @requiredField CreateWixUrlRequest\n */\n function createWixUrl(options?: CreateWixUrlOptions): Promise;\n interface CreateWixUrlOptions {\n /** The parameters used in order to generate the URL into the Bookings checkout flow */\n bookingsCheckout?: WixUrlBookingsCheckoutParams;\n /** The parameters used in order to generate the URL into the Ecom checkout flow */\n ecomCheckout?: WixUrlEcomCheckoutParams;\n /** The parameters used in order to generate the URL into the events checkout flow */\n eventsCheckout?: WixUrlEventsCheckoutParams;\n /** The parameters used in order to generate the URL into the paid plans checkout flow */\n paidPlansCheckout?: WixUrlPaidPlansCheckoutParams;\n /** The parameters used in order to generate the URL into the Wix login page */\n login?: WixUrlLoginParams;\n /** The callbacks (URL) allowing the definition of the pages which should be redirected back to the original site during the flow initiated in Wix */\n callbacks?: CallbackParams;\n }\n const headlessV1WixUrl_universal_d___debug: typeof __debug;\n type headlessV1WixUrl_universal_d_WixUrl = WixUrl;\n type headlessV1WixUrl_universal_d_CreateWixUrlRequest = CreateWixUrlRequest;\n type headlessV1WixUrl_universal_d_CreateWixUrlRequestUrlParamsOneOf = CreateWixUrlRequestUrlParamsOneOf;\n type headlessV1WixUrl_universal_d_WixUrlBookingsCheckoutParams = WixUrlBookingsCheckoutParams;\n type headlessV1WixUrl_universal_d_SlotAvailability = SlotAvailability;\n type headlessV1WixUrl_universal_d_Slot = Slot;\n type headlessV1WixUrl_universal_d_SlotResource = SlotResource;\n type headlessV1WixUrl_universal_d_Location = Location;\n type headlessV1WixUrl_universal_d_LocationType = LocationType;\n const headlessV1WixUrl_universal_d_LocationType: typeof LocationType;\n type headlessV1WixUrl_universal_d_WaitingList = WaitingList;\n type headlessV1WixUrl_universal_d_BookingPolicyViolations = BookingPolicyViolations;\n type headlessV1WixUrl_universal_d_WixUrlEcomCheckoutParams = WixUrlEcomCheckoutParams;\n type headlessV1WixUrl_universal_d_WixUrlEventsCheckoutParams = WixUrlEventsCheckoutParams;\n type headlessV1WixUrl_universal_d_WixUrlPaidPlansCheckoutParams = WixUrlPaidPlansCheckoutParams;\n type headlessV1WixUrl_universal_d_WixUrlLoginParams = WixUrlLoginParams;\n type headlessV1WixUrl_universal_d_CallbackParams = CallbackParams;\n type headlessV1WixUrl_universal_d_CreateWixUrlResponse = CreateWixUrlResponse;\n const headlessV1WixUrl_universal_d_createWixUrl: typeof createWixUrl;\n type headlessV1WixUrl_universal_d_CreateWixUrlOptions = CreateWixUrlOptions;\n namespace headlessV1WixUrl_universal_d {\n export { headlessV1WixUrl_universal_d___debug as __debug, headlessV1WixUrl_universal_d_WixUrl as WixUrl, headlessV1WixUrl_universal_d_CreateWixUrlRequest as CreateWixUrlRequest, headlessV1WixUrl_universal_d_CreateWixUrlRequestUrlParamsOneOf as CreateWixUrlRequestUrlParamsOneOf, headlessV1WixUrl_universal_d_WixUrlBookingsCheckoutParams as WixUrlBookingsCheckoutParams, headlessV1WixUrl_universal_d_SlotAvailability as SlotAvailability, headlessV1WixUrl_universal_d_Slot as Slot, headlessV1WixUrl_universal_d_SlotResource as SlotResource, headlessV1WixUrl_universal_d_Location as Location, headlessV1WixUrl_universal_d_LocationType as LocationType, headlessV1WixUrl_universal_d_WaitingList as WaitingList, headlessV1WixUrl_universal_d_BookingPolicyViolations as BookingPolicyViolations, headlessV1WixUrl_universal_d_WixUrlEcomCheckoutParams as WixUrlEcomCheckoutParams, headlessV1WixUrl_universal_d_WixUrlEventsCheckoutParams as WixUrlEventsCheckoutParams, headlessV1WixUrl_universal_d_WixUrlPaidPlansCheckoutParams as WixUrlPaidPlansCheckoutParams, headlessV1WixUrl_universal_d_WixUrlLoginParams as WixUrlLoginParams, headlessV1WixUrl_universal_d_CallbackParams as CallbackParams, headlessV1WixUrl_universal_d_CreateWixUrlResponse as CreateWixUrlResponse, headlessV1WixUrl_universal_d_createWixUrl as createWixUrl, headlessV1WixUrl_universal_d_CreateWixUrlOptions as CreateWixUrlOptions, };\n }\n export { headlessV1WixUrl_universal_d as redirects };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-media.v2.d.ts", "content": "declare module \"wix-media.v2\" {\n interface Folder {\n /** Folder ID. Generated when a folder is created in the Media Manager. */\n _id?: string;\n /** Folder name as it appears in the Media Manager. */\n displayName?: string;\n /** ID of the folder's parent folder.
      Default: `media-root` folder. */\n parentFolderId?: string;\n /**\n * Date the folder was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date the folder was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * State of the folder.\n * @readonly\n */\n state?: State$1;\n }\n enum State$1 {\n OK = \"OK\",\n DELETED = \"DELETED\"\n }\n enum Namespace$1 {\n NO_NAMESPACE = \"NO_NAMESPACE\",\n OTHERS = \"OTHERS\",\n /** ANY = 2; */\n WIX_VIDEO = \"WIX_VIDEO\",\n /** _nsWixMusic */\n WIX_MUSIC = \"WIX_MUSIC\",\n /** _nsArtStore */\n ALBUMS_AND_ART_STORE = \"ALBUMS_AND_ART_STORE\",\n /** _nsDigitalProduct */\n WIX_ECOM = \"WIX_ECOM\",\n /** _nsPhotoShareApp */\n PHOTO_SHARE_APP = \"PHOTO_SHARE_APP\",\n /** _nsSharingApp, */\n SHARING_APP = \"SHARING_APP\",\n /** engage */\n CHAT = \"CHAT\",\n /** logobuilder */\n LOGO_BUILDER = \"LOGO_BUILDER\",\n /** WixExposure */\n ALBUMS_OLD = \"ALBUMS_OLD\",\n /** chat-mobile-uploads */\n CHAT_MOBILE = \"CHAT_MOBILE\",\n /** _nsWixForms */\n WIX_FORMS = \"WIX_FORMS\"\n }\n interface CreateFolderRequest {\n /** Folder name that appears in the Media Manager. */\n displayName: string;\n /** ID of the folder's parent folder. */\n parentFolderId?: string | null;\n }\n interface CreateFolderResponse {\n /** Information about the newly created folder. */\n folder?: Folder;\n }\n interface GetFolderRequest {\n /** Folder ID. */\n folderId: string;\n }\n interface GetFolderResponse {\n /** Information about the folder. */\n folder?: Folder;\n }\n interface ListFoldersRequest {\n /**\n * ID of the folder's parent folder.\n *
      Default: `media-root` folder.\n */\n parentFolderId?: string | null;\n /**\n * Field name and order to sort by. One of:\n * - `displayName`\n * - `_updatedDate`\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$1 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListFoldersResponse {\n /** Information about the folders in the requested folder. */\n folders?: Folder[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n }\n interface SearchFoldersRequest {\n /**\n * A root folder in the media manager to search in.
      \n * Default: `MEDIA_ROOT`.\n */\n rootFolder?: RootFolder$1;\n /**\n * Field name and order to sort by. One of:\n * - `displayName`\n * - `_updatedDate`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n /**\n * Term to search for, such as the value of a folder's `displayName`.
      \n * For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.\n */\n search?: string | null;\n }\n enum RootFolder$1 {\n /** Root of all site media */\n MEDIA_ROOT = \"MEDIA_ROOT\",\n /** Root of the trash system folder */\n TRASH_ROOT = \"TRASH_ROOT\",\n /** Root of all visitor uploads */\n VISITOR_UPLOADS_ROOT = \"VISITOR_UPLOADS_ROOT\"\n }\n interface SearchFoldersResponse {\n /** Information about the folders in the requested folder. */\n folders?: Folder[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2$1;\n }\n interface UpdateFolderRequest {\n /** The folder to update. */\n folder: Folder;\n }\n interface UpdateFolderResponse {\n /** Information about the updated folder. */\n folder?: Folder;\n }\n interface GenerateFolderDownloadUrlRequest {\n /** Folder ID. */\n folderId: string;\n }\n interface GenerateFolderDownloadUrlResponse {\n /** URL for downloading a specific folder in the Media Manager. */\n downloadUrl?: string;\n }\n interface BulkDeleteFoldersRequest {\n /** IDs of the folders to move to the Media Manager's trash bin. */\n folderIds: string[];\n /**\n * Whether the specified folders are permanently deleted.
      \n * Default: `false`\n */\n permanent?: boolean;\n }\n interface BulkDeleteFoldersResponse {\n }\n interface BulkRestoreFoldersFromTrashBinRequest {\n /** IDs of the folders to restore from the Media Manager's trash bin. */\n folderIds: string[];\n }\n interface BulkRestoreFoldersFromTrashBinResponse {\n }\n interface ListDeletedFoldersRequest {\n /** ID of the folder's parent folder. */\n parentFolderId?: string | null;\n /**\n * Field name and order to sort by. One of:\n * - `displayName`\n * - `_updatedDate`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n }\n interface ListDeletedFoldersResponse {\n /** List of folders in the Media Manager's trash bin. */\n folders?: Folder[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2$1;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new folder in the Media Manager.\n *\n * The `createFolder()` function returns a Promise that resolves to the created folder.\n *\n * Use the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.\n * If no folder is specified, the new folder is created in the `media-root` folder.\n * @param displayName - Folder name that appears in the Media Manager.\n * @public\n * @requiredField displayName\n * @param options - Options for specifying where to create a folder.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function createFolder(displayName: string, options?: CreateFolderOptions): Promise;\n interface CreateFolderOptions {\n /** ID of the folder's parent folder. */\n parentFolderId?: string | null;\n }\n /**\n * Gets information from the specified folder in the Media Manager.\n *\n * The `getFolder()` function returns a Promise that resolves to information about the specified folder.\n * @param folderId - Folder ID.\n * @public\n * @requiredField folderId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n * @returns Information about the folder.\n */\n function getFolder(folderId: string): Promise;\n /**\n * Retrieves a list of folders in the Media Manager.\n *\n * The `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.\n *\n * To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the list of folders within the root folder of the Media Manager.\n *\n * To retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function.\n * @public\n * @param options - Options to use when listing folders from the Media Manager.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function listFolders(options?: ListFoldersOptions): Promise;\n interface ListFoldersOptions {\n /**\n * ID of the folder's parent folder.\n *
      Default: `media-root` folder.\n */\n parentFolderId?: string | null;\n /**\n * Field name and order to sort by. One of:\n * - `displayName`\n * - `_updatedDate`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n }\n /**\n * Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.\n *\n * The `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.\n *\n * If no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder.\n * @public\n * @param options - Options specifying which folders to search.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function searchFolders(options?: SearchFoldersOptions): Promise;\n interface SearchFoldersOptions {\n /**\n * A root folder in the media manager to search in.
      \n * Default: `MEDIA_ROOT`.\n */\n rootFolder?: RootFolder$1;\n /**\n * Field name and order to sort by. One of:\n * - `displayName`\n * - `_updatedDate`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n /**\n * Term to search for, such as the value of a folder's `displayName`.\n *\n * For example, if a folder's `displayName` is 'my-videos-folder', the search term is `'my-videos-folder'`.\n */\n search?: string | null;\n }\n interface UpdateFolder {\n /** Folder ID. Generated when a folder is created in the Media Manager. */\n _id?: string;\n /** Folder name as it appears in the Media Manager. */\n displayName?: string;\n /** ID of the folder's parent folder.
      Default: `media-root` folder. */\n parentFolderId?: string;\n /**\n * Date the folder was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date the folder was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * State of the folder.\n * @readonly\n */\n state?: State$1;\n }\n interface UpdateFolderOptions {\n }\n /**\n * Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.\n *\n * The `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.\n *\n * The compressed file can contain sub-folders, and up to 1000 files.\n * @param folderId - Folder ID.\n * @public\n * @requiredField folderId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function generateFolderDownloadUrl(folderId: string): Promise;\n /**\n * Temporarily deletes the specified folders from the Media Manager.\n *\n * The `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.\n *\n * The deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.\n *\n * >**Notes:**\n * > - When a folder is deleted, the files in that folder are deleted.\n * > - The specified folders can be from different parent folders.\n * > - Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.\n * > - Attempting to delete folders that are already in the trash bin doesn't result in an error.\n * > - If your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).\n * > - You can use the `bulkRestoreFoldersFromTrashBin()` function to restore folders from the Media Manager's trash bin.\n * @param folderIds - IDs of the folders to move to the Media Manager's trash bin.\n * @public\n * @requiredField folderIds\n * @param options - Options to use when deleting folders.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteFolders(folderIds: string[], options?: BulkDeleteFoldersOptions): Promise;\n interface BulkDeleteFoldersOptions {\n /**\n * Whether the specified folders are permanently deleted.
      \n * Default: `false`\n */\n permanent?: boolean;\n }\n /**\n * Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.\n *\n *\n * The `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored.\n * @param folderIds - IDs of the folders to restore from the Media Manager's trash bin.\n * @public\n * @requiredField folderIds\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Promise;\n /**\n * Retrieves a list of deleted folders from the trash bin.\n *\n * The `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.\n *\n * To retrieve a list of non-deleted folders, use the `listFolders()` function.\n * @public\n * @param options - Options to use when listing deleted folders from the trash bin.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @applicableIdentity APP\n * @adminMethod\n */\n function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise;\n interface ListDeletedFoldersOptions {\n /** ID of the folder's parent folder. */\n parentFolderId?: string | null;\n /**\n * Field name and order to sort by. One of:\n * - `displayName`\n * - `_updatedDate`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n }\n type mediaSiteMediaV1FolderFolders_universal_d_Folder = Folder;\n type mediaSiteMediaV1FolderFolders_universal_d_CreateFolderRequest = CreateFolderRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_CreateFolderResponse = CreateFolderResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_GetFolderRequest = GetFolderRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_GetFolderResponse = GetFolderResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_ListFoldersRequest = ListFoldersRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_ListFoldersResponse = ListFoldersResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_SearchFoldersRequest = SearchFoldersRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_SearchFoldersResponse = SearchFoldersResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_UpdateFolderRequest = UpdateFolderRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_UpdateFolderResponse = UpdateFolderResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_GenerateFolderDownloadUrlRequest = GenerateFolderDownloadUrlRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_GenerateFolderDownloadUrlResponse = GenerateFolderDownloadUrlResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_BulkDeleteFoldersRequest = BulkDeleteFoldersRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_BulkDeleteFoldersResponse = BulkDeleteFoldersResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_BulkRestoreFoldersFromTrashBinRequest = BulkRestoreFoldersFromTrashBinRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_BulkRestoreFoldersFromTrashBinResponse = BulkRestoreFoldersFromTrashBinResponse;\n type mediaSiteMediaV1FolderFolders_universal_d_ListDeletedFoldersRequest = ListDeletedFoldersRequest;\n type mediaSiteMediaV1FolderFolders_universal_d_ListDeletedFoldersResponse = ListDeletedFoldersResponse;\n const mediaSiteMediaV1FolderFolders_universal_d_createFolder: typeof createFolder;\n type mediaSiteMediaV1FolderFolders_universal_d_CreateFolderOptions = CreateFolderOptions;\n const mediaSiteMediaV1FolderFolders_universal_d_getFolder: typeof getFolder;\n const mediaSiteMediaV1FolderFolders_universal_d_listFolders: typeof listFolders;\n type mediaSiteMediaV1FolderFolders_universal_d_ListFoldersOptions = ListFoldersOptions;\n const mediaSiteMediaV1FolderFolders_universal_d_searchFolders: typeof searchFolders;\n type mediaSiteMediaV1FolderFolders_universal_d_SearchFoldersOptions = SearchFoldersOptions;\n type mediaSiteMediaV1FolderFolders_universal_d_UpdateFolder = UpdateFolder;\n type mediaSiteMediaV1FolderFolders_universal_d_UpdateFolderOptions = UpdateFolderOptions;\n const mediaSiteMediaV1FolderFolders_universal_d_generateFolderDownloadUrl: typeof generateFolderDownloadUrl;\n const mediaSiteMediaV1FolderFolders_universal_d_bulkDeleteFolders: typeof bulkDeleteFolders;\n type mediaSiteMediaV1FolderFolders_universal_d_BulkDeleteFoldersOptions = BulkDeleteFoldersOptions;\n const mediaSiteMediaV1FolderFolders_universal_d_bulkRestoreFoldersFromTrashBin: typeof bulkRestoreFoldersFromTrashBin;\n const mediaSiteMediaV1FolderFolders_universal_d_listDeletedFolders: typeof listDeletedFolders;\n type mediaSiteMediaV1FolderFolders_universal_d_ListDeletedFoldersOptions = ListDeletedFoldersOptions;\n namespace mediaSiteMediaV1FolderFolders_universal_d {\n export { mediaSiteMediaV1FolderFolders_universal_d_Folder as Folder, State$1 as State, Namespace$1 as Namespace, mediaSiteMediaV1FolderFolders_universal_d_CreateFolderRequest as CreateFolderRequest, mediaSiteMediaV1FolderFolders_universal_d_CreateFolderResponse as CreateFolderResponse, mediaSiteMediaV1FolderFolders_universal_d_GetFolderRequest as GetFolderRequest, mediaSiteMediaV1FolderFolders_universal_d_GetFolderResponse as GetFolderResponse, mediaSiteMediaV1FolderFolders_universal_d_ListFoldersRequest as ListFoldersRequest, Sorting$1 as Sorting, SortOrder$1 as SortOrder, CursorPaging$1 as CursorPaging, mediaSiteMediaV1FolderFolders_universal_d_ListFoldersResponse as ListFoldersResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, mediaSiteMediaV1FolderFolders_universal_d_SearchFoldersRequest as SearchFoldersRequest, RootFolder$1 as RootFolder, mediaSiteMediaV1FolderFolders_universal_d_SearchFoldersResponse as SearchFoldersResponse, mediaSiteMediaV1FolderFolders_universal_d_UpdateFolderRequest as UpdateFolderRequest, mediaSiteMediaV1FolderFolders_universal_d_UpdateFolderResponse as UpdateFolderResponse, mediaSiteMediaV1FolderFolders_universal_d_GenerateFolderDownloadUrlRequest as GenerateFolderDownloadUrlRequest, mediaSiteMediaV1FolderFolders_universal_d_GenerateFolderDownloadUrlResponse as GenerateFolderDownloadUrlResponse, mediaSiteMediaV1FolderFolders_universal_d_BulkDeleteFoldersRequest as BulkDeleteFoldersRequest, mediaSiteMediaV1FolderFolders_universal_d_BulkDeleteFoldersResponse as BulkDeleteFoldersResponse, mediaSiteMediaV1FolderFolders_universal_d_BulkRestoreFoldersFromTrashBinRequest as BulkRestoreFoldersFromTrashBinRequest, mediaSiteMediaV1FolderFolders_universal_d_BulkRestoreFoldersFromTrashBinResponse as BulkRestoreFoldersFromTrashBinResponse, mediaSiteMediaV1FolderFolders_universal_d_ListDeletedFoldersRequest as ListDeletedFoldersRequest, mediaSiteMediaV1FolderFolders_universal_d_ListDeletedFoldersResponse as ListDeletedFoldersResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, mediaSiteMediaV1FolderFolders_universal_d_createFolder as createFolder, mediaSiteMediaV1FolderFolders_universal_d_CreateFolderOptions as CreateFolderOptions, mediaSiteMediaV1FolderFolders_universal_d_getFolder as getFolder, mediaSiteMediaV1FolderFolders_universal_d_listFolders as listFolders, mediaSiteMediaV1FolderFolders_universal_d_ListFoldersOptions as ListFoldersOptions, mediaSiteMediaV1FolderFolders_universal_d_searchFolders as searchFolders, mediaSiteMediaV1FolderFolders_universal_d_SearchFoldersOptions as SearchFoldersOptions, mediaSiteMediaV1FolderFolders_universal_d_UpdateFolder as UpdateFolder, mediaSiteMediaV1FolderFolders_universal_d_UpdateFolderOptions as UpdateFolderOptions, mediaSiteMediaV1FolderFolders_universal_d_generateFolderDownloadUrl as generateFolderDownloadUrl, mediaSiteMediaV1FolderFolders_universal_d_bulkDeleteFolders as bulkDeleteFolders, mediaSiteMediaV1FolderFolders_universal_d_BulkDeleteFoldersOptions as BulkDeleteFoldersOptions, mediaSiteMediaV1FolderFolders_universal_d_bulkRestoreFoldersFromTrashBin as bulkRestoreFoldersFromTrashBin, mediaSiteMediaV1FolderFolders_universal_d_listDeletedFolders as listDeletedFolders, mediaSiteMediaV1FolderFolders_universal_d_ListDeletedFoldersOptions as ListDeletedFoldersOptions, };\n }\n interface FileDescriptor {\n /**\n * File ID. Generated when a file is uploaded to the Media Manager.\n * @readonly\n */\n _id?: string;\n /** File name as it appears in the Media Manager. */\n displayName?: string;\n /**\n * Static URL of the file.\n * @readonly\n */\n url?: string;\n /** ID of the file's parent folder. */\n parentFolderId?: string | null;\n /**\n * File hash.\n * @readonly\n */\n hash?: string;\n /**\n * Size of the uploaded file in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /**\n * Whether the link to the uploaded file is public or private. Private links require a token.\n * @readonly\n */\n private?: boolean;\n /**\n * Media file type.\n * @readonly\n */\n mediaType?: MediaType;\n /**\n * Media file content.\n * @readonly\n */\n media?: FileMedia;\n /**\n * Status of the file that was uploaded.\n * * `FAILED`: The file failed to upload, for example, during media post processing.\n * * `READY`: The file uploaded, finished all processing, and is ready for use.\n * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.\n * @readonly\n */\n operationStatus?: OperationStatus;\n /**\n * URL where the file was uploaded from.\n * @readonly\n */\n sourceUrl?: string | null;\n /**\n * URL of the file's thumbnail.\n * @readonly\n */\n thumbnailUrl?: string | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[];\n /**\n * Date and time the file was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the file was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * The Wix site ID where the media file is stored.\n * @readonly\n */\n siteId?: string;\n /**\n * State of the file.\n * @readonly\n */\n state?: State;\n }\n enum MediaType {\n UNKNOWN = \"UNKNOWN\",\n IMAGE = \"IMAGE\",\n VIDEO = \"VIDEO\",\n AUDIO = \"AUDIO\",\n DOCUMENT = \"DOCUMENT\",\n VECTOR = \"VECTOR\",\n ARCHIVE = \"ARCHIVE\",\n MODEL3D = \"MODEL3D\",\n OTHER = \"OTHER\"\n }\n interface FileMedia extends FileMediaMediaOneOf {\n /** Information about the image. */\n image?: ImageMedia;\n /** Information about the video. */\n video?: string;\n /** Information about the audio. */\n audio?: AudioV2;\n /** Information about the document. */\n document?: string;\n /** Information about the vector. */\n vector?: ImageMedia;\n /** Information about the archive. */\n archive?: Archive;\n /** Information about the 3D Model. */\n model3d?: Model3D;\n }\n /** @oneof */\n interface FileMediaMediaOneOf {\n /** Information about the image. */\n image?: ImageMedia;\n /** Information about the video. */\n video?: string;\n /** Information about the audio. */\n audio?: AudioV2;\n /** Information about the document. */\n document?: string;\n /** Information about the vector. */\n vector?: ImageMedia;\n /** Information about the archive. */\n archive?: Archive;\n /** Information about the 3D Model. */\n model3d?: Model3D;\n }\n interface ImageMedia {\n /** Image data. */\n image?: string;\n /** Image colors. */\n colors?: Colors;\n /** Information about faces in the image. Use to crop images without cutting out faces. */\n faces?: FaceRecognition[];\n /**\n * Information about the image preview.\n * You can use this to display a preview for private images.\n */\n previewImage?: string;\n /**\n * Optional, An AI generated description of the image\n * @readonly\n */\n caption?: string | null;\n }\n interface Colors {\n /** Main color of the image. */\n prominent?: Color;\n /** Color palette of the image. */\n palette?: Color[];\n }\n interface Color {\n /** HEX color. */\n hex?: string | null;\n /** RGB color. */\n rgb?: ColorRGB;\n }\n interface ColorRGB {\n /** Red channel. */\n r?: number | null;\n /** Green channel. */\n g?: number | null;\n /** Blue channel. */\n b?: number | null;\n }\n /**\n * Using this object you can crop images while centering on faces\n * ------------------------\n * | |\n * | x,y |\n * | *-------- |\n * | | . . | |\n * | | | | height |\n * | | \\ / | |\n * | | | |\n * | --------- |\n * | width |\n * | |\n * |______________________|\n */\n interface FaceRecognition {\n /** The accuracy percentage of the face recognition. The likelihood that a face is detected. */\n confidence?: number;\n /** Top left x pixel coordinate of the face. */\n x?: number;\n /** Top left y pixel coordinate of the face. */\n y?: number;\n /** Face pixel height. */\n height?: number;\n /** Face pixel width. */\n width?: number;\n }\n interface VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Video format\n * Possible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'\n * '720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm', 'hls' ]\n */\n format?: string;\n }\n interface AudioV2 {\n /** WixMedia ID. */\n _id?: string;\n /** Audio formats available for this file. */\n assets?: string[];\n /**\n * Audio bitrate.\n * @readonly\n */\n bitrate?: number | null;\n /**\n * Audio format.\n * @readonly\n */\n format?: string | null;\n /**\n * Audio duration in seconds.\n * @readonly\n */\n duration?: number | null;\n /**\n * Audio size in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n }\n interface Archive {\n /** WixMedia ID. */\n _id?: string;\n /** Archive URL. */\n url?: string;\n /**\n * Archive URL expiration date (when relevant).\n * @readonly\n */\n urlExpirationDate?: Date;\n /** Archive size in bytes. */\n sizeInBytes?: string | null;\n /** Archive filename. */\n filename?: string | null;\n }\n interface Model3D {\n /** WixMedia 3D ID. */\n _id?: string;\n /** 3D URL. */\n url?: string;\n /** 3D thumbnail Image */\n thumbnail?: string;\n /** 3D alt text. */\n altText?: string | null;\n /**\n * 3D URL expiration date (when relevant).\n * @readonly\n */\n urlExpirationDate?: Date;\n /**\n * 3D filename.\n * @readonly\n */\n filename?: string | null;\n /**\n * 3D size in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n }\n interface OtherMedia {\n /** WixMedia ID. for use with Site Media APIs only */\n _id?: string;\n /**\n * The media type of the file: 'site_icon', 'swf', 'package', 'ufont'\n * @readonly\n */\n internalMediaType?: string | null;\n /**\n * size in bytes. Optional.\n * @readonly\n */\n sizeInBytes?: string | null;\n }\n enum OperationStatus {\n /** File upload or processing failed */\n FAILED = \"FAILED\",\n /** File is ready for consumption */\n READY = \"READY\",\n /** File is waiting for processing or currently being processed */\n PENDING = \"PENDING\"\n }\n enum State {\n /** File is ready for consumption */\n OK = \"OK\",\n /** Deleted file */\n DELETED = \"DELETED\"\n }\n enum Namespace {\n NO_NAMESPACE = \"NO_NAMESPACE\",\n OTHERS = \"OTHERS\",\n /** ANY = 2; */\n WIX_VIDEO = \"WIX_VIDEO\",\n /** _nsWixMusic */\n WIX_MUSIC = \"WIX_MUSIC\",\n /** _nsArtStore */\n ALBUMS_AND_ART_STORE = \"ALBUMS_AND_ART_STORE\",\n /** _nsDigitalProduct */\n WIX_ECOM = \"WIX_ECOM\",\n /** _nsPhotoShareApp */\n PHOTO_SHARE_APP = \"PHOTO_SHARE_APP\",\n /** _nsSharingApp, */\n SHARING_APP = \"SHARING_APP\",\n /** engage */\n CHAT = \"CHAT\",\n /** logobuilder */\n LOGO_BUILDER = \"LOGO_BUILDER\",\n /** WixExposure */\n ALBUMS_OLD = \"ALBUMS_OLD\",\n /** chat-mobile-uploads */\n CHAT_MOBILE = \"CHAT_MOBILE\",\n /** _nsWixForms */\n WIX_FORMS = \"WIX_FORMS\"\n }\n interface IdentityInfo {\n /** The type of the user that uploaded the file */\n identityType?: IdentityType;\n /** User Id. empty when UNKNOWN */\n identityId?: string | null;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface FileReady {\n /** File entity that is ready with full information */\n file?: FileDescriptor;\n /** External information passed in the file import or upload. */\n externalInfo?: ExternalInfo;\n /** The File was restored from the trash-bin */\n triggeredByUndelete?: boolean;\n }\n interface ExternalInfo {\n /** External information to pass in the File Ready or File Failed events. */\n origin?: string;\n /** External IDs to pass in the File Ready or File Failed events. */\n externalIds?: string[];\n }\n interface FileFailed {\n /** External information passed in the file import or upload. */\n externalInfo?: ExternalInfo;\n }\n interface GenerateFilesDownloadUrlRequest {\n /**\n * IDs of the files to download.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileIds: string[];\n }\n interface GenerateFilesDownloadUrlResponse {\n /** URL for downloading the compressed file containing the specified files in the Media Manager. */\n downloadUrl?: string;\n }\n interface GenerateFileDownloadUrlRequest {\n /**\n * File ID.\n *\n * You can also pass the file's Wix media URL. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileId: string;\n /**\n * Temporary file name used to identify the file type. For example, a file named \"myFile.jpeg\" identifies as an \"image/jpeg\" file type.
      \n *\n * **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.\n */\n downloadFileName?: string | null;\n /**\n * The time that it takes in minutes for the download URL to expire.
      \n * Default: `600`.
      \n * Limit: `525600` (1 year).\n */\n expirationInMinutes?: number | null;\n /**\n * The redirect URL for when the temporary download URL with a token expires.
      \n * Default: A 403 Forbidden response page.\n */\n expirationRedirectUrl?: string | null;\n /**\n * Keys for downloading different assets (format and quality) of a file.\n * Default: `src`, key representing the original file's format and quality.\n */\n assetKeys?: string[] | null;\n /**\n * Whether the link downloads the file or opens the file in the browser.\n *\n * - `ATTACHMENT`: The link downloads the file.\n * - `INLINE`: The link opens the file in the browser.\n *\n * Default: `ATTACHMENT`\n */\n contentDisposition?: ContentDisposition;\n }\n enum ContentDisposition {\n /** Using the link in the browser will download the file */\n ATTACHMENT = \"ATTACHMENT\",\n /** Using the link in the browser will open the file in the browser */\n INLINE = \"INLINE\"\n }\n interface GenerateFileDownloadUrlResponse {\n /** URL for downloading a specific file in the Media Manager. */\n downloadUrls?: DownloadUrl[];\n }\n interface DownloadUrl {\n /** The file download URL. */\n url?: string;\n /**\n * Key for downloading a different asset (format and quality) of a file.\n * Default: `src`, key representing the original file's format and quality.\n */\n assetKey?: string;\n }\n interface GetFileDescriptorRequest {\n /**\n * File ID.\n *\n * You can also pass the file's Wix media URL. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileId: string;\n }\n interface GetFileDescriptorResponse {\n /** Information about the file. */\n file?: FileDescriptor;\n }\n interface GetFileDescriptorsRequest {\n /**\n * File IDs.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileIds: string[];\n }\n interface GetFileDescriptorsResponse {\n /** Information about the requested files. */\n files?: FileDescriptor[];\n }\n interface UpdateFileDescriptorRequest {\n /** The file to update. */\n file: FileDescriptor;\n }\n interface UpdateFileDescriptorResponse {\n /** Information about the updated file. */\n file?: FileDescriptor;\n }\n interface GenerateFileUploadUrlRequest {\n /** File mime type. */\n mimeType: string | null;\n /**\n * Temporary file name used to identify the file type. For example, a file named \"myFile.jpeg\" identifies as an \"image/jpeg\" file type.\n *
      **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.\n */\n fileName?: string | null;\n /**\n * File size in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /**\n * ID of the file's parent folder.
      \n * This folder is the path root for the `filePath`.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Whether the link to the uploaded file is public or private. See `Private Files` in terminology. */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */\n externalInfo?: ExternalInfo;\n /**\n * Path to the folder where the file will be stored.\n * For example, `/videos/2024/december`.
      \n * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.\n * The folders in the path will be created if they don't already exist.
      \n */\n filePath?: string | null;\n }\n interface GenerateFileUploadUrlResponse {\n /** The URL for uploading a file to the Media Manager. */\n uploadUrl?: string;\n }\n interface GenerateFileResumableUploadUrlRequest {\n /** File mime type. */\n mimeType: string | null;\n /**\n * Temporary file name used to identify the file type. For example, a file named \"myFile.jpeg\" identifies as an \"image/jpeg\" file type.\n *
      **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.\n */\n fileName?: string | null;\n /**\n * File size in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /**\n * ID of the file's parent folder.
      \n * This folder is the path root for the `filePath`.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Whether the link to the imported file is public or private. See `Private Files` in terminology. */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** The upload protocol to use for implementing the resumable upload. */\n uploadProtocol?: UploadProtocol;\n /**\n * Path to the folder where the file will be stored.\n * For example, `/videos/2024/december`.
      \n * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.\n * The folders in the path will be created if they don't already exist.
      \n */\n filePath?: string | null;\n }\n enum UploadProtocol {\n /** The upload protocol to use for implementing the resumable upload. */\n TUS = \"TUS\"\n }\n interface GenerateFileResumableUploadUrlResponse {\n /**\n * The upload protocol to use for implementing the resumable upload.\n *\n * Supported values: `\"TUS\"`\n */\n uploadProtocol?: UploadProtocol;\n /** The URL for uploading a file to the Media Manager. */\n uploadUrl?: string;\n /** Single-use upload token. */\n uploadToken?: string;\n }\n interface ImportFileRequest {\n /** Publicly accessible external file URL. */\n url: string;\n /** Media type of the file to import. */\n mediaType?: MediaType;\n /** File name that appears in the Media Manager. */\n displayName?: string | null;\n /**\n * ID of the file's parent folder.
      \n * This folder is the path root for the `filePath`.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** File mime type. */\n mimeType?: string;\n /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */\n externalInfo?: ExternalInfo;\n /** Optional parameters that should be sent with the external URL. */\n urlParams?: Record | null;\n /** Optional headers that should be sent with the external URL. */\n urlHeaders?: Record | null;\n /**\n * Path to the folder where the file will be stored.\n * For example, `/videos/2024/december`.
      \n * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.\n * The folders in the path will be created if they don't already exist.
      \n */\n filePath?: string | null;\n }\n interface ImportFileResponse {\n /** Information about the imported file. */\n file?: FileDescriptor;\n }\n interface BulkImportFilesRequest {\n /** Information about the files to import. */\n importFileRequests: ImportFileRequest[];\n }\n interface BulkImportFilesResponse {\n /** Information about the imported files. */\n files?: FileDescriptor[];\n }\n interface BulkImportFileRequest {\n /** Information about the files to import. */\n importFileRequests: ImportFileRequest[];\n /**\n * Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.\n *\n * Default: `true`\n */\n returnEntity?: boolean | null;\n }\n interface BulkImportFileResponse {\n /** Items created by bulk action. */\n results?: BulkImportFileResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkImportFileResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */\n item?: FileDescriptor;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface ListFilesRequest {\n /**\n * ID of the file's parent folder.
      \n * Default:`media-root`.\n */\n parentFolderId?: string | null;\n /**\n * File media type.\n * excluding: OTHER media type\n */\n mediaTypes?: MediaType[];\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:\n *\n * - `displayName`\n * - `_updatedDate`\n * - `sizeInBytes`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListFilesResponse {\n /** List of files in the Media Manager. */\n files?: FileDescriptor[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n }\n interface SearchFilesRequest {\n /**\n * Term to search for. Possible terms include the value of a file's\n * `displayName`, `mimeType`, and `label`.
      \n * For example, if a file's label is cat, the search term is 'cat'.\n */\n search?: string | null;\n /**\n * A root folder in the media manager to search in.
      \n * Default: `MEDIA_ROOT`.\n */\n rootFolder?: RootFolder;\n /**\n * File media type.\n * excluding: OTHER media type\n */\n mediaTypes?: MediaType[];\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:\n *\n * - `displayName`\n * - `_updatedDate`\n * - `sizeInBytes`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n }\n enum RootFolder {\n /** Root of all site media */\n MEDIA_ROOT = \"MEDIA_ROOT\",\n /** Root of the trash system folder */\n TRASH_ROOT = \"TRASH_ROOT\",\n /** Root of all visitor uploads */\n VISITOR_UPLOADS_ROOT = \"VISITOR_UPLOADS_ROOT\"\n }\n interface SearchFilesResponse {\n /** Files matching the query. */\n files?: FileDescriptor[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2;\n }\n interface GenerateVideoStreamingUrlRequest {\n /**\n * File ID.\n *\n * You can also pass the file's Wix media URL. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileId: string;\n /** Video stream format. */\n format?: StreamFormat;\n }\n enum StreamFormat {\n UNKNOWN = \"UNKNOWN\",\n HLS = \"HLS\",\n DASH = \"DASH\"\n }\n interface GenerateVideoStreamingUrlResponse {\n /** URL for streaming a specific file in the Media Manager. */\n downloadUrl?: DownloadUrl;\n }\n interface GenerateWebSocketTokenRequest {\n }\n interface GenerateWebSocketTokenResponse {\n /** The web socket token for the identity in the request */\n token?: string;\n }\n interface BulkDeleteFilesRequest {\n /**\n * IDs of the files to move to the Media Manager's trash bin.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileIds: string[];\n /**\n * Whether the specified files are permanently deleted.
      \n * Default: `false`\n */\n permanent?: boolean;\n }\n interface BulkDeleteFilesResponse {\n }\n interface BulkRestoreFilesFromTrashBinRequest {\n /**\n * IDs of the files to restore from the Media Manager's trash bin.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileIds: string[];\n }\n interface BulkRestoreFilesFromTrashBinResponse {\n }\n interface ListDeletedFilesRequest {\n /**\n * ID of the file's parent folder.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /**\n * File media type.\n * excluding: OTHER media type\n */\n mediaTypes?: MediaType[];\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:\n *\n * - `displayName`\n * - `_updatedDate`\n * - `sizeInBytes`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n }\n interface ListDeletedFilesResponse {\n /** List of files in the Media Manager's trash bin. */\n files?: FileDescriptor[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2;\n }\n interface UpdateFileRequest {\n /**\n * ID of the file to update.\n *\n * You can also pass the file's Wix media URL. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n */\n fileId: string;\n /** File name that appears in the Media Manager. */\n displayName?: string | null;\n /**\n * ID of the file's parent folder.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n }\n interface UpdateFileResponse {\n /** Information about the updated file. */\n file?: FileDescriptor;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Generates a URL for downloading a compressed file containing specific files in the Media Manager.\n *\n * The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL.\n *\n * The compressed file can contain up to 1000 files.\n *\n * To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function.\n * You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function.\n * Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for.\n * @public\n * @requiredField fileIds\n * @param fileIds - IDs of the files to download.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function generateFilesDownloadUrl(fileIds: string[]): Promise;\n /**\n * Generates one or more temporary URLs for downloading a specific file in the Media Manager.\n *\n * The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter.\n *\n * To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset.\n * If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.\n *\n * Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires.\n *\n * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the `generateFilesDownloadUrl()` function.\n * Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for.\n * @public\n * @requiredField fileId\n * @param options - Options to use when generating a file's download URL.\n * @param fileId - File ID.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise;\n interface GenerateFileDownloadUrlOptions {\n /**\n * Temporary file name used to identify the file type. For example, a file named \"myFile.jpeg\" identifies as an \"image/jpeg\" file type.
      \n *\n * **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.\n */\n downloadFileName?: string | null;\n /**\n * The time that it takes in minutes for the download URL to expire.
      \n * Default: `600`.
      \n * Limit: `525600` (1 year).\n */\n expirationInMinutes?: number | null;\n /**\n * The redirect URL for when the temporary download URL with a token expires.
      \n * Default: A 403 Forbidden response page.\n */\n expirationRedirectUrl?: string | null;\n /**\n * Keys for downloading different assets (format and quality) of a file.\n * Default: `src`, key representing the original file's format and quality.\n */\n assetKeys?: string[] | null;\n /**\n * Whether the link downloads the file or opens the file in the browser.\n *\n * - `ATTACHMENT`: The link downloads the file.\n * - `INLINE`: The link opens the file in the browser.\n *\n * Default: `ATTACHMENT`\n */\n contentDisposition?: ContentDisposition;\n }\n /**\n * Gets information about the specified file in the Media Manager.\n *\n *\n * The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor.\n *\n * Use `getFileDescriptors()` to get multiple file descriptors at once.\n * @public\n * @requiredField fileId\n * @param fileId - File ID.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Information about the file.\n */\n function getFileDescriptor(fileId: string): Promise;\n /**\n * Gets information about the specified files in the Media Manager.\n *\n *\n * The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors.\n *\n * Use `getFileDescriptor()` to get a single file descriptor.\n * @public\n * @requiredField fileIds\n * @param fileIds - File IDs.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function getFileDescriptors(fileIds: string[]): Promise;\n /**\n * Updates a file.\n *\n *\n * The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor.\n *\n * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder.\n * @param file - The file to update.\n * @public\n * @requiredField file\n * @requiredField file._id\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Information about the updated file.\n */\n function updateFileDescriptor(file: FileDescriptor, options?: UpdateFileDescriptorOptions): Promise;\n interface UpdateFileDescriptorOptions {\n }\n /**\n * Generates an upload URL to allow external clients to upload a file to the Media Manager.\n *\n * The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL.\n *\n * To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the Upload API article.\n *\n * > **Note:** Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.\n * @param mimeType - File mime type.\n * @public\n * @requiredField mimeType\n * @param options - Options to use when generating a file's upload URL.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function generateFileUploadUrl(mimeType: string | null, options?: GenerateFileUploadUrlOptions): Promise;\n interface GenerateFileUploadUrlOptions {\n /**\n * Temporary file name used to identify the file type. For example, a file named \"myFile.jpeg\" identifies as an \"image/jpeg\" file type.\n *
      **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.\n */\n fileName?: string | null;\n /**\n * File size in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /**\n * ID of the file's parent folder.
      \n * This folder is the path root for the `filePath`.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Whether the link to the uploaded file is public or private. See `Private Files` in terminology. */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */\n externalInfo?: ExternalInfo;\n /**\n * Path to the folder where the file will be stored.\n * For example, `/videos/2024/december`.
      \n * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.\n * The folders in the path will be created if they don't already exist.
      \n */\n filePath?: string | null;\n }\n /**\n * Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager.\n *\n * The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol.\n *\n * When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. The resumable upload URL is also helpful when network connection is poor.\n *\n * To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the Resumable Upload API article.\n * @param mimeType - File mime type.\n * @public\n * @requiredField mimeType\n * @param options - Options to use when generating a resumable upload URL.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function generateFileResumableUploadUrl(mimeType: string | null, options?: GenerateFileResumableUploadUrlOptions): Promise;\n interface GenerateFileResumableUploadUrlOptions {\n /**\n * Temporary file name used to identify the file type. For example, a file named \"myFile.jpeg\" identifies as an \"image/jpeg\" file type.\n *
      **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.\n */\n fileName?: string | null;\n /**\n * File size in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /**\n * ID of the file's parent folder.
      \n * This folder is the path root for the `filePath`.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Whether the link to the imported file is public or private. See `Private Files` in terminology. */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /**\n * The upload protocol to use for implementing the resumable upload.\n *\n * Supported values: `\"TUS\"`\n */\n uploadProtocol?: UploadProtocol;\n /**\n * Path to the folder where the file will be stored.\n * For example, `/videos/2024/december`.
      \n * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.\n * The folders in the path will be created if they don't already exist.
      \n */\n filePath?: string | null;\n }\n /**\n * Imports a file to the Media Manager using an external URL.\n *\n * The `importFile()` function returns a Promise that resolves to the imported file's descriptor.\n *\n * This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager.\n * Use the `parentFolderId` and `filePath` parameters to specify which folder you want the file to be imported to.\n * If no folder is specified, the file is imported to the `media-root` folder.\n *\n * To import a file, you need to do one of the following:\n * - Pass its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.\n * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.\n * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.\n * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.\n * @param url - Publicly accessible external file URL.\n * @public\n * @requiredField url\n * @param options - Options to use when importing a single file.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function importFile(url: string, options?: ImportFileOptions): Promise;\n interface ImportFileOptions {\n /** Media type of the file to import. */\n mediaType?: MediaType;\n /** File name that appears in the Media Manager. */\n displayName?: string | null;\n /**\n * ID of the file's parent folder.
      \n * This folder is the path root for the `filePath`.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** File mime type. */\n mimeType?: string;\n /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */\n externalInfo?: ExternalInfo;\n /** Optional parameters that should be sent with the external URL. */\n urlParams?: Record | null;\n /** Optional headers that should be sent with the external URL. */\n urlHeaders?: Record | null;\n /**\n * Path to the folder where the file will be stored.\n * For example, `/videos/2024/december`.
      \n * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.\n * The folders in the path will be created if they don't already exist.
      \n */\n filePath?: string | null;\n }\n /**\n * > **Deprecated.**\n * > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024.\n *\n *\n * The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors.\n *\n * Imports a bulk of files to the Media Manager using external urls.\n *\n * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported.\n * If no folder is specified, the file is imported to the `media-root` folder.\n *\n * >**Note:** The `media` property isn't returned in the `files` response object.\n *\n * To import files, you need to do one of the following for each file:\n * - Pass its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.\n * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.\n * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.\n * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.\n * @param importFileRequests - Information about the files to import.\n * @public\n * @requiredField importFileRequests\n * @requiredField importFileRequests.url\n * @param options - Options to use when uploading multiple files.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @deprecated\n * @replacedBy com.wix.media.site_media.v1.FilesService.BulkImportFile\n * @targetRemovalDate 2024-03-31\n */\n function bulkImportFiles(importFileRequests: ImportFileRequest[]): Promise;\n /**\n * Imports a bulk of files to the Media Manager using external urls.\n *\n * The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata.\n *\n * Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported.\n * If no folder is specified, the file is imported to the `media-root` folder.\n *\n * To import files, you need to do one of the following for each file:\n * - Pass its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.\n * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.\n * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.\n * > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.\n * @param importFileRequests - Information about the files to import.\n * @public\n * @requiredField importFileRequests\n * @requiredField importFileRequests.url\n * @param options - Options to include the file descriptor in the response.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkImportFile(importFileRequests: ImportFileRequest[], options?: BulkImportFileOptions): Promise;\n interface BulkImportFileOptions {\n /**\n * Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.\n *\n * Default: `true`\n */\n returnEntity?: boolean | null;\n }\n /**\n * Retrieves a list of files in the Media Manager.\n *\n * The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information.\n *\n * To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager.\n *\n * To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function.\n * @public\n * @param options - Options to use when listing media files.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function listFiles(options?: ListFilesOptions): Promise;\n interface ListFilesOptions {\n /**\n * ID of the file's parent folder.
      \n * Default:`media-root`.\n */\n parentFolderId?: string | null;\n /** Media file type. */\n mediaTypes?: MediaType[];\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:\n *\n * - `displayName`\n * - `_updatedDate`\n * - `sizeInBytes`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n }\n /**\n * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters.\n *\n * The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information.\n *\n * If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder.\n * @public\n * @param options - Options to specify which folders to search.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function searchFiles(options?: SearchFilesOptions): Promise;\n interface SearchFilesOptions {\n /**\n * Term to search for. Possible terms include the value of a file's\n * `displayName`, `mimeType`, and `label`.
      \n * For example, if a file's label is cat, the search term is 'cat'.\n */\n search?: string | null;\n /**\n * A root folder in the media manager to search in.\n *\n * Default: `MEDIA_ROOT`.\n */\n rootFolder?: RootFolder;\n /** Media file type. */\n mediaTypes?: MediaType[];\n /**\n * Whether the link to the imported file is public or private.\n *\n * Default: `false`.\n */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:\n *\n * - `displayName`\n * - `_updatedDate`\n * - `sizeInBytes`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n }\n /**\n * Generates a URL for streaming a specific video file in the Media Manager.\n *\n *\n * The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key.\n *\n * To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality.\n * @public\n * @requiredField fileId\n * @param options - Options to use when generating a video file's streaming URL.\n * @param fileId - File ID.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise;\n interface GenerateVideoStreamingUrlOptions {\n /** Video stream format. */\n format?: StreamFormat;\n }\n /**\n * Deletes the specified files from the Media Manager.\n *\n *\n * The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted.\n *\n * The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass the `permanent` parameter with the value `true`. Permanently deleting files isn't reversible, so make sure that these files aren't being used in a site or in any other way as the files will no longer be accessible.\n *\n * >**Notes:**\n * > - The specified files can be from different folders.\n * > - Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.\n * > - Attempting to delete files that are already in the trash bin doesn't result in an error.\n * > - If your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin).\n * > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin.\n * @public\n * @requiredField fileIds\n * @param options - Options to use when deleting files.\n * @param fileIds - IDs of the files to move to the Media Manager's trash bin.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteFiles(fileIds: string[], options?: BulkDeleteFilesOptions): Promise;\n interface BulkDeleteFilesOptions {\n /**\n * Whether the specified files are permanently deleted.
      \n * Default: `false`\n */\n permanent?: boolean;\n }\n /**\n * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.\n *\n * The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored.\n * @public\n * @requiredField fileIds\n * @param fileIds - IDs of the files to restore from the Media Manager's trash bin.\n *\n * You can also pass the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more in the File and Folder IDs article.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise;\n /**\n * Retrieves a list of files in the Media Manager's trash bin.\n *\n * The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information.\n *\n * >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files.\n *\n * To retrieve a list of non-deleted files, use the `listFiles()` function.\n * @public\n * @param options - Options to use when listing deleted files from the trash bin.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER\n * @permissionScope Manage Media Manager\n * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function listDeletedFiles(options?: ListDeletedFilesOptions): Promise;\n interface ListDeletedFilesOptions {\n /**\n * ID of the file's parent folder.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Media file type. */\n mediaTypes?: MediaType[];\n /** Whether the link to the imported file is public or private. */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:\n *\n * - `displayName`\n * - `_updatedDate`\n * - `sizeInBytes`\n *\n * Default: `_updatedDate` in `\"DESC\"` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n }\n interface UpdateFileOptions {\n /** File name that appears in the Media Manager. */\n displayName?: string | null;\n /**\n * ID of the file's parent folder.
      \n * Default: `media-root`.\n */\n parentFolderId?: string | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n }\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_FileDescriptor = FileDescriptor;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_MediaType = MediaType;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_MediaType: typeof MediaType;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_FileMedia = FileMedia;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_FileMediaMediaOneOf = FileMediaMediaOneOf;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ImageMedia = ImageMedia;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Colors = Colors;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Color = Color;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ColorRGB = ColorRGB;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_FaceRecognition = FaceRecognition;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_VideoResolution = VideoResolution;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_AudioV2 = AudioV2;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Archive = Archive;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Model3D = Model3D;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_OtherMedia = OtherMedia;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_OperationStatus = OperationStatus;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_OperationStatus: typeof OperationStatus;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_State = State;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_State: typeof State;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Namespace = Namespace;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_Namespace: typeof Namespace;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentityInfo = IdentityInfo;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentityType = IdentityType;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentityType: typeof IdentityType;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_FileReady = FileReady;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ExternalInfo = ExternalInfo;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_FileFailed = FileFailed;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFilesDownloadUrlRequest = GenerateFilesDownloadUrlRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFilesDownloadUrlResponse = GenerateFilesDownloadUrlResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileDownloadUrlRequest = GenerateFileDownloadUrlRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ContentDisposition = ContentDisposition;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_ContentDisposition: typeof ContentDisposition;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileDownloadUrlResponse = GenerateFileDownloadUrlResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_DownloadUrl = DownloadUrl;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorRequest = GetFileDescriptorRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorResponse = GetFileDescriptorResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorsRequest = GetFileDescriptorsRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorsResponse = GetFileDescriptorsResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileDescriptorRequest = UpdateFileDescriptorRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileDescriptorResponse = UpdateFileDescriptorResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileUploadUrlRequest = GenerateFileUploadUrlRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileUploadUrlResponse = GenerateFileUploadUrlResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileResumableUploadUrlRequest = GenerateFileResumableUploadUrlRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UploadProtocol = UploadProtocol;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_UploadProtocol: typeof UploadProtocol;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileResumableUploadUrlResponse = GenerateFileResumableUploadUrlResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ImportFileRequest = ImportFileRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ImportFileResponse = ImportFileResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFilesRequest = BulkImportFilesRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFilesResponse = BulkImportFilesResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileRequest = BulkImportFileRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileResponse = BulkImportFileResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileResult = BulkImportFileResult;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ItemMetadata = ItemMetadata;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ApplicationError = ApplicationError;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkActionMetadata = BulkActionMetadata;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ListFilesRequest = ListFilesRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Sorting = Sorting;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_SortOrder = SortOrder;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_SortOrder: typeof SortOrder;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_CursorPaging = CursorPaging;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ListFilesResponse = ListFilesResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_Cursors = Cursors;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_SearchFilesRequest = SearchFilesRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_RootFolder = RootFolder;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_RootFolder: typeof RootFolder;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_SearchFilesResponse = SearchFilesResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateVideoStreamingUrlRequest = GenerateVideoStreamingUrlRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_StreamFormat = StreamFormat;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_StreamFormat: typeof StreamFormat;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateVideoStreamingUrlResponse = GenerateVideoStreamingUrlResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateWebSocketTokenRequest = GenerateWebSocketTokenRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateWebSocketTokenResponse = GenerateWebSocketTokenResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkDeleteFilesRequest = BulkDeleteFilesRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkDeleteFilesResponse = BulkDeleteFilesResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkRestoreFilesFromTrashBinRequest = BulkRestoreFilesFromTrashBinRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkRestoreFilesFromTrashBinResponse = BulkRestoreFilesFromTrashBinResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ListDeletedFilesRequest = ListDeletedFilesRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ListDeletedFilesResponse = ListDeletedFilesResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileRequest = UpdateFileRequest;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileResponse = UpdateFileResponse;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_DomainEvent = DomainEvent;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_RestoreInfo = RestoreInfo;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ActionEvent = ActionEvent;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_MessageEnvelope = MessageEnvelope;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentificationData = IdentificationData;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_WebhookIdentityType = WebhookIdentityType;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFilesDownloadUrl: typeof generateFilesDownloadUrl;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFileDownloadUrl: typeof generateFileDownloadUrl;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileDownloadUrlOptions = GenerateFileDownloadUrlOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_getFileDescriptor: typeof getFileDescriptor;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_getFileDescriptors: typeof getFileDescriptors;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_updateFileDescriptor: typeof updateFileDescriptor;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileDescriptorOptions = UpdateFileDescriptorOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFileUploadUrl: typeof generateFileUploadUrl;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileUploadUrlOptions = GenerateFileUploadUrlOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFileResumableUploadUrl: typeof generateFileResumableUploadUrl;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileResumableUploadUrlOptions = GenerateFileResumableUploadUrlOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_importFile: typeof importFile;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ImportFileOptions = ImportFileOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkImportFiles: typeof bulkImportFiles;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkImportFile: typeof bulkImportFile;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileOptions = BulkImportFileOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_listFiles: typeof listFiles;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ListFilesOptions = ListFilesOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_searchFiles: typeof searchFiles;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_SearchFilesOptions = SearchFilesOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_generateVideoStreamingUrl: typeof generateVideoStreamingUrl;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateVideoStreamingUrlOptions = GenerateVideoStreamingUrlOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkDeleteFiles: typeof bulkDeleteFiles;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkDeleteFilesOptions = BulkDeleteFilesOptions;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkRestoreFilesFromTrashBin: typeof bulkRestoreFilesFromTrashBin;\n const mediaSiteMediaV1FileDescriptorFiles_universal_d_listDeletedFiles: typeof listDeletedFiles;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_ListDeletedFilesOptions = ListDeletedFilesOptions;\n type mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileOptions = UpdateFileOptions;\n namespace mediaSiteMediaV1FileDescriptorFiles_universal_d {\n export { mediaSiteMediaV1FileDescriptorFiles_universal_d_FileDescriptor as FileDescriptor, mediaSiteMediaV1FileDescriptorFiles_universal_d_MediaType as MediaType, mediaSiteMediaV1FileDescriptorFiles_universal_d_FileMedia as FileMedia, mediaSiteMediaV1FileDescriptorFiles_universal_d_FileMediaMediaOneOf as FileMediaMediaOneOf, mediaSiteMediaV1FileDescriptorFiles_universal_d_ImageMedia as ImageMedia, mediaSiteMediaV1FileDescriptorFiles_universal_d_Colors as Colors, mediaSiteMediaV1FileDescriptorFiles_universal_d_Color as Color, mediaSiteMediaV1FileDescriptorFiles_universal_d_ColorRGB as ColorRGB, mediaSiteMediaV1FileDescriptorFiles_universal_d_FaceRecognition as FaceRecognition, mediaSiteMediaV1FileDescriptorFiles_universal_d_VideoResolution as VideoResolution, mediaSiteMediaV1FileDescriptorFiles_universal_d_AudioV2 as AudioV2, mediaSiteMediaV1FileDescriptorFiles_universal_d_Archive as Archive, mediaSiteMediaV1FileDescriptorFiles_universal_d_Model3D as Model3D, mediaSiteMediaV1FileDescriptorFiles_universal_d_OtherMedia as OtherMedia, mediaSiteMediaV1FileDescriptorFiles_universal_d_OperationStatus as OperationStatus, mediaSiteMediaV1FileDescriptorFiles_universal_d_State as State, mediaSiteMediaV1FileDescriptorFiles_universal_d_Namespace as Namespace, mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentityInfo as IdentityInfo, mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentityType as IdentityType, mediaSiteMediaV1FileDescriptorFiles_universal_d_FileReady as FileReady, mediaSiteMediaV1FileDescriptorFiles_universal_d_ExternalInfo as ExternalInfo, mediaSiteMediaV1FileDescriptorFiles_universal_d_FileFailed as FileFailed, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFilesDownloadUrlRequest as GenerateFilesDownloadUrlRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFilesDownloadUrlResponse as GenerateFilesDownloadUrlResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileDownloadUrlRequest as GenerateFileDownloadUrlRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_ContentDisposition as ContentDisposition, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileDownloadUrlResponse as GenerateFileDownloadUrlResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_DownloadUrl as DownloadUrl, mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorRequest as GetFileDescriptorRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorResponse as GetFileDescriptorResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorsRequest as GetFileDescriptorsRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_GetFileDescriptorsResponse as GetFileDescriptorsResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileDescriptorRequest as UpdateFileDescriptorRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileDescriptorResponse as UpdateFileDescriptorResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileUploadUrlRequest as GenerateFileUploadUrlRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileUploadUrlResponse as GenerateFileUploadUrlResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileResumableUploadUrlRequest as GenerateFileResumableUploadUrlRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_UploadProtocol as UploadProtocol, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileResumableUploadUrlResponse as GenerateFileResumableUploadUrlResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_ImportFileRequest as ImportFileRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_ImportFileResponse as ImportFileResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFilesRequest as BulkImportFilesRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFilesResponse as BulkImportFilesResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileRequest as BulkImportFileRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileResponse as BulkImportFileResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileResult as BulkImportFileResult, mediaSiteMediaV1FileDescriptorFiles_universal_d_ItemMetadata as ItemMetadata, mediaSiteMediaV1FileDescriptorFiles_universal_d_ApplicationError as ApplicationError, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkActionMetadata as BulkActionMetadata, mediaSiteMediaV1FileDescriptorFiles_universal_d_ListFilesRequest as ListFilesRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_Sorting as Sorting, mediaSiteMediaV1FileDescriptorFiles_universal_d_SortOrder as SortOrder, mediaSiteMediaV1FileDescriptorFiles_universal_d_CursorPaging as CursorPaging, mediaSiteMediaV1FileDescriptorFiles_universal_d_ListFilesResponse as ListFilesResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_PagingMetadataV2 as PagingMetadataV2, mediaSiteMediaV1FileDescriptorFiles_universal_d_Cursors as Cursors, mediaSiteMediaV1FileDescriptorFiles_universal_d_SearchFilesRequest as SearchFilesRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_RootFolder as RootFolder, mediaSiteMediaV1FileDescriptorFiles_universal_d_SearchFilesResponse as SearchFilesResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateVideoStreamingUrlRequest as GenerateVideoStreamingUrlRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_StreamFormat as StreamFormat, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateVideoStreamingUrlResponse as GenerateVideoStreamingUrlResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateWebSocketTokenRequest as GenerateWebSocketTokenRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateWebSocketTokenResponse as GenerateWebSocketTokenResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkDeleteFilesRequest as BulkDeleteFilesRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkDeleteFilesResponse as BulkDeleteFilesResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkRestoreFilesFromTrashBinRequest as BulkRestoreFilesFromTrashBinRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkRestoreFilesFromTrashBinResponse as BulkRestoreFilesFromTrashBinResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_ListDeletedFilesRequest as ListDeletedFilesRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_ListDeletedFilesResponse as ListDeletedFilesResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileRequest as UpdateFileRequest, mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileResponse as UpdateFileResponse, mediaSiteMediaV1FileDescriptorFiles_universal_d_DomainEvent as DomainEvent, mediaSiteMediaV1FileDescriptorFiles_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, mediaSiteMediaV1FileDescriptorFiles_universal_d_EntityCreatedEvent as EntityCreatedEvent, mediaSiteMediaV1FileDescriptorFiles_universal_d_RestoreInfo as RestoreInfo, mediaSiteMediaV1FileDescriptorFiles_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, mediaSiteMediaV1FileDescriptorFiles_universal_d_EntityDeletedEvent as EntityDeletedEvent, mediaSiteMediaV1FileDescriptorFiles_universal_d_ActionEvent as ActionEvent, mediaSiteMediaV1FileDescriptorFiles_universal_d_MessageEnvelope as MessageEnvelope, mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentificationData as IdentificationData, mediaSiteMediaV1FileDescriptorFiles_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, mediaSiteMediaV1FileDescriptorFiles_universal_d_WebhookIdentityType as WebhookIdentityType, mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFilesDownloadUrl as generateFilesDownloadUrl, mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFileDownloadUrl as generateFileDownloadUrl, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileDownloadUrlOptions as GenerateFileDownloadUrlOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_getFileDescriptor as getFileDescriptor, mediaSiteMediaV1FileDescriptorFiles_universal_d_getFileDescriptors as getFileDescriptors, mediaSiteMediaV1FileDescriptorFiles_universal_d_updateFileDescriptor as updateFileDescriptor, mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileDescriptorOptions as UpdateFileDescriptorOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFileUploadUrl as generateFileUploadUrl, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileUploadUrlOptions as GenerateFileUploadUrlOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_generateFileResumableUploadUrl as generateFileResumableUploadUrl, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateFileResumableUploadUrlOptions as GenerateFileResumableUploadUrlOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_importFile as importFile, mediaSiteMediaV1FileDescriptorFiles_universal_d_ImportFileOptions as ImportFileOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkImportFiles as bulkImportFiles, mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkImportFile as bulkImportFile, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkImportFileOptions as BulkImportFileOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_listFiles as listFiles, mediaSiteMediaV1FileDescriptorFiles_universal_d_ListFilesOptions as ListFilesOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_searchFiles as searchFiles, mediaSiteMediaV1FileDescriptorFiles_universal_d_SearchFilesOptions as SearchFilesOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_generateVideoStreamingUrl as generateVideoStreamingUrl, mediaSiteMediaV1FileDescriptorFiles_universal_d_GenerateVideoStreamingUrlOptions as GenerateVideoStreamingUrlOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkDeleteFiles as bulkDeleteFiles, mediaSiteMediaV1FileDescriptorFiles_universal_d_BulkDeleteFilesOptions as BulkDeleteFilesOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_bulkRestoreFilesFromTrashBin as bulkRestoreFilesFromTrashBin, mediaSiteMediaV1FileDescriptorFiles_universal_d_listDeletedFiles as listDeletedFiles, mediaSiteMediaV1FileDescriptorFiles_universal_d_ListDeletedFilesOptions as ListDeletedFilesOptions, mediaSiteMediaV1FileDescriptorFiles_universal_d_UpdateFileOptions as UpdateFileOptions, };\n }\n export { mediaSiteMediaV1FileDescriptorFiles_universal_d as files, mediaSiteMediaV1FolderFolders_universal_d as folders };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-authentication-management.v2.d.ts", "content": "declare module \"wix-authentication-management.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */\n interface OAuthApp {\n /**\n * ID of the OAuth app.\n * @readonly\n */\n _id?: string | null;\n /**\n * Date and time the OAuth app was created, in ISO 8601 format.\n * @readonly\n */\n _createdDate?: Date;\n /** Display name of the OAuth app, as it appears in the dashboard. */\n name?: string | null;\n /** Description of the OAuth app, as it appears in the dashboard. */\n description?: string | null;\n /**\n * Client secret for the OAuth app. **Note:** This is returned only when the OAuth app is created. It can't be retrieved later.\n * @readonly\n */\n secret?: string | null;\n /** External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate. */\n loginUrl?: string | null;\n /**\n * List of URIs to which redirection from Wix is allowed after authentication.\n *\n * When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated.\n * Wix only redirects the user if the exact URI is contained in this array.\n */\n allowedRedirectUris?: string[];\n /**\n * List of domains to which redirection from Wix is allowed after processes other than authentication.\n *\n * When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to.\n * Wix only redirects the user if the URL is in one of the specified domains.\n */\n allowedRedirectDomains?: string[];\n }\n interface CreateOAuthAppRequest {\n /** OAuth app to create. */\n oAuthApp: OAuthApp;\n }\n interface CreateOAuthAppResponse {\n /** Created OAuth app info. */\n oAuthApp?: OAuthApp;\n }\n interface GetOAuthAppRequest {\n /** ID of the OAuth app to retrieve. */\n oAuthAppId: string;\n }\n interface GetOAuthAppResponse {\n /** Retrieved OAuth app info. */\n oAuthApp?: OAuthApp;\n }\n interface UpdateOAuthAppRequest {\n /** Updated OAuth app details. May include some or all fields. */\n oAuthApp: OAuthApp;\n /** Explicit list of fields to update. Only fields listed are updated. */\n mask: string[];\n }\n interface UpdateOAuthAppResponse {\n /** Updated OAuth app info. */\n oAuthApp?: OAuthApp;\n }\n interface DeleteOAuthAppRequest {\n /** ID of the OAuth app to delete. */\n oAuthAppId: string;\n }\n interface DeleteOAuthAppResponse {\n }\n interface QueryOAuthAppsRequest {\n /** Query options. */\n query?: PlatformQuery;\n }\n interface PlatformQuery extends PlatformQueryPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"name\",\"order\":\"ASC\"},{\"fieldName\":\"created_date\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryOAuthAppsResponse {\n /** List of OAuth apps matching the query. */\n oAuthApps?: OAuthApp[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n /**\n * Creates a new OAuth app for a Wix Headless client.\n *\n *\n * An OAuth app authorizes an external client app or site, on any platform, to authenticate with a Wix site or project and manage its data.\n *\n * > **Note:** The OAuth app secret is returned only when creating the OAuth app, and can't be retrieved later. Store the secret in a secure location.\n * @param oAuthApp - OAuth app to create.\n * @public\n * @documentationMaturity preview\n * @requiredField oAuthApp\n * @requiredField oAuthApp.name\n * @returns Created OAuth app info.\n */\n function createOAuthApp(oAuthApp: OAuthApp): Promise;\n /**\n * Retrieves an OAuth app by ID.\n * @param oAuthAppId - ID of the OAuth app to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField oAuthAppId\n * @returns Retrieved OAuth app info.\n */\n function getOAuthApp(oAuthAppId: string): Promise;\n /**\n * Updates an OAuth app.\n *\n *\n * Only fields provided in `mask` are updated.\n *\n * You can update the following fields:\n * + `name`\n * + `description`\n * + `allowedDomain`\n * + `loginUrl`\n * @param _id - ID of the OAuth app.\n * @param mask - Explicit list of fields to update. Only fields listed are updated.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField mask\n * @requiredField oAuthApp\n * @returns Updated OAuth app info.\n */\n function updateOAuthApp(_id: string | null, oAuthApp: UpdateOAuthApp, mask: string[]): Promise;\n interface UpdateOAuthApp {\n /**\n * ID of the OAuth app.\n * @readonly\n */\n _id?: string | null;\n /**\n * Date and time the OAuth app was created, in ISO 8601 format.\n * @readonly\n */\n _createdDate?: Date;\n /** Display name of the OAuth app, as it appears in the dashboard. */\n name?: string | null;\n /** Description of the OAuth app, as it appears in the dashboard. */\n description?: string | null;\n /**\n * Client secret for the OAuth app. **Note:** This is returned only when the OAuth app is created. It can't be retrieved later.\n * @readonly\n */\n secret?: string | null;\n /** External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate. */\n loginUrl?: string | null;\n /**\n * List of URIs to which redirection from Wix is allowed after authentication.\n *\n * When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated.\n * Wix only redirects the user if the exact URI is contained in this array.\n */\n allowedRedirectUris?: string[];\n /**\n * List of domains to which redirection from Wix is allowed after processes other than authentication.\n *\n * When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to.\n * Wix only redirects the user if the URL is in one of the specified domains.\n */\n allowedRedirectDomains?: string[];\n }\n /**\n * Retrieves a list of OAuth apps, given the provided paging, filtering, and sorting.\n *\n *\n * Query OAuth Apps runs with these defaults, which you can override:\n * + Results are sorted by `id` in descending order.\n * + `paging.offset` is `0`.\n * @public\n * @documentationMaturity preview\n */\n function queryOAuthApps(): OAuthAppsQueryBuilder;\n interface QueryOffsetResult {\n currentPage: number;\n totalPages: number;\n totalCount: number;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OAuthAppsQueryResult extends QueryOffsetResult {\n items: OAuthApp[];\n query: OAuthAppsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface OAuthAppsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\", value: any) => OAuthAppsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_createdDate\" | \"name\">) => OAuthAppsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_createdDate\" | \"name\">) => OAuthAppsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => OAuthAppsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => OAuthAppsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n const headlessV1OAuthApp_universal_d___debug: typeof __debug;\n type headlessV1OAuthApp_universal_d_OAuthApp = OAuthApp;\n type headlessV1OAuthApp_universal_d_CreateOAuthAppRequest = CreateOAuthAppRequest;\n type headlessV1OAuthApp_universal_d_CreateOAuthAppResponse = CreateOAuthAppResponse;\n type headlessV1OAuthApp_universal_d_GetOAuthAppRequest = GetOAuthAppRequest;\n type headlessV1OAuthApp_universal_d_GetOAuthAppResponse = GetOAuthAppResponse;\n type headlessV1OAuthApp_universal_d_UpdateOAuthAppRequest = UpdateOAuthAppRequest;\n type headlessV1OAuthApp_universal_d_UpdateOAuthAppResponse = UpdateOAuthAppResponse;\n type headlessV1OAuthApp_universal_d_DeleteOAuthAppRequest = DeleteOAuthAppRequest;\n type headlessV1OAuthApp_universal_d_DeleteOAuthAppResponse = DeleteOAuthAppResponse;\n type headlessV1OAuthApp_universal_d_QueryOAuthAppsRequest = QueryOAuthAppsRequest;\n type headlessV1OAuthApp_universal_d_PlatformQuery = PlatformQuery;\n type headlessV1OAuthApp_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type headlessV1OAuthApp_universal_d_Sorting = Sorting;\n type headlessV1OAuthApp_universal_d_SortOrder = SortOrder;\n const headlessV1OAuthApp_universal_d_SortOrder: typeof SortOrder;\n type headlessV1OAuthApp_universal_d_Paging = Paging;\n type headlessV1OAuthApp_universal_d_CursorPaging = CursorPaging;\n type headlessV1OAuthApp_universal_d_QueryOAuthAppsResponse = QueryOAuthAppsResponse;\n type headlessV1OAuthApp_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type headlessV1OAuthApp_universal_d_Cursors = Cursors;\n const headlessV1OAuthApp_universal_d_createOAuthApp: typeof createOAuthApp;\n const headlessV1OAuthApp_universal_d_getOAuthApp: typeof getOAuthApp;\n const headlessV1OAuthApp_universal_d_updateOAuthApp: typeof updateOAuthApp;\n type headlessV1OAuthApp_universal_d_UpdateOAuthApp = UpdateOAuthApp;\n const headlessV1OAuthApp_universal_d_queryOAuthApps: typeof queryOAuthApps;\n type headlessV1OAuthApp_universal_d_OAuthAppsQueryResult = OAuthAppsQueryResult;\n type headlessV1OAuthApp_universal_d_OAuthAppsQueryBuilder = OAuthAppsQueryBuilder;\n namespace headlessV1OAuthApp_universal_d {\n export { headlessV1OAuthApp_universal_d___debug as __debug, headlessV1OAuthApp_universal_d_OAuthApp as OAuthApp, headlessV1OAuthApp_universal_d_CreateOAuthAppRequest as CreateOAuthAppRequest, headlessV1OAuthApp_universal_d_CreateOAuthAppResponse as CreateOAuthAppResponse, headlessV1OAuthApp_universal_d_GetOAuthAppRequest as GetOAuthAppRequest, headlessV1OAuthApp_universal_d_GetOAuthAppResponse as GetOAuthAppResponse, headlessV1OAuthApp_universal_d_UpdateOAuthAppRequest as UpdateOAuthAppRequest, headlessV1OAuthApp_universal_d_UpdateOAuthAppResponse as UpdateOAuthAppResponse, headlessV1OAuthApp_universal_d_DeleteOAuthAppRequest as DeleteOAuthAppRequest, headlessV1OAuthApp_universal_d_DeleteOAuthAppResponse as DeleteOAuthAppResponse, headlessV1OAuthApp_universal_d_QueryOAuthAppsRequest as QueryOAuthAppsRequest, headlessV1OAuthApp_universal_d_PlatformQuery as PlatformQuery, headlessV1OAuthApp_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf, headlessV1OAuthApp_universal_d_Sorting as Sorting, headlessV1OAuthApp_universal_d_SortOrder as SortOrder, headlessV1OAuthApp_universal_d_Paging as Paging, headlessV1OAuthApp_universal_d_CursorPaging as CursorPaging, headlessV1OAuthApp_universal_d_QueryOAuthAppsResponse as QueryOAuthAppsResponse, headlessV1OAuthApp_universal_d_PagingMetadataV2 as PagingMetadataV2, headlessV1OAuthApp_universal_d_Cursors as Cursors, headlessV1OAuthApp_universal_d_createOAuthApp as createOAuthApp, headlessV1OAuthApp_universal_d_getOAuthApp as getOAuthApp, headlessV1OAuthApp_universal_d_updateOAuthApp as updateOAuthApp, headlessV1OAuthApp_universal_d_UpdateOAuthApp as UpdateOAuthApp, headlessV1OAuthApp_universal_d_queryOAuthApps as queryOAuthApps, headlessV1OAuthApp_universal_d_OAuthAppsQueryResult as OAuthAppsQueryResult, headlessV1OAuthApp_universal_d_OAuthAppsQueryBuilder as OAuthAppsQueryBuilder, };\n }\n export { headlessV1OAuthApp_universal_d as oAuthApps };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-pricing-plans.v2.d.ts", "content": "declare module \"wix-pricing-plans.v2\" {\n /**\n * An order object includes all of the details related to the purchase of a Pricing Plan.\n * You can manage existing orders, create offline orders, and preview orders not yet purchased.\n *\n * Orders are based on pricing models based on the payment and duration cycles for each plan.\n * Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).\n */\n interface Order {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string;\n /**\n * ID of the plan purchased with the order, from the Plans API.\n * @readonly\n */\n planId?: string;\n /**\n * ID of the related Wix subscription.\n *\n * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. Learn more in\n * a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).\n * @readonly\n */\n subscriptionId?: string;\n /**\n * Wix Pay order ID.\n *\n * Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.\n * @readonly\n */\n wixPayOrderId?: string | null;\n /**\n * The buyer's IDs. Includes `memberId` and `contactId`.\n *\n * Currently, Pricing Plan purchases are limited to members only. `contactId` is returned,\n * but a buyer will not be able to purchase a plan without a `memberId`.\n * @readonly\n */\n buyer?: Buyer;\n /**\n * Order pricing model, price, and payment schedule.\n *\n * Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).\n * @readonly\n */\n pricing?: PricingDetails;\n /**\n * How the order was processed.\n * @readonly\n */\n type?: OrderType;\n /**\n * Status of the order.\n * @readonly\n */\n status?: OrderStatus;\n /**\n * Whether the order will be canceled at the next payment date.\n *\n * If `true`, the order status will be `CANCELED` and the next payment won't be charged. Omitted for single payment orders.\n * @readonly\n */\n autoRenewCanceled?: boolean | null;\n /**\n * Details about the cancellation of an order.\n *\n * Only present if the status is `CANCELED`.\n * @readonly\n */\n cancellation?: Cancellation;\n /**\n * Status of the last payment for the order.\n * Updated automatically for online orders. Updated manually by the Wix user for offline orders.\n * @readonly\n */\n lastPaymentStatus?: PaymentStatus;\n /**\n * Start date and time for the ordered plan.\n * @readonly\n */\n startDate?: Date | null;\n /**\n * Current end date and time for the ordered plan.\n *\n * `endDate` may be updated over the course of an order.\n * If the order is paused, it will have a later `endDate` once it is resumed.\n * `endDate` may also be postponed.\n *\n * Omitted if the order is valid until canceled and still `ACTIVE`.\n * @readonly\n */\n endDate?: Date | null;\n /**\n * List of periods during which the order is paused.\n * @readonly\n */\n pausePeriods?: PausePeriod[];\n /**\n * Free trial period for the order, in days.\n *\n * Only available for recurring plans.\n * @readonly\n */\n freeTrialDays?: number | null;\n /**\n * Earliest end date and time that the plan for the order can expire.\n *\n * Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.\n * @readonly\n */\n earliestEndDate?: Date | null;\n /**\n * Current payment cycle for the order.\n *\n * `currentCycle` will be omitted if the order's status is `CANCELED` or `ENDED`, or if the `startDate` hasn't passed yet.\n * @readonly\n */\n currentCycle?: CurrentCycle;\n /**\n * Plan name at the time of purchase.\n * @readonly\n */\n planName?: string;\n /**\n * Plan description at the time of purchase\n * @readonly\n */\n planDescription?: string;\n /**\n * Plan price as it was at the moment of order creation.\n * @readonly\n */\n planPrice?: string;\n /**\n * Date and time the order was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the order was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Information about the form submitted during the plan's checkout.\n * @readonly\n */\n formData?: FormData;\n }\n interface Buyer {\n /**\n * Member ID for a Wix site member, from the Members API.\n * @readonly\n */\n memberId?: string;\n /**\n * Contact ID for a Wix site contact, from the Contacts API.\n * @readonly\n */\n contactId?: string;\n }\n interface PriceDetails extends PriceDetailsPricingModelOneOf {\n /** Order has recurring payments. */\n subscription?: Recurrence$1;\n /** One-time payment. Order is valid for a specified duration. */\n singlePaymentForDuration?: Duration$1;\n /** One-time payment. Order is valid until it is canceled. */\n singlePaymentUnlimited?: boolean | null;\n /** Price of the order excluding tax, specified as a monetary amount. for example, `\"9.99\"`. */\n subtotal?: string;\n /** Total discount applied. */\n discount?: string;\n /** Tax applied. */\n tax?: Tax;\n /**\n * Price after tax and discount is applied, specified as a monetary amount. For example, `\"13.98\"`.\n *\n * If no tax is applied, the amount is the same as `subtotal`.\n */\n total?: string;\n /** Plan price as it was at the moment of order creation. */\n planPrice?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Free trial period for the order in days. Only available for recurring plans. */\n freeTrialDays?: number | null;\n /** Coupon applied to the order. Empty means no coupon was applied. */\n coupon?: Coupon;\n }\n /** @oneof */\n interface PriceDetailsPricingModelOneOf {\n /** Order has recurring payments. */\n subscription?: Recurrence$1;\n /** One-time payment. Order is valid for a specified duration. */\n singlePaymentForDuration?: Duration$1;\n /** One-time payment. Order is valid until it is canceled. */\n singlePaymentUnlimited?: boolean | null;\n }\n interface Tax {\n /** Name of the tax. For example, VAT. */\n name?: string;\n /** Whether tax is included in the original price. When `false`, tax is added at checkout. */\n includedInPrice?: boolean;\n /** Tax rate percentage, as a number between 0 and 100. For example, a 7% tax rate is `\"7.00\"`. */\n rate?: string;\n /** Total tax, specified as a monetary amount. For example, `\"3.99\"`. */\n amount?: string;\n }\n /** An object specifying how often and for how long payments recur (may be forever). */\n interface Recurrence$1 {\n /**\n * Number of payment cycles the subscription is valid for.\n * `0` for unlimited plans or for plans that are valid until canceled.\n */\n cycleDuration?: Duration$1;\n /**\n * Length of a payment cycle. For example, 1 month to have monthly payments.\n * Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration.\n * Currently, only a value of `1` is supported.\n */\n cycleCount?: number | null;\n }\n /** A duration expressed in number of time units. */\n interface Duration$1 {\n /** Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`. */\n count?: number | null;\n /** Unit of time for the cycle duration. */\n unit?: PeriodUnit$1;\n }\n enum PeriodUnit$1 {\n /** Not defined. */\n UNDEFINED = \"UNDEFINED\",\n /** Time unit is a day. */\n DAY = \"DAY\",\n /** Time unit is a week. */\n WEEK = \"WEEK\",\n /** Time unit is a month. */\n MONTH = \"MONTH\",\n /** Time unit is a year. */\n YEAR = \"YEAR\"\n }\n interface Coupon {\n /** Code of the applied coupon. */\n code?: string;\n /** Total discount of the coupon, as a monetary amount. */\n amount?: string;\n /**\n * Coupon ID.\n * @readonly\n */\n _id?: string;\n }\n interface PricingDetails extends PricingDetailsPricingModelOneOf {\n /** Pricing model for an order with recurring payment cycles. */\n subscription?: Recurrence$1;\n /** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */\n singlePaymentForDuration?: Duration$1;\n /** Pricing model for an order with a one-time payment and the order is valid until canceled. */\n singlePaymentUnlimited?: boolean | null;\n /**\n * Pricing details for all pricing models.\n * @readonly\n */\n prices?: SpannedPrice[];\n }\n /** @oneof */\n interface PricingDetailsPricingModelOneOf {\n /** Pricing model for an order with recurring payment cycles. */\n subscription?: Recurrence$1;\n /** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */\n singlePaymentForDuration?: Duration$1;\n /** Pricing model for an order with a one-time payment and the order is valid until canceled. */\n singlePaymentUnlimited?: boolean | null;\n }\n interface SpannedPrice {\n /**\n * Cycle duration to apply `price` for.\n *\n * Use with all pricing models.\n * Can apply the same price to multiple payment cycles.\n */\n duration?: PriceDuration;\n /** Order price. */\n price?: Price;\n }\n interface PriceDuration {\n /**\n * Price starts to apply with this cycle.\n *\n * `1` is the first payment cycle for all pricing models.\n */\n cycleFrom?: number;\n /**\n * Amount of cycles to apply price for.\n *\n * For `subscription` pricing models with a finite number of cycles, the `numberOfCycles` is the same as `pricing.subscription.cycleCount`.\n *\n * For `subscription` pricing models that are unlimited or until-canceled, the `numberOfCycles` is not returned.\n *\n * For `singlePaymentForDuration` and `singlePaymentUnlimited` pricing models, the `numberOfCycles` is `1`.\n */\n numberOfCycles?: number | null;\n }\n interface Price {\n /** Price of the order excluding tax, specified as a monetary amount. For example, `\"9.99\"`. */\n subtotal?: string;\n /** Coupon applied to the order, from the Coupons API. */\n coupon?: Coupon;\n /** Total discount applied to the order. */\n discount?: string;\n /**\n * Tax applied to the order.\n *\n * Tax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n */\n tax?: Tax;\n /**\n * Price after tax and discount is applied. Specified as a monetary amount, for example, `\"13.98\"`.\n *\n * If no tax is applied, the amount is the same as `subtotal`.\n */\n total?: string;\n /**\n * Three-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency?: string;\n /** Price change after billing date was change and price was adjusted. Could be positive and negative values. */\n proration?: string;\n }\n interface Fee$1 {\n /** Fee name */\n name?: string;\n /** Amount of fee to be charged */\n amount?: string;\n }\n enum OrderType {\n /** Undefined order type. */\n UNDEFINED = \"UNDEFINED\",\n /** The buyer purchased the plan using the site. */\n ONLINE = \"ONLINE\",\n /** The buyer made a manual, offline purchase without using the site. */\n OFFLINE = \"OFFLINE\",\n /** The buyer made a purchase through an external payment provider. */\n EXTERNAL = \"EXTERNAL\"\n }\n enum OrderMethod {\n /** Unknown order method. */\n UNKNOWN = \"UNKNOWN\",\n /** Mail Order / Telephone Order transaction. */\n MOTO = \"MOTO\",\n /** Point of Sale transaction. */\n POS = \"POS\"\n }\n enum OrderStatus {\n /** Undefined order status. */\n UNDEFINED = \"UNDEFINED\",\n /** Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer. */\n DRAFT = \"DRAFT\",\n /** Order has been purchased and its start date is set in the future. */\n PENDING = \"PENDING\",\n /** Order has been processed. The plan is available for use. */\n ACTIVE = \"ACTIVE\",\n /** Order, and use of the plan, is paused. The order, and use of the plan, can be resumed. */\n PAUSED = \"PAUSED\",\n /** Order has completed its duration and is no longer available for use. */\n ENDED = \"ENDED\",\n /** Order has been canceled. */\n CANCELED = \"CANCELED\"\n }\n interface Cancellation {\n /** Date and time the cancellation was requested. */\n requestedDate?: Date | null;\n /** Reason for the cancellation. */\n cause?: CancellationCause;\n /** When the cancellation takes effect. Set when cancelling the order. */\n effectiveAt?: CancellationEffectiveAt;\n }\n enum CancellationCause {\n /** Undefined cancellation cause. */\n UNDEFINED = \"UNDEFINED\",\n /** Wix user canceled the order. */\n OWNER_ACTION = \"OWNER_ACTION\",\n /** Buyer initiated the cancellation. */\n MEMBER_ACTION = \"MEMBER_ACTION\",\n /** Payment transaction failed. */\n PAYMENT_FAILURE = \"PAYMENT_FAILURE\",\n /** Buyer's payment details weren't set up correctly. */\n PAYMENT_SETUP_FAILURE = \"PAYMENT_SETUP_FAILURE\",\n /** Reason for the cancellation is unknown. */\n UNKNOWN = \"UNKNOWN\"\n }\n enum CancellationEffectiveAt {\n /** Undefined cancellation time. */\n UNDEFINED = \"UNDEFINED\",\n /** Cancellation occurs immediately and the buyer can no longer use the plan. */\n IMMEDIATELY = \"IMMEDIATELY\",\n /** Cancellation occurs at the next payment date and time. Buyer can continue to use the plan until that date and time. */\n NEXT_PAYMENT_DATE = \"NEXT_PAYMENT_DATE\"\n }\n enum PaymentStatus {\n /** Undefined payment status. */\n UNDEFINED = \"UNDEFINED\",\n /** Payment has been paid. */\n PAID = \"PAID\",\n /** Payment has been refunded. */\n REFUNDED = \"REFUNDED\",\n /** Payment transaction didn't complete. */\n FAILED = \"FAILED\",\n /** Payment has not been paid. */\n UNPAID = \"UNPAID\",\n /** Billing has been initialized, but actual charge is yet to be made. This can happen for free trials and payments made with PayPal. */\n PENDING = \"PENDING\",\n /** No payment was necessary. For example, for free plans or free trials. */\n NOT_APPLICABLE = \"NOT_APPLICABLE\"\n }\n interface PausePeriod {\n /** Status of the pause period. */\n status?: Status;\n /** Start date and time of the pause period. */\n pauseDate?: Date | null;\n /**\n * End date and time of the pause period.\n *\n * Omitted while the pause period remains `ACTIVE`.\n */\n resumeDate?: Date | null;\n }\n enum Status {\n /** Undefined status. */\n UNDEFINED = \"UNDEFINED\",\n /** Status while the order is paused. */\n ACTIVE = \"ACTIVE\",\n /** Status when the order is resumed. */\n ENDED = \"ENDED\"\n }\n /**\n * Current cycle will be empty when order is cancelled, expired or order start date is in the future\n * Current cycle start and end dates take into account free trial days and suspensions\n */\n interface CurrentCycle {\n /**\n * Index of the current payment cycle in the order.\n *\n * `0` when order is in a free trial period. In all other cases, the index starts with `1`.\n */\n index?: number;\n /** Start date and time for the current payment cycle. */\n startedDate?: Date | null;\n /** End date and time for the current payment cycle. */\n endedDate?: Date | null;\n }\n /** Order cycle start and end dates take into account free trial days and suspensions */\n interface OrderCycle {\n /**\n * Index of this cycle in the order.\n *\n * `0` when order is in a free trial period. In all other cases, the index starts with `1`.\n */\n index?: number;\n /** Start date and time for this order cycle. */\n startedDate?: Date | null;\n /** End date and time for this order cycle. */\n endedDate?: Date | null;\n }\n interface FormData {\n /** ID of the order form ([REST](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction)) associated with the plan at checkout. */\n formId?: string | null;\n /** ID of a submission to the plan's order form at checkout. Every time a visitor completes the checkout process for a plan, a new submission is created. */\n submissionId?: string | null;\n /**\n * Data submitted to the plan's order form at checkout.\n * @readonly\n */\n submissionData?: Record;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface MemberGetOrderRequest {\n /** Order ID. */\n _id: string;\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n enum Set {\n /** Same behavior as `BASIC`.` */\n UNKNOWN_SET = \"UNKNOWN_SET\",\n /** Doesn't return any order form submission data. */\n BASIC = \"BASIC\",\n /** Returns all order form submission data. */\n FULL = \"FULL\"\n }\n interface MemberGetOrderResponse {\n /** Requested order. */\n order?: Order;\n }\n interface MemberListOrdersRequest {\n /** Filter by plan IDs. */\n planIds?: string[];\n /** Filter for orders where auto renewal was canceled. */\n autoRenewCanceled?: boolean | null;\n /** Filter by order status. */\n orderStatuses?: OrderStatus[];\n /** Filter by payment status. */\n paymentStatuses?: PaymentStatus[];\n /** Limit the number of pricing plans returned. Default limit is 50. */\n limit?: number | null;\n /** Number of entries to offset. */\n offset?: number | null;\n /** Sorting direction (defaults to ASC) and field to sort by. */\n sorting?: Sorting$1;\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface MemberListOrdersResponse {\n /** Requested orders. */\n orders?: Order[];\n /** Object containing paging-related data (number of orders returned, offset). */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n /**\n * TODO: Write orders filter and sort docs page\n * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.\n */\n interface QueryOrdersRequest {\n /** Query filter. */\n query?: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * Filter object.\n *\n * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).\n */\n sort?: Sorting$1[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryOrdersResponse {\n /** Order data. */\n plans?: Order[];\n /** Paging-related data (number of orders returned, offset). */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface RequestCancellationRequest {\n /** Order ID. */\n _id: string;\n /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */\n effectiveAt: CancellationEffectiveAt;\n }\n interface RequestCancellationResponse {\n }\n /**\n * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal\n *\n * To determine the specific reason of the cancellation check `order.cancellation.cause` field.\n */\n interface OrderCanceled {\n /** Canceled order. */\n order?: Order;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface CreateOnlineOrderRequest {\n /** Plan ID. */\n planId: string;\n /**\n * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Provided if checkout is initiated on buyer's behalf. */\n onBehalf?: OnBehalf;\n /** Submission ID of the form submitted with this order. */\n submissionId?: string | null;\n }\n interface OnBehalf {\n /** Member ID. */\n memberId?: string;\n /** Method by which checkout is initiated. */\n orderMethod?: OrderMethod;\n }\n interface CreateOnlineOrderResponse {\n /** Created online order. */\n order?: Order;\n }\n interface CouponsError {\n /** Coupon code. */\n couponCode?: string;\n /** Plan ID. */\n planId?: string;\n }\n interface CreateGuestOnlineOrderRequest {\n /** Plan ID. */\n planId: string;\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Captcha data to prove you are not a robot */\n captcha: Captcha;\n /** Visitor info */\n guest: Guest;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n interface Captcha {\n /** Token from captcha */\n token?: string;\n }\n interface Guest {\n /** Email for checkout */\n email?: string;\n }\n interface CreateGuestOnlineOrderResponse {\n /** Order. */\n order?: Order;\n }\n interface CreateOfflineOrderRequest {\n /** ID of the plan being ordered, from the Plans API. */\n planId: string;\n /** ID of the member ordering the plan, from the Members API. */\n memberId: string;\n /**\n * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /**\n * Whether the order is paid.\n *\n * Default: `false`\n */\n paid?: boolean | null;\n /** Coupon code to apply, from the Coupons API. */\n couponCode?: string | null;\n /** Form submission ID that was submitted with the order. */\n submissionId?: string | null;\n }\n interface CreateOfflineOrderResponse {\n /** Order. */\n order?: Order;\n }\n interface CreateExternalOrderRequest {\n /** Plan ID. */\n planId: string;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n interface CreateExternalOrderResponse {\n /** Created order */\n order?: Order;\n }\n interface GetOnlineOrderPreviewRequest {\n /** Plan ID. */\n planId: string;\n /**\n * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n interface GetOnlineOrderPreviewResponse {\n /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */\n order?: Order;\n /** Whether the member has already reached purchase limit for the order's plan. */\n purchaseLimitExceeded?: boolean;\n }\n interface GetGuestOnlineOrderPreviewRequest {\n /** Plan ID. */\n planId: string;\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Email for checkout */\n email: string;\n }\n interface GetGuestOnlineOrderPreviewResponse {\n /** Will be missing if limit is exceeded */\n order?: Order;\n /**\n * Whether the purchase limit has already been reached for this plan by this email.\n * Always false for plans without purchase limits.\n */\n purchaseLimitExceeded?: boolean;\n }\n interface GetOfflineOrderPreviewRequest {\n /** ID of the plan of the previewed order, from the Plans API. */\n planId: string;\n /** Member ID of the buyer the previewed order is for, from the Members API. */\n memberId: string;\n /**\n * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /** Coupon code to apply, from the Coupons API. */\n couponCode?: string | null;\n }\n interface GetOfflineOrderPreviewResponse {\n /** The previewed order, as if the plan had been ordered. */\n order?: Order;\n /**\n * Whether this previewed order would exceed the permitted amount of purchases available\n * for this plan for this buyer.\n *\n * Always `false` for plans that do not have purchase limits.\n */\n purchaseLimitExceeded?: boolean;\n }\n interface GetPricePreviewRequest {\n /** ID of plan to preview. */\n planId: string;\n /** Coupon code to apply, from the Coupons API. */\n couponCode?: string | null;\n }\n interface GetPricePreviewResponse {\n /** Pricing details. */\n prices?: SpannedPrice[];\n }\n interface ChangeStartDateRequest {\n /** Draft order ID. */\n orderId: string;\n /** New valid from date (timestamp). */\n startDate: Date | null;\n }\n interface ChangeStartDateResponse {\n /** Updated draft order. */\n order?: Order;\n }\n interface OrderStartDateChanged {\n /** Order whose `startDate` changed. */\n order?: Order;\n }\n interface ApplyCouponRequest {\n /** Draft order ID. */\n orderId: string;\n /** Coupon code to apply. */\n couponCode: string;\n }\n interface ApplyCouponResponse {\n /** Order with applied coupon and recalculated tax. */\n order?: Order;\n }\n interface SetSubmissionRequest {\n /** Order ID. */\n orderId: string;\n /** Submission ID. */\n submissionId: string;\n }\n interface SetSubmissionResponse {\n /** Order with submission id */\n order?: Order;\n }\n interface OrderPurchased {\n /** Order that was paid for. If a free or an offline order, the order that was created. */\n order?: Order;\n }\n interface OrderStarted {\n /** Order that reached its `startDate`. */\n order?: Order;\n }\n /**\n * Triggered at the start of a new payment cycle for an existing order.\n *\n * This webhook does not trigger at the initial start of an offline order.\n */\n interface OrderCycleStarted {\n /** Order whose new cycle started. */\n order?: Order;\n /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */\n cycleNumber?: number;\n }\n /** Emitted when a recurring order is canceled for the next payment cycle */\n interface OrderAutoRenewCanceled {\n /** Order that is canceled, effective at the end of the current payment cycle. */\n order?: Order;\n }\n interface OrderEnded {\n /** Order that ended. */\n order?: Order;\n }\n interface GetOrderRequest {\n /** Order ID. */\n _id: string;\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n interface GetOrderResponse {\n /** Order. */\n order?: Order;\n }\n interface ListOrdersRequest {\n /** Filter by a buyer's member ID, from the Members API. */\n buyerIds?: string[];\n /** Filter by plan IDs, from the Plans API. */\n planIds?: string[];\n /** Filter by whether or not the auto-renewal of recurring orders was canceled. */\n autoRenewCanceled?: boolean | null;\n /** Filter by order status. */\n orderStatuses?: OrderStatus[];\n /** Filter by payment status. */\n paymentStatuses?: PaymentStatus[];\n /**\n * Number of orders to return. See Sorting and Paging for more information.\n *\n * Max: `50`\n */\n limit?: number | null;\n /** Number of orders to skip in the current sort order. */\n offset?: number | null;\n /**\n * Sort order.\n *\n * Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Default: `DESC`.\n */\n sorting?: Sorting$1;\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n interface ListOrdersResponse {\n /** List of orders. */\n orders?: Order[];\n /** Object containing paging-related data (number of orders returned, offset). */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface OrdersQueryOrdersRequest {\n /** Query filter. */\n query?: QueryV2$1;\n }\n interface OrdersQueryOrdersResponse {\n /** Retrieved orders. */\n plans?: Order[];\n /** Paging-related data (number of orders returned, offset). */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface GetOrdersStatsRequest {\n }\n interface GetOrdersStatsResponse {\n /** Total number of orders. */\n totalOrderCount?: number;\n /** Number of active orders. */\n activeOrderCount?: number;\n }\n interface GetAvailableOrderActionsRequest {\n /** Order ID. */\n _id: string;\n }\n interface GetAvailableOrderActionsResponse {\n /** Whether the order can be suspended. */\n suspendable?: boolean;\n /** If the order cannot be suspended, a reason is returned here. */\n notSuspendableReason?: ReasonNotSuspendable;\n /** Whether the order can be canceled by the buyer. */\n cancelableByBuyer?: boolean;\n }\n enum ReasonNotSuspendable {\n /** Undefined reason. */\n UNDEFINED = \"UNDEFINED\",\n /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */\n PENDING = \"PENDING\",\n /** Trial orders can't be suspended. */\n TRIAL = \"TRIAL\",\n /** Canceled orders can't be suspended. */\n CANCELED = \"CANCELED\",\n /** Ended orders can't be suspended. */\n ENDED = \"ENDED\",\n /** Paid for orders with future start dates can't be suspended. */\n NOT_STARTED = \"NOT_STARTED\",\n /** Order is already suspended. */\n ALREADY_SUSPENDED = \"ALREADY_SUSPENDED\",\n /** Orders based on recurring payments using older stripe versions can't be suspended. */\n OLD_STRIPE = \"OLD_STRIPE\"\n }\n interface PostponeEndDateRequest {\n /** Order ID. */\n _id: string;\n /**\n * New end date and time.\n *\n * Must be later than the current end date and time.\n */\n endDate: Date | null;\n }\n interface PostponeEndDateResponse {\n }\n interface OrderEndDatePostponed {\n /** Order whose `endDate` was postponed. */\n order?: Order;\n }\n interface CancelOrderRequest {\n /** Order ID. */\n _id: string;\n /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */\n effectiveAt: CancellationEffectiveAt;\n }\n interface CancelOrderResponse {\n }\n interface MarkAsPaidRequest {\n /** Order ID. */\n _id: string;\n }\n interface MarkAsPaidResponse {\n }\n interface OrderMarkedAsPaid {\n /** Order that was marked as paid. */\n order?: Order;\n }\n interface PauseOrderRequest {\n /** Order ID. */\n _id: string;\n }\n interface PauseOrderResponse {\n }\n interface OrderPaused {\n /** Paused order. */\n order?: Order;\n }\n interface BulkPauseOrderRequest {\n /** List of Order IDs. */\n ids: string[];\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n interface BulkPauseOrderResponse {\n /** Orders that were paused. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkOrderResult {\n /** Item metadata */\n itemMetadata?: ItemMetadata$1;\n /** The order. */\n order?: Order;\n }\n interface ItemMetadata$1 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$1;\n }\n interface ApplicationError$1 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$1 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface ResumeOrderRequest {\n /** Order ID. */\n _id: string;\n }\n interface ResumeOrderResponse {\n }\n interface OrderResumed {\n /** Resumed order. */\n order?: Order;\n }\n interface BulkResumeOrderRequest {\n /** List of Order IDs. */\n ids: string[];\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n interface BulkResumeOrderResponse {\n /** Orders that were resumed. */\n results?: BulkOrderResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n /**\n * Retrieves an order for the currently logged-in member by ID.\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @param options - Options for getting a logged-in member's order.\n * @permissionId PRICING_PLANS.READ_OWN_ORDERS\n * @applicableIdentity MEMBER\n * @returns Requested order.\n * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder\n */\n function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise;\n interface MemberGetOrderOptions {\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n /**\n * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.\n * @public\n * @param options - Filtering, sorting, and pagination options.\n * @permissionId PRICING_PLANS.READ_OWN_ORDERS\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders\n */\n function memberListOrders(options?: MemberListOrdersOptions): Promise;\n interface MemberListOrdersOptions {\n /** Filter by plan IDs. */\n planIds?: string[];\n /** Filter for orders where auto renewal was canceled. */\n autoRenewCanceled?: boolean | null;\n /** Filter by order status. */\n orderStatuses?: OrderStatus[];\n /** Filter by payment status. */\n paymentStatuses?: PaymentStatus[];\n /** Limit the number of pricing plans returned. Default limit is 50. */\n limit?: number | null;\n /** Number of entries to offset. */\n offset?: number | null;\n /** Sorting direction (defaults to ASC) and field to sort by. */\n sorting?: Sorting$1;\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PlansQueryResult$1 extends QueryCursorResult {\n items: Order[];\n query: PlansQueryBuilder$1;\n next: () => Promise;\n prev: () => Promise;\n }\n interface PlansQueryBuilder$1 {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\", value: any) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\", value: any) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.freeTrialDays\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"cancellation.requestedDate\" | \"startDate\" | \"endDate\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.freeTrialDays\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"cancellation.requestedDate\" | \"startDate\" | \"endDate\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.freeTrialDays\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"cancellation.requestedDate\" | \"startDate\" | \"endDate\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.freeTrialDays\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"cancellation.requestedDate\" | \"startDate\" | \"endDate\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax.name\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"formData.formId\" | \"formData.submissionId\", value: string) => PlansQueryBuilder$1;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\", value: any[]) => PlansQueryBuilder$1;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\", value: any) => PlansQueryBuilder$1;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\", value: boolean) => PlansQueryBuilder$1;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"orderMethod\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\" | \"formData.submissionData\" | \"statusNew\">) => PlansQueryBuilder$1;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"planId\" | \"subscriptionId\" | \"wixPayOrderId\" | \"buyer\" | \"buyer.memberId\" | \"buyer.contactId\" | \"priceDetails\" | \"priceDetails.subscription\" | \"priceDetails.subscription.cycleDuration\" | \"priceDetails.subscription.cycleDuration.count\" | \"priceDetails.subscription.cycleDuration.unit\" | \"priceDetails.subscription.cycleCount\" | \"priceDetails.singlePaymentForDuration\" | \"priceDetails.singlePaymentForDuration.count\" | \"priceDetails.singlePaymentForDuration.unit\" | \"priceDetails.singlePaymentUnlimited\" | \"priceDetails.subtotal\" | \"priceDetails.discount\" | \"priceDetails.tax\" | \"priceDetails.tax.name\" | \"priceDetails.tax.includedInPrice\" | \"priceDetails.tax.rate\" | \"priceDetails.tax.amount\" | \"priceDetails.total\" | \"priceDetails.planPrice\" | \"priceDetails.currency\" | \"priceDetails.freeTrialDays\" | \"priceDetails.coupon\" | \"priceDetails.coupon.code\" | \"priceDetails.coupon.amount\" | \"priceDetails.coupon.id\" | \"pricing\" | \"pricing.subscription\" | \"pricing.subscription.cycleDuration\" | \"pricing.subscription.cycleCount\" | \"pricing.singlePaymentForDuration\" | \"pricing.singlePaymentForDuration.count\" | \"pricing.singlePaymentForDuration.unit\" | \"pricing.singlePaymentUnlimited\" | \"pricing.prices\" | \"pricing.prices.duration\" | \"pricing.prices.duration.cycleFrom\" | \"pricing.prices.duration.numberOfCycles\" | \"pricing.prices.price\" | \"pricing.prices.price.subtotal\" | \"pricing.prices.price.coupon\" | \"pricing.prices.price.coupon.code\" | \"pricing.prices.price.coupon.amount\" | \"pricing.prices.price.coupon.id\" | \"pricing.prices.price.discount\" | \"pricing.prices.price.tax\" | \"pricing.prices.price.tax.name\" | \"pricing.prices.price.tax.includedInPrice\" | \"pricing.prices.price.tax.rate\" | \"pricing.prices.price.tax.amount\" | \"pricing.prices.price.total\" | \"pricing.prices.price.currency\" | \"pricing.prices.price.fees.name\" | \"pricing.prices.price.fees.amount\" | \"pricing.prices.price.proration\" | \"type\" | \"orderMethod\" | \"status\" | \"autoRenewCanceled\" | \"cancellation\" | \"cancellation.requestedDate\" | \"cancellation.cause\" | \"cancellation.effectiveAt\" | \"lastPaymentStatus\" | \"startDate\" | \"endDate\" | \"pausePeriods\" | \"pausePeriods.status\" | \"pausePeriods.pauseDate\" | \"pausePeriods.resumeDate\" | \"freeTrialDays\" | \"earliestEndDate\" | \"currentCycle\" | \"currentCycle.index\" | \"currentCycle.startedDate\" | \"currentCycle.endedDate\" | \"cycles.index\" | \"cycles.startedDate\" | \"cycles.endedDate\" | \"planName\" | \"planDescription\" | \"planPrice\" | \"_createdDate\" | \"_updatedDate\" | \"formData\" | \"formData.formId\" | \"formData.submissionId\" | \"formData.submissionData\" | \"statusNew\">) => PlansQueryBuilder$1;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => PlansQueryBuilder$1;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => PlansQueryBuilder$1;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.\n *\n * There may be some operations that continue to be processed before the status of the order is changed to `\"CANCELED\"`. For example, payments might need to be refunded before the order is fully canceled.\n *\n * Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.\n *\n * >**Note:**\n * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @param _id - Order ID.\n * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.\n * @public\n * @requiredField _id\n * @requiredField effectiveAt\n * @param options - Options for requesting a cancellation.\n * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation\n */\n function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAt): Promise;\n /**\n * Creates an online order for a site member.\n *\n * If this method is called by a site member ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)), the plan is automatically ordered on behalf of that site member. Otherwise, you must specify `onBehalf.memberId` in your call.\n *\n * When an online order is created, but payment hasn't been processed, its status is set to `DRAFT`. After the payment has been processed, if the start date is in the future the order's status is set to `PENDING`. Otherwise, it's set to `ACTIVE`.\n * @param planId - Plan ID.\n * @public\n * @requiredField options.onBehalf.memberId\n * @requiredField planId\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.CheckoutService.CreateOnlineOrder\n */\n function createOnlineOrder(planId: string, options?: CreateOnlineOrderOptions): Promise;\n interface CreateOnlineOrderOptions {\n /**\n * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Provided if checkout is initiated on buyer's behalf. */\n onBehalf?: OnBehalf;\n /** Submission ID of the form submitted with this order. */\n submissionId?: string | null;\n }\n interface CreateGuestOnlineOrderOptions {\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Captcha data to prove you are not a robot */\n captcha: Captcha;\n /** Visitor info */\n guest: Guest;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n /**\n * Creates an order for a buyer who purchased the plan with an offline transaction.\n *\n * An offline order is handled off of the Wix site and is marked as `type`: `offline`. If a pricing plan\n * has a limit on the amount of purchases per buyer, that limit is ignored for offline orders.\n * Tax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n *\n * When creating a free offline order:\n * The order's status is set to `\"PENDING\"` if the start date is in the future. Otherwise, the status is set to `\"ACTIVE\"`.\n * The order's last payment status is set to `\"NOT_APPLICABLE\"`. \"\n *\n * When creating a non-free offline order:\n * The order's status is set to `\"PENDING\"` if the start date is in the future. Otherwise, the status is set to `\"ACTIVE\"`.\n * The order's last payment status is set to `\"UNPAID\"` or `\"PAID\"` based on the data passed in the `paid` boolean in the request.\n *\n * Payment for an offline order can be set in 1 of 2 ways:\n * + During order creation, set `paid`: `true`.\n * + After creation, call Mark As Paid.\n * @param planId - ID of the plan being ordered, from the Plans API.\n * @param memberId - ID of the member ordering the plan, from the Members API.\n * @public\n * @requiredField memberId\n * @requiredField planId\n * @param options - Options for creating an offline order.\n * @permissionId PRICING_PLANS.REGISTER_OFFLINE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.CheckoutService.CreateOfflineOrder\n */\n function createOfflineOrder(planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise;\n interface CreateOfflineOrderOptions {\n /**\n * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /**\n * Whether the order is paid.\n *\n * Default: `false`\n */\n paid?: boolean | null;\n /** Coupon code to apply, from the Coupons API. */\n couponCode?: string | null;\n /** Form submission ID that was submitted with the order. */\n submissionId?: string | null;\n }\n interface CreateExternalOrderOptions {\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n /**\n * Returns an `order` object that represents a potential online order for a site member.\n *\n * You can use this method to show a site member a preview of an online order before [creating](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/orders/create-online-order) it.\n *\n * This method must be called using the site member identity ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)). Therefore, [Wix apps](https://dev.wix.com/docs/build-apps) can't currently call this method using REST.\n * @param planId - Plan ID.\n * @public\n * @requiredField planId\n * @permissionId PRICING_PLANS.PURCHASE_PLANS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.membership.v2.orders.CheckoutService.GetOnlineOrderPreview\n */\n function getOnlineOrderPreview(planId: string, options?: GetOnlineOrderPreviewOptions): Promise;\n interface GetOnlineOrderPreviewOptions {\n /**\n * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n interface GetGuestOnlineOrderPreviewOptions {\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Email for checkout */\n email: string;\n }\n /**\n * Performs a dry run of a purchase and provides an order preview.\n *\n * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually\n * created, the preview order's `orderId` and `subscriptionId` are displayed as a string of multiple zero characters\n * (`000000-0000`). Tax is only calculated if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n *
      \n * If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview.\n * But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then\n * `purchaseLimitExceeded` will return as `true`.\n *\n * To get a general price preview for a plan that's not buyer-specific, call Get Price Preview.\n * @param memberId - Member ID of the buyer the previewed order is for, from the Members API.\n * @public\n * @requiredField memberId\n * @requiredField planId\n * @param options - Options for previewing the offline order.\n * @param planId - ID of the plan of the previewed order.\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.CheckoutService.GetOfflineOrderPreview\n */\n function getOfflineOrderPreview(planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions): Promise;\n interface GetOfflineOrderPreviewOptions {\n /**\n * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.\n *\n * Default: Current date and time.\n */\n startDate?: Date | null;\n /** Coupon code to apply, from the Coupons API. */\n couponCode?: string | null;\n }\n /**\n * Retrieves a plan's pricing.\n *\n * The price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if\n * the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection). The price is returned\n * in the pricing model format used for orders. Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).\n *\n * Buyers do not have to be logged in to preview the price, and as such, the details returned are not buyer-specific. To\n * generate a preview of a purchase for a specific buyer, call Get Offline Order Preview.\n * @param planId - ID of plan to preview.\n * @public\n * @requiredField planId\n * @param options - Options for getting a price preview.\n * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS\n * @permissionScope Read Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.membership.v2.orders.CheckoutService.GetPricePreview\n */\n function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise;\n interface GetPricePreviewOptions {\n /** Coupon code to apply, from the Coupons API. */\n couponCode?: string | null;\n }\n /**\n * Retrieves an order by ID.\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @param options - Options to use when getting an order.\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder\n */\n function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise;\n interface ManagementGetOrderOptions {\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n /**\n * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.\n *\n * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.\n * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.\n * @public\n * @param options - Filtering, sorting, and pagination options.\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders\n */\n function managementListOrders(options?: ManagementListOrdersOptions): Promise;\n interface ManagementListOrdersOptions {\n /** Filter by a buyer's member ID, from the Members API. */\n buyerIds?: string[];\n /** Filter by plan IDs, from the Plans API. */\n planIds?: string[];\n /** Filter by whether or not the auto-renewal of recurring orders was canceled. */\n autoRenewCanceled?: boolean | null;\n /** Filter by order status. */\n orderStatuses?: OrderStatus[];\n /** Filter by payment status. */\n paymentStatuses?: PaymentStatus[];\n /**\n * Number of orders to return. See Sorting and Paging for more information.\n *\n * Max: `50`\n */\n limit?: number | null;\n /** Number of orders to skip in the current sort order. */\n offset?: number | null;\n /**\n * Sort order.\n *\n * Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Default: `DESC`.\n */\n sorting?: Sorting$1;\n /**\n * Predefined set of fields to return.\n *\n * Default: If `fieldSet` is omitted, no order form submission data is returned.\n */\n fieldSet?: Set;\n }\n interface ManagementQueryOrdersOptions {\n /** Query filter. */\n query?: QueryV2$1;\n }\n /**\n * Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.\n *\n * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.\n * Can't postpone an order with `status`: `PAUSED`.\n * @param _id - Order ID.\n * @param endDate - New end date and time.\n *\n * Must be later than the current end date and time.\n * @public\n * @requiredField _id\n * @requiredField endDate\n * @param options - Options for postponing the end date of an order.\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate\n */\n function postponeEndDate(_id: string, endDate: Date | null): Promise;\n /**\n * Cancels an existing order.\n *\n * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.\n * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.\n *\n * #### Canceling during the free trial period.\n *\n * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end\n * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end\n * of the free trial period.\n *\n * When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation\n * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer\n * immediately, even during the free trial period and the buyer won't be billed. Canceling at the\n * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.\n * Then, the subscription ends and the buyer is not billed.\n * @param _id - Order ID.\n * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.\n * @public\n * @requiredField _id\n * @requiredField effectiveAt\n * @param options - Options for canceling orders.\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder\n */\n function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAt): Promise;\n /**\n * Marks an offline order as paid.\n * > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.\n *\n * Marking an offline order as paid causes the following changes:\n * - The order's `lastPaymentStatus` changes to `\"PAID\"`.\n * - The order's status changes to either `\"PENDING\"` or `\"ACTIVE\"`, depending on the order's `startDate`.\n *\n * An error occurs if you attempt to:\n * - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.\n * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid\n */\n function markAsPaid(_id: string): Promise;\n /**\n * Pauses an order. Calling this method changes the order status to `\"PAUSED\"` and updates the `pausePeriods` array.\n *\n * Only orders with `status`: `ACTIVE` can be paused.\n * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.\n * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.\n * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.\n *\n * To resume a paused order, call Resume Order.\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder\n */\n function pauseOrder(_id: string): Promise;\n interface BulkPauseOrderOptions {\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n /**\n * Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.\n *\n * Resuming an order causes the following changes:\n * - The order status changes to `\"ACTIVE\"`.\n * - The `pausePeriods` array is updated.\n * - The `endDate` for the order is adjusted to include the pause period.\n * - For orders with recurring payments, the payment schedule is restarted.\n * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).\n *\n * To pause an order, call Pause Order.\n * @param _id - Order ID.\n * @public\n * @requiredField _id\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder\n */\n function resumeOrder(_id: string): Promise;\n interface BulkResumeOrderOptions {\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n type pricingPlansV2OrderOrders_universal_d_Order = Order;\n type pricingPlansV2OrderOrders_universal_d_Buyer = Buyer;\n type pricingPlansV2OrderOrders_universal_d_PriceDetails = PriceDetails;\n type pricingPlansV2OrderOrders_universal_d_PriceDetailsPricingModelOneOf = PriceDetailsPricingModelOneOf;\n type pricingPlansV2OrderOrders_universal_d_Tax = Tax;\n type pricingPlansV2OrderOrders_universal_d_Coupon = Coupon;\n type pricingPlansV2OrderOrders_universal_d_PricingDetails = PricingDetails;\n type pricingPlansV2OrderOrders_universal_d_PricingDetailsPricingModelOneOf = PricingDetailsPricingModelOneOf;\n type pricingPlansV2OrderOrders_universal_d_SpannedPrice = SpannedPrice;\n type pricingPlansV2OrderOrders_universal_d_PriceDuration = PriceDuration;\n type pricingPlansV2OrderOrders_universal_d_Price = Price;\n type pricingPlansV2OrderOrders_universal_d_OrderType = OrderType;\n const pricingPlansV2OrderOrders_universal_d_OrderType: typeof OrderType;\n type pricingPlansV2OrderOrders_universal_d_OrderMethod = OrderMethod;\n const pricingPlansV2OrderOrders_universal_d_OrderMethod: typeof OrderMethod;\n type pricingPlansV2OrderOrders_universal_d_OrderStatus = OrderStatus;\n const pricingPlansV2OrderOrders_universal_d_OrderStatus: typeof OrderStatus;\n type pricingPlansV2OrderOrders_universal_d_Cancellation = Cancellation;\n type pricingPlansV2OrderOrders_universal_d_CancellationCause = CancellationCause;\n const pricingPlansV2OrderOrders_universal_d_CancellationCause: typeof CancellationCause;\n type pricingPlansV2OrderOrders_universal_d_CancellationEffectiveAt = CancellationEffectiveAt;\n const pricingPlansV2OrderOrders_universal_d_CancellationEffectiveAt: typeof CancellationEffectiveAt;\n type pricingPlansV2OrderOrders_universal_d_PaymentStatus = PaymentStatus;\n const pricingPlansV2OrderOrders_universal_d_PaymentStatus: typeof PaymentStatus;\n type pricingPlansV2OrderOrders_universal_d_PausePeriod = PausePeriod;\n type pricingPlansV2OrderOrders_universal_d_Status = Status;\n const pricingPlansV2OrderOrders_universal_d_Status: typeof Status;\n type pricingPlansV2OrderOrders_universal_d_CurrentCycle = CurrentCycle;\n type pricingPlansV2OrderOrders_universal_d_OrderCycle = OrderCycle;\n type pricingPlansV2OrderOrders_universal_d_FormData = FormData;\n type pricingPlansV2OrderOrders_universal_d_Empty = Empty;\n type pricingPlansV2OrderOrders_universal_d_MemberGetOrderRequest = MemberGetOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_Set = Set;\n const pricingPlansV2OrderOrders_universal_d_Set: typeof Set;\n type pricingPlansV2OrderOrders_universal_d_MemberGetOrderResponse = MemberGetOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_MemberListOrdersRequest = MemberListOrdersRequest;\n type pricingPlansV2OrderOrders_universal_d_MemberListOrdersResponse = MemberListOrdersResponse;\n type pricingPlansV2OrderOrders_universal_d_QueryOrdersRequest = QueryOrdersRequest;\n type pricingPlansV2OrderOrders_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type pricingPlansV2OrderOrders_universal_d_CursorPaging = CursorPaging;\n type pricingPlansV2OrderOrders_universal_d_QueryOrdersResponse = QueryOrdersResponse;\n type pricingPlansV2OrderOrders_universal_d_RequestCancellationRequest = RequestCancellationRequest;\n type pricingPlansV2OrderOrders_universal_d_RequestCancellationResponse = RequestCancellationResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderCanceled = OrderCanceled;\n type pricingPlansV2OrderOrders_universal_d_CreateOnlineOrderRequest = CreateOnlineOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_OnBehalf = OnBehalf;\n type pricingPlansV2OrderOrders_universal_d_CreateOnlineOrderResponse = CreateOnlineOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_CouponsError = CouponsError;\n type pricingPlansV2OrderOrders_universal_d_CreateGuestOnlineOrderRequest = CreateGuestOnlineOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_Captcha = Captcha;\n type pricingPlansV2OrderOrders_universal_d_Guest = Guest;\n type pricingPlansV2OrderOrders_universal_d_CreateGuestOnlineOrderResponse = CreateGuestOnlineOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_CreateOfflineOrderRequest = CreateOfflineOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_CreateOfflineOrderResponse = CreateOfflineOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_CreateExternalOrderRequest = CreateExternalOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_CreateExternalOrderResponse = CreateExternalOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_GetOnlineOrderPreviewRequest = GetOnlineOrderPreviewRequest;\n type pricingPlansV2OrderOrders_universal_d_GetOnlineOrderPreviewResponse = GetOnlineOrderPreviewResponse;\n type pricingPlansV2OrderOrders_universal_d_GetGuestOnlineOrderPreviewRequest = GetGuestOnlineOrderPreviewRequest;\n type pricingPlansV2OrderOrders_universal_d_GetGuestOnlineOrderPreviewResponse = GetGuestOnlineOrderPreviewResponse;\n type pricingPlansV2OrderOrders_universal_d_GetOfflineOrderPreviewRequest = GetOfflineOrderPreviewRequest;\n type pricingPlansV2OrderOrders_universal_d_GetOfflineOrderPreviewResponse = GetOfflineOrderPreviewResponse;\n type pricingPlansV2OrderOrders_universal_d_GetPricePreviewRequest = GetPricePreviewRequest;\n type pricingPlansV2OrderOrders_universal_d_GetPricePreviewResponse = GetPricePreviewResponse;\n type pricingPlansV2OrderOrders_universal_d_ChangeStartDateRequest = ChangeStartDateRequest;\n type pricingPlansV2OrderOrders_universal_d_ChangeStartDateResponse = ChangeStartDateResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderStartDateChanged = OrderStartDateChanged;\n type pricingPlansV2OrderOrders_universal_d_ApplyCouponRequest = ApplyCouponRequest;\n type pricingPlansV2OrderOrders_universal_d_ApplyCouponResponse = ApplyCouponResponse;\n type pricingPlansV2OrderOrders_universal_d_SetSubmissionRequest = SetSubmissionRequest;\n type pricingPlansV2OrderOrders_universal_d_SetSubmissionResponse = SetSubmissionResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderPurchased = OrderPurchased;\n type pricingPlansV2OrderOrders_universal_d_OrderStarted = OrderStarted;\n type pricingPlansV2OrderOrders_universal_d_OrderCycleStarted = OrderCycleStarted;\n type pricingPlansV2OrderOrders_universal_d_OrderAutoRenewCanceled = OrderAutoRenewCanceled;\n type pricingPlansV2OrderOrders_universal_d_OrderEnded = OrderEnded;\n type pricingPlansV2OrderOrders_universal_d_GetOrderRequest = GetOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_GetOrderResponse = GetOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_ListOrdersRequest = ListOrdersRequest;\n type pricingPlansV2OrderOrders_universal_d_ListOrdersResponse = ListOrdersResponse;\n type pricingPlansV2OrderOrders_universal_d_OrdersQueryOrdersRequest = OrdersQueryOrdersRequest;\n type pricingPlansV2OrderOrders_universal_d_OrdersQueryOrdersResponse = OrdersQueryOrdersResponse;\n type pricingPlansV2OrderOrders_universal_d_GetOrdersStatsRequest = GetOrdersStatsRequest;\n type pricingPlansV2OrderOrders_universal_d_GetOrdersStatsResponse = GetOrdersStatsResponse;\n type pricingPlansV2OrderOrders_universal_d_GetAvailableOrderActionsRequest = GetAvailableOrderActionsRequest;\n type pricingPlansV2OrderOrders_universal_d_GetAvailableOrderActionsResponse = GetAvailableOrderActionsResponse;\n type pricingPlansV2OrderOrders_universal_d_ReasonNotSuspendable = ReasonNotSuspendable;\n const pricingPlansV2OrderOrders_universal_d_ReasonNotSuspendable: typeof ReasonNotSuspendable;\n type pricingPlansV2OrderOrders_universal_d_PostponeEndDateRequest = PostponeEndDateRequest;\n type pricingPlansV2OrderOrders_universal_d_PostponeEndDateResponse = PostponeEndDateResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderEndDatePostponed = OrderEndDatePostponed;\n type pricingPlansV2OrderOrders_universal_d_CancelOrderRequest = CancelOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_CancelOrderResponse = CancelOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_MarkAsPaidRequest = MarkAsPaidRequest;\n type pricingPlansV2OrderOrders_universal_d_MarkAsPaidResponse = MarkAsPaidResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderMarkedAsPaid = OrderMarkedAsPaid;\n type pricingPlansV2OrderOrders_universal_d_PauseOrderRequest = PauseOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_PauseOrderResponse = PauseOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderPaused = OrderPaused;\n type pricingPlansV2OrderOrders_universal_d_BulkPauseOrderRequest = BulkPauseOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_BulkPauseOrderResponse = BulkPauseOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_BulkOrderResult = BulkOrderResult;\n type pricingPlansV2OrderOrders_universal_d_ResumeOrderRequest = ResumeOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_ResumeOrderResponse = ResumeOrderResponse;\n type pricingPlansV2OrderOrders_universal_d_OrderResumed = OrderResumed;\n type pricingPlansV2OrderOrders_universal_d_BulkResumeOrderRequest = BulkResumeOrderRequest;\n type pricingPlansV2OrderOrders_universal_d_BulkResumeOrderResponse = BulkResumeOrderResponse;\n const pricingPlansV2OrderOrders_universal_d_memberGetOrder: typeof memberGetOrder;\n type pricingPlansV2OrderOrders_universal_d_MemberGetOrderOptions = MemberGetOrderOptions;\n const pricingPlansV2OrderOrders_universal_d_memberListOrders: typeof memberListOrders;\n type pricingPlansV2OrderOrders_universal_d_MemberListOrdersOptions = MemberListOrdersOptions;\n const pricingPlansV2OrderOrders_universal_d_requestCancellation: typeof requestCancellation;\n const pricingPlansV2OrderOrders_universal_d_createOnlineOrder: typeof createOnlineOrder;\n type pricingPlansV2OrderOrders_universal_d_CreateOnlineOrderOptions = CreateOnlineOrderOptions;\n type pricingPlansV2OrderOrders_universal_d_CreateGuestOnlineOrderOptions = CreateGuestOnlineOrderOptions;\n const pricingPlansV2OrderOrders_universal_d_createOfflineOrder: typeof createOfflineOrder;\n type pricingPlansV2OrderOrders_universal_d_CreateOfflineOrderOptions = CreateOfflineOrderOptions;\n type pricingPlansV2OrderOrders_universal_d_CreateExternalOrderOptions = CreateExternalOrderOptions;\n const pricingPlansV2OrderOrders_universal_d_getOnlineOrderPreview: typeof getOnlineOrderPreview;\n type pricingPlansV2OrderOrders_universal_d_GetOnlineOrderPreviewOptions = GetOnlineOrderPreviewOptions;\n type pricingPlansV2OrderOrders_universal_d_GetGuestOnlineOrderPreviewOptions = GetGuestOnlineOrderPreviewOptions;\n const pricingPlansV2OrderOrders_universal_d_getOfflineOrderPreview: typeof getOfflineOrderPreview;\n type pricingPlansV2OrderOrders_universal_d_GetOfflineOrderPreviewOptions = GetOfflineOrderPreviewOptions;\n const pricingPlansV2OrderOrders_universal_d_getPricePreview: typeof getPricePreview;\n type pricingPlansV2OrderOrders_universal_d_GetPricePreviewOptions = GetPricePreviewOptions;\n const pricingPlansV2OrderOrders_universal_d_managementGetOrder: typeof managementGetOrder;\n type pricingPlansV2OrderOrders_universal_d_ManagementGetOrderOptions = ManagementGetOrderOptions;\n const pricingPlansV2OrderOrders_universal_d_managementListOrders: typeof managementListOrders;\n type pricingPlansV2OrderOrders_universal_d_ManagementListOrdersOptions = ManagementListOrdersOptions;\n type pricingPlansV2OrderOrders_universal_d_ManagementQueryOrdersOptions = ManagementQueryOrdersOptions;\n const pricingPlansV2OrderOrders_universal_d_postponeEndDate: typeof postponeEndDate;\n const pricingPlansV2OrderOrders_universal_d_cancelOrder: typeof cancelOrder;\n const pricingPlansV2OrderOrders_universal_d_markAsPaid: typeof markAsPaid;\n const pricingPlansV2OrderOrders_universal_d_pauseOrder: typeof pauseOrder;\n type pricingPlansV2OrderOrders_universal_d_BulkPauseOrderOptions = BulkPauseOrderOptions;\n const pricingPlansV2OrderOrders_universal_d_resumeOrder: typeof resumeOrder;\n type pricingPlansV2OrderOrders_universal_d_BulkResumeOrderOptions = BulkResumeOrderOptions;\n namespace pricingPlansV2OrderOrders_universal_d {\n export { pricingPlansV2OrderOrders_universal_d_Order as Order, pricingPlansV2OrderOrders_universal_d_Buyer as Buyer, pricingPlansV2OrderOrders_universal_d_PriceDetails as PriceDetails, pricingPlansV2OrderOrders_universal_d_PriceDetailsPricingModelOneOf as PriceDetailsPricingModelOneOf, pricingPlansV2OrderOrders_universal_d_Tax as Tax, Recurrence$1 as Recurrence, Duration$1 as Duration, PeriodUnit$1 as PeriodUnit, pricingPlansV2OrderOrders_universal_d_Coupon as Coupon, pricingPlansV2OrderOrders_universal_d_PricingDetails as PricingDetails, pricingPlansV2OrderOrders_universal_d_PricingDetailsPricingModelOneOf as PricingDetailsPricingModelOneOf, pricingPlansV2OrderOrders_universal_d_SpannedPrice as SpannedPrice, pricingPlansV2OrderOrders_universal_d_PriceDuration as PriceDuration, pricingPlansV2OrderOrders_universal_d_Price as Price, Fee$1 as Fee, pricingPlansV2OrderOrders_universal_d_OrderType as OrderType, pricingPlansV2OrderOrders_universal_d_OrderMethod as OrderMethod, pricingPlansV2OrderOrders_universal_d_OrderStatus as OrderStatus, pricingPlansV2OrderOrders_universal_d_Cancellation as Cancellation, pricingPlansV2OrderOrders_universal_d_CancellationCause as CancellationCause, pricingPlansV2OrderOrders_universal_d_CancellationEffectiveAt as CancellationEffectiveAt, pricingPlansV2OrderOrders_universal_d_PaymentStatus as PaymentStatus, pricingPlansV2OrderOrders_universal_d_PausePeriod as PausePeriod, pricingPlansV2OrderOrders_universal_d_Status as Status, pricingPlansV2OrderOrders_universal_d_CurrentCycle as CurrentCycle, pricingPlansV2OrderOrders_universal_d_OrderCycle as OrderCycle, pricingPlansV2OrderOrders_universal_d_FormData as FormData, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, pricingPlansV2OrderOrders_universal_d_Empty as Empty, pricingPlansV2OrderOrders_universal_d_MemberGetOrderRequest as MemberGetOrderRequest, pricingPlansV2OrderOrders_universal_d_Set as Set, pricingPlansV2OrderOrders_universal_d_MemberGetOrderResponse as MemberGetOrderResponse, pricingPlansV2OrderOrders_universal_d_MemberListOrdersRequest as MemberListOrdersRequest, Sorting$1 as Sorting, SortOrder$1 as SortOrder, pricingPlansV2OrderOrders_universal_d_MemberListOrdersResponse as MemberListOrdersResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, pricingPlansV2OrderOrders_universal_d_QueryOrdersRequest as QueryOrdersRequest, QueryV2$1 as QueryV2, pricingPlansV2OrderOrders_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, Paging$1 as Paging, pricingPlansV2OrderOrders_universal_d_CursorPaging as CursorPaging, pricingPlansV2OrderOrders_universal_d_QueryOrdersResponse as QueryOrdersResponse, pricingPlansV2OrderOrders_universal_d_RequestCancellationRequest as RequestCancellationRequest, pricingPlansV2OrderOrders_universal_d_RequestCancellationResponse as RequestCancellationResponse, pricingPlansV2OrderOrders_universal_d_OrderCanceled as OrderCanceled, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, pricingPlansV2OrderOrders_universal_d_CreateOnlineOrderRequest as CreateOnlineOrderRequest, pricingPlansV2OrderOrders_universal_d_OnBehalf as OnBehalf, pricingPlansV2OrderOrders_universal_d_CreateOnlineOrderResponse as CreateOnlineOrderResponse, pricingPlansV2OrderOrders_universal_d_CouponsError as CouponsError, pricingPlansV2OrderOrders_universal_d_CreateGuestOnlineOrderRequest as CreateGuestOnlineOrderRequest, pricingPlansV2OrderOrders_universal_d_Captcha as Captcha, pricingPlansV2OrderOrders_universal_d_Guest as Guest, pricingPlansV2OrderOrders_universal_d_CreateGuestOnlineOrderResponse as CreateGuestOnlineOrderResponse, pricingPlansV2OrderOrders_universal_d_CreateOfflineOrderRequest as CreateOfflineOrderRequest, pricingPlansV2OrderOrders_universal_d_CreateOfflineOrderResponse as CreateOfflineOrderResponse, pricingPlansV2OrderOrders_universal_d_CreateExternalOrderRequest as CreateExternalOrderRequest, pricingPlansV2OrderOrders_universal_d_CreateExternalOrderResponse as CreateExternalOrderResponse, pricingPlansV2OrderOrders_universal_d_GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequest, pricingPlansV2OrderOrders_universal_d_GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponse, pricingPlansV2OrderOrders_universal_d_GetGuestOnlineOrderPreviewRequest as GetGuestOnlineOrderPreviewRequest, pricingPlansV2OrderOrders_universal_d_GetGuestOnlineOrderPreviewResponse as GetGuestOnlineOrderPreviewResponse, pricingPlansV2OrderOrders_universal_d_GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequest, pricingPlansV2OrderOrders_universal_d_GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponse, pricingPlansV2OrderOrders_universal_d_GetPricePreviewRequest as GetPricePreviewRequest, pricingPlansV2OrderOrders_universal_d_GetPricePreviewResponse as GetPricePreviewResponse, pricingPlansV2OrderOrders_universal_d_ChangeStartDateRequest as ChangeStartDateRequest, pricingPlansV2OrderOrders_universal_d_ChangeStartDateResponse as ChangeStartDateResponse, pricingPlansV2OrderOrders_universal_d_OrderStartDateChanged as OrderStartDateChanged, pricingPlansV2OrderOrders_universal_d_ApplyCouponRequest as ApplyCouponRequest, pricingPlansV2OrderOrders_universal_d_ApplyCouponResponse as ApplyCouponResponse, pricingPlansV2OrderOrders_universal_d_SetSubmissionRequest as SetSubmissionRequest, pricingPlansV2OrderOrders_universal_d_SetSubmissionResponse as SetSubmissionResponse, pricingPlansV2OrderOrders_universal_d_OrderPurchased as OrderPurchased, pricingPlansV2OrderOrders_universal_d_OrderStarted as OrderStarted, pricingPlansV2OrderOrders_universal_d_OrderCycleStarted as OrderCycleStarted, pricingPlansV2OrderOrders_universal_d_OrderAutoRenewCanceled as OrderAutoRenewCanceled, pricingPlansV2OrderOrders_universal_d_OrderEnded as OrderEnded, pricingPlansV2OrderOrders_universal_d_GetOrderRequest as GetOrderRequest, pricingPlansV2OrderOrders_universal_d_GetOrderResponse as GetOrderResponse, pricingPlansV2OrderOrders_universal_d_ListOrdersRequest as ListOrdersRequest, pricingPlansV2OrderOrders_universal_d_ListOrdersResponse as ListOrdersResponse, pricingPlansV2OrderOrders_universal_d_OrdersQueryOrdersRequest as OrdersQueryOrdersRequest, pricingPlansV2OrderOrders_universal_d_OrdersQueryOrdersResponse as OrdersQueryOrdersResponse, pricingPlansV2OrderOrders_universal_d_GetOrdersStatsRequest as GetOrdersStatsRequest, pricingPlansV2OrderOrders_universal_d_GetOrdersStatsResponse as GetOrdersStatsResponse, pricingPlansV2OrderOrders_universal_d_GetAvailableOrderActionsRequest as GetAvailableOrderActionsRequest, pricingPlansV2OrderOrders_universal_d_GetAvailableOrderActionsResponse as GetAvailableOrderActionsResponse, pricingPlansV2OrderOrders_universal_d_ReasonNotSuspendable as ReasonNotSuspendable, pricingPlansV2OrderOrders_universal_d_PostponeEndDateRequest as PostponeEndDateRequest, pricingPlansV2OrderOrders_universal_d_PostponeEndDateResponse as PostponeEndDateResponse, pricingPlansV2OrderOrders_universal_d_OrderEndDatePostponed as OrderEndDatePostponed, pricingPlansV2OrderOrders_universal_d_CancelOrderRequest as CancelOrderRequest, pricingPlansV2OrderOrders_universal_d_CancelOrderResponse as CancelOrderResponse, pricingPlansV2OrderOrders_universal_d_MarkAsPaidRequest as MarkAsPaidRequest, pricingPlansV2OrderOrders_universal_d_MarkAsPaidResponse as MarkAsPaidResponse, pricingPlansV2OrderOrders_universal_d_OrderMarkedAsPaid as OrderMarkedAsPaid, pricingPlansV2OrderOrders_universal_d_PauseOrderRequest as PauseOrderRequest, pricingPlansV2OrderOrders_universal_d_PauseOrderResponse as PauseOrderResponse, pricingPlansV2OrderOrders_universal_d_OrderPaused as OrderPaused, pricingPlansV2OrderOrders_universal_d_BulkPauseOrderRequest as BulkPauseOrderRequest, pricingPlansV2OrderOrders_universal_d_BulkPauseOrderResponse as BulkPauseOrderResponse, pricingPlansV2OrderOrders_universal_d_BulkOrderResult as BulkOrderResult, ItemMetadata$1 as ItemMetadata, ApplicationError$1 as ApplicationError, BulkActionMetadata$1 as BulkActionMetadata, pricingPlansV2OrderOrders_universal_d_ResumeOrderRequest as ResumeOrderRequest, pricingPlansV2OrderOrders_universal_d_ResumeOrderResponse as ResumeOrderResponse, pricingPlansV2OrderOrders_universal_d_OrderResumed as OrderResumed, pricingPlansV2OrderOrders_universal_d_BulkResumeOrderRequest as BulkResumeOrderRequest, pricingPlansV2OrderOrders_universal_d_BulkResumeOrderResponse as BulkResumeOrderResponse, pricingPlansV2OrderOrders_universal_d_memberGetOrder as memberGetOrder, pricingPlansV2OrderOrders_universal_d_MemberGetOrderOptions as MemberGetOrderOptions, pricingPlansV2OrderOrders_universal_d_memberListOrders as memberListOrders, pricingPlansV2OrderOrders_universal_d_MemberListOrdersOptions as MemberListOrdersOptions, PlansQueryResult$1 as PlansQueryResult, PlansQueryBuilder$1 as PlansQueryBuilder, pricingPlansV2OrderOrders_universal_d_requestCancellation as requestCancellation, pricingPlansV2OrderOrders_universal_d_createOnlineOrder as createOnlineOrder, pricingPlansV2OrderOrders_universal_d_CreateOnlineOrderOptions as CreateOnlineOrderOptions, pricingPlansV2OrderOrders_universal_d_CreateGuestOnlineOrderOptions as CreateGuestOnlineOrderOptions, pricingPlansV2OrderOrders_universal_d_createOfflineOrder as createOfflineOrder, pricingPlansV2OrderOrders_universal_d_CreateOfflineOrderOptions as CreateOfflineOrderOptions, pricingPlansV2OrderOrders_universal_d_CreateExternalOrderOptions as CreateExternalOrderOptions, pricingPlansV2OrderOrders_universal_d_getOnlineOrderPreview as getOnlineOrderPreview, pricingPlansV2OrderOrders_universal_d_GetOnlineOrderPreviewOptions as GetOnlineOrderPreviewOptions, pricingPlansV2OrderOrders_universal_d_GetGuestOnlineOrderPreviewOptions as GetGuestOnlineOrderPreviewOptions, pricingPlansV2OrderOrders_universal_d_getOfflineOrderPreview as getOfflineOrderPreview, pricingPlansV2OrderOrders_universal_d_GetOfflineOrderPreviewOptions as GetOfflineOrderPreviewOptions, pricingPlansV2OrderOrders_universal_d_getPricePreview as getPricePreview, pricingPlansV2OrderOrders_universal_d_GetPricePreviewOptions as GetPricePreviewOptions, pricingPlansV2OrderOrders_universal_d_managementGetOrder as managementGetOrder, pricingPlansV2OrderOrders_universal_d_ManagementGetOrderOptions as ManagementGetOrderOptions, pricingPlansV2OrderOrders_universal_d_managementListOrders as managementListOrders, pricingPlansV2OrderOrders_universal_d_ManagementListOrdersOptions as ManagementListOrdersOptions, pricingPlansV2OrderOrders_universal_d_ManagementQueryOrdersOptions as ManagementQueryOrdersOptions, pricingPlansV2OrderOrders_universal_d_postponeEndDate as postponeEndDate, pricingPlansV2OrderOrders_universal_d_cancelOrder as cancelOrder, pricingPlansV2OrderOrders_universal_d_markAsPaid as markAsPaid, pricingPlansV2OrderOrders_universal_d_pauseOrder as pauseOrder, pricingPlansV2OrderOrders_universal_d_BulkPauseOrderOptions as BulkPauseOrderOptions, pricingPlansV2OrderOrders_universal_d_resumeOrder as resumeOrder, pricingPlansV2OrderOrders_universal_d_BulkResumeOrderOptions as BulkResumeOrderOptions, };\n }\n /** Information about the pricing plan. */\n interface Plan {\n /**\n * Plan ID.\n * @readonly\n */\n _id?: string;\n /** Plan name. */\n name?: string | null;\n /** Plan description. */\n description?: string | null;\n /**\n * List of text strings that promote what is included with this plan.\n *\n * For example, \"Plenty of parking\" or \"Free gift on your birthday\".\n */\n perks?: StringList;\n /** Plan price, payment schedule, and expiration. */\n pricing?: Pricing;\n /** Whether the plan is public (visible to site visitors and members). */\n public?: boolean | null;\n /**\n * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.\n * @readonly\n */\n archived?: boolean;\n /**\n * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.\n *\n * Default: `false`.\n * @readonly\n */\n primary?: boolean;\n /**\n * Whether the plan has any orders (including pending and unpaid orders).\n * @readonly\n */\n hasOrders?: boolean;\n /**\n * Date plan was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date plan was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * URL-friendly version of plan name. Unique across all plans in the same site.\n * @readonly\n */\n slug?: string | null;\n /**\n * Number of times the same buyer can purchase the plan. Currently limited to support:\n * - Empty value or a value of `0`, meaning no limitation.\n * - Value of `1`, meaning limited to one purchase per buyer.\n */\n maxPurchasesPerBuyer?: number | null;\n /**\n * Whether the buyer can start the plan at a later date.\n *\n * Default: `false`.\n *\n */\n allowFutureStartDate?: boolean | null;\n /**\n * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.\n *\n * Default: `true`.\n *\n */\n buyerCanCancel?: boolean | null;\n /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */\n termsAndConditions?: string | null;\n /** ID of the form associated with the plan at checkout. */\n formId?: string | null;\n }\n /** This wrapper type exist in order to distinguish an empty string list from no list at all in update requests. */\n interface StringList {\n values?: string[];\n }\n /** Plan pricing information. Includes the price of the plan and payment details. */\n interface Pricing extends PricingPricingModelOneOf {\n /**\n * Pricing model indicating that the plan has recurring payments.\n *\n * Note: This type of subscription is not a \"Wix subscription,\" which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.\n */\n subscription?: Recurrence;\n /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */\n singlePaymentForDuration?: Duration;\n /** Pricing model indicating the plan is paid in one single payment. The plan is valid until canceled. */\n singlePaymentUnlimited?: boolean | null;\n /** Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription. */\n price?: Money;\n /** Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial. */\n freeTrialDays?: number | null;\n }\n /** @oneof */\n interface PricingPricingModelOneOf {\n /** Plan has recurring payments. */\n subscription?: Recurrence;\n /** One time payment, plan is valid for the specified duration. */\n singlePaymentForDuration?: Duration;\n /** One time payment, plan is valid until it is canceled. */\n singlePaymentUnlimited?: boolean | null;\n }\n /** An object specifying how often and for how long payments recur (may be forever). */\n interface Recurrence {\n /** Length of one payment cycle. For example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. Currently, only a value of `1` is supported. */\n cycleDuration?: Duration;\n /**\n * Amount of payment cycles the subscription is valid for.\n *\n * `0` for unlimited plans or for plans that are valid until canceled.\n */\n cycleCount?: number | null;\n }\n /** A duration expressed in number of time units. */\n interface Duration {\n /** Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`. */\n count?: number | null;\n /** Unit of time for the cycle duration. */\n unit?: PeriodUnit;\n }\n enum PeriodUnit {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface Money {\n /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Cannot be a negative value. */\n value?: string;\n /**\n * Currency code. Three-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.\n */\n currency?: string;\n }\n interface FeeConfig {\n /** Fee configuration. */\n fee?: Fee;\n /** The time this fee will be charged */\n appliedAt?: AppliedAt;\n }\n interface Fee {\n /** Fee name */\n name?: string;\n /** Amount of fee to be charged */\n amount?: string;\n }\n enum AppliedAt {\n UNKNOWN_CHARGE_EVENT = \"UNKNOWN_CHARGE_EVENT\",\n /** Will charge the fee on first payment. If order has a free trial meaning it will charge after the free trial. */\n FIRST_PAYMENT = \"FIRST_PAYMENT\"\n }\n interface ListPublicPlansRequest {\n /**\n * Number of pricing plans to list.\n *\n * Default: `75`.\n */\n limit?: number | null;\n /**\n * Number of pricing plans to skip.\n *\n * Default: `0`.\n */\n offset?: number | null;\n /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs. */\n planIds?: string[];\n }\n interface ListPublicPlansResponse {\n /** List of public pricing plans. */\n plans?: PublicPlan[];\n /** Details on the paged set of public pricing plans returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */\n interface PublicPlan {\n /** Plan ID. */\n _id?: string;\n /** Plan name. */\n name?: string | null;\n /** Plan description. */\n description?: string | null;\n /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */\n perks?: StringList;\n /** Plan price, payment schedule, and expiration. */\n pricing?: Pricing;\n /** Whether the plan is marked as primary. */\n primary?: boolean;\n /** Date plan was created. */\n _createdDate?: Date;\n /** Date plan was last updated. */\n _updatedDate?: Date;\n /** URL-friendly version of plan name. Unique across all plans in the same site. */\n slug?: string | null;\n /** Number of times the same buyer can purchase the plan. An empty value or a value of zero means no limitation. */\n maxPurchasesPerBuyer?: number | null;\n /** Whether the buyer can start the plan at a later date. Defaults to false. */\n allowFutureStartDate?: boolean | null;\n /** Whether the buyer is allowed to cancel their plan. Defaults to false. */\n buyerCanCancel?: boolean | null;\n /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */\n termsAndConditions?: string | null;\n /** ID of the form associated with the plan at checkout. */\n formId?: string | null;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryPublicPlansRequest {\n /** Query */\n query?: QueryV2;\n }\n interface QueryV2 {\n /** A filter object. See [supported fields and operators](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans) */\n filter?: Record | null;\n /** Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}] */\n sort?: Sorting[];\n /** Pointer to page of results using offset. Can not be used together with 'cursorPaging' */\n paging?: Paging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryPublicPlansResponse {\n /** List of public pricing plans that match the specified query. */\n plans?: PublicPlan[];\n /** Object containing paging-related data (number of plans returned, offset). */\n pagingMetadata?: PagingMetadataV2;\n }\n interface GetPlanRequest {\n /** Plan ID. */\n _id: string;\n }\n interface GetPlanResponse {\n /** Pricing plan info. */\n plan?: Plan;\n }\n interface ListPlansRequest {\n /**\n * Archived filter.\n *\n * Default: `ACTIVE` (not archived).\n */\n archived?: ArchivedFilter;\n /**\n * Visibility filter.\n *\n * Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).\n *\n */\n public?: PublicFilter;\n /**\n * Number of pricing plans to list.\n *\n * Default: `75`.\n */\n limit?: number | null;\n /**\n * Number of pricing plans to skip.\n *\n * Default: `0`.\n */\n offset?: number | null;\n /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs. */\n planIds?: string[];\n }\n enum ArchivedFilter {\n /** Returns all plans that are active. */\n ACTIVE = \"ACTIVE\",\n /** Returns all plans that are archived. */\n ARCHIVED = \"ARCHIVED\",\n /** Returns all plans that are active and archived. */\n ARCHIVED_AND_ACTIVE = \"ARCHIVED_AND_ACTIVE\"\n }\n enum PublicFilter {\n /** Returns all public and hidden plans. */\n PUBLIC_AND_HIDDEN = \"PUBLIC_AND_HIDDEN\",\n /** Returns only public plans. */\n PUBLIC = \"PUBLIC\",\n /** Returns only hidden plans. */\n HIDDEN = \"HIDDEN\"\n }\n interface ListPlansResponse {\n /** List of all public and hidden pricing plans. */\n plans?: Plan[];\n /** Details on the paged set of pricing plans returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface GetPlanStatsRequest {\n }\n interface GetPlanStatsResponse {\n /** Total number of plans created, including active plans (both public and hidden) and archived plans. */\n totalPlans?: number;\n }\n interface CreatePlanRequest {\n /** Information for the plan being created. */\n plan: Plan;\n }\n interface CreatePlanResponse {\n /** Plan info. */\n plan?: Plan;\n }\n interface UpdatePlanRequest {\n /** Plan info to update. */\n plan: Plan;\n }\n interface UpdatePlanResponse {\n /** Updated plan info. */\n plan?: Plan;\n }\n interface BuyerCanCancelUpdated {\n /** Pricing plan. */\n plan?: Plan;\n }\n interface SetPlanVisibilityRequest {\n /** The ID of the plan to either display or hide on the site page. */\n _id: string;\n /** Whether to set the plan as visible. */\n visible: boolean;\n }\n interface SetPlanVisibilityResponse {\n /** Plan info. */\n plan?: Plan;\n }\n interface MakePlanPrimaryRequest {\n /** ID of the pricing plan to set as the primary plan. */\n _id: string;\n }\n interface MakePlanPrimaryResponse {\n /** Primary plan info. */\n plan?: Plan;\n }\n interface ClearPrimaryRequest {\n }\n interface ClearPrimaryResponse {\n }\n interface ArchivePlanRequest {\n _id: string;\n }\n interface ArchivePlanResponse {\n /** Archived plan info. */\n plan?: Plan;\n }\n interface PlanArchived {\n /** Pricing plan. */\n plan?: Plan;\n }\n interface BulkArchivePlanRequest {\n /** List of Plan IDs. */\n ids: string[];\n /** Set to true to return Plan entity in response. */\n returnFullEntity?: boolean;\n }\n interface BulkArchivePlanResponse {\n /** Plans to be archived. */\n results?: BulkPlanResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkPlanResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n /** Pricing plan. */\n plan?: Plan;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface ArrangePlansRequest {\n /** IDs of all non-archived plans in the order you want them arranged. */\n ids: string[];\n }\n interface ArrangePlansResponse {\n }\n interface CountPlansRequest {\n /** The filter. */\n filter?: Record | null;\n /** If true, will count only visible plans (visible and not archived). If no value is given all site's plans will be counted. */\n visibility?: boolean | null;\n }\n interface CountPlansResponse {\n /** Number of plans in the response. */\n count?: number;\n }\n interface GetPlansPremiumStatusRequest {\n }\n interface GetPlansPremiumStatusResponse {\n /** True if site has non-free, non-template plans. */\n hasPaidPlans?: boolean;\n /** True if site has plans that were created before Pricing Plans became a premium app. */\n hasOldPlans?: boolean;\n }\n interface QueryPlansRequest {\n /** Query */\n query?: QueryV2;\n }\n interface QueryPlansResponse {\n /** List of pricing plans that match the specified query. */\n plans?: Plan[];\n /** Object containing paging-related data (number of plans returned, offset). */\n pagingMetadata?: PagingMetadataV2;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves a list of public pricing plans.\n *\n *\n * The `listPublicPlans()` function returns a Promise that resolves to a list of up to 100 public pricing plans. Public plans are visible plans that site visitors can see on the site and purchase.\n * @public\n * @param options - Options for filtering and paging the list of public plans.\n * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS\n * @permissionScope Read Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Fulfilled - List of public pricing plans.\n */\n function listPublicPlans(options?: ListPublicPlansOptions): Promise;\n interface ListPublicPlansOptions {\n /**\n * Number of pricing plans to list.\n *\n * Default: `75`.\n */\n limit?: number | null;\n /**\n * Number of pricing plans to skip.\n *\n * Default: `0`.\n */\n offset?: number | null;\n /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs. */\n planIds?: string[];\n }\n /**\n * Creates a query to retrieve a list of public pricing plans.\n *\n *\n * The `queryPublicPlans()` function builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) function.\n *\n * You can refine the query by chaining `PublicPlansQueryBuilder` functions onto the query. `PublicPlansQueryBuilder` functions enable you to sort, filter, and control the results that `queryPublicPlans()` returns.\n *\n * `queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:\n * - [`skip`](#plansquerybuilder/skip): `0`\n * - [`limit`](#plansquerybuilder/limit): `50`\n *\n * The functions that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.\n *\n * The following `PublicPlansQueryBuilder` functions are supported for the `queryPublicPlans()` function. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).\n * @public\n * @permissionScope Read Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryPublicPlans(): PlansQueryBuilder;\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PlansQueryResult extends QueryOffsetResult {\n items: PublicPlan[];\n query: PlansQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface PlansQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\", value: any) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\", value: any) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"_id\" | \"slug\", value: string) => PlansQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\", value: any[]) => PlansQueryBuilder;\n in: (propertyName: \"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\", value: any) => PlansQueryBuilder;\n exists: (propertyName: \"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\", value: boolean) => PlansQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\">) => PlansQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"primary\" | \"_createdDate\" | \"_updatedDate\" | \"slug\">) => PlansQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => PlansQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => PlansQueryBuilder;\n find: () => Promise;\n }\n /**\n * Retrieves a pricing plan by the specified ID.\n *\n * The `getPlan()` function returns a Promise that resolves to a plan whose ID matched the specified ID.\n * @param _id - Plan ID.\n * @public\n * @requiredField _id\n * @permissionId PRICING_PLANS.READ_PLANS\n * @permissionScope Read Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The retrieved plan's information.\n */\n function getPlan(_id: string): Promise;\n /**\n * Retrieves a list of pricing plans.\n *\n * The `listPlans()` function returns a Promise that resolves to a list of up to 100 pricing plans. This includes public, hidden, and archived plans.\n * @public\n * @documentationMaturity preview\n * @param options - Options for filtering and paging the list of plans.\n * @permissionId PRICING_PLANS.READ_PLANS\n * @permissionScope Read Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - List of plans that match the given criteria.\n */\n function listPlans(options?: ListPlansOptions): Promise;\n interface ListPlansOptions {\n /**\n * Archived filter.\n *\n * Default: `ACTIVE` (not archived).\n */\n archived?: ArchivedFilter;\n /**\n * Visibility filter.\n *\n * Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).\n *\n */\n public?: PublicFilter;\n /**\n * Number of pricing plans to list.\n *\n * Default: `75`.\n */\n limit?: number | null;\n /**\n * Number of pricing plans to skip.\n *\n * Default: `0`.\n */\n offset?: number | null;\n /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs. */\n planIds?: string[];\n }\n /**\n * Retrieves statistics about the pricing plans.\n *\n *\n * The `getPlanStats()` function returns a Promise that resolves to statistics about the plan on the site.\n *\n * Currently this function provides only the total number of pricing plans, including archived plans.\n * @public\n * @permissionId PRICING_PLANS.READ_PLANS\n * @permissionScope Read Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - Overall statistics about the pricing plans.\n */\n function getPlanStats(): Promise;\n /**\n * Creates a pricing plan.\n *\n *\n * The `createPlan()` function returns a Promise that resolves to a newly-created pricing plan after is has successfully been created.\n *\n * The passed `plan` object must contain a [pricing model](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/pricing-models). A pricing model can be one of the following:\n * - **A subscription**: A subscription with recurring payment and how often the plan occurs. Subscriptions can have free trial days.\n * - **A plan that does not renew**: A single payment for a specific duration that doesn't renew.\n * - **An unlimited plan**: A single payment for an unlimited amount of time (until canceled).\n *\n * Pricing plans created by this function are available to the site owner in the Pricing Plans section in the Dashboard.\n * @public\n * @requiredField plan\n * @requiredField plan.name\n * @requiredField plan.pricing\n * @requiredField plan.pricing.singlePaymentForDuration.count\n * @requiredField plan.pricing.subscription.cycleCount\n * @requiredField plan.pricing.subscription.cycleDuration\n * @requiredField plan.pricing.subscription.cycleDuration.count\n * @param plan - Information for the plan being created.\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The created plan.\n *\n * Rejected - Error message.\n */\n function createPlan(plan: Plan): Promise;\n /**\n * Updates a pricing plan.\n *\n *\n * The `updatePlan()` function returns a Promise that resolves to an updated plan.\n *\n * Updating a plan does not impact existing purchases made for the plan. All purchases keep the details of the original plan that was active at the time of the purchase.\n * @public\n * @requiredField _id\n * @requiredField plan\n * @param _id - ID of the plan to update.\n * @param options - Options for updating the plan.\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The updated plan.\n *\n * Rejected - Error message.\n */\n function updatePlan(_id: string, plan: UpdatePlan, options?: UpdatePlanOptions): Promise;\n interface UpdatePlan {\n /**\n * Plan ID.\n * @readonly\n */\n _id?: string;\n /** Plan name. */\n name?: string | null;\n /** Plan description. */\n description?: string | null;\n /**\n * List of text strings that promote what is included with this plan.\n *\n * For example, \"Plenty of parking\" or \"Free gift on your birthday\".\n */\n perks?: StringList;\n /** Plan price, payment schedule, and expiration. */\n pricing?: Pricing;\n /** Whether the plan is public (visible to site visitors and members). */\n public?: boolean | null;\n /**\n * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.\n * @readonly\n */\n archived?: boolean;\n /**\n * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.\n *\n * Default: `false`.\n * @readonly\n */\n primary?: boolean;\n /**\n * Whether the plan has any orders (including pending and unpaid orders).\n * @readonly\n */\n hasOrders?: boolean;\n /**\n * Date plan was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date plan was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * URL-friendly version of plan name. Unique across all plans in the same site.\n * @readonly\n */\n slug?: string | null;\n /**\n * Number of times the same buyer can purchase the plan. Currently limited to support:\n * - Empty value or a value of `0`, meaning no limitation.\n * - Value of `1`, meaning limited to one purchase per buyer.\n */\n maxPurchasesPerBuyer?: number | null;\n /**\n * Whether the buyer can start the plan at a later date.\n *\n * Default: `false`.\n *\n */\n allowFutureStartDate?: boolean | null;\n /**\n * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.\n *\n * Default: `true`.\n *\n */\n buyerCanCancel?: boolean | null;\n /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */\n termsAndConditions?: string | null;\n /** ID of the form associated with the plan at checkout. */\n formId?: string | null;\n }\n interface UpdatePlanOptions {\n }\n /**\n * Sets visibility for non-archived pricing plans.\n *\n * The `setPlanVisibility()` functions returns a Promise that resolves to a pricing plan when its visibility has successfully been set.\n *\n * By default, pricing plans are public, meaning they are visible. [Plans can be hidden](https://support.wix.com/en/article/pricing-plans-removing-a-plan-from-your-site#hiding-plans) so that site members and visitors cannot see or choose them.\n *\n * As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible).\n *\n * >**Note:** An archived plan always remains archived and cannot be made active again. When archiving a plan, its `public` property is automatically set to `false` so that it is hidden.\n *\n * Changing a plan's visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their terms and payment options.\n * @param visible - Whether to set the plan as visible.\n * @public\n * @requiredField _id\n * @requiredField visible\n * @param _id - The ID of the plan to either display or hide on the site page.\n * @param options - Plan visibility options.\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The plan's information.\n *\n * Rejected - Error message.\n */\n function setPlanVisibility(_id: string, visible: boolean): Promise;\n /**\n * Marks a pricing plan as the primary pricing plan.\n *\n *\n * The `makePlanPrimary()` function returns a Promise that resolves to the now primary pricing plan.\n *\n * Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling `makePlanPrimary()` causes the existing primary plan to lose its primary status.\n *\n * When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.\n * @public\n * @requiredField _id\n * @param _id - ID of the pricing plan to set as the primary plan.\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The primary plan.\n */\n function makePlanPrimary(_id: string): Promise;\n /**\n * Sets all pricing plans to no longer be primary.\n *\n * The `clearPrimary()` function returns a Promise that is resolved when there are no pricing plans marked as `primary`.\n *\n * After clearing the primary plan, when viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.\n * @public\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n */\n function clearPrimary(): Promise;\n /**\n * Archives a single plan.\n *\n *\n * The `archivePlan()` function returns a Promise that resolves to the newly-archived plan.\n *\n * When a plan is archived, the plan\n * - Is no longer available for display or selection by visitors. This is because the plan's `public` property is automatically set to `false`.\n * - Cannot be purchased.\n * - Cannot be \"un-archived\", meaning the plan cannot be made active again.\n *\n * Plan archiving does not impact existing purchases made for the plan. All purchases for the plan are still active and keep their payment options and terms.\n *\n * Site owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.\n *\n * >**Note:** An attempt to archive an already-archived plan throws an error.\n * @public\n * @requiredField _id\n * @param _id - ID of the active plan to archive.\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @permissionScope Manage Pricing Plans\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Fulfilled - The archived plan.\n *\n * Rejected - Error message.\n */\n function archivePlan(_id: string): Promise;\n interface BulkArchivePlanOptions {\n /** Set to true to return Plan entity in response. */\n returnFullEntity?: boolean;\n }\n interface CountPlansOptions {\n /** The filter. */\n filter?: Record | null;\n /** If true, will count only visible plans (visible and not archived). If no value is given all site's plans will be counted. */\n visibility?: boolean | null;\n }\n interface QueryPlansOptions {\n /** Query */\n query?: QueryV2;\n }\n type pricingPlansV2PlanPlans_universal_d_Plan = Plan;\n type pricingPlansV2PlanPlans_universal_d_StringList = StringList;\n type pricingPlansV2PlanPlans_universal_d_Pricing = Pricing;\n type pricingPlansV2PlanPlans_universal_d_PricingPricingModelOneOf = PricingPricingModelOneOf;\n type pricingPlansV2PlanPlans_universal_d_Recurrence = Recurrence;\n type pricingPlansV2PlanPlans_universal_d_Duration = Duration;\n type pricingPlansV2PlanPlans_universal_d_PeriodUnit = PeriodUnit;\n const pricingPlansV2PlanPlans_universal_d_PeriodUnit: typeof PeriodUnit;\n type pricingPlansV2PlanPlans_universal_d_Money = Money;\n type pricingPlansV2PlanPlans_universal_d_FeeConfig = FeeConfig;\n type pricingPlansV2PlanPlans_universal_d_Fee = Fee;\n type pricingPlansV2PlanPlans_universal_d_AppliedAt = AppliedAt;\n const pricingPlansV2PlanPlans_universal_d_AppliedAt: typeof AppliedAt;\n type pricingPlansV2PlanPlans_universal_d_ListPublicPlansRequest = ListPublicPlansRequest;\n type pricingPlansV2PlanPlans_universal_d_ListPublicPlansResponse = ListPublicPlansResponse;\n type pricingPlansV2PlanPlans_universal_d_PublicPlan = PublicPlan;\n type pricingPlansV2PlanPlans_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type pricingPlansV2PlanPlans_universal_d_Cursors = Cursors;\n type pricingPlansV2PlanPlans_universal_d_QueryPublicPlansRequest = QueryPublicPlansRequest;\n type pricingPlansV2PlanPlans_universal_d_QueryV2 = QueryV2;\n type pricingPlansV2PlanPlans_universal_d_Sorting = Sorting;\n type pricingPlansV2PlanPlans_universal_d_SortOrder = SortOrder;\n const pricingPlansV2PlanPlans_universal_d_SortOrder: typeof SortOrder;\n type pricingPlansV2PlanPlans_universal_d_Paging = Paging;\n type pricingPlansV2PlanPlans_universal_d_QueryPublicPlansResponse = QueryPublicPlansResponse;\n type pricingPlansV2PlanPlans_universal_d_GetPlanRequest = GetPlanRequest;\n type pricingPlansV2PlanPlans_universal_d_GetPlanResponse = GetPlanResponse;\n type pricingPlansV2PlanPlans_universal_d_ListPlansRequest = ListPlansRequest;\n type pricingPlansV2PlanPlans_universal_d_ArchivedFilter = ArchivedFilter;\n const pricingPlansV2PlanPlans_universal_d_ArchivedFilter: typeof ArchivedFilter;\n type pricingPlansV2PlanPlans_universal_d_PublicFilter = PublicFilter;\n const pricingPlansV2PlanPlans_universal_d_PublicFilter: typeof PublicFilter;\n type pricingPlansV2PlanPlans_universal_d_ListPlansResponse = ListPlansResponse;\n type pricingPlansV2PlanPlans_universal_d_GetPlanStatsRequest = GetPlanStatsRequest;\n type pricingPlansV2PlanPlans_universal_d_GetPlanStatsResponse = GetPlanStatsResponse;\n type pricingPlansV2PlanPlans_universal_d_CreatePlanRequest = CreatePlanRequest;\n type pricingPlansV2PlanPlans_universal_d_CreatePlanResponse = CreatePlanResponse;\n type pricingPlansV2PlanPlans_universal_d_UpdatePlanRequest = UpdatePlanRequest;\n type pricingPlansV2PlanPlans_universal_d_UpdatePlanResponse = UpdatePlanResponse;\n type pricingPlansV2PlanPlans_universal_d_BuyerCanCancelUpdated = BuyerCanCancelUpdated;\n type pricingPlansV2PlanPlans_universal_d_SetPlanVisibilityRequest = SetPlanVisibilityRequest;\n type pricingPlansV2PlanPlans_universal_d_SetPlanVisibilityResponse = SetPlanVisibilityResponse;\n type pricingPlansV2PlanPlans_universal_d_MakePlanPrimaryRequest = MakePlanPrimaryRequest;\n type pricingPlansV2PlanPlans_universal_d_MakePlanPrimaryResponse = MakePlanPrimaryResponse;\n type pricingPlansV2PlanPlans_universal_d_ClearPrimaryRequest = ClearPrimaryRequest;\n type pricingPlansV2PlanPlans_universal_d_ClearPrimaryResponse = ClearPrimaryResponse;\n type pricingPlansV2PlanPlans_universal_d_ArchivePlanRequest = ArchivePlanRequest;\n type pricingPlansV2PlanPlans_universal_d_ArchivePlanResponse = ArchivePlanResponse;\n type pricingPlansV2PlanPlans_universal_d_PlanArchived = PlanArchived;\n type pricingPlansV2PlanPlans_universal_d_BulkArchivePlanRequest = BulkArchivePlanRequest;\n type pricingPlansV2PlanPlans_universal_d_BulkArchivePlanResponse = BulkArchivePlanResponse;\n type pricingPlansV2PlanPlans_universal_d_BulkPlanResult = BulkPlanResult;\n type pricingPlansV2PlanPlans_universal_d_ItemMetadata = ItemMetadata;\n type pricingPlansV2PlanPlans_universal_d_ApplicationError = ApplicationError;\n type pricingPlansV2PlanPlans_universal_d_BulkActionMetadata = BulkActionMetadata;\n type pricingPlansV2PlanPlans_universal_d_ArrangePlansRequest = ArrangePlansRequest;\n type pricingPlansV2PlanPlans_universal_d_ArrangePlansResponse = ArrangePlansResponse;\n type pricingPlansV2PlanPlans_universal_d_CountPlansRequest = CountPlansRequest;\n type pricingPlansV2PlanPlans_universal_d_CountPlansResponse = CountPlansResponse;\n type pricingPlansV2PlanPlans_universal_d_GetPlansPremiumStatusRequest = GetPlansPremiumStatusRequest;\n type pricingPlansV2PlanPlans_universal_d_GetPlansPremiumStatusResponse = GetPlansPremiumStatusResponse;\n type pricingPlansV2PlanPlans_universal_d_QueryPlansRequest = QueryPlansRequest;\n type pricingPlansV2PlanPlans_universal_d_QueryPlansResponse = QueryPlansResponse;\n type pricingPlansV2PlanPlans_universal_d_DomainEvent = DomainEvent;\n type pricingPlansV2PlanPlans_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type pricingPlansV2PlanPlans_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type pricingPlansV2PlanPlans_universal_d_RestoreInfo = RestoreInfo;\n type pricingPlansV2PlanPlans_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type pricingPlansV2PlanPlans_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type pricingPlansV2PlanPlans_universal_d_ActionEvent = ActionEvent;\n type pricingPlansV2PlanPlans_universal_d_MessageEnvelope = MessageEnvelope;\n type pricingPlansV2PlanPlans_universal_d_IdentificationData = IdentificationData;\n type pricingPlansV2PlanPlans_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type pricingPlansV2PlanPlans_universal_d_WebhookIdentityType = WebhookIdentityType;\n const pricingPlansV2PlanPlans_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const pricingPlansV2PlanPlans_universal_d_listPublicPlans: typeof listPublicPlans;\n type pricingPlansV2PlanPlans_universal_d_ListPublicPlansOptions = ListPublicPlansOptions;\n const pricingPlansV2PlanPlans_universal_d_queryPublicPlans: typeof queryPublicPlans;\n type pricingPlansV2PlanPlans_universal_d_PlansQueryResult = PlansQueryResult;\n type pricingPlansV2PlanPlans_universal_d_PlansQueryBuilder = PlansQueryBuilder;\n const pricingPlansV2PlanPlans_universal_d_getPlan: typeof getPlan;\n const pricingPlansV2PlanPlans_universal_d_listPlans: typeof listPlans;\n type pricingPlansV2PlanPlans_universal_d_ListPlansOptions = ListPlansOptions;\n const pricingPlansV2PlanPlans_universal_d_getPlanStats: typeof getPlanStats;\n const pricingPlansV2PlanPlans_universal_d_createPlan: typeof createPlan;\n const pricingPlansV2PlanPlans_universal_d_updatePlan: typeof updatePlan;\n type pricingPlansV2PlanPlans_universal_d_UpdatePlan = UpdatePlan;\n type pricingPlansV2PlanPlans_universal_d_UpdatePlanOptions = UpdatePlanOptions;\n const pricingPlansV2PlanPlans_universal_d_setPlanVisibility: typeof setPlanVisibility;\n const pricingPlansV2PlanPlans_universal_d_makePlanPrimary: typeof makePlanPrimary;\n const pricingPlansV2PlanPlans_universal_d_clearPrimary: typeof clearPrimary;\n const pricingPlansV2PlanPlans_universal_d_archivePlan: typeof archivePlan;\n type pricingPlansV2PlanPlans_universal_d_BulkArchivePlanOptions = BulkArchivePlanOptions;\n type pricingPlansV2PlanPlans_universal_d_CountPlansOptions = CountPlansOptions;\n type pricingPlansV2PlanPlans_universal_d_QueryPlansOptions = QueryPlansOptions;\n namespace pricingPlansV2PlanPlans_universal_d {\n export { pricingPlansV2PlanPlans_universal_d_Plan as Plan, pricingPlansV2PlanPlans_universal_d_StringList as StringList, pricingPlansV2PlanPlans_universal_d_Pricing as Pricing, pricingPlansV2PlanPlans_universal_d_PricingPricingModelOneOf as PricingPricingModelOneOf, pricingPlansV2PlanPlans_universal_d_Recurrence as Recurrence, pricingPlansV2PlanPlans_universal_d_Duration as Duration, pricingPlansV2PlanPlans_universal_d_PeriodUnit as PeriodUnit, pricingPlansV2PlanPlans_universal_d_Money as Money, pricingPlansV2PlanPlans_universal_d_FeeConfig as FeeConfig, pricingPlansV2PlanPlans_universal_d_Fee as Fee, pricingPlansV2PlanPlans_universal_d_AppliedAt as AppliedAt, pricingPlansV2PlanPlans_universal_d_ListPublicPlansRequest as ListPublicPlansRequest, pricingPlansV2PlanPlans_universal_d_ListPublicPlansResponse as ListPublicPlansResponse, pricingPlansV2PlanPlans_universal_d_PublicPlan as PublicPlan, pricingPlansV2PlanPlans_universal_d_PagingMetadataV2 as PagingMetadataV2, pricingPlansV2PlanPlans_universal_d_Cursors as Cursors, pricingPlansV2PlanPlans_universal_d_QueryPublicPlansRequest as QueryPublicPlansRequest, pricingPlansV2PlanPlans_universal_d_QueryV2 as QueryV2, pricingPlansV2PlanPlans_universal_d_Sorting as Sorting, pricingPlansV2PlanPlans_universal_d_SortOrder as SortOrder, pricingPlansV2PlanPlans_universal_d_Paging as Paging, pricingPlansV2PlanPlans_universal_d_QueryPublicPlansResponse as QueryPublicPlansResponse, pricingPlansV2PlanPlans_universal_d_GetPlanRequest as GetPlanRequest, pricingPlansV2PlanPlans_universal_d_GetPlanResponse as GetPlanResponse, pricingPlansV2PlanPlans_universal_d_ListPlansRequest as ListPlansRequest, pricingPlansV2PlanPlans_universal_d_ArchivedFilter as ArchivedFilter, pricingPlansV2PlanPlans_universal_d_PublicFilter as PublicFilter, pricingPlansV2PlanPlans_universal_d_ListPlansResponse as ListPlansResponse, pricingPlansV2PlanPlans_universal_d_GetPlanStatsRequest as GetPlanStatsRequest, pricingPlansV2PlanPlans_universal_d_GetPlanStatsResponse as GetPlanStatsResponse, pricingPlansV2PlanPlans_universal_d_CreatePlanRequest as CreatePlanRequest, pricingPlansV2PlanPlans_universal_d_CreatePlanResponse as CreatePlanResponse, pricingPlansV2PlanPlans_universal_d_UpdatePlanRequest as UpdatePlanRequest, pricingPlansV2PlanPlans_universal_d_UpdatePlanResponse as UpdatePlanResponse, pricingPlansV2PlanPlans_universal_d_BuyerCanCancelUpdated as BuyerCanCancelUpdated, pricingPlansV2PlanPlans_universal_d_SetPlanVisibilityRequest as SetPlanVisibilityRequest, pricingPlansV2PlanPlans_universal_d_SetPlanVisibilityResponse as SetPlanVisibilityResponse, pricingPlansV2PlanPlans_universal_d_MakePlanPrimaryRequest as MakePlanPrimaryRequest, pricingPlansV2PlanPlans_universal_d_MakePlanPrimaryResponse as MakePlanPrimaryResponse, pricingPlansV2PlanPlans_universal_d_ClearPrimaryRequest as ClearPrimaryRequest, pricingPlansV2PlanPlans_universal_d_ClearPrimaryResponse as ClearPrimaryResponse, pricingPlansV2PlanPlans_universal_d_ArchivePlanRequest as ArchivePlanRequest, pricingPlansV2PlanPlans_universal_d_ArchivePlanResponse as ArchivePlanResponse, pricingPlansV2PlanPlans_universal_d_PlanArchived as PlanArchived, pricingPlansV2PlanPlans_universal_d_BulkArchivePlanRequest as BulkArchivePlanRequest, pricingPlansV2PlanPlans_universal_d_BulkArchivePlanResponse as BulkArchivePlanResponse, pricingPlansV2PlanPlans_universal_d_BulkPlanResult as BulkPlanResult, pricingPlansV2PlanPlans_universal_d_ItemMetadata as ItemMetadata, pricingPlansV2PlanPlans_universal_d_ApplicationError as ApplicationError, pricingPlansV2PlanPlans_universal_d_BulkActionMetadata as BulkActionMetadata, pricingPlansV2PlanPlans_universal_d_ArrangePlansRequest as ArrangePlansRequest, pricingPlansV2PlanPlans_universal_d_ArrangePlansResponse as ArrangePlansResponse, pricingPlansV2PlanPlans_universal_d_CountPlansRequest as CountPlansRequest, pricingPlansV2PlanPlans_universal_d_CountPlansResponse as CountPlansResponse, pricingPlansV2PlanPlans_universal_d_GetPlansPremiumStatusRequest as GetPlansPremiumStatusRequest, pricingPlansV2PlanPlans_universal_d_GetPlansPremiumStatusResponse as GetPlansPremiumStatusResponse, pricingPlansV2PlanPlans_universal_d_QueryPlansRequest as QueryPlansRequest, pricingPlansV2PlanPlans_universal_d_QueryPlansResponse as QueryPlansResponse, pricingPlansV2PlanPlans_universal_d_DomainEvent as DomainEvent, pricingPlansV2PlanPlans_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, pricingPlansV2PlanPlans_universal_d_EntityCreatedEvent as EntityCreatedEvent, pricingPlansV2PlanPlans_universal_d_RestoreInfo as RestoreInfo, pricingPlansV2PlanPlans_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, pricingPlansV2PlanPlans_universal_d_EntityDeletedEvent as EntityDeletedEvent, pricingPlansV2PlanPlans_universal_d_ActionEvent as ActionEvent, pricingPlansV2PlanPlans_universal_d_MessageEnvelope as MessageEnvelope, pricingPlansV2PlanPlans_universal_d_IdentificationData as IdentificationData, pricingPlansV2PlanPlans_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, pricingPlansV2PlanPlans_universal_d_WebhookIdentityType as WebhookIdentityType, pricingPlansV2PlanPlans_universal_d_listPublicPlans as listPublicPlans, pricingPlansV2PlanPlans_universal_d_ListPublicPlansOptions as ListPublicPlansOptions, pricingPlansV2PlanPlans_universal_d_queryPublicPlans as queryPublicPlans, pricingPlansV2PlanPlans_universal_d_PlansQueryResult as PlansQueryResult, pricingPlansV2PlanPlans_universal_d_PlansQueryBuilder as PlansQueryBuilder, pricingPlansV2PlanPlans_universal_d_getPlan as getPlan, pricingPlansV2PlanPlans_universal_d_listPlans as listPlans, pricingPlansV2PlanPlans_universal_d_ListPlansOptions as ListPlansOptions, pricingPlansV2PlanPlans_universal_d_getPlanStats as getPlanStats, pricingPlansV2PlanPlans_universal_d_createPlan as createPlan, pricingPlansV2PlanPlans_universal_d_updatePlan as updatePlan, pricingPlansV2PlanPlans_universal_d_UpdatePlan as UpdatePlan, pricingPlansV2PlanPlans_universal_d_UpdatePlanOptions as UpdatePlanOptions, pricingPlansV2PlanPlans_universal_d_setPlanVisibility as setPlanVisibility, pricingPlansV2PlanPlans_universal_d_makePlanPrimary as makePlanPrimary, pricingPlansV2PlanPlans_universal_d_clearPrimary as clearPrimary, pricingPlansV2PlanPlans_universal_d_archivePlan as archivePlan, pricingPlansV2PlanPlans_universal_d_BulkArchivePlanOptions as BulkArchivePlanOptions, pricingPlansV2PlanPlans_universal_d_CountPlansOptions as CountPlansOptions, pricingPlansV2PlanPlans_universal_d_QueryPlansOptions as QueryPlansOptions, };\n }\n export { pricingPlansV2OrderOrders_universal_d as orders, pricingPlansV2PlanPlans_universal_d as plans };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-members.v2.d.ts", "content": "declare module \"wix-members.v2\" {\n interface Member$1 {\n /**\n * Member ID.\n * @readonly\n */\n _id?: string;\n /**\n * Email used by the member to log in to the site.\n *\n *\n */\n loginEmail?: string | null;\n /** Member's first name. */\n firstName?: string | null;\n /** Member's last name. */\n lastName?: string | null;\n /** Name that identifies the member to other members. Displayed on the member's profile page and interactions in the forum or blog. */\n nickname?: string | null;\n /**\n * Member privacy status.\n *\n * One of:\n * - `\"PUBLIC\"`: Member is visible to everyone.\n * - `\"PRIVATE\"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n * - `\"UNKNOWN\"`: Insufficient permissions to get the status.\n */\n profilePrivacyStatus?: SiteMemberPrivacyStatus;\n /** URL segment that determines the member's profile page. */\n slug?: string | null;\n /**\n * Member site access status.\n *\n * One of:\n * - `\"PENDING\"`: Member created and is waiting for approval by site owner.\n * - `\"APPROVED\"`: Member can log in to the site.\n * - \"OFFLINE\"`: Member is a guest author for the site blog and cannot log in to the site.\n * - `\"BLOCKED\"`: Member is blocked and cannot log in to the site.\n * - `\"UNKNOWN\"`: Insufficient permissions to get the status.\n */\n status?: SiteMemberStatus;\n /**\n * Date and time when the member was created.\n * @readonly\n */\n creationDate?: Date;\n /**\n * Date and time when the member was last updated.\n *\n *\n * @readonly\n */\n lastUpdateDate?: Date;\n /**\n * Date and time when the member last logged in to the site.\n *\n * @readonly\n */\n lastLoginDate?: Date;\n /**\n * List of email addresses.\n *\n *\n */\n emails?: string[];\n /** List of phone numbers. */\n phones?: string[];\n /** List of street addresses. */\n addresses?: Address$1[];\n /**\n * Custom fields, structured as key:object pairs. Custom field keys are defined in the Contacts Extended Fields API. The paired object contains the `name` and `value` properties, where `name` is the display name and `value` is the value stored for the member.\n *\n * Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.\n *\n * When updating a member, `name` is ignored.\n */\n customFields?: CustomField$1[];\n /** Member's profile picture URL. */\n picture?: string;\n /**\n * Member's contact ID.\n * @readonly\n */\n contactId?: string | null;\n }\n enum Role {\n UNDEFINED_ROLE = \"UNDEFINED_ROLE\",\n MEMBER = \"MEMBER\",\n OWNER = \"OWNER\",\n CONTRIBUTOR = \"CONTRIBUTOR\"\n }\n enum SiteMemberPrivacyStatus {\n UNDEFINED = \"UNDEFINED\",\n PUBLIC = \"PUBLIC\",\n PRIVATE = \"PRIVATE\",\n COMMUNITY = \"COMMUNITY\"\n }\n enum SiteMemberStatus {\n UNDEFINED_STATUS = \"UNDEFINED_STATUS\",\n APPLICANT = \"APPLICANT\",\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\",\n BLOCKED = \"BLOCKED\",\n OFFLINE_ONLY = \"OFFLINE_ONLY\"\n }\n interface Address$1 {\n /** Street address. */\n street?: string | null;\n /** City name. */\n city?: string | null;\n /** Region name. */\n region?: string | null;\n /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Postal code. */\n postalCode?: string | null;\n }\n interface CustomField$1 extends CustomFieldValueOneOf {\n /** String value. */\n strValue?: string | null;\n /** Number value. */\n numValue?: number;\n /** Date value. */\n dateValue?: Date;\n /** Display name. */\n name?: string;\n }\n /** @oneof */\n interface CustomFieldValueOneOf {\n strValue?: string | null;\n numValue?: number;\n dateValue?: Date;\n }\n interface Group {\n _id?: string;\n name?: string;\n type?: string;\n }\n interface ListMembersRequest$2 {\n /** for paging - maximum number of records to retrieve */\n limit?: number;\n /** for paging - how many records to skip */\n offset?: number;\n /** sort order - list of field and direction tuples. e.g. `[\"first_name:asc\", \"last_name:desc\"]` */\n order?: string[];\n /** partial response request - list of field names to get back in response */\n fields?: string[];\n /** filter members with specific status */\n status?: SiteMemberStatus;\n /** whether to include contact details */\n includeContactDetails?: boolean;\n }\n interface ListMembersResponse$2 {\n /** members returned by List request */\n members?: Member$1[];\n /** pagination information */\n pagination?: PaginationResponse;\n }\n interface PaginationResponse {\n /** offset that was applied to the request */\n offset?: number;\n /** limit that was applied to the request */\n limit?: number;\n /** total rows available */\n total?: number;\n /** indication that the total count was too expensive to calculate */\n tooManyToCount?: boolean;\n }\n interface SearchRequest {\n /** paging - offset and limit */\n paging?: Paging$2;\n /** search by field */\n searchBy?: SearchBy;\n /** partial response request - list of field names to get back in response */\n fields?: string[];\n /** filters */\n filterBy?: FilterBy;\n /** ASC or DESC order */\n sort?: Sorting$2;\n }\n interface Paging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface SearchBy {\n /** nick name filter */\n nickname?: string | null;\n }\n interface FilterBy {\n /** filter members with specific status */\n status?: string | null;\n /** group Id filter */\n groupId?: string | null;\n /** privacy status filter */\n privacyStatus?: SiteMemberPrivacyStatus;\n /** roles filter */\n roles?: Role[];\n }\n enum Sorting$2 {\n DESC = \"DESC\",\n ASC = \"ASC\"\n }\n interface SearchResponse {\n /** members returned by List request */\n members?: Member$1[];\n /** pagination information */\n pagination?: PaginationResponse;\n }\n interface GetCurrentMemberRequest {\n }\n interface GetMemberResponse$1 {\n member?: Member$1;\n }\n interface GetMemberRequest$1 {\n /** unique identifier of the requested member(required) */\n _id: string;\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include groups details */\n includeGroupsDetails?: boolean;\n }\n interface GetUserMembershipsRequest {\n /** unique identifier of the requested **Wix** user */\n userId: string;\n /** paging - offset and limit ( the max limit for page is 200) */\n paging?: Paging$2;\n }\n interface GetUserMembershipsResponse {\n /** sequence of member's of the user with there metaSiteId */\n userMemberships?: UserMembership[];\n }\n interface UserMembership {\n /** member id */\n memberId?: string;\n /** meta site id whom the member existing on */\n metasiteId?: string;\n }\n interface GetMemberRoleRequest {\n _id: string;\n }\n interface GetMemberRoleResponse {\n /**\n * member's role:\n *\n * `OWNER` - member that belongs to site owner\n * `CONTRIBUTOR` - member that belongs to a contributor in site\n * `MEMBER` - other members that registered to site\n */\n role?: Role;\n userId?: string | null;\n status?: SiteMemberStatus;\n contactId?: string | null;\n }\n interface GetMemberRolesRequest {\n /** user_id and/or contact_id */\n ids?: string[];\n }\n interface GetMemberRolesResponse {\n idsToRoles?: Record;\n }\n interface MemberRole {\n /**\n * member's role:\n *\n * `OWNER` - member that belongs to site owner\n * `CONTRIBUTOR` - member that belongs to a contributor in site\n * `MEMBER` - other members that registered to site\n */\n role?: Role;\n userId?: string | null;\n status?: SiteMemberStatus;\n contactId?: string | null;\n }\n interface BatchGetMembersRequest {\n /** unique identifier of the requested member(required) */\n ids?: string[];\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include groups details */\n includeGroupsDetails?: boolean;\n }\n interface BatchGetMembersResponse {\n /** lest of members details */\n members?: Member$1[];\n }\n interface GetAuthorizedPagesRequest {\n _id?: string;\n siteId: string;\n }\n interface GetAuthorizedPagesResponse {\n authorizedPages?: Record;\n }\n interface UpdateMemberRequest$1 {\n /** member id */\n _id: string;\n /** the Member object containing the fields to update */\n member?: Member$1;\n }\n interface UpdateMemberResponse$1 {\n /** updated member */\n member?: Member$1;\n }\n interface ChangeLoginEmailRequest {\n /** Member ID. */\n _id: string;\n /** New login email address. */\n newEmail?: string;\n }\n interface ChangeLoginEmailResponse {\n /** Member with the updated login email address. */\n member?: Member$1;\n }\n interface QueryMembersRequest$1 {\n /**\n * query - See https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md\n * supported fields: `id`, `login_email`, `status`, `language`, `date_created`, `last_update_date`, `flags`, `name`, `first_name`, `last_name`, `nickname`, `email_verified`, `privacy_status`\n */\n query?: string;\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include offline members */\n includeOfflineMembers?: boolean;\n }\n interface QueryMembersResponse$1 {\n /** members matching the query criteria */\n members?: Member$1[];\n /** pagination information */\n pagination?: PaginationResponse;\n }\n interface DeleteMemberRequest$1 {\n /** id of member that should be deleted (required) */\n _id: string;\n /** defines if the request is a bulk action */\n isBulkAction?: boolean;\n }\n interface DeleteMemberResponse$1 {\n }\n interface ApproveMemberRequest$1 extends ApproveMemberRequestMemberIdentifierOneOf {\n /** ID of the member to approve. */\n _id?: string;\n /** Login email address of the member to approve. */\n email?: string;\n /** Approval token returned by the [`register()`](#register) function. */\n token?: string;\n }\n /** @oneof */\n interface ApproveMemberRequestMemberIdentifierOneOf {\n /** ID of the member to approve. */\n _id?: string;\n /** Login email address of the member to approve. */\n email?: string;\n /**\n * \n */\n token?: string;\n }\n interface ApproveMemberResponse$1 {\n /** Approval session token. */\n session?: Session;\n }\n interface Session {\n /** Session token when the current member is logged into the site. */\n token?: string | null;\n }\n interface BlockMemberRequest$1 extends BlockMemberRequestMemberIdentifierOneOf {\n /** ID of the member to block. */\n _id?: string;\n /** Login email address of the member to block. */\n email?: string;\n }\n /** @oneof */\n interface BlockMemberRequestMemberIdentifierOneOf {\n _id?: string;\n /** Login email address of the member to block. */\n email?: string;\n }\n enum Source {\n UNKNOWN = \"UNKNOWN\",\n HANDLING_SPAM = \"HANDLING_SPAM\"\n }\n interface BlockMemberResponse$1 {\n }\n interface MakeMemberOfflineRequest {\n /** unique identifier of the requested member */\n _id: string;\n }\n interface MakeMemberOfflineResponse {\n }\n /** Registration options. */\n interface RegisterRequest {\n /** Login email address for the new site member. */\n email?: string;\n /**\n * Password the new site member will use to log in.\n *\n * Must be 4 to 15 ASCII-printable characters.\n */\n password?: string;\n /** Contact information for the registered member. */\n contactInfo?: MemberContactInfo;\n /**\n * Sets the privacy status of a new member upon registration.\n *\n * - `PUBLIC`: Member is visible to everyone.\n * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n * - `UNKNOWN`: Insufficient permissions to get the status.\n */\n profilePrivacyStatus?: SiteMemberPrivacyStatus;\n }\n interface MemberContactInfo {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Contact's profile picture. */\n picture?: string | null;\n /** Contact's email addresses. */\n emails?: string[];\n /** Contact's phone numbers. */\n phones?: string[];\n /** List of contact's labels. */\n labels?: string[];\n /**\n * Any number of custom fields.\n * [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n * are used to store additional information about your site's contacts.\n * When setting a custom field, use key:value pairs,\n * where the key matches the names defined in your site's\n * [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).\n * You can only set values for custom fields that already exist in the Contacts application.\n */\n customFields?: CustomField$1[];\n }\n interface DialogData {\n visitorId?: string | null;\n appId?: string | null;\n initiator?: string | null;\n }\n interface EmailVerification {\n /** ID of the verification process. */\n verificationId?: string;\n /**\n * 6-digit code for verification. Code can be between 100000 and 999999.\n *\n */\n otp?: string;\n }\n interface RegisterResponse {\n /** Newly registered member. */\n member?: Member$1;\n /**\n * in case the site is open for registration, all members are automatically\n * approved. they will get a temporary token for obtaining a valid session\n */\n session?: Session;\n /**\n * in case the site requires members approval, the registered member\n * will be an applicant until he's approved. the token can be used as a member\n * identifier for approval using the `MembersService.Approve` API\n */\n approvalToken?: string | null;\n }\n interface EmailVerificationRequired {\n /** ID of the verification process. */\n verificationId?: string;\n }\n interface EmailVerificationFailed {\n /** ID of the failed verification process. */\n verificationId?: string;\n /** Reason for verification failure. */\n verificationFailureReason?: VerificationFailureReason;\n }\n enum VerificationFailureReason {\n /** Default value - means no failure */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** Bad verification code */\n BAD_CODE = \"BAD_CODE\",\n /** Verification code was not found */\n NOT_FOUND = \"NOT_FOUND\",\n /** Error while sending the code to the user */\n SEND_CODE_ERROR = \"SEND_CODE_ERROR\"\n }\n interface LoginRequest {\n /** Login email address. */\n email?: string;\n /** Member password. */\n password?: string;\n }\n /** Session token for logging the member in. */\n interface LoginResponse {\n /** Session token. */\n session?: Session;\n /** the member's details */\n member?: Member$1;\n }\n interface GetResetPasswordLinkRequest {\n /** Contact ID of the member whose password will be reset. */\n contactId: string;\n }\n interface GetResetPasswordLinkResponse {\n /**\n * Reset password link.\n * Valid for one use, up to two weeks from when it is created.\n */\n resetPasswordLink?: string;\n }\n interface SendSetPasswordEmailRequest {\n /** Login email of the member whose password will be set. */\n email: string;\n /**\n * Whether to hide the ignore this email message .\n *\n * If `true`, the email tells the member\n * they can safely ignore\n * if they did not request the password change.\n *\n * Default: `false`.\n */\n hideIgnoreMessage?: boolean;\n }\n interface SendSetPasswordEmailResponse {\n /** Indicates if the request was successfully received. */\n accepted?: boolean;\n }\n interface ResetPasswordRequest {\n /** Contact ID of the member whose password will be reset. */\n contactId: string;\n }\n interface ResetPasswordResponse {\n /** Indicates if the request was successfully received. */\n accepted?: boolean;\n }\n interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {\n appleLogin?: AppleLogin;\n googleLogin?: GoogleLogin;\n facebookLogin?: FacebookLogin;\n /** Must either pass explicit msid OR signed instance with visitor */\n metaSiteId?: string | null;\n }\n /** @oneof */\n interface SocialLoginRequestLoginOneOf {\n appleLogin?: AppleLogin;\n googleLogin?: GoogleLogin;\n facebookLogin?: FacebookLogin;\n }\n interface AppleLogin {\n /** JWT signed by apple, contains target (aud), email etc */\n token?: string;\n }\n interface GoogleLogin {\n /** JWT signed by Google, contains target (aud), email etc */\n token?: string;\n }\n interface FacebookLogin {\n /** AccessToken created by Facebook, used to later fetch details over API */\n token?: string;\n }\n interface ListOptions {\n /** for paging - maximum number of records to retrieve */\n limit?: number;\n /** for paging - how many records to skip */\n offset?: number;\n /** sort order - list of field and direction tuples. e.g. `[\"first_name:asc\", \"last_name:desc\"]` */\n order?: string[];\n /** partial response request - list of field names to get back in response */\n fields?: string[];\n /** filter members with specific status */\n status?: SiteMemberStatus;\n /** whether to include contact details */\n includeContactDetails?: boolean;\n }\n interface SearchOptions {\n /** paging - offset and limit */\n paging?: Paging$2;\n /** search by field */\n searchBy?: SearchBy;\n /** partial response request - list of field names to get back in response */\n fields?: string[];\n /** filters */\n filterBy?: FilterBy;\n /** ASC or DESC order */\n sort?: Sorting$2;\n }\n interface GetOptions {\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include groups details */\n includeGroupsDetails?: boolean;\n }\n interface GetUserMembershipsOptions {\n /** paging - offset and limit ( the max limit for page is 200) */\n paging?: Paging$2;\n }\n interface GetRolesOptions {\n /** user_id and/or contact_id */\n ids?: string[];\n }\n interface BatchGetOptions {\n /** unique identifier of the requested member(required) */\n ids?: string[];\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include groups details */\n includeGroupsDetails?: boolean;\n }\n interface GetAuthorizedPagesOptions {\n _id?: string;\n }\n interface UpdateOptions {\n /** the Member object containing the fields to update */\n member?: Member$1;\n }\n /**\n * Changes a member's login email address.\n *\n * After running this function, the specified member can log in with the new email address. If the member uses social login (for example, Google login) and the member tries to log in with the old email address, they will be re-registered with the old email address.\n *\n * Site collaborators can use `changeLoginEmail()` to change another member's login email. Members who are not site collaborators can use `changeLoginEmail()` to change their own login email only.\n *\n * > **Note:** `changeLoginEmail()` cannot be used to change the login email of a site collaborator. Site collaborators can change their login emails from their Wix [account settings](https://manage.wix.com/account/account-settings).\n * @param _id - Member ID.\n * @param newEmail - New login email address.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField newEmail\n * @param options - Options for changing a login email address.\n * @adminMethod\n */\n function changeLoginEmail(_id: string, newEmail: string, options?: ChangeLoginEmailOptions): Promise;\n interface ChangeLoginEmailOptions {\n }\n interface QueryOptions {\n /**\n * query - See https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md\n * supported fields: `id`, `login_email`, `status`, `language`, `date_created`, `last_update_date`, `flags`, `name`, `first_name`, `last_name`, `nickname`, `email_verified`, `privacy_status`\n */\n query?: string;\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include offline members */\n includeOfflineMembers?: boolean;\n }\n interface DeleteOptions {\n /** defines if the request is a bulk action */\n isBulkAction?: boolean;\n }\n /**\n * Approves a pending member using an ID, email address or approval token.\n *\n * Tokens must be approved within 30 hours of token creation.\n * Use the `approvalToken` parameter returned from the\n * [`register()`](#register) function when approving a member by `token`.\n *\n * > **Note:**\n * > A new member's status is `\"PENDING\"` when the site's membership policy is set to manual approval.\n * > To learn more about setting your site's membership approval policy, see\n * > [Editing Your Member Signup Settings](https://support.wix.com/en/article/editing-your-member-signup-settings-for-the-default-form).\n *\n * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n */\n function approve(options?: ApproveOptions): Promise;\n interface ApproveOptions extends ApproveMemberRequestMemberIdentifierOneOf {\n /** ID of the member to approve. */\n _id?: string;\n /** Login email address of the member to approve. */\n email?: string;\n /** Approval token returned by the [`register()`](#register) function. */\n token?: string;\n }\n /**\n * Blocks a member from logging in to the site using an ID or email address.\n *\n * To unblock the member and allow them to log in to the site, use the [`approve()`](#approve) function.\n * @public\n * @documentationMaturity preview\n * @param options - Options for blocking a member from logging in.\n * @adminMethod\n */\n function block(options?: BlockOptions): Promise;\n interface BlockOptions extends BlockMemberRequestMemberIdentifierOneOf {\n /** ID of the member to block. */\n _id?: string;\n /** Login email address of the member to block. */\n email?: string;\n }\n /**\n * Registers a new site member.\n *\n * The specified `password` must be between 4 and 100 ASCII characters.\n *\n * >**Note:** The `register()` function behaves differently depending on your site's [member signup settings](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-members/enabling-custom-site-registration).\n * @param email - Login email address for the new site member.\n * @param password - Password the new site member will use to log in.\n *\n * Must be 4 to 15 ASCII-printable characters.\n * @public\n * @documentationMaturity preview\n * @requiredField email\n * @requiredField password\n * @param options - Options for registering a new member.\n * @adminMethod\n */\n function register(email: string, password: string, options?: RegisterOptions): Promise;\n interface RegisterOptions {\n /** Contact information for the registered member. */\n contactInfo?: MemberContactInfo;\n /**\n * Sets the privacy status of a new member upon registration.\n *\n * - `PUBLIC`: Member is visible to everyone.\n * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n * - `UNKNOWN`: Insufficient permissions to get the status.\n */\n profilePrivacyStatus?: SiteMemberPrivacyStatus;\n }\n interface SignupOptions {\n /** Login email address for the new site member. */\n email?: string;\n /**\n * Password the new site member will use to log in.\n *\n * Must be 4 to 15 ASCII-printable characters.\n */\n password?: string;\n /** Contact information for the registered member. */\n contactInfo?: MemberContactInfo;\n /**\n * Sets the privacy status of a new member upon registration.\n *\n * - `PUBLIC`: Member is visible to everyone.\n * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.\n * - `UNKNOWN`: Insufficient permissions to get the status.\n */\n profilePrivacyStatus?: SiteMemberPrivacyStatus;\n }\n /**\n * Logs in a registered member with an email and password.\n *\n * The `login()` function only works with existing members. To register a new member use the [`register()`](#register) function.\n *\n * To complete the login, the returned session token must be applied using the `applySessionToken()` function in the wix-members-frontend API.\n * @param email - Login email address.\n * @param password - Member password.\n * @public\n * @documentationMaturity preview\n * @requiredField email\n * @requiredField password\n * @param options - Options for logging in a member.\n * @adminMethod\n * @returns Session token for logging the member in.\n */\n function login(email: string, password: string, options?: LoginOptions): Promise;\n interface LoginOptions {\n }\n /**\n * Sends a site member an email with a link to set their password.\n *\n * The set password link is valid for 3 hours,\n * and it can be used only once.\n * If the link expires, the original password remains.\n * @param email - Login email of the member whose password will be set.\n * @public\n * @documentationMaturity preview\n * @requiredField email\n * @param options - Email display options.\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function sendSetPasswordEmail(email: string, options?: SendSetPasswordEmailOptions): Promise;\n interface SendSetPasswordEmailOptions {\n /**\n * Whether to hide the ignore this email message .\n *\n * If `true`, the email tells the member\n * they can safely ignore\n * if they did not request the password change.\n *\n * Default: `false`.\n */\n hideIgnoreMessage?: boolean;\n }\n interface SocialLoginOptions extends SocialLoginRequestLoginOneOf {\n /** Must either pass explicit msid OR signed instance with visitor */\n metaSiteId?: string | null;\n appleLogin?: AppleLogin;\n googleLogin?: GoogleLogin;\n facebookLogin?: FacebookLogin;\n }\n type identityMembersV1MemberAuthentication_universal_d_Role = Role;\n const identityMembersV1MemberAuthentication_universal_d_Role: typeof Role;\n type identityMembersV1MemberAuthentication_universal_d_SiteMemberPrivacyStatus = SiteMemberPrivacyStatus;\n const identityMembersV1MemberAuthentication_universal_d_SiteMemberPrivacyStatus: typeof SiteMemberPrivacyStatus;\n type identityMembersV1MemberAuthentication_universal_d_SiteMemberStatus = SiteMemberStatus;\n const identityMembersV1MemberAuthentication_universal_d_SiteMemberStatus: typeof SiteMemberStatus;\n type identityMembersV1MemberAuthentication_universal_d_CustomFieldValueOneOf = CustomFieldValueOneOf;\n type identityMembersV1MemberAuthentication_universal_d_Group = Group;\n type identityMembersV1MemberAuthentication_universal_d_PaginationResponse = PaginationResponse;\n type identityMembersV1MemberAuthentication_universal_d_SearchRequest = SearchRequest;\n type identityMembersV1MemberAuthentication_universal_d_SearchBy = SearchBy;\n type identityMembersV1MemberAuthentication_universal_d_FilterBy = FilterBy;\n type identityMembersV1MemberAuthentication_universal_d_SearchResponse = SearchResponse;\n type identityMembersV1MemberAuthentication_universal_d_GetCurrentMemberRequest = GetCurrentMemberRequest;\n type identityMembersV1MemberAuthentication_universal_d_GetUserMembershipsRequest = GetUserMembershipsRequest;\n type identityMembersV1MemberAuthentication_universal_d_GetUserMembershipsResponse = GetUserMembershipsResponse;\n type identityMembersV1MemberAuthentication_universal_d_UserMembership = UserMembership;\n type identityMembersV1MemberAuthentication_universal_d_GetMemberRoleRequest = GetMemberRoleRequest;\n type identityMembersV1MemberAuthentication_universal_d_GetMemberRoleResponse = GetMemberRoleResponse;\n type identityMembersV1MemberAuthentication_universal_d_GetMemberRolesRequest = GetMemberRolesRequest;\n type identityMembersV1MemberAuthentication_universal_d_GetMemberRolesResponse = GetMemberRolesResponse;\n type identityMembersV1MemberAuthentication_universal_d_MemberRole = MemberRole;\n type identityMembersV1MemberAuthentication_universal_d_BatchGetMembersRequest = BatchGetMembersRequest;\n type identityMembersV1MemberAuthentication_universal_d_BatchGetMembersResponse = BatchGetMembersResponse;\n type identityMembersV1MemberAuthentication_universal_d_GetAuthorizedPagesRequest = GetAuthorizedPagesRequest;\n type identityMembersV1MemberAuthentication_universal_d_GetAuthorizedPagesResponse = GetAuthorizedPagesResponse;\n type identityMembersV1MemberAuthentication_universal_d_ChangeLoginEmailRequest = ChangeLoginEmailRequest;\n type identityMembersV1MemberAuthentication_universal_d_ChangeLoginEmailResponse = ChangeLoginEmailResponse;\n type identityMembersV1MemberAuthentication_universal_d_ApproveMemberRequestMemberIdentifierOneOf = ApproveMemberRequestMemberIdentifierOneOf;\n type identityMembersV1MemberAuthentication_universal_d_Session = Session;\n type identityMembersV1MemberAuthentication_universal_d_BlockMemberRequestMemberIdentifierOneOf = BlockMemberRequestMemberIdentifierOneOf;\n type identityMembersV1MemberAuthentication_universal_d_Source = Source;\n const identityMembersV1MemberAuthentication_universal_d_Source: typeof Source;\n type identityMembersV1MemberAuthentication_universal_d_MakeMemberOfflineRequest = MakeMemberOfflineRequest;\n type identityMembersV1MemberAuthentication_universal_d_MakeMemberOfflineResponse = MakeMemberOfflineResponse;\n type identityMembersV1MemberAuthentication_universal_d_RegisterRequest = RegisterRequest;\n type identityMembersV1MemberAuthentication_universal_d_MemberContactInfo = MemberContactInfo;\n type identityMembersV1MemberAuthentication_universal_d_DialogData = DialogData;\n type identityMembersV1MemberAuthentication_universal_d_EmailVerification = EmailVerification;\n type identityMembersV1MemberAuthentication_universal_d_RegisterResponse = RegisterResponse;\n type identityMembersV1MemberAuthentication_universal_d_EmailVerificationRequired = EmailVerificationRequired;\n type identityMembersV1MemberAuthentication_universal_d_EmailVerificationFailed = EmailVerificationFailed;\n type identityMembersV1MemberAuthentication_universal_d_VerificationFailureReason = VerificationFailureReason;\n const identityMembersV1MemberAuthentication_universal_d_VerificationFailureReason: typeof VerificationFailureReason;\n type identityMembersV1MemberAuthentication_universal_d_LoginRequest = LoginRequest;\n type identityMembersV1MemberAuthentication_universal_d_LoginResponse = LoginResponse;\n type identityMembersV1MemberAuthentication_universal_d_GetResetPasswordLinkRequest = GetResetPasswordLinkRequest;\n type identityMembersV1MemberAuthentication_universal_d_GetResetPasswordLinkResponse = GetResetPasswordLinkResponse;\n type identityMembersV1MemberAuthentication_universal_d_SendSetPasswordEmailRequest = SendSetPasswordEmailRequest;\n type identityMembersV1MemberAuthentication_universal_d_SendSetPasswordEmailResponse = SendSetPasswordEmailResponse;\n type identityMembersV1MemberAuthentication_universal_d_ResetPasswordRequest = ResetPasswordRequest;\n type identityMembersV1MemberAuthentication_universal_d_ResetPasswordResponse = ResetPasswordResponse;\n type identityMembersV1MemberAuthentication_universal_d_SocialLoginRequest = SocialLoginRequest;\n type identityMembersV1MemberAuthentication_universal_d_SocialLoginRequestLoginOneOf = SocialLoginRequestLoginOneOf;\n type identityMembersV1MemberAuthentication_universal_d_AppleLogin = AppleLogin;\n type identityMembersV1MemberAuthentication_universal_d_GoogleLogin = GoogleLogin;\n type identityMembersV1MemberAuthentication_universal_d_FacebookLogin = FacebookLogin;\n type identityMembersV1MemberAuthentication_universal_d_ListOptions = ListOptions;\n type identityMembersV1MemberAuthentication_universal_d_SearchOptions = SearchOptions;\n type identityMembersV1MemberAuthentication_universal_d_GetOptions = GetOptions;\n type identityMembersV1MemberAuthentication_universal_d_GetUserMembershipsOptions = GetUserMembershipsOptions;\n type identityMembersV1MemberAuthentication_universal_d_GetRolesOptions = GetRolesOptions;\n type identityMembersV1MemberAuthentication_universal_d_BatchGetOptions = BatchGetOptions;\n type identityMembersV1MemberAuthentication_universal_d_GetAuthorizedPagesOptions = GetAuthorizedPagesOptions;\n type identityMembersV1MemberAuthentication_universal_d_UpdateOptions = UpdateOptions;\n const identityMembersV1MemberAuthentication_universal_d_changeLoginEmail: typeof changeLoginEmail;\n type identityMembersV1MemberAuthentication_universal_d_ChangeLoginEmailOptions = ChangeLoginEmailOptions;\n type identityMembersV1MemberAuthentication_universal_d_QueryOptions = QueryOptions;\n type identityMembersV1MemberAuthentication_universal_d_DeleteOptions = DeleteOptions;\n const identityMembersV1MemberAuthentication_universal_d_approve: typeof approve;\n type identityMembersV1MemberAuthentication_universal_d_ApproveOptions = ApproveOptions;\n const identityMembersV1MemberAuthentication_universal_d_block: typeof block;\n type identityMembersV1MemberAuthentication_universal_d_BlockOptions = BlockOptions;\n const identityMembersV1MemberAuthentication_universal_d_register: typeof register;\n type identityMembersV1MemberAuthentication_universal_d_RegisterOptions = RegisterOptions;\n type identityMembersV1MemberAuthentication_universal_d_SignupOptions = SignupOptions;\n const identityMembersV1MemberAuthentication_universal_d_login: typeof login;\n type identityMembersV1MemberAuthentication_universal_d_LoginOptions = LoginOptions;\n const identityMembersV1MemberAuthentication_universal_d_sendSetPasswordEmail: typeof sendSetPasswordEmail;\n type identityMembersV1MemberAuthentication_universal_d_SendSetPasswordEmailOptions = SendSetPasswordEmailOptions;\n type identityMembersV1MemberAuthentication_universal_d_SocialLoginOptions = SocialLoginOptions;\n namespace identityMembersV1MemberAuthentication_universal_d {\n export { Member$1 as Member, identityMembersV1MemberAuthentication_universal_d_Role as Role, identityMembersV1MemberAuthentication_universal_d_SiteMemberPrivacyStatus as SiteMemberPrivacyStatus, identityMembersV1MemberAuthentication_universal_d_SiteMemberStatus as SiteMemberStatus, Address$1 as Address, CustomField$1 as CustomField, identityMembersV1MemberAuthentication_universal_d_CustomFieldValueOneOf as CustomFieldValueOneOf, identityMembersV1MemberAuthentication_universal_d_Group as Group, ListMembersRequest$2 as ListMembersRequest, ListMembersResponse$2 as ListMembersResponse, identityMembersV1MemberAuthentication_universal_d_PaginationResponse as PaginationResponse, identityMembersV1MemberAuthentication_universal_d_SearchRequest as SearchRequest, Paging$2 as Paging, identityMembersV1MemberAuthentication_universal_d_SearchBy as SearchBy, identityMembersV1MemberAuthentication_universal_d_FilterBy as FilterBy, Sorting$2 as Sorting, identityMembersV1MemberAuthentication_universal_d_SearchResponse as SearchResponse, identityMembersV1MemberAuthentication_universal_d_GetCurrentMemberRequest as GetCurrentMemberRequest, GetMemberResponse$1 as GetMemberResponse, GetMemberRequest$1 as GetMemberRequest, identityMembersV1MemberAuthentication_universal_d_GetUserMembershipsRequest as GetUserMembershipsRequest, identityMembersV1MemberAuthentication_universal_d_GetUserMembershipsResponse as GetUserMembershipsResponse, identityMembersV1MemberAuthentication_universal_d_UserMembership as UserMembership, identityMembersV1MemberAuthentication_universal_d_GetMemberRoleRequest as GetMemberRoleRequest, identityMembersV1MemberAuthentication_universal_d_GetMemberRoleResponse as GetMemberRoleResponse, identityMembersV1MemberAuthentication_universal_d_GetMemberRolesRequest as GetMemberRolesRequest, identityMembersV1MemberAuthentication_universal_d_GetMemberRolesResponse as GetMemberRolesResponse, identityMembersV1MemberAuthentication_universal_d_MemberRole as MemberRole, identityMembersV1MemberAuthentication_universal_d_BatchGetMembersRequest as BatchGetMembersRequest, identityMembersV1MemberAuthentication_universal_d_BatchGetMembersResponse as BatchGetMembersResponse, identityMembersV1MemberAuthentication_universal_d_GetAuthorizedPagesRequest as GetAuthorizedPagesRequest, identityMembersV1MemberAuthentication_universal_d_GetAuthorizedPagesResponse as GetAuthorizedPagesResponse, UpdateMemberRequest$1 as UpdateMemberRequest, UpdateMemberResponse$1 as UpdateMemberResponse, identityMembersV1MemberAuthentication_universal_d_ChangeLoginEmailRequest as ChangeLoginEmailRequest, identityMembersV1MemberAuthentication_universal_d_ChangeLoginEmailResponse as ChangeLoginEmailResponse, QueryMembersRequest$1 as QueryMembersRequest, QueryMembersResponse$1 as QueryMembersResponse, DeleteMemberRequest$1 as DeleteMemberRequest, DeleteMemberResponse$1 as DeleteMemberResponse, ApproveMemberRequest$1 as ApproveMemberRequest, identityMembersV1MemberAuthentication_universal_d_ApproveMemberRequestMemberIdentifierOneOf as ApproveMemberRequestMemberIdentifierOneOf, ApproveMemberResponse$1 as ApproveMemberResponse, identityMembersV1MemberAuthentication_universal_d_Session as Session, BlockMemberRequest$1 as BlockMemberRequest, identityMembersV1MemberAuthentication_universal_d_BlockMemberRequestMemberIdentifierOneOf as BlockMemberRequestMemberIdentifierOneOf, identityMembersV1MemberAuthentication_universal_d_Source as Source, BlockMemberResponse$1 as BlockMemberResponse, identityMembersV1MemberAuthentication_universal_d_MakeMemberOfflineRequest as MakeMemberOfflineRequest, identityMembersV1MemberAuthentication_universal_d_MakeMemberOfflineResponse as MakeMemberOfflineResponse, identityMembersV1MemberAuthentication_universal_d_RegisterRequest as RegisterRequest, identityMembersV1MemberAuthentication_universal_d_MemberContactInfo as MemberContactInfo, identityMembersV1MemberAuthentication_universal_d_DialogData as DialogData, identityMembersV1MemberAuthentication_universal_d_EmailVerification as EmailVerification, identityMembersV1MemberAuthentication_universal_d_RegisterResponse as RegisterResponse, identityMembersV1MemberAuthentication_universal_d_EmailVerificationRequired as EmailVerificationRequired, identityMembersV1MemberAuthentication_universal_d_EmailVerificationFailed as EmailVerificationFailed, identityMembersV1MemberAuthentication_universal_d_VerificationFailureReason as VerificationFailureReason, identityMembersV1MemberAuthentication_universal_d_LoginRequest as LoginRequest, identityMembersV1MemberAuthentication_universal_d_LoginResponse as LoginResponse, identityMembersV1MemberAuthentication_universal_d_GetResetPasswordLinkRequest as GetResetPasswordLinkRequest, identityMembersV1MemberAuthentication_universal_d_GetResetPasswordLinkResponse as GetResetPasswordLinkResponse, identityMembersV1MemberAuthentication_universal_d_SendSetPasswordEmailRequest as SendSetPasswordEmailRequest, identityMembersV1MemberAuthentication_universal_d_SendSetPasswordEmailResponse as SendSetPasswordEmailResponse, identityMembersV1MemberAuthentication_universal_d_ResetPasswordRequest as ResetPasswordRequest, identityMembersV1MemberAuthentication_universal_d_ResetPasswordResponse as ResetPasswordResponse, identityMembersV1MemberAuthentication_universal_d_SocialLoginRequest as SocialLoginRequest, identityMembersV1MemberAuthentication_universal_d_SocialLoginRequestLoginOneOf as SocialLoginRequestLoginOneOf, identityMembersV1MemberAuthentication_universal_d_AppleLogin as AppleLogin, identityMembersV1MemberAuthentication_universal_d_GoogleLogin as GoogleLogin, identityMembersV1MemberAuthentication_universal_d_FacebookLogin as FacebookLogin, identityMembersV1MemberAuthentication_universal_d_ListOptions as ListOptions, identityMembersV1MemberAuthentication_universal_d_SearchOptions as SearchOptions, identityMembersV1MemberAuthentication_universal_d_GetOptions as GetOptions, identityMembersV1MemberAuthentication_universal_d_GetUserMembershipsOptions as GetUserMembershipsOptions, identityMembersV1MemberAuthentication_universal_d_GetRolesOptions as GetRolesOptions, identityMembersV1MemberAuthentication_universal_d_BatchGetOptions as BatchGetOptions, identityMembersV1MemberAuthentication_universal_d_GetAuthorizedPagesOptions as GetAuthorizedPagesOptions, identityMembersV1MemberAuthentication_universal_d_UpdateOptions as UpdateOptions, identityMembersV1MemberAuthentication_universal_d_changeLoginEmail as changeLoginEmail, identityMembersV1MemberAuthentication_universal_d_ChangeLoginEmailOptions as ChangeLoginEmailOptions, identityMembersV1MemberAuthentication_universal_d_QueryOptions as QueryOptions, identityMembersV1MemberAuthentication_universal_d_DeleteOptions as DeleteOptions, identityMembersV1MemberAuthentication_universal_d_approve as approve, identityMembersV1MemberAuthentication_universal_d_ApproveOptions as ApproveOptions, identityMembersV1MemberAuthentication_universal_d_block as block, identityMembersV1MemberAuthentication_universal_d_BlockOptions as BlockOptions, identityMembersV1MemberAuthentication_universal_d_register as register, identityMembersV1MemberAuthentication_universal_d_RegisterOptions as RegisterOptions, identityMembersV1MemberAuthentication_universal_d_SignupOptions as SignupOptions, identityMembersV1MemberAuthentication_universal_d_login as login, identityMembersV1MemberAuthentication_universal_d_LoginOptions as LoginOptions, identityMembersV1MemberAuthentication_universal_d_sendSetPasswordEmail as sendSetPasswordEmail, identityMembersV1MemberAuthentication_universal_d_SendSetPasswordEmailOptions as SendSetPasswordEmailOptions, identityMembersV1MemberAuthentication_universal_d_SocialLoginOptions as SocialLoginOptions, };\n }\n interface Member {\n /**\n * Member ID.\n * @readonly\n */\n _id?: string | null;\n /** Email used by the member to log in to the site. */\n loginEmail?: string | null;\n /**\n * Whether the email used by the member has been verified.\n * @readonly\n */\n loginEmailVerified?: boolean | null;\n /**\n * Member site access status.\n * @readonly\n */\n status?: Status;\n /**\n * Contact ID.\n * @readonly\n */\n contactId?: string | null;\n /**\n * Member's contact information. Contact information is stored in the\n * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n */\n contact?: Contact;\n /** Profile display details. */\n profile?: Profile;\n /** Member privacy status. */\n privacyStatus?: PrivacyStatusStatus;\n /**\n * Member activity status.\n * @readonly\n */\n activityStatus?: ActivityStatusStatus;\n /**\n * Date and time when the member was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time when the member was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Date and time when the member last logged in to the site.\n * @readonly\n */\n lastLoginDate?: Date | null;\n }\n enum Status {\n /** Insufficient permissions to get the status. */\n UNKNOWN = \"UNKNOWN\",\n /** Member created and is waiting for approval by site owner. */\n PENDING = \"PENDING\",\n /** Member can log in to the site. */\n APPROVED = \"APPROVED\",\n /** Member is blocked and can't log in to the site. */\n BLOCKED = \"BLOCKED\",\n /** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and can't log in to the site. */\n OFFLINE = \"OFFLINE\"\n }\n /** Contact info associated with the member. */\n interface Contact {\n /** Contact's first name. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /** List of phone numbers. */\n phones?: string[] | null;\n /** List of email addresses. */\n emails?: string[] | null;\n /** List of street addresses. */\n addresses?: Address[];\n /**\n * Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\n *\n * Example: `\"2020-03-15\"` for March 15, 2020.\n */\n birthdate?: string | null;\n /** Contact's company name. */\n company?: string | null;\n /** Contact's job title. */\n jobTitle?: string | null;\n /**\n * Custom fields are structured as key:value pairs where each key is the field `name`, and each value is the field's `value` for the member.\n *\n * > **Notes:**\n * > - Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.\n * > - When updating a member, `name` is ignored.\n */\n customFields?: Record;\n }\n /** Street address. */\n interface Address extends AddressStreetOneOf {\n /** Street address object, with number and name in separate fields. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n /**\n * Street address ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Free text providing more detailed address information,\n * such as apartment, suite, or floor.\n */\n addressLine2?: string | null;\n /** City name. */\n city?: string | null;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an\n * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string | null;\n /**\n * 2-letter country code in an\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string | null;\n /** Postal code. */\n postalCode?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf {\n /** Street address object, with number and name in separate fields. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface CustomField {\n /** Custom field name. */\n name?: string | null;\n /** Custom field value. */\n value?: any;\n }\n /** Member Profile */\n interface Profile {\n /**\n * Name that identifies the member to other members.\n * Displayed on the member's profile page\n * and interactions in the forum or blog.\n */\n nickname?: string | null;\n /**\n * Slug that determines the member's profile page URL.\n * @readonly\n */\n slug?: string | null;\n /** Member's profile photo. */\n photo?: Image;\n /**\n * Member's cover photo,\n * used as a background picture in members profile page.\n *\n * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.\n * When left empty, the values default to `0`.\n */\n cover?: Image;\n /**\n * Member title.\n *\n * Currently available through the API only.\n */\n title?: string | null;\n }\n interface Image {\n /**\n * Wix Media image ID,\n * set when the member selects an image from Wix Media.\n */\n _id?: string;\n /** Image URL. */\n url?: string;\n /** Original image width. */\n height?: number;\n /** Original image height. */\n width?: number;\n /**\n * X-axis offset.\n *\n * Default: `0`.\n */\n offsetX?: number | null;\n /**\n * Y-axis offset.\n *\n * Default: `0`.\n */\n offsetY?: number | null;\n }\n enum PrivacyStatusStatus {\n /** Insufficient permissions to get the status. */\n UNKNOWN = \"UNKNOWN\",\n /** Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions. */\n PRIVATE = \"PRIVATE\",\n /** Member is visible to everyone. */\n PUBLIC = \"PUBLIC\"\n }\n enum ActivityStatusStatus {\n /** Insufficient permissions to get the status. */\n UNKNOWN = \"UNKNOWN\",\n /** Member can write forum posts and blog comments. */\n ACTIVE = \"ACTIVE\",\n /** Member can't write forum posts or blog comments. */\n MUTED = \"MUTED\"\n }\n interface ExtendedFields {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface InvalidateCache extends InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n hardPurge?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App;\n /** Invalidate by page id */\n page?: Page;\n /** Invalidate by URI path */\n uri?: URI;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File;\n }\n interface App {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface UpdateMySlugRequest {\n /** New slug. */\n slug: string;\n }\n interface UpdateMySlugResponse {\n /** Updated member. */\n member?: Member;\n }\n interface SlugAlreadyExistsPayload {\n slug?: string;\n }\n interface UpdateMemberSlugRequest {\n /** Member ID. */\n _id: string;\n /** New slug. */\n slug: string;\n }\n interface UpdateMemberSlugResponse {\n /** Updated member. */\n member?: Member;\n }\n interface JoinCommunityRequest {\n }\n /** Member profile. */\n interface JoinCommunityResponse {\n /** The updated member. */\n member?: Member;\n }\n interface MemberJoinedCommunity {\n /**\n * Member id who joined the community\n * @readonly\n */\n memberId?: string;\n }\n interface LeaveCommunityRequest {\n }\n /** Member profile. */\n interface LeaveCommunityResponse {\n /** The updated member. */\n member?: Member;\n }\n interface MemberLeftCommunity {\n /**\n * Member id who left the community\n * @readonly\n */\n memberId?: string;\n }\n interface GetMyMemberRequest {\n /**\n * Predefined set of fields to return.\n *\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `_id` and all fields under `profile`.\n *\n * > **Note:**\n * > When returning the `\"PUBLIC\"` fieldset,\n * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`\n * > are returned as `\"UNKNOWN\"`.\n * @deprecated\n */\n fieldSet?: Set;\n /**\n * Predefined set of fields to return.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Set[];\n }\n enum Set {\n /**\n * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.\n * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n */\n PUBLIC = \"PUBLIC\",\n /** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */\n EXTENDED = \"EXTENDED\",\n /** Includes all fields. */\n FULL = \"FULL\"\n }\n /** Member profile. */\n interface GetMyMemberResponse {\n /** The logged-in member. */\n member?: Member;\n }\n interface GetMemberRequest {\n /** Member ID. */\n _id: string;\n /**\n * Predefined set of fields to return. One of:\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n * - `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n *\n *\n */\n fieldsets?: Set[];\n }\n interface GetMemberResponse {\n /** The requested member. */\n member?: Member;\n }\n interface MemberToMemberBlockedPayload {\n /** Member ID. */\n memberId?: string;\n }\n interface ListMembersRequest$1 {\n paging?: Paging$1;\n /**\n * Predefined set of fields to return. One of:\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n * - `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n *\n * Default: `\"PUBLIC\"`.\n */\n fieldsets?: Set[];\n sorting?: Sorting$1[];\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$1 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListMembersResponse$1 {\n /** List of members. */\n members?: Member[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata$1;\n }\n interface PagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface CursorPagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors$1;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$1 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryMembersRequest {\n /** Query options. */\n query?: Query;\n /**\n * Predefined sets of fields to return.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Set[];\n /** Plain text search. */\n search?: Search;\n }\n interface Query {\n /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */\n filter?: any;\n /** Limit number of results */\n paging?: Paging$1;\n /** Sort the results */\n sorting?: Sorting$1[];\n }\n /** Free text to match in searchable fields */\n interface Search {\n /** Search term or expression. */\n expression?: string | null;\n /**\n * Currently supported fields for search:\n *\n * - `loginEmail`\n * - `contact.firstName`\n * - `contact.lastName`\n * - `profile.title`\n * - `profile.nickname`\n * - `profile.slug`\n *\n * Default: `profile.nickname`.\n */\n fields?: string[];\n }\n interface QueryMembersResponse {\n /** List of members that met the query filter criteria. */\n members?: Member[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata$1;\n }\n interface MuteMemberRequest {\n /** ID of the member to mute. */\n _id: string;\n }\n interface MuteMemberResponse {\n /** Muted member. */\n member?: Member;\n }\n interface MemberMuted {\n /**\n * Member id who got muted\n * @readonly\n */\n memberId?: string;\n }\n interface UnmuteMemberRequest {\n /** ID of the member to unmute. */\n _id: string;\n }\n interface UnmuteMemberResponse {\n /** Unmuted member. */\n member?: Member;\n }\n interface MemberUnmuted {\n /**\n * Member id who got unmuted\n * @readonly\n */\n memberId?: string;\n }\n interface ApproveMemberRequest {\n /** ID of the member to approve. */\n _id: string;\n }\n interface ApproveMemberResponse {\n /** Approved member. */\n member?: Member;\n }\n interface MemberApproved {\n /**\n * Member id who got approved\n * @readonly\n */\n memberId?: string;\n }\n interface BlockMemberRequest {\n /** ID of a member to block. */\n _id: string;\n }\n interface BlockMemberResponse {\n /** Blocked member. */\n member?: Member;\n }\n interface MemberBlocked {\n /**\n * Member id who got blocked\n * @readonly\n */\n memberId?: string;\n }\n interface MemberSelfBlockForbiddenPayload {\n /** Target's member ID. */\n memberId?: string;\n }\n interface OwnerMemberBlockForbiddenPayload {\n /** Owner's member ID. */\n memberId?: string;\n }\n interface ActiveSubscriptionMemberBlockForbiddenPayload {\n /** Active subscription member ID. */\n memberId?: string;\n }\n interface DisconnectMemberRequest {\n /** ID of a member to disconnect. */\n _id: string;\n }\n interface DisconnectMemberResponse {\n /** Disconnected member. */\n member?: Member;\n }\n interface DeleteMemberRequest {\n /** ID of the member to delete. */\n _id: string;\n }\n interface DeleteMemberResponse {\n }\n interface ContentReassignmentRequested {\n fromMember?: Member;\n toMember?: Member;\n }\n interface ContentDeletionRequested {\n member?: Member;\n }\n interface OwnerOrContributorDeleteForbiddenPayload {\n /** Owner's or contributor's member ID. */\n memberId?: string;\n }\n interface ActiveSubscriptionMemberDeleteForbiddenPayload {\n /** Active subscription member ID. */\n memberId?: string;\n }\n interface DeleteMyMemberRequest {\n /** ID of a member receiving deleted member's content. */\n contentAssigneeId?: string | null;\n }\n interface DeleteMyMemberResponse {\n }\n interface BulkDeleteMembersRequest {\n /** IDs of members to be deleted. */\n memberIds: string[];\n }\n interface BulkDeleteMembersResponse {\n /** Result. */\n results?: BulkMemberResult[];\n /** Bulk action result metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkMemberResult {\n itemMetadata?: ItemMetadata;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkDeleteMembersByFilterRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */\n filter: any;\n /** ID of a member receiving the deleted member's content. */\n contentAssigneeId?: string | null;\n /** Plain text search. */\n search?: Search;\n }\n interface BulkDeleteMembersByFilterResponse {\n /**\n * Job ID.\n * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.\n */\n jobId?: string;\n }\n interface BulkApproveMembersRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */\n filter: any;\n }\n interface BulkApproveMembersResponse {\n /**\n * Job ID.\n * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.\n */\n jobId?: string;\n }\n interface BulkBlockMembersRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */\n filter: any;\n }\n interface BulkBlockMembersResponse {\n /**\n * Job ID.\n * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.\n */\n jobId?: string;\n }\n interface CreateMemberRequest {\n /** Member to create. */\n member?: Member;\n }\n interface CreateMemberResponse {\n /** New member. */\n member?: Member;\n }\n interface UpdateMemberRequest {\n /** Member to update. */\n member?: Member;\n }\n interface UpdateMemberResponse {\n /** Updated member. */\n member?: Member;\n }\n interface InvalidCustomFieldUrlPayload {\n /** Custom field key and invalid URL. */\n fields?: Record;\n }\n interface DeleteMemberPhonesRequest {\n /** ID of the member whose phone numbers will be deleted. */\n _id: string;\n }\n interface DeleteMemberPhonesResponse {\n /** Updated member. */\n member?: Member;\n }\n interface DeleteMemberEmailsRequest {\n /** ID of the member whose email addresses will be deleted. */\n _id: string;\n }\n interface DeleteMemberEmailsResponse {\n /** Updated member. */\n member?: Member;\n }\n interface DeleteMemberAddressesRequest {\n /** ID of the member whose street addresses will be deleted. */\n _id: string;\n }\n interface DeleteMemberAddressesResponse {\n /** Updated member. */\n member?: Member;\n }\n interface Empty {\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned;\n /** A meta site id. */\n metaSiteId?: string;\n /** A meta site version. Monotonically increasing. */\n version?: string;\n /** A timestamp of the event. */\n timestamp?: string;\n /**\n * TODO(meta-site): Change validation once validations are disabled for consumers\n * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659\n */\n assets?: Asset[];\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated;\n /** Emitted on a meta site transfer completion. */\n siteTransferred?: SiteTransferred;\n /** Emitted on a meta site deletion. */\n siteDeleted?: SiteDeleted;\n /** Emitted on a meta site restoration. */\n siteUndeleted?: SiteUndeleted;\n /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */\n sitePublished?: SitePublished;\n /** Emitted on a meta site unpublish. */\n siteUnpublished?: SiteUnpublished;\n /** Emitted when meta site is marked as template. */\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n /** Emitted when meta site is marked as a WixSite. */\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n /** Emitted when an application is provisioned (installed). */\n serviceProvisioned?: ServiceProvisioned;\n /** Emitted when an application is removed (uninstalled). */\n serviceRemoved?: ServiceRemoved;\n /** Emitted when meta site name (URL slug) is changed. */\n siteRenamedPayload?: SiteRenamed;\n /** Emitted when meta site was permanently deleted. */\n hardDeleted?: SiteHardDeleted;\n /** Emitted on a namespace change. */\n namespaceChanged?: NamespaceChanged;\n /** Emitted when Studio is attached. */\n studioAssigned?: StudioAssigned;\n /** Emitted when Studio is detached. */\n studioUnassigned?: StudioUnassigned;\n }\n interface Asset {\n /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */\n appDefId?: string;\n /** An instance id. For legacy reasons may be UUID or a string. */\n instanceId?: string;\n /** An application state. */\n state?: State;\n }\n enum State {\n UNKNOWN = \"UNKNOWN\",\n ENABLED = \"ENABLED\",\n DISABLED = \"DISABLED\",\n PENDING = \"PENDING\",\n DEMO = \"DEMO\"\n }\n interface SiteCreated {\n /** A template identifier (empty if not created from a template). */\n originTemplateId?: string;\n /** An account id of the owner. */\n ownerId?: string;\n /** A context in which meta site was created. */\n context?: SiteCreatedContext;\n /**\n * A meta site id from which this site was created.\n *\n * In case of a creation from a template it's a template id.\n * In case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.\n */\n originMetaSiteId?: string | null;\n /** A meta site name (URL slug). */\n siteName?: string;\n /** A namespace. */\n namespace?: Namespace;\n }\n enum SiteCreatedContext {\n /** A valid option, we don't expose all reasons why site might be created. */\n OTHER = \"OTHER\",\n /** A meta site was created from template. */\n FROM_TEMPLATE = \"FROM_TEMPLATE\",\n /** A meta site was created by copying of the transfferred meta site. */\n DUPLICATE_BY_SITE_TRANSFER = \"DUPLICATE_BY_SITE_TRANSFER\",\n /** A copy of existing meta site. */\n DUPLICATE = \"DUPLICATE\",\n /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */\n OLD_SITE_TRANSFER = \"OLD_SITE_TRANSFER\",\n /** deprecated A meta site was created for Flash editor. */\n FLASH = \"FLASH\"\n }\n enum Namespace {\n UNKNOWN_NAMESPACE = \"UNKNOWN_NAMESPACE\",\n /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */\n WIX = \"WIX\",\n /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n SHOUT_OUT = \"SHOUT_OUT\",\n /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ALBUMS = \"ALBUMS\",\n /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n WIX_STORES_TEST_DRIVE = \"WIX_STORES_TEST_DRIVE\",\n /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n HOTELS = \"HOTELS\",\n /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n CLUBS = \"CLUBS\",\n /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n ONBOARDING_DRAFT = \"ONBOARDING_DRAFT\",\n /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_SITE = \"DEV_SITE\",\n /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n LOGOS = \"LOGOS\",\n /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */\n VIDEO_MAKER = \"VIDEO_MAKER\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n PARTNER_DASHBOARD = \"PARTNER_DASHBOARD\",\n /** MetaSites with this namespace will *not* be shown in a user's site list by default. */\n DEV_CENTER_COMPANY = \"DEV_CENTER_COMPANY\",\n /**\n * A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n *\n * Meta site with this namespace will *not* be shown in a user's site list by default.\n */\n HTML_DRAFT = \"HTML_DRAFT\",\n /**\n * the user-journey for Fitness users who want to start from managing their business instead of designing their website.\n * Will be accessible from Site List and will not have a website app.\n * Once the user attaches a site, the site will become a regular wixsite.\n */\n SITELESS_BUSINESS = \"SITELESS_BUSINESS\",\n /** Belongs to \"strategic products\" company. Supports new product in the creator's economy space. */\n CREATOR_ECONOMY = \"CREATOR_ECONOMY\",\n /** It is to be used in the Business First efforts. */\n DASHBOARD_FIRST = \"DASHBOARD_FIRST\",\n /** Bookings business flow with no site. */\n ANYWHERE = \"ANYWHERE\",\n /** Namespace for Headless Backoffice with no editor */\n HEADLESS = \"HEADLESS\",\n /**\n * Namespace for master site that will exist in parent account that will be referenced by subaccounts\n * The site will be used for account level CSM feature for enterprise\n */\n ACCOUNT_MASTER_CMS = \"ACCOUNT_MASTER_CMS\",\n /** Rise.ai Siteless account management for Gift Cards and Store Credit. */\n RISE = \"RISE\",\n /**\n * As part of the branded app new funnel, users now can create a meta site that will be branded app first.\n * There's a blank site behind the scene but it's blank).\n * The Mobile company will be the owner of this namespace.\n */\n BRANDED_FIRST = \"BRANDED_FIRST\",\n /** Nownia.com Siteless account management for Ai Scheduling Assistant. */\n NOWNIA = \"NOWNIA\",\n /**\n * UGC Templates are templates that are created by users for personal use and to sale to other users.\n * The Partners company owns this namespace.\n */\n UGC_TEMPLATE = \"UGC_TEMPLATE\",\n /** Codux Headless Sites */\n CODUX = \"CODUX\",\n /** Bobb - AI Design Creator. */\n MEDIA_DESIGN_CREATOR = \"MEDIA_DESIGN_CREATOR\",\n /**\n * Shared Blog Site is a unique single site across Enterprise account,\n * This site will hold all Blog posts related to the Marketing product.\n */\n SHARED_BLOG_ENTERPRISE = \"SHARED_BLOG_ENTERPRISE\"\n }\n /** Site transferred to another user. */\n interface SiteTransferred {\n /** A previous owner id (user that transfers meta site). */\n oldOwnerId?: string;\n /** A new owner id (user that accepts meta site). */\n newOwnerId?: string;\n }\n /** Soft deletion of the meta site. Could be restored. */\n interface SiteDeleted {\n /** A deletion context. */\n deleteContext?: DeleteContext;\n }\n interface DeleteContext {\n /** When the meta site was deleted. */\n dateDeleted?: Date | null;\n /** A status. */\n deleteStatus?: DeleteStatus;\n /** A reason (flow). */\n deleteOrigin?: string;\n /** A service that deleted it. */\n initiatorId?: string | null;\n }\n enum DeleteStatus {\n UNKNOWN = \"UNKNOWN\",\n TRASH = \"TRASH\",\n DELETED = \"DELETED\",\n PENDING_PURGE = \"PENDING_PURGE\"\n }\n /** Restoration of the meta site. */\n interface SiteUndeleted {\n }\n /** First publish of a meta site. Or subsequent publish after unpublish. */\n interface SitePublished {\n }\n interface SiteUnpublished {\n /** A list of URLs previously associated with the meta site. */\n urls?: string[];\n }\n interface SiteMarkedAsTemplate {\n }\n interface SiteMarkedAsWixSite {\n }\n /**\n * Represents a service provisioned a site.\n *\n * Note on `origin_instance_id`:\n * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.\n * This is because of the following scenario:\n *\n * Imagine you have a template where a third-party application (TPA) includes some stub data,\n * such as a product catalog. When you create a site from this template, you inherit this\n * default product catalog. However, if the template's product catalog is modified,\n * your site will retain the catalog as it was at the time of site creation. This ensures that\n * your site remains consistent with what you initially received and does not include any\n * changes made to the original template afterward.\n * To ensure this, the TPA on the template gets a new instance_id.\n */\n interface ServiceProvisioned {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** An instance id from which this instance is originated. */\n originInstanceId?: string;\n /** A version. */\n version?: string | null;\n /** The origin meta site id */\n originMetaSiteId?: string | null;\n }\n interface ServiceRemoved {\n /** Either UUID or EmbeddedServiceType. */\n appDefId?: string;\n /** Not only UUID. Something here could be something weird. */\n instanceId?: string;\n /** A version. */\n version?: string | null;\n }\n /** Rename of the site. Meaning, free public url has been changed as well. */\n interface SiteRenamed {\n /** A new meta site name (URL slug). */\n newSiteName?: string;\n /** A previous meta site name (URL slug). */\n oldSiteName?: string;\n }\n /**\n * Hard deletion of the meta site.\n *\n * Could not be restored. Therefore it's desirable to cleanup data.\n */\n interface SiteHardDeleted {\n /** A deletion context. */\n deleteContext?: DeleteContext;\n }\n interface NamespaceChanged {\n /** A previous namespace. */\n oldNamespace?: Namespace;\n /** A new namespace. */\n newNamespace?: Namespace;\n }\n /** Assigned Studio editor */\n interface StudioAssigned {\n }\n /** Unassigned Studio editor */\n interface StudioUnassigned {\n }\n interface MemberOwnershipTransferred {\n fromMember?: Member;\n toMember?: Member;\n }\n interface MemberIdChanged {\n fromId?: string;\n toId?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Updates the currently logged in member's slug.\n *\n * The `slug` is the end of a member's URL that refers to a specific logged-in member. For example, if a member's URL is `https://example.com/member/{my-member-slug}`, the slug is `my-member-slug`. The slug is case-sensitive and is generally derived from the member's `nickname`; otherwise, it's derived from the `loginEmail`.\n *\n * > **Note:**\n * > Only logged-in members can call this function without elevated permissions.\n * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @param slug - New slug.\n * @public\n * @requiredField slug\n * @permissionId MEMBERS.MEMBER_UPDATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.members.api.Members.UpdateMySlug\n */\n function updateCurrentMemberSlug(slug: string): Promise;\n /**\n * Updates the member's slug.\n * @param _id - Member ID.\n * @param slug - New slug.\n * @public\n * @requiredField _id\n * @requiredField slug\n * @permissionId MEMBERS.MEMBER_UPDATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.members.api.Members.UpdateMemberSlug\n */\n function updateMemberSlug(_id: string, slug: string): Promise;\n /**\n * Joins the currently logged-in member to the site community and sets their profile to public.\n *\n * When a member's profile is public, they have access to the site's\n * [Members Area](https://support.wix.com/en/article/about-members-area)\n * features — such as chat, forum, and followers —\n * and their profile is visible to other members and site visitors.\n *\n * > **Note:**\n * > Only logged-in members can call this function without elevated permissions.\n * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @public\n * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY\n * @applicableIdentity MEMBER\n * @returns Member profile.\n * @fqn com.wixpress.members.api.Members.JoinCommunity\n */\n function joinCommunity(): Promise;\n /**\n * Removes the currently logged-in member from the site community and sets their profile to private.\n *\n * When a member's profile is private,\n * they do not have access to the site's\n * [Members Area](https://support.wix.com/en/article/about-members-area)\n * features — such as chat, forum, and followers —\n * and their profile is hidden from other members and site visitors.\n *\n * > **Notes:**\n * > + If a member leaves the site's community, their content (such as forum posts and blog comments) remain publicly visible.\n *\n * > + Only logged-in members can call this function without elevated permissions.\n * > + To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @public\n * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY\n * @applicableIdentity MEMBER\n * @returns Member profile.\n * @fqn com.wixpress.members.api.Members.LeaveCommunity\n */\n function leaveCommunity(): Promise;\n /**\n * Retrieves the currently logged-in member.\n * @public\n * @permissionId MEMBERS.MEMBER_READ\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Members and Contacts - all read permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Read Members\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Member profile.\n * @fqn com.wixpress.members.api.Members.GetMyMember\n */\n function getCurrentMember(options?: GetCurrentMemberOptions): Promise;\n interface GetCurrentMemberOptions {\n /**\n * Predefined set of fields to return.\n *\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `_id` and all fields under `profile`.\n *\n * > **Note:**\n * > When returning the `\"PUBLIC\"` fieldset,\n * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`\n * > are returned as `\"UNKNOWN\"`.\n * @deprecated\n */\n fieldSet?: Set;\n /**\n * Predefined set of fields to return.\n *\n * Default: `PUBLIC`.\n */\n fieldsets?: Set[];\n }\n /**\n * Retrieves a member by ID.\n *\n * >**Note:** The returned Member object contains only the fields that were explicitly added to the Member object. Custom Contact fields are **not** automatically added to the Member object. They must be [added to the Member object by the site owner](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).\n *\n * @param _id - Member ID.\n * @public\n * @requiredField _id\n * @param options - Fieldset options.\n * @permissionId MEMBERS.MEMBER_READ\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Members and Contacts - all read permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Read Members\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns The requested member.\n * @fqn com.wixpress.members.api.Members.GetMember\n */\n function getMember(_id: string, options?: GetMemberOptions): Promise;\n interface GetMemberOptions {\n /**\n * Predefined set of fields to return. One of:\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n * - `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n *\n * Default: `\"PUBLIC\"`.\n */\n fieldsets?: Set[];\n }\n /**\n * Lists site members, given the provided paging and fieldsets.\n *\n * - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.\n * - `FULL` fieldset returns all fields.\n * @public\n * @param options - Options for paging, sorting, and specifying fields to return.\n * @permissionId MEMBERS.MEMBER_READ\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Members and Contacts - all read permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Read Members\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.members.api.Members.ListMembers\n */\n function listMembers(options?: ListMembersOptions): Promise;\n interface ListMembersOptions {\n /** Paging options. */\n paging?: Paging$1;\n /**\n * Predefined set of fields to return. One of:\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n * - `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n *\n * Default: `\"PUBLIC\"`.\n */\n fieldsets?: Set[];\n /** Sorting options. */\n sorting?: Sorting$1[];\n }\n /**\n * Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.\n *\n * The returned object contains the query definition which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `MembersQueryBuilder` functions onto the query. `MembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns. The functions that are chained to `queryMembers()` are applied in the order they are called.\n *\n * `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:\n * - `skip`: `0`\n * - `limit`: `50`\n *\n * Currently supported fields for sorting:\n * - `profile.nickname`\n * - `contact.firstName`\n * - `contact.lastName`\n * - `createdDate`\n * - `lastLoginDate`\n *\n * The following `MembersQueryBuilder` functions are supported for the `queryMembers()` function. For a full description of the Locations object, see the returned for the `items` property in `MembersQueryResult`.\n * @public\n * @param options - Query options.\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Read Members and Contacts - all read permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Read Members\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @permissionId MEMBERS.MEMBER_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.members.api.Members.QueryMembers\n */\n function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;\n interface QueryMembersOptions {\n /**\n * Predefined set of fields to return. One of:\n * - `\"FULL\"`: Returns all fields.\n * - `\"PUBLIC\"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.\n * - `\"EXTENDED\"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.\n *\n * Default: `\"PUBLIC\"`.\n */\n fieldsets?: Set[] | undefined;\n /** Plain text search. */\n search?: Search | undefined;\n }\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface MembersQueryResult extends QueryOffsetResult {\n items: Member[];\n query: MembersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface MembersQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"loginEmail\" | \"contactId\" | \"contact.firstName\" | \"contact.lastName\" | \"profile.nickname\" | \"profile.slug\" | \"privacyStatus\", value: any) => MembersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"loginEmail\" | \"contactId\" | \"contact.firstName\" | \"contact.lastName\" | \"profile.nickname\" | \"profile.slug\" | \"privacyStatus\", value: any) => MembersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"_id\" | \"loginEmail\" | \"contactId\" | \"contact.firstName\" | \"contact.lastName\" | \"profile.nickname\" | \"profile.slug\", value: string) => MembersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"_id\" | \"loginEmail\" | \"contactId\" | \"contact.firstName\" | \"contact.lastName\" | \"profile.nickname\" | \"profile.slug\" | \"privacyStatus\", value: any[]) => MembersQueryBuilder;\n in: (propertyName: \"_id\" | \"loginEmail\" | \"contactId\" | \"contact.firstName\" | \"contact.lastName\" | \"profile.nickname\" | \"profile.slug\" | \"privacyStatus\", value: any) => MembersQueryBuilder;\n exists: (propertyName: \"_id\" | \"loginEmail\" | \"contactId\" | \"contact.firstName\" | \"contact.lastName\" | \"profile.nickname\" | \"profile.slug\" | \"privacyStatus\", value: boolean) => MembersQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => MembersQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => MembersQueryBuilder;\n find: () => Promise;\n }\n /**\n * Mutes a member.\n *\n * Muted members can't engage with a community. For example, leave comments, like, and share posts or comments.\n *\n * You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).\n * @param _id - ID of the member to mute.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_MUTE\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.MuteMember\n */\n function muteMember(_id: string): Promise;\n /**\n * Unmutes a member.\n *\n * Unmuted members can engage with the comunity. For example, leave comments, like, and share posts.\n *\n * You can unmute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).\n * @param _id - ID of the member to unmute.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_MUTE\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.UnmuteMember\n */\n function unmuteMember(_id: string): Promise;\n /**\n * Changes member status to `APPROVED` and gives access to members-only pages.\n *\n * Call this API to:\n * - Approve a pending member.\n * - Unblock a blocked member.\n * @param _id - ID of the member to approve.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_APPROVE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.ApproveMember\n */\n function approveMember(_id: string): Promise;\n /**\n * Blocks a member.\n *\n * A blocked member can't log in to members-only pages.\n *\n * To unblock a member, call Approve Member.\n * @param _id - ID of a member to block.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_BLOCK\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.BlockMember\n */\n function blockMember(_id: string): Promise;\n /**\n * Disconnects a member.\n *\n * A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.\n *\n * >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.\n * @param _id - ID of a member to disconnect.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_DISCONNECT\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.DisconnectMember\n */\n function disconnectMember(_id: string): Promise;\n /**\n * Deletes a member.\n *\n * The `deleteMember()` function returns a Promise that resolves to a member object when the specified member is deleted.\n *\n * >**Note:** This function permanently deletes a member. Once deleted, a member cannot be restored.\n * @param _id - ID of the member to delete.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_DELETE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.DeleteMember\n */\n function deleteMember(_id: string, options?: DeleteMemberOptions): Promise;\n interface DeleteMemberOptions {\n }\n /**\n * Deletes the currently logged in member.\n *\n * After calling this method, the member is logged out of the site.\n *\n * All content created by this member is transferred to another account. For example, if a Wix user had blog posts, those posts are transferred to the specified account, which then becomes the owner of those posts.\n *\n * >**Note:**\n * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).\n * @public\n * @permissionId MEMBERS.MEMBER_DELETE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.DeleteMyMember\n */\n function deleteMyMember(options?: DeleteMyMemberOptions): Promise;\n interface DeleteMyMemberOptions {\n /** ID of a member receiving deleted member's content. */\n contentAssigneeId?: string | null;\n }\n /**\n * Deletes multiple members by `memberId`.\n *\n * All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.\n * @param memberIds - IDs of members to be deleted.\n * @public\n * @requiredField memberIds\n * @permissionId MEMBERS.MEMBER_DELETE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.BulkDeleteMembers\n */\n function bulkDeleteMembers(memberIds: string[]): Promise;\n /**\n * Deletes multiple members by the specified filter.\n *\n * All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.\n * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.\n * @public\n * @requiredField filter\n * @permissionId MEMBERS.MEMBER_DELETE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter\n */\n function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise;\n interface BulkDeleteMembersByFilterOptions {\n /** ID of a member receiving the deleted member's content. */\n contentAssigneeId?: string | null;\n /** Plain text search. */\n search?: Search;\n }\n /**\n * Changes status of multiple members to `APPROVED`, and gives access to members-only pages.\n *\n * Call this API to:\n * - Approve pending members.\n * - Unblock blocked members.\n * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.\n * @public\n * @requiredField filter\n * @permissionId MEMBERS.MEMBER_APPROVE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.BulkApproveMembers\n */\n function bulkApproveMembers(filter: any): Promise;\n /**\n * Blocks multiple members by a specified filter.\n *\n * Blocked members can't log in to members-only pages.\n *\n * To unblock multiple members, call Bulk Approve Members.\n * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.\n * @public\n * @requiredField filter\n * @permissionId MEMBERS.MEMBER_BLOCK\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.members.api.Members.BulkBlockMembers\n */\n function bulkBlockMembers(filter: any): Promise;\n /**\n * Creates a site member.\n *\n * After creation, you can use the `sendSetPasswordEmail()` function in the Members Authentication API to email the member with a link to set their password.\n * The member can log in to the site once they set their password for the first time.\n *\n * > **Note:**\n * > When creating multiple members, set your requests at least 1 second apart to keep below rate limits.\n * @public\n * @permissionId MEMBERS.MEMBER_CREATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @returns New member.\n * @fqn com.wixpress.members.api.Members.CreateMember\n */\n function createMember(options?: CreateMemberOptions): Promise;\n interface CreateMemberOptions {\n /** Member to create. */\n member?: Member;\n }\n /**\n * Updates a member's properties.\n *\n * Only the requested fields are updated.\n * To clear a field's value, set an empty value with an empty string `\"\"`.\n *\n * > **Note:**\n * > Updating the `contact.addresses`, `contact.emails`, or `contact.phones` array overwrites the entire array, so any existing values you want to retain must be passed in the `updateMember()` call along with the new values to add.\n * > However, passing an empty array will have no effect, and these functions must be used to clear all data from the respective array:\n * >- To clear `contact.addresses`, use `deleteMemberAddresses()`.\n * >- To clear `contact.emails`, use `deleteMemberEmails()`.\n * >- To clear `contact.phones`, use `deleteMemberPhones()`.\n *\n * > **Note:**\n * > Only logged-in members can call this function without elevated permissions.\n * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @param _id - Member ID.\n * @public\n * @requiredField _id\n * @requiredField member\n * @param options - Member to update.\n * @permissionId MEMBERS.MEMBER_UPDATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @returns Updated member.\n * @fqn com.wixpress.members.api.Members.UpdateMember\n */\n function updateMember(_id: string | null, member: UpdateMember): Promise;\n interface UpdateMember {\n /**\n * Member ID.\n * @readonly\n */\n _id?: string | null;\n /** Email used by the member to log in to the site. */\n loginEmail?: string | null;\n /**\n * Whether the email used by the member has been verified.\n * @readonly\n */\n loginEmailVerified?: boolean | null;\n /**\n * Member site access status.\n * @readonly\n */\n status?: Status;\n /**\n * Contact ID.\n * @readonly\n */\n contactId?: string | null;\n /**\n * Member's contact information. Contact information is stored in the\n * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\n */\n contact?: Contact;\n /** Profile display details. */\n profile?: Profile;\n /** Member privacy status. */\n privacyStatus?: PrivacyStatusStatus;\n /**\n * Member activity status.\n * @readonly\n */\n activityStatus?: ActivityStatusStatus;\n /**\n * Date and time when the member was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time when the member was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Date and time when the member last logged in to the site.\n * @readonly\n */\n lastLoginDate?: Date | null;\n }\n /**\n * Clears a member's phone numbers.\n *\n * The `deleteMemberPhones()` function clears the `phones` array under the `contact` property.\n *\n * > **Note:**\n * > Only logged-in members can call this function without elevated permissions.\n * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @param _id - ID of the member whose phone numbers will be deleted.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_UPDATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.members.api.Members.DeleteMemberPhones\n */\n function deleteMemberPhones(_id: string): Promise;\n /**\n * Clears a member's email addresses.\n *\n * The `deleteMemberEmails()` function clears the `emails` array under the `contact` property.\n *\n * > **Notes:**\n * > A member can still log in with their `loginEmail`,\n * > which is not cleared when this function is called.\n *\n * > Only logged-in members can call this function without elevated permissions.\n * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @param _id - ID of the member whose email addresses will be deleted.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_UPDATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.members.api.Members.DeleteMemberEmails\n */\n function deleteMemberEmails(_id: string): Promise;\n /**\n * Deletes a member's street addresses.\n *\n * The `deleteMemberAddresses()` function clears the `addresses` array under the `contact` property.\n *\n * > **Note:**\n * > Only logged-in members can call this function without elevated permissions.\n * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.\n * @param _id - ID of the member whose street addresses will be deleted.\n * @public\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_UPDATE\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @fqn com.wixpress.members.api.Members.DeleteMemberAddresses\n */\n function deleteMemberAddresses(_id: string): Promise;\n type membersV1MemberMembers_universal_d_Member = Member;\n type membersV1MemberMembers_universal_d_Status = Status;\n const membersV1MemberMembers_universal_d_Status: typeof Status;\n type membersV1MemberMembers_universal_d_Contact = Contact;\n type membersV1MemberMembers_universal_d_Address = Address;\n type membersV1MemberMembers_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type membersV1MemberMembers_universal_d_StreetAddress = StreetAddress;\n type membersV1MemberMembers_universal_d_CustomField = CustomField;\n type membersV1MemberMembers_universal_d_Profile = Profile;\n type membersV1MemberMembers_universal_d_Image = Image;\n type membersV1MemberMembers_universal_d_PrivacyStatusStatus = PrivacyStatusStatus;\n const membersV1MemberMembers_universal_d_PrivacyStatusStatus: typeof PrivacyStatusStatus;\n type membersV1MemberMembers_universal_d_ActivityStatusStatus = ActivityStatusStatus;\n const membersV1MemberMembers_universal_d_ActivityStatusStatus: typeof ActivityStatusStatus;\n type membersV1MemberMembers_universal_d_ExtendedFields = ExtendedFields;\n type membersV1MemberMembers_universal_d_InvalidateCache = InvalidateCache;\n type membersV1MemberMembers_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type membersV1MemberMembers_universal_d_App = App;\n type membersV1MemberMembers_universal_d_Page = Page;\n type membersV1MemberMembers_universal_d_URI = URI;\n type membersV1MemberMembers_universal_d_File = File;\n type membersV1MemberMembers_universal_d_UpdateMySlugRequest = UpdateMySlugRequest;\n type membersV1MemberMembers_universal_d_UpdateMySlugResponse = UpdateMySlugResponse;\n type membersV1MemberMembers_universal_d_SlugAlreadyExistsPayload = SlugAlreadyExistsPayload;\n type membersV1MemberMembers_universal_d_UpdateMemberSlugRequest = UpdateMemberSlugRequest;\n type membersV1MemberMembers_universal_d_UpdateMemberSlugResponse = UpdateMemberSlugResponse;\n type membersV1MemberMembers_universal_d_JoinCommunityRequest = JoinCommunityRequest;\n type membersV1MemberMembers_universal_d_JoinCommunityResponse = JoinCommunityResponse;\n type membersV1MemberMembers_universal_d_MemberJoinedCommunity = MemberJoinedCommunity;\n type membersV1MemberMembers_universal_d_LeaveCommunityRequest = LeaveCommunityRequest;\n type membersV1MemberMembers_universal_d_LeaveCommunityResponse = LeaveCommunityResponse;\n type membersV1MemberMembers_universal_d_MemberLeftCommunity = MemberLeftCommunity;\n type membersV1MemberMembers_universal_d_GetMyMemberRequest = GetMyMemberRequest;\n type membersV1MemberMembers_universal_d_Set = Set;\n const membersV1MemberMembers_universal_d_Set: typeof Set;\n type membersV1MemberMembers_universal_d_GetMyMemberResponse = GetMyMemberResponse;\n type membersV1MemberMembers_universal_d_GetMemberRequest = GetMemberRequest;\n type membersV1MemberMembers_universal_d_GetMemberResponse = GetMemberResponse;\n type membersV1MemberMembers_universal_d_MemberToMemberBlockedPayload = MemberToMemberBlockedPayload;\n type membersV1MemberMembers_universal_d_QueryMembersRequest = QueryMembersRequest;\n type membersV1MemberMembers_universal_d_Query = Query;\n type membersV1MemberMembers_universal_d_Search = Search;\n type membersV1MemberMembers_universal_d_QueryMembersResponse = QueryMembersResponse;\n type membersV1MemberMembers_universal_d_MuteMemberRequest = MuteMemberRequest;\n type membersV1MemberMembers_universal_d_MuteMemberResponse = MuteMemberResponse;\n type membersV1MemberMembers_universal_d_MemberMuted = MemberMuted;\n type membersV1MemberMembers_universal_d_UnmuteMemberRequest = UnmuteMemberRequest;\n type membersV1MemberMembers_universal_d_UnmuteMemberResponse = UnmuteMemberResponse;\n type membersV1MemberMembers_universal_d_MemberUnmuted = MemberUnmuted;\n type membersV1MemberMembers_universal_d_ApproveMemberRequest = ApproveMemberRequest;\n type membersV1MemberMembers_universal_d_ApproveMemberResponse = ApproveMemberResponse;\n type membersV1MemberMembers_universal_d_MemberApproved = MemberApproved;\n type membersV1MemberMembers_universal_d_BlockMemberRequest = BlockMemberRequest;\n type membersV1MemberMembers_universal_d_BlockMemberResponse = BlockMemberResponse;\n type membersV1MemberMembers_universal_d_MemberBlocked = MemberBlocked;\n type membersV1MemberMembers_universal_d_MemberSelfBlockForbiddenPayload = MemberSelfBlockForbiddenPayload;\n type membersV1MemberMembers_universal_d_OwnerMemberBlockForbiddenPayload = OwnerMemberBlockForbiddenPayload;\n type membersV1MemberMembers_universal_d_ActiveSubscriptionMemberBlockForbiddenPayload = ActiveSubscriptionMemberBlockForbiddenPayload;\n type membersV1MemberMembers_universal_d_DisconnectMemberRequest = DisconnectMemberRequest;\n type membersV1MemberMembers_universal_d_DisconnectMemberResponse = DisconnectMemberResponse;\n type membersV1MemberMembers_universal_d_DeleteMemberRequest = DeleteMemberRequest;\n type membersV1MemberMembers_universal_d_DeleteMemberResponse = DeleteMemberResponse;\n type membersV1MemberMembers_universal_d_ContentReassignmentRequested = ContentReassignmentRequested;\n type membersV1MemberMembers_universal_d_ContentDeletionRequested = ContentDeletionRequested;\n type membersV1MemberMembers_universal_d_OwnerOrContributorDeleteForbiddenPayload = OwnerOrContributorDeleteForbiddenPayload;\n type membersV1MemberMembers_universal_d_ActiveSubscriptionMemberDeleteForbiddenPayload = ActiveSubscriptionMemberDeleteForbiddenPayload;\n type membersV1MemberMembers_universal_d_DeleteMyMemberRequest = DeleteMyMemberRequest;\n type membersV1MemberMembers_universal_d_DeleteMyMemberResponse = DeleteMyMemberResponse;\n type membersV1MemberMembers_universal_d_BulkDeleteMembersRequest = BulkDeleteMembersRequest;\n type membersV1MemberMembers_universal_d_BulkDeleteMembersResponse = BulkDeleteMembersResponse;\n type membersV1MemberMembers_universal_d_ItemMetadata = ItemMetadata;\n type membersV1MemberMembers_universal_d_ApplicationError = ApplicationError;\n type membersV1MemberMembers_universal_d_BulkMemberResult = BulkMemberResult;\n type membersV1MemberMembers_universal_d_BulkActionMetadata = BulkActionMetadata;\n type membersV1MemberMembers_universal_d_BulkDeleteMembersByFilterRequest = BulkDeleteMembersByFilterRequest;\n type membersV1MemberMembers_universal_d_BulkDeleteMembersByFilterResponse = BulkDeleteMembersByFilterResponse;\n type membersV1MemberMembers_universal_d_BulkApproveMembersRequest = BulkApproveMembersRequest;\n type membersV1MemberMembers_universal_d_BulkApproveMembersResponse = BulkApproveMembersResponse;\n type membersV1MemberMembers_universal_d_BulkBlockMembersRequest = BulkBlockMembersRequest;\n type membersV1MemberMembers_universal_d_BulkBlockMembersResponse = BulkBlockMembersResponse;\n type membersV1MemberMembers_universal_d_CreateMemberRequest = CreateMemberRequest;\n type membersV1MemberMembers_universal_d_CreateMemberResponse = CreateMemberResponse;\n type membersV1MemberMembers_universal_d_UpdateMemberRequest = UpdateMemberRequest;\n type membersV1MemberMembers_universal_d_UpdateMemberResponse = UpdateMemberResponse;\n type membersV1MemberMembers_universal_d_InvalidCustomFieldUrlPayload = InvalidCustomFieldUrlPayload;\n type membersV1MemberMembers_universal_d_DeleteMemberPhonesRequest = DeleteMemberPhonesRequest;\n type membersV1MemberMembers_universal_d_DeleteMemberPhonesResponse = DeleteMemberPhonesResponse;\n type membersV1MemberMembers_universal_d_DeleteMemberEmailsRequest = DeleteMemberEmailsRequest;\n type membersV1MemberMembers_universal_d_DeleteMemberEmailsResponse = DeleteMemberEmailsResponse;\n type membersV1MemberMembers_universal_d_DeleteMemberAddressesRequest = DeleteMemberAddressesRequest;\n type membersV1MemberMembers_universal_d_DeleteMemberAddressesResponse = DeleteMemberAddressesResponse;\n type membersV1MemberMembers_universal_d_Empty = Empty;\n type membersV1MemberMembers_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type membersV1MemberMembers_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type membersV1MemberMembers_universal_d_Asset = Asset;\n type membersV1MemberMembers_universal_d_State = State;\n const membersV1MemberMembers_universal_d_State: typeof State;\n type membersV1MemberMembers_universal_d_SiteCreated = SiteCreated;\n type membersV1MemberMembers_universal_d_SiteCreatedContext = SiteCreatedContext;\n const membersV1MemberMembers_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type membersV1MemberMembers_universal_d_Namespace = Namespace;\n const membersV1MemberMembers_universal_d_Namespace: typeof Namespace;\n type membersV1MemberMembers_universal_d_SiteTransferred = SiteTransferred;\n type membersV1MemberMembers_universal_d_SiteDeleted = SiteDeleted;\n type membersV1MemberMembers_universal_d_DeleteContext = DeleteContext;\n type membersV1MemberMembers_universal_d_DeleteStatus = DeleteStatus;\n const membersV1MemberMembers_universal_d_DeleteStatus: typeof DeleteStatus;\n type membersV1MemberMembers_universal_d_SiteUndeleted = SiteUndeleted;\n type membersV1MemberMembers_universal_d_SitePublished = SitePublished;\n type membersV1MemberMembers_universal_d_SiteUnpublished = SiteUnpublished;\n type membersV1MemberMembers_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type membersV1MemberMembers_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type membersV1MemberMembers_universal_d_ServiceProvisioned = ServiceProvisioned;\n type membersV1MemberMembers_universal_d_ServiceRemoved = ServiceRemoved;\n type membersV1MemberMembers_universal_d_SiteRenamed = SiteRenamed;\n type membersV1MemberMembers_universal_d_SiteHardDeleted = SiteHardDeleted;\n type membersV1MemberMembers_universal_d_NamespaceChanged = NamespaceChanged;\n type membersV1MemberMembers_universal_d_StudioAssigned = StudioAssigned;\n type membersV1MemberMembers_universal_d_StudioUnassigned = StudioUnassigned;\n type membersV1MemberMembers_universal_d_MemberOwnershipTransferred = MemberOwnershipTransferred;\n type membersV1MemberMembers_universal_d_MemberIdChanged = MemberIdChanged;\n const membersV1MemberMembers_universal_d_updateCurrentMemberSlug: typeof updateCurrentMemberSlug;\n const membersV1MemberMembers_universal_d_updateMemberSlug: typeof updateMemberSlug;\n const membersV1MemberMembers_universal_d_joinCommunity: typeof joinCommunity;\n const membersV1MemberMembers_universal_d_leaveCommunity: typeof leaveCommunity;\n const membersV1MemberMembers_universal_d_getCurrentMember: typeof getCurrentMember;\n type membersV1MemberMembers_universal_d_GetCurrentMemberOptions = GetCurrentMemberOptions;\n const membersV1MemberMembers_universal_d_getMember: typeof getMember;\n type membersV1MemberMembers_universal_d_GetMemberOptions = GetMemberOptions;\n const membersV1MemberMembers_universal_d_listMembers: typeof listMembers;\n type membersV1MemberMembers_universal_d_ListMembersOptions = ListMembersOptions;\n const membersV1MemberMembers_universal_d_queryMembers: typeof queryMembers;\n type membersV1MemberMembers_universal_d_QueryMembersOptions = QueryMembersOptions;\n type membersV1MemberMembers_universal_d_MembersQueryResult = MembersQueryResult;\n type membersV1MemberMembers_universal_d_MembersQueryBuilder = MembersQueryBuilder;\n const membersV1MemberMembers_universal_d_muteMember: typeof muteMember;\n const membersV1MemberMembers_universal_d_unmuteMember: typeof unmuteMember;\n const membersV1MemberMembers_universal_d_approveMember: typeof approveMember;\n const membersV1MemberMembers_universal_d_blockMember: typeof blockMember;\n const membersV1MemberMembers_universal_d_disconnectMember: typeof disconnectMember;\n const membersV1MemberMembers_universal_d_deleteMember: typeof deleteMember;\n type membersV1MemberMembers_universal_d_DeleteMemberOptions = DeleteMemberOptions;\n const membersV1MemberMembers_universal_d_deleteMyMember: typeof deleteMyMember;\n type membersV1MemberMembers_universal_d_DeleteMyMemberOptions = DeleteMyMemberOptions;\n const membersV1MemberMembers_universal_d_bulkDeleteMembers: typeof bulkDeleteMembers;\n const membersV1MemberMembers_universal_d_bulkDeleteMembersByFilter: typeof bulkDeleteMembersByFilter;\n type membersV1MemberMembers_universal_d_BulkDeleteMembersByFilterOptions = BulkDeleteMembersByFilterOptions;\n const membersV1MemberMembers_universal_d_bulkApproveMembers: typeof bulkApproveMembers;\n const membersV1MemberMembers_universal_d_bulkBlockMembers: typeof bulkBlockMembers;\n const membersV1MemberMembers_universal_d_createMember: typeof createMember;\n type membersV1MemberMembers_universal_d_CreateMemberOptions = CreateMemberOptions;\n const membersV1MemberMembers_universal_d_updateMember: typeof updateMember;\n type membersV1MemberMembers_universal_d_UpdateMember = UpdateMember;\n const membersV1MemberMembers_universal_d_deleteMemberPhones: typeof deleteMemberPhones;\n const membersV1MemberMembers_universal_d_deleteMemberEmails: typeof deleteMemberEmails;\n const membersV1MemberMembers_universal_d_deleteMemberAddresses: typeof deleteMemberAddresses;\n namespace membersV1MemberMembers_universal_d {\n export { membersV1MemberMembers_universal_d_Member as Member, membersV1MemberMembers_universal_d_Status as Status, membersV1MemberMembers_universal_d_Contact as Contact, membersV1MemberMembers_universal_d_Address as Address, membersV1MemberMembers_universal_d_AddressStreetOneOf as AddressStreetOneOf, membersV1MemberMembers_universal_d_StreetAddress as StreetAddress, membersV1MemberMembers_universal_d_CustomField as CustomField, membersV1MemberMembers_universal_d_Profile as Profile, membersV1MemberMembers_universal_d_Image as Image, membersV1MemberMembers_universal_d_PrivacyStatusStatus as PrivacyStatusStatus, membersV1MemberMembers_universal_d_ActivityStatusStatus as ActivityStatusStatus, membersV1MemberMembers_universal_d_ExtendedFields as ExtendedFields, membersV1MemberMembers_universal_d_InvalidateCache as InvalidateCache, membersV1MemberMembers_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, membersV1MemberMembers_universal_d_App as App, membersV1MemberMembers_universal_d_Page as Page, membersV1MemberMembers_universal_d_URI as URI, membersV1MemberMembers_universal_d_File as File, membersV1MemberMembers_universal_d_UpdateMySlugRequest as UpdateMySlugRequest, membersV1MemberMembers_universal_d_UpdateMySlugResponse as UpdateMySlugResponse, membersV1MemberMembers_universal_d_SlugAlreadyExistsPayload as SlugAlreadyExistsPayload, membersV1MemberMembers_universal_d_UpdateMemberSlugRequest as UpdateMemberSlugRequest, membersV1MemberMembers_universal_d_UpdateMemberSlugResponse as UpdateMemberSlugResponse, membersV1MemberMembers_universal_d_JoinCommunityRequest as JoinCommunityRequest, membersV1MemberMembers_universal_d_JoinCommunityResponse as JoinCommunityResponse, membersV1MemberMembers_universal_d_MemberJoinedCommunity as MemberJoinedCommunity, membersV1MemberMembers_universal_d_LeaveCommunityRequest as LeaveCommunityRequest, membersV1MemberMembers_universal_d_LeaveCommunityResponse as LeaveCommunityResponse, membersV1MemberMembers_universal_d_MemberLeftCommunity as MemberLeftCommunity, membersV1MemberMembers_universal_d_GetMyMemberRequest as GetMyMemberRequest, membersV1MemberMembers_universal_d_Set as Set, membersV1MemberMembers_universal_d_GetMyMemberResponse as GetMyMemberResponse, membersV1MemberMembers_universal_d_GetMemberRequest as GetMemberRequest, membersV1MemberMembers_universal_d_GetMemberResponse as GetMemberResponse, membersV1MemberMembers_universal_d_MemberToMemberBlockedPayload as MemberToMemberBlockedPayload, ListMembersRequest$1 as ListMembersRequest, Paging$1 as Paging, Sorting$1 as Sorting, SortOrder$1 as SortOrder, CursorPaging$1 as CursorPaging, ListMembersResponse$1 as ListMembersResponse, PagingMetadata$1 as PagingMetadata, CursorPagingMetadata$1 as CursorPagingMetadata, Cursors$1 as Cursors, membersV1MemberMembers_universal_d_QueryMembersRequest as QueryMembersRequest, membersV1MemberMembers_universal_d_Query as Query, membersV1MemberMembers_universal_d_Search as Search, membersV1MemberMembers_universal_d_QueryMembersResponse as QueryMembersResponse, membersV1MemberMembers_universal_d_MuteMemberRequest as MuteMemberRequest, membersV1MemberMembers_universal_d_MuteMemberResponse as MuteMemberResponse, membersV1MemberMembers_universal_d_MemberMuted as MemberMuted, membersV1MemberMembers_universal_d_UnmuteMemberRequest as UnmuteMemberRequest, membersV1MemberMembers_universal_d_UnmuteMemberResponse as UnmuteMemberResponse, membersV1MemberMembers_universal_d_MemberUnmuted as MemberUnmuted, membersV1MemberMembers_universal_d_ApproveMemberRequest as ApproveMemberRequest, membersV1MemberMembers_universal_d_ApproveMemberResponse as ApproveMemberResponse, membersV1MemberMembers_universal_d_MemberApproved as MemberApproved, membersV1MemberMembers_universal_d_BlockMemberRequest as BlockMemberRequest, membersV1MemberMembers_universal_d_BlockMemberResponse as BlockMemberResponse, membersV1MemberMembers_universal_d_MemberBlocked as MemberBlocked, membersV1MemberMembers_universal_d_MemberSelfBlockForbiddenPayload as MemberSelfBlockForbiddenPayload, membersV1MemberMembers_universal_d_OwnerMemberBlockForbiddenPayload as OwnerMemberBlockForbiddenPayload, membersV1MemberMembers_universal_d_ActiveSubscriptionMemberBlockForbiddenPayload as ActiveSubscriptionMemberBlockForbiddenPayload, membersV1MemberMembers_universal_d_DisconnectMemberRequest as DisconnectMemberRequest, membersV1MemberMembers_universal_d_DisconnectMemberResponse as DisconnectMemberResponse, membersV1MemberMembers_universal_d_DeleteMemberRequest as DeleteMemberRequest, membersV1MemberMembers_universal_d_DeleteMemberResponse as DeleteMemberResponse, membersV1MemberMembers_universal_d_ContentReassignmentRequested as ContentReassignmentRequested, membersV1MemberMembers_universal_d_ContentDeletionRequested as ContentDeletionRequested, membersV1MemberMembers_universal_d_OwnerOrContributorDeleteForbiddenPayload as OwnerOrContributorDeleteForbiddenPayload, membersV1MemberMembers_universal_d_ActiveSubscriptionMemberDeleteForbiddenPayload as ActiveSubscriptionMemberDeleteForbiddenPayload, membersV1MemberMembers_universal_d_DeleteMyMemberRequest as DeleteMyMemberRequest, membersV1MemberMembers_universal_d_DeleteMyMemberResponse as DeleteMyMemberResponse, membersV1MemberMembers_universal_d_BulkDeleteMembersRequest as BulkDeleteMembersRequest, membersV1MemberMembers_universal_d_BulkDeleteMembersResponse as BulkDeleteMembersResponse, membersV1MemberMembers_universal_d_ItemMetadata as ItemMetadata, membersV1MemberMembers_universal_d_ApplicationError as ApplicationError, membersV1MemberMembers_universal_d_BulkMemberResult as BulkMemberResult, membersV1MemberMembers_universal_d_BulkActionMetadata as BulkActionMetadata, membersV1MemberMembers_universal_d_BulkDeleteMembersByFilterRequest as BulkDeleteMembersByFilterRequest, membersV1MemberMembers_universal_d_BulkDeleteMembersByFilterResponse as BulkDeleteMembersByFilterResponse, membersV1MemberMembers_universal_d_BulkApproveMembersRequest as BulkApproveMembersRequest, membersV1MemberMembers_universal_d_BulkApproveMembersResponse as BulkApproveMembersResponse, membersV1MemberMembers_universal_d_BulkBlockMembersRequest as BulkBlockMembersRequest, membersV1MemberMembers_universal_d_BulkBlockMembersResponse as BulkBlockMembersResponse, membersV1MemberMembers_universal_d_CreateMemberRequest as CreateMemberRequest, membersV1MemberMembers_universal_d_CreateMemberResponse as CreateMemberResponse, membersV1MemberMembers_universal_d_UpdateMemberRequest as UpdateMemberRequest, membersV1MemberMembers_universal_d_UpdateMemberResponse as UpdateMemberResponse, membersV1MemberMembers_universal_d_InvalidCustomFieldUrlPayload as InvalidCustomFieldUrlPayload, membersV1MemberMembers_universal_d_DeleteMemberPhonesRequest as DeleteMemberPhonesRequest, membersV1MemberMembers_universal_d_DeleteMemberPhonesResponse as DeleteMemberPhonesResponse, membersV1MemberMembers_universal_d_DeleteMemberEmailsRequest as DeleteMemberEmailsRequest, membersV1MemberMembers_universal_d_DeleteMemberEmailsResponse as DeleteMemberEmailsResponse, membersV1MemberMembers_universal_d_DeleteMemberAddressesRequest as DeleteMemberAddressesRequest, membersV1MemberMembers_universal_d_DeleteMemberAddressesResponse as DeleteMemberAddressesResponse, membersV1MemberMembers_universal_d_Empty as Empty, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, membersV1MemberMembers_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, membersV1MemberMembers_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, membersV1MemberMembers_universal_d_Asset as Asset, membersV1MemberMembers_universal_d_State as State, membersV1MemberMembers_universal_d_SiteCreated as SiteCreated, membersV1MemberMembers_universal_d_SiteCreatedContext as SiteCreatedContext, membersV1MemberMembers_universal_d_Namespace as Namespace, membersV1MemberMembers_universal_d_SiteTransferred as SiteTransferred, membersV1MemberMembers_universal_d_SiteDeleted as SiteDeleted, membersV1MemberMembers_universal_d_DeleteContext as DeleteContext, membersV1MemberMembers_universal_d_DeleteStatus as DeleteStatus, membersV1MemberMembers_universal_d_SiteUndeleted as SiteUndeleted, membersV1MemberMembers_universal_d_SitePublished as SitePublished, membersV1MemberMembers_universal_d_SiteUnpublished as SiteUnpublished, membersV1MemberMembers_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, membersV1MemberMembers_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, membersV1MemberMembers_universal_d_ServiceProvisioned as ServiceProvisioned, membersV1MemberMembers_universal_d_ServiceRemoved as ServiceRemoved, membersV1MemberMembers_universal_d_SiteRenamed as SiteRenamed, membersV1MemberMembers_universal_d_SiteHardDeleted as SiteHardDeleted, membersV1MemberMembers_universal_d_NamespaceChanged as NamespaceChanged, membersV1MemberMembers_universal_d_StudioAssigned as StudioAssigned, membersV1MemberMembers_universal_d_StudioUnassigned as StudioUnassigned, membersV1MemberMembers_universal_d_MemberOwnershipTransferred as MemberOwnershipTransferred, membersV1MemberMembers_universal_d_MemberIdChanged as MemberIdChanged, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, membersV1MemberMembers_universal_d_updateCurrentMemberSlug as updateCurrentMemberSlug, membersV1MemberMembers_universal_d_updateMemberSlug as updateMemberSlug, membersV1MemberMembers_universal_d_joinCommunity as joinCommunity, membersV1MemberMembers_universal_d_leaveCommunity as leaveCommunity, membersV1MemberMembers_universal_d_getCurrentMember as getCurrentMember, membersV1MemberMembers_universal_d_GetCurrentMemberOptions as GetCurrentMemberOptions, membersV1MemberMembers_universal_d_getMember as getMember, membersV1MemberMembers_universal_d_GetMemberOptions as GetMemberOptions, membersV1MemberMembers_universal_d_listMembers as listMembers, membersV1MemberMembers_universal_d_ListMembersOptions as ListMembersOptions, membersV1MemberMembers_universal_d_queryMembers as queryMembers, membersV1MemberMembers_universal_d_QueryMembersOptions as QueryMembersOptions, membersV1MemberMembers_universal_d_MembersQueryResult as MembersQueryResult, membersV1MemberMembers_universal_d_MembersQueryBuilder as MembersQueryBuilder, membersV1MemberMembers_universal_d_muteMember as muteMember, membersV1MemberMembers_universal_d_unmuteMember as unmuteMember, membersV1MemberMembers_universal_d_approveMember as approveMember, membersV1MemberMembers_universal_d_blockMember as blockMember, membersV1MemberMembers_universal_d_disconnectMember as disconnectMember, membersV1MemberMembers_universal_d_deleteMember as deleteMember, membersV1MemberMembers_universal_d_DeleteMemberOptions as DeleteMemberOptions, membersV1MemberMembers_universal_d_deleteMyMember as deleteMyMember, membersV1MemberMembers_universal_d_DeleteMyMemberOptions as DeleteMyMemberOptions, membersV1MemberMembers_universal_d_bulkDeleteMembers as bulkDeleteMembers, membersV1MemberMembers_universal_d_bulkDeleteMembersByFilter as bulkDeleteMembersByFilter, membersV1MemberMembers_universal_d_BulkDeleteMembersByFilterOptions as BulkDeleteMembersByFilterOptions, membersV1MemberMembers_universal_d_bulkApproveMembers as bulkApproveMembers, membersV1MemberMembers_universal_d_bulkBlockMembers as bulkBlockMembers, membersV1MemberMembers_universal_d_createMember as createMember, membersV1MemberMembers_universal_d_CreateMemberOptions as CreateMemberOptions, membersV1MemberMembers_universal_d_updateMember as updateMember, membersV1MemberMembers_universal_d_UpdateMember as UpdateMember, membersV1MemberMembers_universal_d_deleteMemberPhones as deleteMemberPhones, membersV1MemberMembers_universal_d_deleteMemberEmails as deleteMemberEmails, membersV1MemberMembers_universal_d_deleteMemberAddresses as deleteMemberAddresses, };\n }\n interface Badge {\n /**\n * Badge ID.\n * @readonly\n */\n _id?: string;\n /** Text displayed on the badge in the Wix UI. */\n title?: string | null;\n /** Badge description. */\n description?: string | null;\n /**\n * Badge background color in hexadecimal RGB format. Uppercase letters only.\n *\n * Default: `#796EFF ` (purple).\n */\n backgroundColor?: string | null;\n /**\n * Badge text color in hexadecimal RGB format. Uppercase letters only.\n *\n * Default: `\"#FFFFFF\"` (white).\n */\n textColor?: string | null;\n /**\n * Badge icon as an SVG image. One of:\n *\n * - An external web URL in the following format: `http(s)://`.\n * - The [source URL](https://www.wix.com/velo/reference/wix-media-backend/mediamanager-obj/getfileurl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.\n */\n icon?: string | null;\n /**\n * Whether the badge has special permissions\n * to access specific members-only pages.\n * When `true`, members with the badge receive special permissions,\n * and site contributors can\n * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)\n * in the Dashboard.\n * When `false`, members with the badge receive no special permissions.\n */\n permissionsEnabled?: boolean | null;\n /**\n * Slugified name. Used to represent the badge in a URL.\n * @readonly\n */\n slug?: string | null;\n /**\n * Date the badge was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date the badge was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface CreateBadgeRequest {\n /** Badge to create. */\n badge: Badge;\n }\n interface CreateBadgeResponse {\n /** Created badge. */\n badge?: Badge;\n }\n interface UpdateBadgeRequest {\n /** Badge to update. */\n badge: Badge;\n }\n interface UpdateBadgeResponse {\n /** Updated badge. */\n badge?: Badge;\n }\n interface ListBadgesRequest {\n /** Pagination options. */\n paging?: Paging;\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListBadgesResponse {\n /** List of badges. */\n badges?: Badge[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata;\n }\n interface PagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface QueryBadgesRequest {\n /**\n * Filter options.\n * Currently supported fields for filtering:\n * - id\n * - title\n * - slug\n * For more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sorting options.\n * For more details on how to use sorting,\n * see [API Query Language: The Sort Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-sort-section)\n */\n sort?: Sorting[];\n /** Pagination options. */\n paging?: Paging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryBadgesResponse {\n /** List of badges. */\n badges?: Badge[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata;\n }\n interface GetBadgeRequest {\n /** Badge ID. */\n _id: string;\n }\n interface GetBadgeResponse {\n /** Badge. */\n badge?: Badge;\n }\n interface DeleteBadgeRequest {\n /** Badge ID. */\n _id: string;\n }\n interface DeleteBadgeResponse {\n }\n interface CountBadgesRequest {\n /**\n * Filter options.\n * Currently supported fields for filtering:\n * - id\n * - title\n * - slug\n * For more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).\n */\n filter?: Record | null;\n }\n interface CountBadgesResponse {\n /** Badge count. */\n count?: string;\n }\n interface AssignBadgeRequest {\n /** Badge ID. */\n _id: string;\n /** List of member IDs to assign to the badge. */\n memberIds: string[];\n }\n interface AssignBadgeResponse {\n /** List of member IDs assigned to the badge. */\n memberIds?: string[];\n }\n interface BadgeAssigned {\n /** ID of the member who received the badge. */\n memberId?: string;\n }\n interface AssignBadgesRequest {\n /** List of badge IDs to assign to the member. */\n ids: string[];\n /** Member ID. */\n memberId: string;\n }\n interface AssignBadgesResponse {\n /** List of badge IDs newly assigned to the member. */\n ids?: string[];\n }\n interface UnassignBadgeRequest {\n /** Badge ID. */\n _id: string;\n /** List of members to remove. */\n memberIds: string[];\n }\n interface UnassignBadgeResponse {\n }\n interface BadgeUnassigned {\n /** ID of the member who lost the badge. */\n memberId?: string;\n }\n interface ListMembersRequest {\n /** Badge ID. */\n _id: string;\n /** Pagination options. */\n paging?: Paging;\n }\n interface ListMembersResponse {\n /** Member IDs assigned to the badge. */\n memberIds?: string[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata;\n }\n interface ListMembersBadgeIdsRequest {\n /** List of members. */\n memberIds: string[];\n }\n interface ListMembersBadgeIdsResponse {\n /** List of members and the badges they're assigned to. */\n memberBadgeIds?: MemberBadgeIds[];\n }\n interface MemberBadgeIds {\n /** Member ID. */\n memberId?: string;\n /** List of badges the member is assigned to. */\n badgeIds?: string[];\n }\n interface GetMemberCountsPerBadgeRequest {\n }\n interface GetMemberCountsPerBadgeResponse {\n /** List of badges and counts of members who have each badge. */\n badgeMemberCounts?: BadgeMemberCount[];\n }\n interface BadgeMemberCount {\n /** Badge ID. */\n badgeId?: string;\n /** Badge member count. */\n memberCount?: number;\n }\n interface UpdateBadgesDisplayOrderRequest {\n /** Ordered badge IDs. */\n badgeIds: string[];\n }\n interface UpdateBadgesDisplayOrderResponse {\n /** Reordered badges list. */\n badges?: Badge[];\n }\n interface ListMembersWithBadgesRequest {\n /** Cursor paging options */\n paging?: CursorPaging;\n }\n interface CursorPaging {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListMembersWithBadgesResponse {\n /** List of members */\n memberIds?: string[];\n /** Metadata for the paginated results */\n pagingMetadata?: CursorPagingMetadata;\n }\n interface CursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a badge.\n *\n *\n * The `createBadge()` function returns a Promise that resolves to the newly created badge.\n *\n * New badges do not have any badge permissions by default. You can set [badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge) from the Badges page in the Dashboard.\n *\n * If `backgroundColor` or `textColor` are not specified, they default to `\"#796EFF\"` (purple) and `\"#FFFFFF\"` (white) respectively.\n * @param badge - Badge to create.\n * @public\n * @requiredField badge\n * @requiredField badge.backgroundColor\n * @requiredField badge.textColor\n * @requiredField badge.title\n * @permissionId BADGES.BADGE_CREATE\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created badge.\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.CreateBadge\n */\n function createBadge(badge: Badge): Promise;\n /**\n * Updates a badge.\n *\n * The `updateBadge()` function returns a Promise that resolves to the updated badge.\n *\n * Only the properties passed in the `BadgeInfo` object will be updated. All other properties will remain the same.\n *\n * Because the badge `slug` is based on the badge `title`, if you change `title`, `slug` is updated accordingly.\n *\n * `badgeId` must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n * @requiredField badge\n * @permissionId BADGES.BADGE_UPDATE\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated badge.\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.UpdateBadge\n */\n function updateBadge(_id: string, badge: UpdateBadge): Promise;\n interface UpdateBadge {\n /**\n * Badge ID.\n * @readonly\n */\n _id?: string;\n /** Text displayed on the badge in the Wix UI. */\n title?: string | null;\n /** Badge description. */\n description?: string | null;\n /**\n * Badge background color in hexadecimal RGB format. Uppercase letters only.\n *\n * Default: `#796EFF ` (purple).\n */\n backgroundColor?: string | null;\n /**\n * Badge text color in hexadecimal RGB format. Uppercase letters only.\n *\n * Default: `\"#FFFFFF\"` (white).\n */\n textColor?: string | null;\n /**\n * Badge icon as an SVG image. One of:\n *\n * - An external web URL in the following format: `http(s)://`.\n * - The [source URL](https://www.wix.com/velo/reference/wix-media-backend/mediamanager-obj/getfileurl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.\n */\n icon?: string | null;\n /**\n * Whether the badge has special permissions\n * to access specific members-only pages.\n * When `true`, members with the badge receive special permissions,\n * and site contributors can\n * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)\n * in the Dashboard.\n * When `false`, members with the badge receive no special permissions.\n */\n permissionsEnabled?: boolean | null;\n /**\n * Slugified name. Used to represent the badge in a URL.\n * @readonly\n */\n slug?: string | null;\n /**\n * Date the badge was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date the badge was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n /**\n * Lists the badges.\n *\n *\n * The `listBadges` function returns a Promise that resolves when the badges are retrieved. Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0.\n *\n * This function is not a universal function and runs only on the backend.\n * @public\n * @permissionId BADGES.BADGE_READ\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @permissionScope Read Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.ListBadges\n */\n function listBadges(options?: ListBadgesOptions): Promise;\n interface ListBadgesOptions {\n /** Pagination options. */\n paging?: Paging;\n }\n interface QueryBadgesOptions {\n /**\n * Filter options.\n * Currently supported fields for filtering:\n * - id\n * - title\n * - slug\n * For more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).\n */\n filter?: Record | null;\n /**\n * Sorting options.\n * For more details on how to use sorting,\n * see [API Query Language: The Sort Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-sort-section)\n */\n sort?: Sorting[];\n /** Pagination options. */\n paging?: Paging;\n }\n /**\n * Retrieves information about a badge.\n *\n *\n * The `getBadge` function returns a Promise that resolves when the badge information is retrieved.\n *\n * The `_id` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n * @permissionId BADGES.BADGE_READ\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @permissionScope Read Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Badge.\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.GetBadge\n */\n function getBadge(_id: string): Promise;\n /**\n * Deletes a badge.\n *\n *\n * The `deleteBadge()` function returns a Promise that resolves when the specified badge is deleted.\n *\n * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n * @permissionId BADGES.BADGE_DELETE\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.DeleteBadge\n */\n function deleteBadge(_id: string): Promise;\n interface CountBadgesOptions {\n /**\n * Filter options.\n * Currently supported fields for filtering:\n * - id\n * - title\n * - slug\n * For more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).\n */\n filter?: Record | null;\n }\n /**\n * Assigns a badge to site members.\n *\n *\n * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.\n *\n * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n * @param _id - Badge ID.\n * @param memberIds - List of member IDs to assign to the badge.\n * @public\n * @requiredField _id\n * @requiredField memberIds\n * @permissionId BADGES.BADGE_ASSIGN\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.AssignBadge\n */\n function assignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Removes site members from an assigned badge.\n *\n *\n * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.\n *\n * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n * @param _id - Badge ID.\n * @param memberIds - List of members to remove.\n * @public\n * @requiredField _id\n * @requiredField memberIds\n * @permissionId BADGES.BADGE_ASSIGN\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.UnassignBadge\n */\n function unassignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Lists the IDs of all members assigned to a badge.\n *\n *\n * The `listMembersByBadge()` function returns a Promise that resolves to a list of member IDs assigned to the specified badge.\n *\n * Retrieves up to 1000 site members who have a specified badge. Default `paging.limit` is 100, `paging.offset` - 0.\n *\n * The `_id` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n * @permissionId BADGES.BADGE_READ_MEMBERS\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @permissionScope Read Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.ListMembers\n */\n function listMembersByBadge(_id: string, options?: ListMembersByBadgeOptions): Promise;\n interface ListMembersByBadgeOptions {\n /** Pagination options. */\n paging?: Paging;\n }\n /**\n * Lists the badges assigned to each of the specified site members.\n *\n *\n * The `listBadgesPerMember()` function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.\n *\n * This function is not a universal function and runs only on the backend.\n * @param memberIds - List of members.\n * @public\n * @requiredField memberIds\n * @permissionId BADGES.BADGE_READ_MEMBERS\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @permissionScope Read Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.ListMembersBadgeIds\n */\n function listBadgesPerMember(memberIds: string[]): Promise;\n /**\n * Retrieves member count per badge.\n *\n *\n * The `getMemberCountsPerBadge` function returns a Promise that resolves when the member counts of each badge are retrieved.\n *\n * This function is not a universal function and runs only on the backend.\n * @public\n * @permissionId BADGES.BADGE_READ_MEMBERS\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @permissionScope Read Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.GetMemberCountsPerBadge\n */\n function getMemberCountsPerBadge(): Promise;\n /**\n * Updates badges' display order.\n *\n *\n * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.\n *\n * This function is not a universal function and runs only on the backend\n * @param badgeIds - Ordered badge IDs.\n * @public\n * @requiredField badgeIds\n * @permissionId BADGES.BADGE_UPDATE_DISPLAY_ORDER\n * @permissionScope Manage Badges\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.badges.v3.BadgesServiceV3.UpdateBadgesDisplayOrder\n */\n function updateBadgesDisplayOrder(badgeIds: string[]): Promise;\n type badgesV3BadgeBadges_universal_d_Badge = Badge;\n type badgesV3BadgeBadges_universal_d_CreateBadgeRequest = CreateBadgeRequest;\n type badgesV3BadgeBadges_universal_d_CreateBadgeResponse = CreateBadgeResponse;\n type badgesV3BadgeBadges_universal_d_UpdateBadgeRequest = UpdateBadgeRequest;\n type badgesV3BadgeBadges_universal_d_UpdateBadgeResponse = UpdateBadgeResponse;\n type badgesV3BadgeBadges_universal_d_ListBadgesRequest = ListBadgesRequest;\n type badgesV3BadgeBadges_universal_d_Paging = Paging;\n type badgesV3BadgeBadges_universal_d_ListBadgesResponse = ListBadgesResponse;\n type badgesV3BadgeBadges_universal_d_PagingMetadata = PagingMetadata;\n type badgesV3BadgeBadges_universal_d_QueryBadgesRequest = QueryBadgesRequest;\n type badgesV3BadgeBadges_universal_d_Sorting = Sorting;\n type badgesV3BadgeBadges_universal_d_SortOrder = SortOrder;\n const badgesV3BadgeBadges_universal_d_SortOrder: typeof SortOrder;\n type badgesV3BadgeBadges_universal_d_QueryBadgesResponse = QueryBadgesResponse;\n type badgesV3BadgeBadges_universal_d_GetBadgeRequest = GetBadgeRequest;\n type badgesV3BadgeBadges_universal_d_GetBadgeResponse = GetBadgeResponse;\n type badgesV3BadgeBadges_universal_d_DeleteBadgeRequest = DeleteBadgeRequest;\n type badgesV3BadgeBadges_universal_d_DeleteBadgeResponse = DeleteBadgeResponse;\n type badgesV3BadgeBadges_universal_d_CountBadgesRequest = CountBadgesRequest;\n type badgesV3BadgeBadges_universal_d_CountBadgesResponse = CountBadgesResponse;\n type badgesV3BadgeBadges_universal_d_AssignBadgeRequest = AssignBadgeRequest;\n type badgesV3BadgeBadges_universal_d_AssignBadgeResponse = AssignBadgeResponse;\n type badgesV3BadgeBadges_universal_d_BadgeAssigned = BadgeAssigned;\n type badgesV3BadgeBadges_universal_d_AssignBadgesRequest = AssignBadgesRequest;\n type badgesV3BadgeBadges_universal_d_AssignBadgesResponse = AssignBadgesResponse;\n type badgesV3BadgeBadges_universal_d_UnassignBadgeRequest = UnassignBadgeRequest;\n type badgesV3BadgeBadges_universal_d_UnassignBadgeResponse = UnassignBadgeResponse;\n type badgesV3BadgeBadges_universal_d_BadgeUnassigned = BadgeUnassigned;\n type badgesV3BadgeBadges_universal_d_ListMembersRequest = ListMembersRequest;\n type badgesV3BadgeBadges_universal_d_ListMembersResponse = ListMembersResponse;\n type badgesV3BadgeBadges_universal_d_ListMembersBadgeIdsRequest = ListMembersBadgeIdsRequest;\n type badgesV3BadgeBadges_universal_d_ListMembersBadgeIdsResponse = ListMembersBadgeIdsResponse;\n type badgesV3BadgeBadges_universal_d_MemberBadgeIds = MemberBadgeIds;\n type badgesV3BadgeBadges_universal_d_GetMemberCountsPerBadgeRequest = GetMemberCountsPerBadgeRequest;\n type badgesV3BadgeBadges_universal_d_GetMemberCountsPerBadgeResponse = GetMemberCountsPerBadgeResponse;\n type badgesV3BadgeBadges_universal_d_BadgeMemberCount = BadgeMemberCount;\n type badgesV3BadgeBadges_universal_d_UpdateBadgesDisplayOrderRequest = UpdateBadgesDisplayOrderRequest;\n type badgesV3BadgeBadges_universal_d_UpdateBadgesDisplayOrderResponse = UpdateBadgesDisplayOrderResponse;\n type badgesV3BadgeBadges_universal_d_ListMembersWithBadgesRequest = ListMembersWithBadgesRequest;\n type badgesV3BadgeBadges_universal_d_CursorPaging = CursorPaging;\n type badgesV3BadgeBadges_universal_d_ListMembersWithBadgesResponse = ListMembersWithBadgesResponse;\n type badgesV3BadgeBadges_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type badgesV3BadgeBadges_universal_d_Cursors = Cursors;\n type badgesV3BadgeBadges_universal_d_DomainEvent = DomainEvent;\n type badgesV3BadgeBadges_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type badgesV3BadgeBadges_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type badgesV3BadgeBadges_universal_d_RestoreInfo = RestoreInfo;\n type badgesV3BadgeBadges_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type badgesV3BadgeBadges_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type badgesV3BadgeBadges_universal_d_ActionEvent = ActionEvent;\n type badgesV3BadgeBadges_universal_d_MessageEnvelope = MessageEnvelope;\n type badgesV3BadgeBadges_universal_d_IdentificationData = IdentificationData;\n type badgesV3BadgeBadges_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type badgesV3BadgeBadges_universal_d_WebhookIdentityType = WebhookIdentityType;\n const badgesV3BadgeBadges_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const badgesV3BadgeBadges_universal_d_createBadge: typeof createBadge;\n const badgesV3BadgeBadges_universal_d_updateBadge: typeof updateBadge;\n type badgesV3BadgeBadges_universal_d_UpdateBadge = UpdateBadge;\n const badgesV3BadgeBadges_universal_d_listBadges: typeof listBadges;\n type badgesV3BadgeBadges_universal_d_ListBadgesOptions = ListBadgesOptions;\n type badgesV3BadgeBadges_universal_d_QueryBadgesOptions = QueryBadgesOptions;\n const badgesV3BadgeBadges_universal_d_getBadge: typeof getBadge;\n const badgesV3BadgeBadges_universal_d_deleteBadge: typeof deleteBadge;\n type badgesV3BadgeBadges_universal_d_CountBadgesOptions = CountBadgesOptions;\n const badgesV3BadgeBadges_universal_d_assignBadge: typeof assignBadge;\n const badgesV3BadgeBadges_universal_d_unassignBadge: typeof unassignBadge;\n const badgesV3BadgeBadges_universal_d_listMembersByBadge: typeof listMembersByBadge;\n type badgesV3BadgeBadges_universal_d_ListMembersByBadgeOptions = ListMembersByBadgeOptions;\n const badgesV3BadgeBadges_universal_d_listBadgesPerMember: typeof listBadgesPerMember;\n const badgesV3BadgeBadges_universal_d_getMemberCountsPerBadge: typeof getMemberCountsPerBadge;\n const badgesV3BadgeBadges_universal_d_updateBadgesDisplayOrder: typeof updateBadgesDisplayOrder;\n namespace badgesV3BadgeBadges_universal_d {\n export { badgesV3BadgeBadges_universal_d_Badge as Badge, badgesV3BadgeBadges_universal_d_CreateBadgeRequest as CreateBadgeRequest, badgesV3BadgeBadges_universal_d_CreateBadgeResponse as CreateBadgeResponse, badgesV3BadgeBadges_universal_d_UpdateBadgeRequest as UpdateBadgeRequest, badgesV3BadgeBadges_universal_d_UpdateBadgeResponse as UpdateBadgeResponse, badgesV3BadgeBadges_universal_d_ListBadgesRequest as ListBadgesRequest, badgesV3BadgeBadges_universal_d_Paging as Paging, badgesV3BadgeBadges_universal_d_ListBadgesResponse as ListBadgesResponse, badgesV3BadgeBadges_universal_d_PagingMetadata as PagingMetadata, badgesV3BadgeBadges_universal_d_QueryBadgesRequest as QueryBadgesRequest, badgesV3BadgeBadges_universal_d_Sorting as Sorting, badgesV3BadgeBadges_universal_d_SortOrder as SortOrder, badgesV3BadgeBadges_universal_d_QueryBadgesResponse as QueryBadgesResponse, badgesV3BadgeBadges_universal_d_GetBadgeRequest as GetBadgeRequest, badgesV3BadgeBadges_universal_d_GetBadgeResponse as GetBadgeResponse, badgesV3BadgeBadges_universal_d_DeleteBadgeRequest as DeleteBadgeRequest, badgesV3BadgeBadges_universal_d_DeleteBadgeResponse as DeleteBadgeResponse, badgesV3BadgeBadges_universal_d_CountBadgesRequest as CountBadgesRequest, badgesV3BadgeBadges_universal_d_CountBadgesResponse as CountBadgesResponse, badgesV3BadgeBadges_universal_d_AssignBadgeRequest as AssignBadgeRequest, badgesV3BadgeBadges_universal_d_AssignBadgeResponse as AssignBadgeResponse, badgesV3BadgeBadges_universal_d_BadgeAssigned as BadgeAssigned, badgesV3BadgeBadges_universal_d_AssignBadgesRequest as AssignBadgesRequest, badgesV3BadgeBadges_universal_d_AssignBadgesResponse as AssignBadgesResponse, badgesV3BadgeBadges_universal_d_UnassignBadgeRequest as UnassignBadgeRequest, badgesV3BadgeBadges_universal_d_UnassignBadgeResponse as UnassignBadgeResponse, badgesV3BadgeBadges_universal_d_BadgeUnassigned as BadgeUnassigned, badgesV3BadgeBadges_universal_d_ListMembersRequest as ListMembersRequest, badgesV3BadgeBadges_universal_d_ListMembersResponse as ListMembersResponse, badgesV3BadgeBadges_universal_d_ListMembersBadgeIdsRequest as ListMembersBadgeIdsRequest, badgesV3BadgeBadges_universal_d_ListMembersBadgeIdsResponse as ListMembersBadgeIdsResponse, badgesV3BadgeBadges_universal_d_MemberBadgeIds as MemberBadgeIds, badgesV3BadgeBadges_universal_d_GetMemberCountsPerBadgeRequest as GetMemberCountsPerBadgeRequest, badgesV3BadgeBadges_universal_d_GetMemberCountsPerBadgeResponse as GetMemberCountsPerBadgeResponse, badgesV3BadgeBadges_universal_d_BadgeMemberCount as BadgeMemberCount, badgesV3BadgeBadges_universal_d_UpdateBadgesDisplayOrderRequest as UpdateBadgesDisplayOrderRequest, badgesV3BadgeBadges_universal_d_UpdateBadgesDisplayOrderResponse as UpdateBadgesDisplayOrderResponse, badgesV3BadgeBadges_universal_d_ListMembersWithBadgesRequest as ListMembersWithBadgesRequest, badgesV3BadgeBadges_universal_d_CursorPaging as CursorPaging, badgesV3BadgeBadges_universal_d_ListMembersWithBadgesResponse as ListMembersWithBadgesResponse, badgesV3BadgeBadges_universal_d_CursorPagingMetadata as CursorPagingMetadata, badgesV3BadgeBadges_universal_d_Cursors as Cursors, badgesV3BadgeBadges_universal_d_DomainEvent as DomainEvent, badgesV3BadgeBadges_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, badgesV3BadgeBadges_universal_d_EntityCreatedEvent as EntityCreatedEvent, badgesV3BadgeBadges_universal_d_RestoreInfo as RestoreInfo, badgesV3BadgeBadges_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, badgesV3BadgeBadges_universal_d_EntityDeletedEvent as EntityDeletedEvent, badgesV3BadgeBadges_universal_d_ActionEvent as ActionEvent, badgesV3BadgeBadges_universal_d_MessageEnvelope as MessageEnvelope, badgesV3BadgeBadges_universal_d_IdentificationData as IdentificationData, badgesV3BadgeBadges_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, badgesV3BadgeBadges_universal_d_WebhookIdentityType as WebhookIdentityType, badgesV3BadgeBadges_universal_d_createBadge as createBadge, badgesV3BadgeBadges_universal_d_updateBadge as updateBadge, badgesV3BadgeBadges_universal_d_UpdateBadge as UpdateBadge, badgesV3BadgeBadges_universal_d_listBadges as listBadges, badgesV3BadgeBadges_universal_d_ListBadgesOptions as ListBadgesOptions, badgesV3BadgeBadges_universal_d_QueryBadgesOptions as QueryBadgesOptions, badgesV3BadgeBadges_universal_d_getBadge as getBadge, badgesV3BadgeBadges_universal_d_deleteBadge as deleteBadge, badgesV3BadgeBadges_universal_d_CountBadgesOptions as CountBadgesOptions, badgesV3BadgeBadges_universal_d_assignBadge as assignBadge, badgesV3BadgeBadges_universal_d_unassignBadge as unassignBadge, badgesV3BadgeBadges_universal_d_listMembersByBadge as listMembersByBadge, badgesV3BadgeBadges_universal_d_ListMembersByBadgeOptions as ListMembersByBadgeOptions, badgesV3BadgeBadges_universal_d_listBadgesPerMember as listBadgesPerMember, badgesV3BadgeBadges_universal_d_getMemberCountsPerBadge as getMemberCountsPerBadge, badgesV3BadgeBadges_universal_d_updateBadgesDisplayOrder as updateBadgesDisplayOrder, };\n }\n export { identityMembersV1MemberAuthentication_universal_d as authentication, badgesV3BadgeBadges_universal_d as badges, membersV1MemberMembers_universal_d as members };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-groups.v2.d.ts", "content": "declare module \"wix-groups.v2\" {\n interface GroupMember$1 {\n /**\n * Site member ID.\n * @readonly\n */\n memberId?: string;\n /** Group Member Role. */\n role?: GroupRole$1;\n /**\n * Date and time the group Member joined the group.\n * @readonly\n */\n joinedDate?: Date;\n }\n /**\n * A group member may have multiple roles in a single group.\n * Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.\n */\n interface GroupRole$1 {\n /**\n * Group member role. One of:\n * - `\"MEMBER\"` - Regular group member.\n * - `\"ADMIN\"` - Group administrator.\n */\n value?: Role$1;\n }\n enum Role$1 {\n UNKNOWN_ROLE = \"UNKNOWN_ROLE\",\n /** Regular group member. */\n MEMBER = \"MEMBER\",\n /** Group administrator. */\n ADMIN = \"ADMIN\"\n }\n interface SocialGroupsEvent$1 extends SocialGroupsEventPayloadOneOf$1 {\n memberJoined?: MemberJoinedGroup$1;\n membersAdded?: MembersAddedToGroup$1;\n joinRequestsApproved?: JoinRequestsApproved$1;\n membersInvited?: MembersInvitedToGroup$1;\n }\n /** @oneof */\n interface SocialGroupsEventPayloadOneOf$1 {\n memberJoined?: MemberJoinedGroup$1;\n membersAdded?: MembersAddedToGroup$1;\n joinRequestsApproved?: JoinRequestsApproved$1;\n membersInvited?: MembersInvitedToGroup$1;\n }\n interface MemberJoinedGroup$1 {\n groupId?: string;\n groupsInstanceId?: string;\n siteMemberId?: string;\n }\n interface MembersAddedToGroup$1 {\n groupId?: string;\n groupsInstanceId?: string;\n whoAddedId?: string | null;\n siteMemberIds?: string[];\n /** Used for Apes sticky experiment */\n operationId?: string;\n }\n interface JoinRequestsApproved$1 {\n groupId?: string;\n groupsInstanceId?: string;\n siteMemberIds?: string[];\n /** Used for Apes sticky experiment */\n operationId?: string;\n }\n interface MembersInvitedToGroup$1 {\n groupId?: string;\n groupsInstanceId?: string;\n siteMemberIds?: string[];\n }\n /** ID of the group to join. */\n interface JoinRequest {\n groupId: string;\n /** Answers to membership questions. A Join Request will fail, if the answer to a required question is omitted. */\n membershipQuestionAnswers?: MembershipQuestionAnswer$1[];\n autoInviteId?: string | null;\n }\n /** Answer to a membership question. */\n interface MembershipQuestionAnswer$1 {\n /** Question ID. */\n _id?: string;\n /** Answer text. */\n text?: string | null;\n }\n interface JoinResponse {\n /** New member. */\n member?: GroupMember$1;\n }\n interface MemberJoined {\n /** Group ID that member has joined. */\n groupId?: string;\n /** Joined group member. */\n groupMember?: GroupMember$1;\n }\n enum JoinBy {\n MANUALLY = \"MANUALLY\",\n PERSONAL_INVITE_LINK = \"PERSONAL_INVITE_LINK\",\n PUBLIC_INVITE_LINK = \"PUBLIC_INVITE_LINK\"\n }\n interface LeaveRequest {\n /** ID of the Group to leave. */\n groupId: string;\n }\n interface LeaveResponse {\n }\n interface MemberLeft {\n /** Group ID that member has left. */\n groupId?: string;\n /** Group member that left. */\n groupMember?: GroupMember$1;\n }\n interface AddGroupMembersRequest {\n /** Group ID. */\n groupId: string;\n /**\n * IDs of the site members to add to the group.\n *\n *\n */\n memberIds?: string[];\n }\n interface AddGroupMembersResponse {\n /** New members. */\n members?: GroupMember$1[];\n }\n interface MemberAdded {\n /** Group ID that member was added to. */\n groupId?: string;\n /** Added group member. */\n groupMember?: GroupMember$1;\n }\n interface RemoveGroupMembersRequest {\n /** Group ID. */\n groupId: string;\n /** IDs of the site members to remove from the group. */\n memberIds?: string[];\n }\n interface RemoveGroupMembersResponse {\n }\n interface MemberRemoved {\n /** Group ID that member was removed from. */\n groupId?: string;\n /** Removed group member. */\n groupMember?: GroupMember$1;\n }\n interface ListGroupMembersRequest {\n /** Group ID. */\n groupId: string;\n /** Number of items to load. Maximum `100.` */\n limit?: number | null;\n /** Number of group members to skip in the list. */\n offset?: number | null;\n }\n interface ListGroupMembersResponse {\n /** Retrieved members. */\n members?: GroupMember$1[];\n /** Paging information. */\n metadata?: PagingMetadata$2;\n }\n interface PagingMetadata$2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface QueryGroupMembersRequest {\n /** Group ID. */\n groupId: string;\n query?: Query$2;\n }\n interface Query$2 {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$2[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryGroupMembersResponse {\n /** Group members. */\n members?: GroupMember$1[];\n /** Paging information. */\n metadata?: PagingMetadata$2;\n }\n interface QueryNonGroupMembersRequest {\n /** Group ID. */\n groupId: string;\n query?: Query$2;\n }\n interface QueryNonGroupMembersResponse {\n /** Retrieved members. */\n members?: GroupMember$1[];\n }\n interface ListMembershipsRequest {\n /** Site member ID. */\n memberId: string | null;\n /** Number of items to load. */\n limit?: number | null;\n /** Number of memberships to skip in the list. */\n offset?: number | null;\n }\n interface ListMembershipsResponse {\n /** Site member's memberships. */\n memberships?: Membership[];\n /** Paging information. */\n metadata?: PagingMetadata$2;\n }\n interface Membership {\n /**\n * Group ID.\n * @readonly\n */\n groupId?: string;\n /**\n * Membership status with Group\n * - `\"JOINED\"` - Site member is a group member.\n * - `\"PENDING\"` - Site member has submitted a Join Request for this group that is still `\"PENDING\"`.\n */\n status?: MembershipStatus$1;\n /** Group member role. When membership status is not `JOINED`, this is empty. */\n role?: GroupRole$1;\n }\n enum MembershipStatus$1 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Site member is a group member. */\n JOINED = \"JOINED\",\n /** Site member has join group request with `PENDING` status for this group. */\n PENDING = \"PENDING\"\n }\n interface QueryMembershipsRequest {\n /** Site member ID. */\n memberId: string | null;\n query?: Query$2;\n }\n interface QueryMembershipsResponse {\n /** Site member's memberships. */\n memberships?: Membership[];\n /** Paging information. */\n metadata?: PagingMetadata$2;\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n }\n interface RestoreInfo$3 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$3;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface JoinGroupOptions {\n /** Answers to membership questions. A Join Request will fail, if the answer to a required question is omitted. */\n membershipQuestionAnswers?: MembershipQuestionAnswer$1[];\n autoInviteId?: string | null;\n }\n /**\n * Adds site members to a group.\n *\n *\n * The `addGroupMembers()` function returns a Promise that resolves to the newly-added group member\n * after the member has successfully been added.\n *\n * For `SECRET` groups, site admins, group admins, and group members can add additional members to their group.\n *\n * For `PUBLIC` and `PRIVATE` groups, only site admins and group admins can add additional members to their group. They can also choose to allow all group members to add a new member to the group.\n * This setting can be found in your site's Dashboard under **Groups Application > Your Group > Admin Tools > Member Permissions**.\n *\n * \n *\n * @param groupId - Group ID.\n * @param memberIds - IDs of the site members to add to the group.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @adminMethod\n */\n function addGroupMembers(groupId: string, memberIds: string[], options?: AddGroupMembersOptions): Promise;\n interface AddGroupMembersOptions {\n }\n /**\n * Removes members from a group.\n *\n *\n * The `removeGroupMembers()` function returns a Promise that resolves when the member is removed from the group.\n *\n * > **Note:** Only site admins and group admins can remove members from their group. \n *\n * @param groupId - Group ID.\n * @param memberIds - IDs of the site members to remove from the group.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @adminMethod\n */\n function removeGroupMembers(groupId: string, memberIds: string[], options?: RemoveGroupMembersOptions): Promise;\n interface RemoveGroupMembersOptions {\n }\n /**\n * Lists all members of a group.\n *\n *\n * The `listGroupMembers()` function returns a Promise that resolves to a list of up to 100 group members.\n * Sorts by default to `joinedDate` in descending order.\n *\n * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see the list of group members. \n * \n *\n * @param groupId - Group ID.\n * @public\n * @requiredField groupId\n * @param options - Paging options.\n * @adminMethod\n */\n function listGroupMembers(groupId: string, options?: ListGroupMembersOptions): Promise;\n interface ListGroupMembersOptions {\n /** Maximum number of group members to retrieve. Defaults to 100. */\n limit?: number | null;\n /** Number of group members to skip in the list. */\n offset?: number | null;\n }\n /**\n * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.\n *\n *\n * Creates a query to retrieve a list of group members.\n *\n * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. \n *\n * The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](#membersquerybuilder) object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](#membersquerybuilder/find) function.\n *\n * You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.\n *\n * `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:\n * + [`limit(100)`](/members-query-builder/limit)\n * + [`descending(\"joinedDate\")`](/members-query-builder/descending)\n *\n * The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](/members-query-result/items) property in `MembersQueryResult`.\n * @public\n * @requiredField groupId\n * @param groupId - Group ID.\n * @adminMethod\n */\n function queryGroupMembers(groupId: string): MembersQueryBuilder;\n interface QueryOffsetResult$2 {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface MembersQueryResult extends QueryOffsetResult$2 {\n items: GroupMember$1[];\n query: MembersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface MembersQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"role\", value: any) => MembersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"role\", value: any) => MembersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"role\", value: any[]) => MembersQueryBuilder;\n in: (propertyName: \"role\", value: any) => MembersQueryBuilder;\n exists: (propertyName: \"role\", value: boolean) => MembersQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"role\" | \"joinedDate\">) => MembersQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"role\" | \"joinedDate\">) => MembersQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => MembersQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => MembersQueryBuilder;\n find: () => Promise;\n }\n interface QueryNonGroupMembersOptions {\n query?: Query$2;\n }\n /**\n * Lists all group memberships of a site member.\n *\n *\n * The `listMemberships()` function returns a Promise that resolves to a list of up to 100 group memberships.\n * Sorts by default to `groupId` in descending order.\n *\n * > **Note:** Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships. \n * \n *\n * @public\n * @requiredField memberId\n * @param memberId - Site member ID.\n * @param options - Paging options.\n * @adminMethod\n */\n function listMemberships(memberId: string | null, options?: ListMembershipsOptions): Promise;\n interface ListMembershipsOptions {\n /** Maximum number of memberships to retrieve. Defaults to 100. */\n limit?: number | null;\n /** Number of memberships to skip in the list. */\n offset?: number | null;\n }\n /**\n * Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.\n *\n * The queryMemberships function returns a Promise that resolves to a list of memberships.\n *\n * >**Note:** Site members can only query their own memberships.\n *\n * | Property | Supported Filters & Sorting |\n * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n * | `status` | [`eq()`](#membershipsquerybuilder/eq), [`ne()`](#membershipsquerybuilder/ne) |\n * | `role` | [`eq()`](#membershipsquerybuilder/eq), [`ne()`](#membershipsquerybuilder/ne) |\n *\n * @public\n * @requiredField memberId\n * @param memberId - Site member ID.\n * @adminMethod\n */\n function queryMemberships(memberId: string | null, options?: QueryMembershipsOptions): Promise;\n interface QueryMembershipsOptions {\n query?: Query$2;\n }\n type socialGroupsV2GroupMemberMembers_universal_d_JoinRequest = JoinRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_JoinResponse = JoinResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_MemberJoined = MemberJoined;\n type socialGroupsV2GroupMemberMembers_universal_d_JoinBy = JoinBy;\n const socialGroupsV2GroupMemberMembers_universal_d_JoinBy: typeof JoinBy;\n type socialGroupsV2GroupMemberMembers_universal_d_LeaveRequest = LeaveRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_LeaveResponse = LeaveResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_MemberLeft = MemberLeft;\n type socialGroupsV2GroupMemberMembers_universal_d_AddGroupMembersRequest = AddGroupMembersRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_AddGroupMembersResponse = AddGroupMembersResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_MemberAdded = MemberAdded;\n type socialGroupsV2GroupMemberMembers_universal_d_RemoveGroupMembersRequest = RemoveGroupMembersRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_RemoveGroupMembersResponse = RemoveGroupMembersResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_MemberRemoved = MemberRemoved;\n type socialGroupsV2GroupMemberMembers_universal_d_ListGroupMembersRequest = ListGroupMembersRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_ListGroupMembersResponse = ListGroupMembersResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryGroupMembersRequest = QueryGroupMembersRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryGroupMembersResponse = QueryGroupMembersResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryNonGroupMembersRequest = QueryNonGroupMembersRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryNonGroupMembersResponse = QueryNonGroupMembersResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_ListMembershipsRequest = ListMembershipsRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_ListMembershipsResponse = ListMembershipsResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_Membership = Membership;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryMembershipsRequest = QueryMembershipsRequest;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryMembershipsResponse = QueryMembershipsResponse;\n type socialGroupsV2GroupMemberMembers_universal_d_JoinGroupOptions = JoinGroupOptions;\n const socialGroupsV2GroupMemberMembers_universal_d_addGroupMembers: typeof addGroupMembers;\n type socialGroupsV2GroupMemberMembers_universal_d_AddGroupMembersOptions = AddGroupMembersOptions;\n const socialGroupsV2GroupMemberMembers_universal_d_removeGroupMembers: typeof removeGroupMembers;\n type socialGroupsV2GroupMemberMembers_universal_d_RemoveGroupMembersOptions = RemoveGroupMembersOptions;\n const socialGroupsV2GroupMemberMembers_universal_d_listGroupMembers: typeof listGroupMembers;\n type socialGroupsV2GroupMemberMembers_universal_d_ListGroupMembersOptions = ListGroupMembersOptions;\n const socialGroupsV2GroupMemberMembers_universal_d_queryGroupMembers: typeof queryGroupMembers;\n type socialGroupsV2GroupMemberMembers_universal_d_MembersQueryResult = MembersQueryResult;\n type socialGroupsV2GroupMemberMembers_universal_d_MembersQueryBuilder = MembersQueryBuilder;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryNonGroupMembersOptions = QueryNonGroupMembersOptions;\n const socialGroupsV2GroupMemberMembers_universal_d_listMemberships: typeof listMemberships;\n type socialGroupsV2GroupMemberMembers_universal_d_ListMembershipsOptions = ListMembershipsOptions;\n const socialGroupsV2GroupMemberMembers_universal_d_queryMemberships: typeof queryMemberships;\n type socialGroupsV2GroupMemberMembers_universal_d_QueryMembershipsOptions = QueryMembershipsOptions;\n namespace socialGroupsV2GroupMemberMembers_universal_d {\n export { GroupMember$1 as GroupMember, GroupRole$1 as GroupRole, Role$1 as Role, SocialGroupsEvent$1 as SocialGroupsEvent, SocialGroupsEventPayloadOneOf$1 as SocialGroupsEventPayloadOneOf, MemberJoinedGroup$1 as MemberJoinedGroup, MembersAddedToGroup$1 as MembersAddedToGroup, JoinRequestsApproved$1 as JoinRequestsApproved, MembersInvitedToGroup$1 as MembersInvitedToGroup, socialGroupsV2GroupMemberMembers_universal_d_JoinRequest as JoinRequest, MembershipQuestionAnswer$1 as MembershipQuestionAnswer, socialGroupsV2GroupMemberMembers_universal_d_JoinResponse as JoinResponse, socialGroupsV2GroupMemberMembers_universal_d_MemberJoined as MemberJoined, socialGroupsV2GroupMemberMembers_universal_d_JoinBy as JoinBy, socialGroupsV2GroupMemberMembers_universal_d_LeaveRequest as LeaveRequest, socialGroupsV2GroupMemberMembers_universal_d_LeaveResponse as LeaveResponse, socialGroupsV2GroupMemberMembers_universal_d_MemberLeft as MemberLeft, socialGroupsV2GroupMemberMembers_universal_d_AddGroupMembersRequest as AddGroupMembersRequest, socialGroupsV2GroupMemberMembers_universal_d_AddGroupMembersResponse as AddGroupMembersResponse, socialGroupsV2GroupMemberMembers_universal_d_MemberAdded as MemberAdded, socialGroupsV2GroupMemberMembers_universal_d_RemoveGroupMembersRequest as RemoveGroupMembersRequest, socialGroupsV2GroupMemberMembers_universal_d_RemoveGroupMembersResponse as RemoveGroupMembersResponse, socialGroupsV2GroupMemberMembers_universal_d_MemberRemoved as MemberRemoved, socialGroupsV2GroupMemberMembers_universal_d_ListGroupMembersRequest as ListGroupMembersRequest, socialGroupsV2GroupMemberMembers_universal_d_ListGroupMembersResponse as ListGroupMembersResponse, PagingMetadata$2 as PagingMetadata, socialGroupsV2GroupMemberMembers_universal_d_QueryGroupMembersRequest as QueryGroupMembersRequest, Query$2 as Query, Sorting$2 as Sorting, SortOrder$2 as SortOrder, Paging$2 as Paging, socialGroupsV2GroupMemberMembers_universal_d_QueryGroupMembersResponse as QueryGroupMembersResponse, socialGroupsV2GroupMemberMembers_universal_d_QueryNonGroupMembersRequest as QueryNonGroupMembersRequest, socialGroupsV2GroupMemberMembers_universal_d_QueryNonGroupMembersResponse as QueryNonGroupMembersResponse, socialGroupsV2GroupMemberMembers_universal_d_ListMembershipsRequest as ListMembershipsRequest, socialGroupsV2GroupMemberMembers_universal_d_ListMembershipsResponse as ListMembershipsResponse, socialGroupsV2GroupMemberMembers_universal_d_Membership as Membership, MembershipStatus$1 as MembershipStatus, socialGroupsV2GroupMemberMembers_universal_d_QueryMembershipsRequest as QueryMembershipsRequest, socialGroupsV2GroupMemberMembers_universal_d_QueryMembershipsResponse as QueryMembershipsResponse, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$3 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, MessageEnvelope$3 as MessageEnvelope, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, socialGroupsV2GroupMemberMembers_universal_d_JoinGroupOptions as JoinGroupOptions, socialGroupsV2GroupMemberMembers_universal_d_addGroupMembers as addGroupMembers, socialGroupsV2GroupMemberMembers_universal_d_AddGroupMembersOptions as AddGroupMembersOptions, socialGroupsV2GroupMemberMembers_universal_d_removeGroupMembers as removeGroupMembers, socialGroupsV2GroupMemberMembers_universal_d_RemoveGroupMembersOptions as RemoveGroupMembersOptions, socialGroupsV2GroupMemberMembers_universal_d_listGroupMembers as listGroupMembers, socialGroupsV2GroupMemberMembers_universal_d_ListGroupMembersOptions as ListGroupMembersOptions, socialGroupsV2GroupMemberMembers_universal_d_queryGroupMembers as queryGroupMembers, socialGroupsV2GroupMemberMembers_universal_d_MembersQueryResult as MembersQueryResult, socialGroupsV2GroupMemberMembers_universal_d_MembersQueryBuilder as MembersQueryBuilder, socialGroupsV2GroupMemberMembers_universal_d_QueryNonGroupMembersOptions as QueryNonGroupMembersOptions, socialGroupsV2GroupMemberMembers_universal_d_listMemberships as listMemberships, socialGroupsV2GroupMemberMembers_universal_d_ListMembershipsOptions as ListMembershipsOptions, socialGroupsV2GroupMemberMembers_universal_d_queryMemberships as queryMemberships, socialGroupsV2GroupMemberMembers_universal_d_QueryMembershipsOptions as QueryMembershipsOptions, };\n }\n /**\n * A group member may have multiple roles in a single group.\n * Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.\n */\n interface GroupRole {\n /** Member's role. */\n value?: Role;\n }\n enum Role {\n /** Undefined group member role. */\n UNKNOWN_ROLE = \"UNKNOWN_ROLE\",\n /** Regular group member. */\n MEMBER = \"MEMBER\",\n /** Group administrator. */\n ADMIN = \"ADMIN\"\n }\n interface AssignRoleRequest {\n /** Group ID. */\n groupId: string;\n /** Member IDs. Limited to 100 member IDs. See the Members API for details. */\n memberIds?: string[];\n /** Role to assign. */\n role?: GroupRole;\n }\n interface AssignRoleResponse {\n /** Group ID. */\n groupId?: string;\n /** Member IDs. Limited to 100 member IDs. See the Members API for details. */\n memberIds?: string[];\n /** Assigned role. */\n role?: GroupRole;\n }\n interface RoleAssignedToGroupMember {\n /** Group ID in which role was assigned. */\n groupId?: string;\n /** Group member to whom the role was assigned. */\n groupMember?: GroupMember;\n /** Assigned group role. */\n role?: GroupRole;\n /** ID of site member who assigned the role. It can be empty if the role was assigned by a third-party application. */\n assignedById?: string | null;\n }\n interface GroupMember {\n /**\n * Member ID. See the Members API for more details.\n * @readonly\n */\n memberId?: string;\n /** Group member role. */\n role?: GroupRole;\n /**\n * Date and time the group Member joined the group.\n * @readonly\n */\n joinedDate?: Date | null;\n }\n interface UnassignRoleRequest {\n /** Group ID. */\n groupId: string;\n /** Member IDs. Limited to 100 member IDs. See the Members API for details. */\n memberIds?: string[];\n /** Role to unassign. */\n role?: GroupRole;\n }\n interface UnassignRoleResponse {\n /** Group ID. */\n groupId?: string;\n /** Member IDs. Limited to 100 member IDs. See the Members API for details. */\n memberIds?: string[];\n /** Unassigned role. */\n role?: GroupRole;\n }\n interface RoleUnassignedFromGroupMember {\n /** Group ID in which role was unassigned. */\n groupId?: string;\n /** Group member from whom role was removed. */\n groupMember?: GroupMember;\n /** Unassigned group role. */\n role?: GroupRole;\n /** ID of site member who unassigned the role. It can be empty if the role was assigned by a third-party application. */\n unassignedById?: string | null;\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n }\n interface RestoreInfo$2 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$2 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$2 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$2 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$2;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$2;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Assigns a specific role to group members.\n *\n * Calling this method overrides the group member's current `role.value`.\n *\n * >**Notes:**\n * > + Only group admins can assign roles.\n * > + You cannot create new members with this method.\n * @param groupId - Group ID.\n * @param memberIds - Member IDs. Limited to 100 member IDs. See the Members API for details.\n * @param role - Role to assign.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @requiredField role\n * @adminMethod\n * @fqn wix.social.groups.api.v2.GroupRolesService.AssignRole\n */\n function assignRole(groupId: string, memberIds: string[], role: GroupRole, options?: AssignRoleOptions): Promise;\n interface AssignRoleOptions {\n }\n /**\n * Unassigns a role from group members.\n *\n * You can only unassign `ADMIN` roles. Calling this method with group members\n * with `role.value` set to `MEMBER` returns an error.\n *\n * > **Notes:**\n * > + Only group admins can assign roles.\n * > + You cannot remove members with this method.\n * @param groupId - Group ID.\n * @param memberIds - Member IDs. Limited to 100 member IDs. See the Members API for details.\n * @param role - Role to unassign.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @requiredField role\n * @adminMethod\n * @fqn wix.social.groups.api.v2.GroupRolesService.UnassignRole\n */\n function unassignRole(groupId: string, memberIds: string[], role: GroupRole, options?: UnassignRoleOptions): Promise;\n interface UnassignRoleOptions {\n }\n type socialGroupsV2GroupRoleRoles_universal_d_GroupRole = GroupRole;\n type socialGroupsV2GroupRoleRoles_universal_d_Role = Role;\n const socialGroupsV2GroupRoleRoles_universal_d_Role: typeof Role;\n type socialGroupsV2GroupRoleRoles_universal_d_AssignRoleRequest = AssignRoleRequest;\n type socialGroupsV2GroupRoleRoles_universal_d_AssignRoleResponse = AssignRoleResponse;\n type socialGroupsV2GroupRoleRoles_universal_d_RoleAssignedToGroupMember = RoleAssignedToGroupMember;\n type socialGroupsV2GroupRoleRoles_universal_d_GroupMember = GroupMember;\n type socialGroupsV2GroupRoleRoles_universal_d_UnassignRoleRequest = UnassignRoleRequest;\n type socialGroupsV2GroupRoleRoles_universal_d_UnassignRoleResponse = UnassignRoleResponse;\n type socialGroupsV2GroupRoleRoles_universal_d_RoleUnassignedFromGroupMember = RoleUnassignedFromGroupMember;\n const socialGroupsV2GroupRoleRoles_universal_d_assignRole: typeof assignRole;\n type socialGroupsV2GroupRoleRoles_universal_d_AssignRoleOptions = AssignRoleOptions;\n const socialGroupsV2GroupRoleRoles_universal_d_unassignRole: typeof unassignRole;\n type socialGroupsV2GroupRoleRoles_universal_d_UnassignRoleOptions = UnassignRoleOptions;\n namespace socialGroupsV2GroupRoleRoles_universal_d {\n export { socialGroupsV2GroupRoleRoles_universal_d_GroupRole as GroupRole, socialGroupsV2GroupRoleRoles_universal_d_Role as Role, socialGroupsV2GroupRoleRoles_universal_d_AssignRoleRequest as AssignRoleRequest, socialGroupsV2GroupRoleRoles_universal_d_AssignRoleResponse as AssignRoleResponse, socialGroupsV2GroupRoleRoles_universal_d_RoleAssignedToGroupMember as RoleAssignedToGroupMember, socialGroupsV2GroupRoleRoles_universal_d_GroupMember as GroupMember, socialGroupsV2GroupRoleRoles_universal_d_UnassignRoleRequest as UnassignRoleRequest, socialGroupsV2GroupRoleRoles_universal_d_UnassignRoleResponse as UnassignRoleResponse, socialGroupsV2GroupRoleRoles_universal_d_RoleUnassignedFromGroupMember as RoleUnassignedFromGroupMember, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, RestoreInfo$2 as RestoreInfo, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, MessageEnvelope$2 as MessageEnvelope, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, socialGroupsV2GroupRoleRoles_universal_d_assignRole as assignRole, socialGroupsV2GroupRoleRoles_universal_d_AssignRoleOptions as AssignRoleOptions, socialGroupsV2GroupRoleRoles_universal_d_unassignRole as unassignRole, socialGroupsV2GroupRoleRoles_universal_d_UnassignRoleOptions as UnassignRoleOptions, };\n }\n interface Group {\n /**\n * Group ID.\n * @readonly\n */\n _id?: string | null;\n /** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */\n slug?: string | null;\n /** Group privacy status. */\n privacyStatus?: PrivacyStatus;\n /** Group name. */\n name?: string | null;\n /** Group description in [DraftJS](https://draftjs.org) format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */\n memberTitle?: string | null;\n /** Cover image. You cannot upload your own cover image. */\n coverImage?: CoverImage;\n /**\n * Group specific settings.\n *\n * These settings can also be found in [a site's Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fwix-groups/settings?).\n */\n settings?: GroupSettings;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * Group owner.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Group creation date and time.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time of the latest group update.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Date and time of the most recent group activity, for example a post or comment.\n * @readonly\n */\n lastActivityDate?: Date | null;\n }\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n ADMIN_APPROVAL = \"ADMIN_APPROVAL\",\n PAID_PLANS = \"PAID_PLANS\",\n EVENTS = \"EVENTS\"\n }\n interface Events {\n eventIds?: string[];\n }\n interface Logo {\n /** Logo image ID (for internal use). */\n mediaId?: string | null;\n /** Logo image width. */\n width?: number | null;\n /** Logo image height. */\n height?: number | null;\n }\n interface GroupDetailsPosition {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n interface Image {\n /** Image ID (for internal use). */\n mediaId?: string | null;\n /** Image width. */\n width?: number | null;\n /** Image height. */\n height?: number | null;\n /** Indicates pre-configured/auto-generated images (from templates, client generated). */\n preset?: boolean | null;\n }\n interface Position {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n enum AllowPolicy {\n UNKNOWN = \"UNKNOWN\",\n OWNER_AND_ADMINS = \"OWNER_AND_ADMINS\",\n OWNER = \"OWNER\",\n ALL_MEMBERS = \"ALL_MEMBERS\"\n }\n interface OnboardingStepSettings {\n stepKey?: StepKey;\n visible?: boolean;\n }\n enum StepKey {\n UNKNOWN = \"UNKNOWN\",\n CREATE_POST = \"CREATE_POST\",\n REACT_TO_POST = \"REACT_TO_POST\",\n INVITE_MEMBERS = \"INVITE_MEMBERS\"\n }\n enum PrivacyStatus {\n /** Undefined group privacy status. */\n UNKNOWN = \"UNKNOWN\",\n /** Anyone can see the group and its content. Anyone can join the group. */\n PUBLIC = \"PUBLIC\",\n /** Anyone can see the group, but only members can see its content. New members must submit a `Join Group Request`. */\n PRIVATE = \"PRIVATE\",\n /** Only admins and members can see the group. New members can only be added by other members. */\n SECRET = \"SECRET\"\n }\n interface AccessRestriction extends AccessRestrictionDataOneOf {\n events?: Events;\n type?: Type;\n }\n /** @oneof */\n interface AccessRestrictionDataOneOf {\n events?: Events;\n }\n interface GroupDetails {\n /** Group logo. You cannot upload your own logo. */\n logo?: Logo;\n /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */\n membersTitle?: string | null;\n }\n /** Cover image. You cannot upload your own cover image. */\n interface CoverImage {\n /** Cover image. */\n image?: Image;\n /** Position of the corner of the cover image (or logo). */\n position?: Position;\n /** Position of the corner of the cover image (or logo) for mobile browser. */\n mobilePosition?: Position;\n /**\n * Alternative text is typically a relatively short phrase that describes what the image depicts.\n *\n * The alternative text is used:\n * + If the browser cannot display the image.\n * + If the user is utilizing a screen reader.\n * + By search engines to understand what images are on your site.\n */\n altText?: string | null;\n }\n interface GroupSettings {\n /**\n * __Deprecated.__ Use `allowedToInviteMembers` instead.\n * Whether regular members are permitted to invite new members.\n * If `false`, only admins can invite members. Defaults to `true`.\n * @deprecated\n */\n membersCanInvite?: boolean | null;\n /**\n * __Deprecated.__ Use `allowedToApproveJoinRequests` instead.\n * Whether all group members are permitted to approve join group requests.\n * If `false`, member approval is limited to the admins.\n * @deprecated\n */\n membersCanApprove?: boolean | null;\n /** Whether a daily post about new members is enabled. */\n welcomeMemberPostEnabled?: boolean | null;\n /** Whether an automatic post about changing the group details is enabled. */\n groupDetailsChangedPostEnabled?: boolean | null;\n /** Whether all members can see the full member list. */\n showMemberList?: boolean | null;\n /** Determines who can invite members to the group */\n allowedToInviteMembers?: AllowPolicy;\n /** Determines who can approve member join requests to the group */\n allowedToApproveJoinRequests?: AllowPolicy;\n }\n interface Identity {\n /** Member ID of the group creator. See the Members API for more details. */\n _id?: string | null;\n identityType?: IdentityType;\n }\n enum IdentityType {\n /** Wix user. */\n USER = \"USER\",\n /** Wix member. */\n MEMBER = \"MEMBER\"\n }\n interface CreateGroupRequest {\n /** Group to create. */\n group: Group;\n /** ID of the member who created the group, from the Members API. This member will automatically become an admin. */\n creatorId?: string | null;\n /** Content type. */\n contentType?: ContentType;\n }\n enum ContentType {\n PLAIN_TEXT = \"PLAIN_TEXT\",\n DRAFTJS = \"DRAFTJS\",\n RICH_CONTENT = \"RICH_CONTENT\"\n }\n interface CreateGroupResponse {\n /** Created group. */\n group?: Group;\n }\n interface UpdateGroupRequest {\n /** Group to update. */\n group: Group;\n /** Content type. */\n contentType?: ContentType;\n }\n interface UpdateGroupResponse {\n /** Updated group. */\n group?: Group;\n }\n interface GroupCoverChanged {\n /** Old URL of group cover. */\n oldUrl?: string | null;\n /** New URL of group cover. */\n newUrl?: string | null;\n }\n interface GroupDescriptionChanged {\n /** Group's old description. */\n oldDescription?: string | null;\n /** Group's new description. */\n newDescription?: string | null;\n }\n interface DeleteGroupRequest {\n /** ID of the group to delete. */\n groupId: string;\n }\n interface DeleteGroupResponse {\n /** Deleted group. */\n group?: Group;\n }\n interface GetGroupRequest {\n /** ID of the group to retrieve. */\n groupId: string;\n /** Content type. */\n contentType?: ContentType;\n }\n interface GetGroupResponse {\n /** Retrieved group. */\n group?: Group;\n }\n interface GetGroupBySlugRequest {\n /** Unique part of the group's URL. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. Case-sensitive. */\n slug: string;\n autoInviteId?: string | null;\n /** Content type. */\n contentType?: ContentType;\n }\n interface GetGroupBySlugResponse {\n /** Retrieved group. */\n group?: Group;\n }\n interface GetGroupIdBySlugRequest {\n /** Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive. */\n slug: string;\n autoInviteId?: string | null;\n }\n interface GetGroupIdBySlugResponse {\n /** ID of the group that correspond to slug */\n groupId?: string;\n /** Global feed permissions */\n accessPermissions?: GlobalFeedPermissions;\n }\n interface GlobalFeedPermissions {\n feedPermissions?: FeedPermissions;\n ownFeedItemPermissions?: FeedItemPermissions;\n allFeedItemPermissions?: FeedItemPermissions;\n activityFeedItemPermissions?: FeedItemPermissions;\n }\n interface FeedPermissions {\n canViewPosts?: boolean;\n canCreatePosts?: boolean;\n canPinPosts?: boolean;\n canCreateTopic?: boolean;\n canFollowPosts?: boolean;\n canCreatePaidPosts?: boolean;\n canReadSettings?: boolean;\n canManageSettings?: boolean;\n }\n interface FeedItemPermissions {\n canViewFullPost?: boolean;\n canAssignTopic?: boolean;\n canUnassignTopic?: boolean;\n /** bool canFollow = 3; // it's not related to context token */\n canUpdate?: boolean;\n canDelete?: boolean;\n /** always true */\n canShare?: boolean;\n canAddComment?: boolean;\n canReact?: boolean;\n canPin?: boolean;\n }\n interface ListGroupsRequest {\n /** Number of items to load. Maximum `100`. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n /** Content type. */\n contentType?: ContentType;\n }\n interface ListGroupsResponse {\n /** Retrieved Groups. */\n groups?: Group[];\n /** Paging metadata. */\n metadata?: PagingMetadata$1;\n }\n interface PagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface ListGroupsByUserIdRequest {\n /** Content type. */\n contentType?: ContentType;\n }\n interface ListGroupsByUserIdResponse {\n groups?: GroupWithMsId[];\n }\n /** Retrieved Groups by metasite id */\n interface GroupWithMsId {\n metaSiteId?: string;\n groups?: Group[];\n }\n interface QueryGroupsRequest {\n /** Query options. */\n query?: Query$1;\n /** Content type. */\n contentType?: ContentType;\n }\n interface Query$1 {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$1[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryGroupsResponse {\n /** Retrieved groups. */\n groups?: Group[];\n /** Paging metadata. */\n metadata?: PagingMetadata$1;\n }\n interface QueryJoinedGroupsRequest {\n /** Query options. */\n query?: Query$1;\n /** Content type. */\n contentType?: ContentType;\n }\n interface QueryJoinedGroupsResponse {\n /** Retrieved groups. */\n groups?: Group[];\n /** Paging metadata. */\n metadata?: PagingMetadata$1;\n }\n interface QueryGroupsByMembershipRequest {\n /** Query options. */\n query?: Query$1;\n membershipStatus?: MembershipStatus;\n /** Filter groups by permissions. */\n permissionsFilter?: GroupPermissions;\n /** Content type. */\n contentType?: ContentType;\n }\n enum MembershipStatus {\n NONE = \"NONE\",\n JOINED = \"JOINED\",\n PENDING = \"PENDING\"\n }\n interface GroupPermissions {\n canCreatePosts?: boolean | null;\n }\n interface QueryGroupsByMembershipResponse {\n /** Retrieved groups. */\n groups?: Group[];\n /** Paging metadata. */\n metadata?: PagingMetadata$1;\n }\n interface ListGroupIntegrationsDataRequest {\n groupIds?: string[];\n }\n interface ListGroupIntegrationsDataResponse {\n groupsIntegrationsData?: GroupIntegrationsData[];\n }\n interface GroupIntegrationsData {\n groupId?: string;\n feedItemsCount?: number;\n topicIds?: string[];\n eventIds?: string[];\n connectedPricingPlanIds?: string[];\n onlineProgramIds?: string[];\n }\n interface GetGroupMembersGroupIdsRequest {\n /** ID of the group to retrieve members group ids. */\n groupId?: string;\n }\n interface GetGroupMembersGroupIdsResponse {\n /** All members group id */\n allMembersGroupId?: string;\n /** Admins members group id */\n adminMembersGroupId?: string;\n }\n interface GetGroupBMFeaturesRequest {\n /** ID of the group to retrieve BM features. */\n groupId: string;\n }\n interface GetGroupBMFeaturesResponse {\n level?: number;\n features?: BMFeatures;\n }\n interface BMFeatures {\n bmFeatures?: BMFeaturesBMFeatures[];\n }\n enum BMFeaturesBMFeatures {\n BM_FEATURES_UNKNOWN = \"BM_FEATURES_UNKNOWN\",\n BM_FEATURES_GENERATE_TOPICS = \"BM_FEATURES_GENERATE_TOPICS\",\n BM_FEATURES_GENERATE_QUESTIONS = \"BM_FEATURES_GENERATE_QUESTIONS\"\n }\n interface QueryJoinedGroupsWithMemberRequest {\n /** Query options. */\n query?: Query$1;\n /** ID of the member to find common groups with */\n memberId?: string;\n /** Content type. */\n contentType?: ContentType;\n }\n interface QueryJoinedGroupsWithMemberResponse {\n /** Retrieved groups. */\n groups?: Group[];\n /** Paging metadata. */\n metadata?: PagingMetadata$1;\n }\n interface GetPrivacyRequest {\n /** Group ids to list privacy for */\n groupIds?: string[];\n }\n interface GetPrivacyResponse {\n /** Privacy statuses listed per group id */\n privacyStatuses?: Record;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a group.\n *\n * When a group is created, the newly created group is added to the [Groups List](https://support.wix.com/en/article/wix-groups-about-your-groups-pages#groups-group-list) page\n * of a site.\n *\n * Specify a `creatorId` to set the group's creator. The group's creator will automatically become a group admin, see Terminology ([REST](https://dev.wix.com/docs/rest/crm/community/groups/terminology) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/groups/terminology)).\n *\n * Wix users determine who can create a group.\n * This setting can be found in [a site's Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fwix-groups/settings?) under **Groups > General Settings > Group Creation**.\n * If set to **members with approval**, site members can create a group with the Create Group method, and the group becomes a `createRequest` with a status of `PENDING`.\n * A Wix user either approves or rejects the request to create a group.\n * If set to **all site members**, site members can create a group with the Create Group method and no approval is required.\n * If set to **only admins**, only Wix users can create a group with the Create Group method.\n * Default is set to **members with approval**.\n * @param group - Group to create.\n * @public\n * @requiredField group\n * @param options - Optional fields for group creation.\n * @adminMethod\n * @returns Created group.\n * @fqn wix.social.groups.api.v2.GroupsService.CreateGroup\n */\n function createGroup(group: Group, options?: CreateGroupOptions): Promise;\n interface CreateGroupOptions {\n /** ID of the member who created the group, from the Members API. This member will automatically become an admin. */\n creatorId?: string | null;\n /** Content type. */\n contentType?: ContentType;\n }\n /**\n * Updates a group.\n *\n * When a public or private group's name is updated, the slug is updated to reflect the new group name.\n * Only group admins can update their group.\n *\n * > **Notes:**\n * > + When `group.privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending group join requests are automatically approved.\n * > + When `group.privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending group join requests are automatically rejected.\n * @param _id - Group ID.\n * @public\n * @requiredField _id\n * @requiredField group\n * @adminMethod\n * @returns Updated group.\n * @fqn wix.social.groups.api.v2.GroupsService.UpdateGroup\n */\n function updateGroup(_id: string | null, group: UpdateGroup, options?: UpdateGroupOptions): Promise;\n interface UpdateGroup {\n /**\n * Group ID.\n * @readonly\n */\n _id?: string | null;\n /** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */\n slug?: string | null;\n /** Group privacy status. */\n privacyStatus?: PrivacyStatus;\n /** Group name. */\n name?: string | null;\n /** Group description in [DraftJS](https://draftjs.org) format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */\n memberTitle?: string | null;\n /** Cover image. You cannot upload your own cover image. */\n coverImage?: CoverImage;\n /**\n * Group specific settings.\n *\n * These settings can also be found in [a site's Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fwix-groups/settings?).\n */\n settings?: GroupSettings;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * Group owner.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Group creation date and time.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time of the latest group update.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Date and time of the most recent group activity, for example a post or comment.\n * @readonly\n */\n lastActivityDate?: Date | null;\n }\n interface UpdateGroupOptions {\n /** Content type. */\n contentType?: ContentType;\n }\n /**\n * Hides a group from the [Groups List](https://support.wix.com/en/article/wix-groups-about-your-groups-pages#groups-group-list) or cancels a group request.\n *\n * >**Notes:**\n * > + Only group admins can delete their group.\n * > + The group will no longer be visible in the live site or the dashboard.\n * > + It is not possible to restore a deleted group with the Update Group method.\n * > + It is still possible to retrieve the group with the Get Group, List Groups, and Query Groups methods.\n * @param groupId - ID of the group to delete.\n * @public\n * @requiredField groupId\n * @adminMethod\n * @fqn wix.social.groups.api.v2.GroupsService.DeleteGroup\n */\n function deleteGroup(groupId: string): Promise;\n /**\n * Retrieves a group.\n *\n * For groups with `group.privacyStatus` set to `SECRET`, only group admins and group members can see the group and its content.\n * @param groupId - ID of the group to retrieve.\n * @public\n * @requiredField groupId\n * @adminMethod\n * @returns Retrieved group.\n * @fqn wix.social.groups.api.v2.GroupsService.GetGroup\n */\n function getGroup(groupId: string, options?: GetGroupOptions): Promise;\n interface GetGroupOptions {\n /** Content type. */\n contentType?: ContentType;\n }\n /**\n * Retrieves a group by slug.\n *\n * The slug is the end of a group's URL that refers to a specific group.\n * For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`.\n * Slugs are case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters,\n * for example, `https:/example.com/groups/{5D3yTX}`.\n *\n * For groups with `group.privacyStatus` set to `SECRET`, only group admins and group members can see the group and its content.\n * @param slug - Unique part of the group's URL. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. Case-sensitive.\n * @public\n * @requiredField slug\n * @adminMethod\n * @fqn wix.social.groups.api.v2.GroupsService.GetGroupBySlug\n */\n function getGroupBySlug(slug: string, options?: GetGroupBySlugOptions): Promise;\n interface GetGroupBySlugOptions {\n autoInviteId?: string | null;\n /** Content type. */\n contentType?: ContentType;\n }\n interface GetGroupIdBySlugOptions {\n autoInviteId?: string | null;\n }\n /**\n * Retrieves up to 100 groups.\n *\n *\n * Default sorts by `_createdDate` in descending order. For `SECRET` groups, only group admins and group members can see a list of groups and their content.\n *\n * > **Note:** This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify limit only, call `listGroups(paging, null)`.\n * @public\n * @param options - Limit and offset options.\n * @adminMethod\n * @fqn wix.social.groups.api.v2.GroupsService.ListGroups\n */\n function listGroups(options?: ListGroupsOptions): Promise;\n interface ListGroupsOptions {\n /** Number of items to load. Maximum `100`. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n /** Content type. */\n contentType?: ContentType;\n }\n interface ListGroupsByUserIdOptions {\n /** Content type. */\n contentType?: ContentType;\n }\n /**\n * Retrieves up to 100 groups, given the provided paging, filtering, and sorting.\n *\n * Supported fields for filtering:\n * - `title`\n *\n * Supported fields for sorting:\n * - `title`\n * - `createdDate`\n * - `membersCount`\n * - `recentActivityDate`\n *\n * For groups with `group.privacyStatus` set to `SECRET`, only group admins and group members can see the group and its content.\n * @public\n * @adminMethod\n * @fqn wix.social.groups.api.v2.GroupsService.QueryGroups\n */\n function queryGroups(options?: QueryGroupsOptions): GroupsQueryBuilder;\n interface QueryGroupsOptions {\n /** Content type. */\n contentType?: ContentType | undefined;\n }\n interface QueryOffsetResult$1 {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface GroupsQueryResult extends QueryOffsetResult$1 {\n items: Group[];\n query: GroupsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface GroupsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: string, value: any) => GroupsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: string, value: any) => GroupsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: string, value: string) => GroupsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: string, value: any[]) => GroupsQueryBuilder;\n in: (propertyName: string, value: any) => GroupsQueryBuilder;\n exists: (propertyName: string, value: boolean) => GroupsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"membersCount\" | \"_createdDate\">) => GroupsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"membersCount\" | \"_createdDate\">) => GroupsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => GroupsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => GroupsQueryBuilder;\n find: () => Promise;\n }\n interface QueryJoinedGroupsOptions {\n /** Query options. */\n query?: Query$1;\n /** Content type. */\n contentType?: ContentType;\n }\n interface QueryGroupsByMembershipOptions {\n /** Query options. */\n query?: Query$1;\n membershipStatus?: MembershipStatus;\n /** Filter groups by permissions. */\n permissionsFilter?: GroupPermissions;\n /** Content type. */\n contentType?: ContentType;\n }\n interface ListGroupIntegrationsDataOptions {\n groupIds?: string[];\n }\n interface QueryJoinedGroupsWithMemberOptions {\n /** Query options. */\n query?: Query$1;\n /** ID of the member to find common groups with */\n memberId?: string;\n /** Content type. */\n contentType?: ContentType;\n }\n type socialGroupsV2GroupGroups_universal_d_Group = Group;\n type socialGroupsV2GroupGroups_universal_d_Type = Type;\n const socialGroupsV2GroupGroups_universal_d_Type: typeof Type;\n type socialGroupsV2GroupGroups_universal_d_Events = Events;\n type socialGroupsV2GroupGroups_universal_d_Logo = Logo;\n type socialGroupsV2GroupGroups_universal_d_GroupDetailsPosition = GroupDetailsPosition;\n type socialGroupsV2GroupGroups_universal_d_Image = Image;\n type socialGroupsV2GroupGroups_universal_d_Position = Position;\n type socialGroupsV2GroupGroups_universal_d_AllowPolicy = AllowPolicy;\n const socialGroupsV2GroupGroups_universal_d_AllowPolicy: typeof AllowPolicy;\n type socialGroupsV2GroupGroups_universal_d_OnboardingStepSettings = OnboardingStepSettings;\n type socialGroupsV2GroupGroups_universal_d_StepKey = StepKey;\n const socialGroupsV2GroupGroups_universal_d_StepKey: typeof StepKey;\n type socialGroupsV2GroupGroups_universal_d_PrivacyStatus = PrivacyStatus;\n const socialGroupsV2GroupGroups_universal_d_PrivacyStatus: typeof PrivacyStatus;\n type socialGroupsV2GroupGroups_universal_d_AccessRestriction = AccessRestriction;\n type socialGroupsV2GroupGroups_universal_d_AccessRestrictionDataOneOf = AccessRestrictionDataOneOf;\n type socialGroupsV2GroupGroups_universal_d_GroupDetails = GroupDetails;\n type socialGroupsV2GroupGroups_universal_d_CoverImage = CoverImage;\n type socialGroupsV2GroupGroups_universal_d_GroupSettings = GroupSettings;\n type socialGroupsV2GroupGroups_universal_d_Identity = Identity;\n type socialGroupsV2GroupGroups_universal_d_IdentityType = IdentityType;\n const socialGroupsV2GroupGroups_universal_d_IdentityType: typeof IdentityType;\n type socialGroupsV2GroupGroups_universal_d_CreateGroupRequest = CreateGroupRequest;\n type socialGroupsV2GroupGroups_universal_d_ContentType = ContentType;\n const socialGroupsV2GroupGroups_universal_d_ContentType: typeof ContentType;\n type socialGroupsV2GroupGroups_universal_d_CreateGroupResponse = CreateGroupResponse;\n type socialGroupsV2GroupGroups_universal_d_UpdateGroupRequest = UpdateGroupRequest;\n type socialGroupsV2GroupGroups_universal_d_UpdateGroupResponse = UpdateGroupResponse;\n type socialGroupsV2GroupGroups_universal_d_GroupCoverChanged = GroupCoverChanged;\n type socialGroupsV2GroupGroups_universal_d_GroupDescriptionChanged = GroupDescriptionChanged;\n type socialGroupsV2GroupGroups_universal_d_DeleteGroupRequest = DeleteGroupRequest;\n type socialGroupsV2GroupGroups_universal_d_DeleteGroupResponse = DeleteGroupResponse;\n type socialGroupsV2GroupGroups_universal_d_GetGroupRequest = GetGroupRequest;\n type socialGroupsV2GroupGroups_universal_d_GetGroupResponse = GetGroupResponse;\n type socialGroupsV2GroupGroups_universal_d_GetGroupBySlugRequest = GetGroupBySlugRequest;\n type socialGroupsV2GroupGroups_universal_d_GetGroupBySlugResponse = GetGroupBySlugResponse;\n type socialGroupsV2GroupGroups_universal_d_GetGroupIdBySlugRequest = GetGroupIdBySlugRequest;\n type socialGroupsV2GroupGroups_universal_d_GetGroupIdBySlugResponse = GetGroupIdBySlugResponse;\n type socialGroupsV2GroupGroups_universal_d_GlobalFeedPermissions = GlobalFeedPermissions;\n type socialGroupsV2GroupGroups_universal_d_FeedPermissions = FeedPermissions;\n type socialGroupsV2GroupGroups_universal_d_FeedItemPermissions = FeedItemPermissions;\n type socialGroupsV2GroupGroups_universal_d_ListGroupsRequest = ListGroupsRequest;\n type socialGroupsV2GroupGroups_universal_d_ListGroupsResponse = ListGroupsResponse;\n type socialGroupsV2GroupGroups_universal_d_ListGroupsByUserIdRequest = ListGroupsByUserIdRequest;\n type socialGroupsV2GroupGroups_universal_d_ListGroupsByUserIdResponse = ListGroupsByUserIdResponse;\n type socialGroupsV2GroupGroups_universal_d_GroupWithMsId = GroupWithMsId;\n type socialGroupsV2GroupGroups_universal_d_QueryGroupsRequest = QueryGroupsRequest;\n type socialGroupsV2GroupGroups_universal_d_QueryGroupsResponse = QueryGroupsResponse;\n type socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsRequest = QueryJoinedGroupsRequest;\n type socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsResponse = QueryJoinedGroupsResponse;\n type socialGroupsV2GroupGroups_universal_d_QueryGroupsByMembershipRequest = QueryGroupsByMembershipRequest;\n type socialGroupsV2GroupGroups_universal_d_MembershipStatus = MembershipStatus;\n const socialGroupsV2GroupGroups_universal_d_MembershipStatus: typeof MembershipStatus;\n type socialGroupsV2GroupGroups_universal_d_GroupPermissions = GroupPermissions;\n type socialGroupsV2GroupGroups_universal_d_QueryGroupsByMembershipResponse = QueryGroupsByMembershipResponse;\n type socialGroupsV2GroupGroups_universal_d_ListGroupIntegrationsDataRequest = ListGroupIntegrationsDataRequest;\n type socialGroupsV2GroupGroups_universal_d_ListGroupIntegrationsDataResponse = ListGroupIntegrationsDataResponse;\n type socialGroupsV2GroupGroups_universal_d_GroupIntegrationsData = GroupIntegrationsData;\n type socialGroupsV2GroupGroups_universal_d_GetGroupMembersGroupIdsRequest = GetGroupMembersGroupIdsRequest;\n type socialGroupsV2GroupGroups_universal_d_GetGroupMembersGroupIdsResponse = GetGroupMembersGroupIdsResponse;\n type socialGroupsV2GroupGroups_universal_d_GetGroupBMFeaturesRequest = GetGroupBMFeaturesRequest;\n type socialGroupsV2GroupGroups_universal_d_GetGroupBMFeaturesResponse = GetGroupBMFeaturesResponse;\n type socialGroupsV2GroupGroups_universal_d_BMFeatures = BMFeatures;\n type socialGroupsV2GroupGroups_universal_d_BMFeaturesBMFeatures = BMFeaturesBMFeatures;\n const socialGroupsV2GroupGroups_universal_d_BMFeaturesBMFeatures: typeof BMFeaturesBMFeatures;\n type socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsWithMemberRequest = QueryJoinedGroupsWithMemberRequest;\n type socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsWithMemberResponse = QueryJoinedGroupsWithMemberResponse;\n type socialGroupsV2GroupGroups_universal_d_GetPrivacyRequest = GetPrivacyRequest;\n type socialGroupsV2GroupGroups_universal_d_GetPrivacyResponse = GetPrivacyResponse;\n const socialGroupsV2GroupGroups_universal_d_createGroup: typeof createGroup;\n type socialGroupsV2GroupGroups_universal_d_CreateGroupOptions = CreateGroupOptions;\n const socialGroupsV2GroupGroups_universal_d_updateGroup: typeof updateGroup;\n type socialGroupsV2GroupGroups_universal_d_UpdateGroup = UpdateGroup;\n type socialGroupsV2GroupGroups_universal_d_UpdateGroupOptions = UpdateGroupOptions;\n const socialGroupsV2GroupGroups_universal_d_deleteGroup: typeof deleteGroup;\n const socialGroupsV2GroupGroups_universal_d_getGroup: typeof getGroup;\n type socialGroupsV2GroupGroups_universal_d_GetGroupOptions = GetGroupOptions;\n const socialGroupsV2GroupGroups_universal_d_getGroupBySlug: typeof getGroupBySlug;\n type socialGroupsV2GroupGroups_universal_d_GetGroupBySlugOptions = GetGroupBySlugOptions;\n type socialGroupsV2GroupGroups_universal_d_GetGroupIdBySlugOptions = GetGroupIdBySlugOptions;\n const socialGroupsV2GroupGroups_universal_d_listGroups: typeof listGroups;\n type socialGroupsV2GroupGroups_universal_d_ListGroupsOptions = ListGroupsOptions;\n type socialGroupsV2GroupGroups_universal_d_ListGroupsByUserIdOptions = ListGroupsByUserIdOptions;\n const socialGroupsV2GroupGroups_universal_d_queryGroups: typeof queryGroups;\n type socialGroupsV2GroupGroups_universal_d_QueryGroupsOptions = QueryGroupsOptions;\n type socialGroupsV2GroupGroups_universal_d_GroupsQueryResult = GroupsQueryResult;\n type socialGroupsV2GroupGroups_universal_d_GroupsQueryBuilder = GroupsQueryBuilder;\n type socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsOptions = QueryJoinedGroupsOptions;\n type socialGroupsV2GroupGroups_universal_d_QueryGroupsByMembershipOptions = QueryGroupsByMembershipOptions;\n type socialGroupsV2GroupGroups_universal_d_ListGroupIntegrationsDataOptions = ListGroupIntegrationsDataOptions;\n type socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsWithMemberOptions = QueryJoinedGroupsWithMemberOptions;\n namespace socialGroupsV2GroupGroups_universal_d {\n export { socialGroupsV2GroupGroups_universal_d_Group as Group, socialGroupsV2GroupGroups_universal_d_Type as Type, socialGroupsV2GroupGroups_universal_d_Events as Events, socialGroupsV2GroupGroups_universal_d_Logo as Logo, socialGroupsV2GroupGroups_universal_d_GroupDetailsPosition as GroupDetailsPosition, socialGroupsV2GroupGroups_universal_d_Image as Image, socialGroupsV2GroupGroups_universal_d_Position as Position, socialGroupsV2GroupGroups_universal_d_AllowPolicy as AllowPolicy, socialGroupsV2GroupGroups_universal_d_OnboardingStepSettings as OnboardingStepSettings, socialGroupsV2GroupGroups_universal_d_StepKey as StepKey, socialGroupsV2GroupGroups_universal_d_PrivacyStatus as PrivacyStatus, socialGroupsV2GroupGroups_universal_d_AccessRestriction as AccessRestriction, socialGroupsV2GroupGroups_universal_d_AccessRestrictionDataOneOf as AccessRestrictionDataOneOf, socialGroupsV2GroupGroups_universal_d_GroupDetails as GroupDetails, socialGroupsV2GroupGroups_universal_d_CoverImage as CoverImage, socialGroupsV2GroupGroups_universal_d_GroupSettings as GroupSettings, socialGroupsV2GroupGroups_universal_d_Identity as Identity, socialGroupsV2GroupGroups_universal_d_IdentityType as IdentityType, socialGroupsV2GroupGroups_universal_d_CreateGroupRequest as CreateGroupRequest, socialGroupsV2GroupGroups_universal_d_ContentType as ContentType, socialGroupsV2GroupGroups_universal_d_CreateGroupResponse as CreateGroupResponse, socialGroupsV2GroupGroups_universal_d_UpdateGroupRequest as UpdateGroupRequest, socialGroupsV2GroupGroups_universal_d_UpdateGroupResponse as UpdateGroupResponse, socialGroupsV2GroupGroups_universal_d_GroupCoverChanged as GroupCoverChanged, socialGroupsV2GroupGroups_universal_d_GroupDescriptionChanged as GroupDescriptionChanged, socialGroupsV2GroupGroups_universal_d_DeleteGroupRequest as DeleteGroupRequest, socialGroupsV2GroupGroups_universal_d_DeleteGroupResponse as DeleteGroupResponse, socialGroupsV2GroupGroups_universal_d_GetGroupRequest as GetGroupRequest, socialGroupsV2GroupGroups_universal_d_GetGroupResponse as GetGroupResponse, socialGroupsV2GroupGroups_universal_d_GetGroupBySlugRequest as GetGroupBySlugRequest, socialGroupsV2GroupGroups_universal_d_GetGroupBySlugResponse as GetGroupBySlugResponse, socialGroupsV2GroupGroups_universal_d_GetGroupIdBySlugRequest as GetGroupIdBySlugRequest, socialGroupsV2GroupGroups_universal_d_GetGroupIdBySlugResponse as GetGroupIdBySlugResponse, socialGroupsV2GroupGroups_universal_d_GlobalFeedPermissions as GlobalFeedPermissions, socialGroupsV2GroupGroups_universal_d_FeedPermissions as FeedPermissions, socialGroupsV2GroupGroups_universal_d_FeedItemPermissions as FeedItemPermissions, socialGroupsV2GroupGroups_universal_d_ListGroupsRequest as ListGroupsRequest, socialGroupsV2GroupGroups_universal_d_ListGroupsResponse as ListGroupsResponse, PagingMetadata$1 as PagingMetadata, socialGroupsV2GroupGroups_universal_d_ListGroupsByUserIdRequest as ListGroupsByUserIdRequest, socialGroupsV2GroupGroups_universal_d_ListGroupsByUserIdResponse as ListGroupsByUserIdResponse, socialGroupsV2GroupGroups_universal_d_GroupWithMsId as GroupWithMsId, socialGroupsV2GroupGroups_universal_d_QueryGroupsRequest as QueryGroupsRequest, Query$1 as Query, Sorting$1 as Sorting, SortOrder$1 as SortOrder, Paging$1 as Paging, socialGroupsV2GroupGroups_universal_d_QueryGroupsResponse as QueryGroupsResponse, socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsRequest as QueryJoinedGroupsRequest, socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsResponse as QueryJoinedGroupsResponse, socialGroupsV2GroupGroups_universal_d_QueryGroupsByMembershipRequest as QueryGroupsByMembershipRequest, socialGroupsV2GroupGroups_universal_d_MembershipStatus as MembershipStatus, socialGroupsV2GroupGroups_universal_d_GroupPermissions as GroupPermissions, socialGroupsV2GroupGroups_universal_d_QueryGroupsByMembershipResponse as QueryGroupsByMembershipResponse, socialGroupsV2GroupGroups_universal_d_ListGroupIntegrationsDataRequest as ListGroupIntegrationsDataRequest, socialGroupsV2GroupGroups_universal_d_ListGroupIntegrationsDataResponse as ListGroupIntegrationsDataResponse, socialGroupsV2GroupGroups_universal_d_GroupIntegrationsData as GroupIntegrationsData, socialGroupsV2GroupGroups_universal_d_GetGroupMembersGroupIdsRequest as GetGroupMembersGroupIdsRequest, socialGroupsV2GroupGroups_universal_d_GetGroupMembersGroupIdsResponse as GetGroupMembersGroupIdsResponse, socialGroupsV2GroupGroups_universal_d_GetGroupBMFeaturesRequest as GetGroupBMFeaturesRequest, socialGroupsV2GroupGroups_universal_d_GetGroupBMFeaturesResponse as GetGroupBMFeaturesResponse, socialGroupsV2GroupGroups_universal_d_BMFeatures as BMFeatures, socialGroupsV2GroupGroups_universal_d_BMFeaturesBMFeatures as BMFeaturesBMFeatures, socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsWithMemberRequest as QueryJoinedGroupsWithMemberRequest, socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsWithMemberResponse as QueryJoinedGroupsWithMemberResponse, socialGroupsV2GroupGroups_universal_d_GetPrivacyRequest as GetPrivacyRequest, socialGroupsV2GroupGroups_universal_d_GetPrivacyResponse as GetPrivacyResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, socialGroupsV2GroupGroups_universal_d_createGroup as createGroup, socialGroupsV2GroupGroups_universal_d_CreateGroupOptions as CreateGroupOptions, socialGroupsV2GroupGroups_universal_d_updateGroup as updateGroup, socialGroupsV2GroupGroups_universal_d_UpdateGroup as UpdateGroup, socialGroupsV2GroupGroups_universal_d_UpdateGroupOptions as UpdateGroupOptions, socialGroupsV2GroupGroups_universal_d_deleteGroup as deleteGroup, socialGroupsV2GroupGroups_universal_d_getGroup as getGroup, socialGroupsV2GroupGroups_universal_d_GetGroupOptions as GetGroupOptions, socialGroupsV2GroupGroups_universal_d_getGroupBySlug as getGroupBySlug, socialGroupsV2GroupGroups_universal_d_GetGroupBySlugOptions as GetGroupBySlugOptions, socialGroupsV2GroupGroups_universal_d_GetGroupIdBySlugOptions as GetGroupIdBySlugOptions, socialGroupsV2GroupGroups_universal_d_listGroups as listGroups, socialGroupsV2GroupGroups_universal_d_ListGroupsOptions as ListGroupsOptions, socialGroupsV2GroupGroups_universal_d_ListGroupsByUserIdOptions as ListGroupsByUserIdOptions, socialGroupsV2GroupGroups_universal_d_queryGroups as queryGroups, socialGroupsV2GroupGroups_universal_d_QueryGroupsOptions as QueryGroupsOptions, socialGroupsV2GroupGroups_universal_d_GroupsQueryResult as GroupsQueryResult, socialGroupsV2GroupGroups_universal_d_GroupsQueryBuilder as GroupsQueryBuilder, socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsOptions as QueryJoinedGroupsOptions, socialGroupsV2GroupGroups_universal_d_QueryGroupsByMembershipOptions as QueryGroupsByMembershipOptions, socialGroupsV2GroupGroups_universal_d_ListGroupIntegrationsDataOptions as ListGroupIntegrationsDataOptions, socialGroupsV2GroupGroups_universal_d_QueryJoinedGroupsWithMemberOptions as QueryJoinedGroupsWithMemberOptions, };\n }\n /**\n * To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.\n * When the request is approved, the site member becomes a group member.\n */\n interface JoinGroupRequest {\n /**\n * Site member ID of the requester.\n * @readonly\n */\n siteMemberId?: string;\n /** @readonly */\n contactId?: string;\n /**\n * Status of the request to join a group.\n *\n * One of:\n * - `\"PENDING\"`\n * - `\"APPROVED\"`\n * - `\"REJECTED\"`\n */\n status?: RequestStatus;\n /** Join group request details. */\n requestDetails?: RequestDetails;\n }\n enum RequestStatus {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Pending request. */\n PENDING = \"PENDING\",\n /** Approved request. */\n APPROVED = \"APPROVED\",\n /** Rejected request. */\n REJECTED = \"REJECTED\",\n /** Cancelled request. */\n CANCELLED = \"CANCELLED\",\n /** Canceled request. */\n CANCELED = \"CANCELED\"\n }\n interface RequestDetails {\n /** Reason the request to join a group was rejected. */\n rejectionReason?: string | null;\n }\n interface SocialGroupsEvent extends SocialGroupsEventPayloadOneOf {\n memberJoined?: MemberJoinedGroup;\n membersAdded?: MembersAddedToGroup;\n joinRequestsApproved?: JoinRequestsApproved;\n membersInvited?: MembersInvitedToGroup;\n }\n /** @oneof */\n interface SocialGroupsEventPayloadOneOf {\n memberJoined?: MemberJoinedGroup;\n membersAdded?: MembersAddedToGroup;\n joinRequestsApproved?: JoinRequestsApproved;\n membersInvited?: MembersInvitedToGroup;\n }\n interface MemberJoinedGroup {\n groupId?: string;\n groupsInstanceId?: string;\n siteMemberId?: string;\n }\n interface MembersAddedToGroup {\n groupId?: string;\n groupsInstanceId?: string;\n whoAddedId?: string | null;\n siteMemberIds?: string[];\n /** Used for Apes sticky experiment */\n operationId?: string;\n }\n interface JoinRequestsApproved {\n groupId?: string;\n groupsInstanceId?: string;\n siteMemberIds?: string[];\n /** Used for Apes sticky experiment */\n operationId?: string;\n }\n interface MembersInvitedToGroup {\n groupId?: string;\n groupsInstanceId?: string;\n siteMemberIds?: string[];\n }\n interface GetJoinRequirementsRequest {\n /** ID of the group requested to join. */\n groupId: string;\n /** Answers to membership questions. They can be empty, but submit join group request will fail if an answer to a required question is omitted. */\n membershipQuestionAnswers?: MembershipQuestionAnswer[];\n autoInviteId?: string | null;\n }\n /** Answer to a membership question. */\n interface MembershipQuestionAnswer {\n /** Question ID. */\n _id?: string;\n /** Answer text. */\n text?: string | null;\n }\n interface GetJoinRequirementsResponse {\n violation?: Violation;\n }\n interface PaidPlan {\n planId?: string;\n name?: string;\n startsAt?: Date;\n }\n enum ViolationType {\n NONE = \"NONE\",\n NOT_LOGGED_IN = \"NOT_LOGGED_IN\",\n ALREADY_JOINED = \"ALREADY_JOINED\",\n SECRET_GROUP = \"SECRET_GROUP\",\n EVENTS = \"EVENTS\",\n PRICING_PlANS = \"PRICING_PlANS\",\n MEMBERSHIP_QUESTIONS = \"MEMBERSHIP_QUESTIONS\",\n ADMIN_APPROVAL = \"ADMIN_APPROVAL\"\n }\n interface EventsViolationOptions {\n /** Events which allow user to join the group. */\n eventIds?: string[];\n }\n interface PricingPlanViolationOptions {\n installed?: boolean;\n /** Plan ids which allow user to join the group. */\n requiredPlans?: PaidPlan[];\n /** Plan ids which user have, but they don't allow to join group right now, because they start some time in the future. */\n futurePlans?: PaidPlan[];\n }\n interface MembershipQuestionViolationOptions {\n requiredQuestionIds?: string[];\n }\n interface Violation extends ViolationViolationOptionsOneOf {\n eventsOptions?: EventsViolationOptions;\n pricingPlansOptions?: PricingPlanViolationOptions;\n membershipQuestionsOptions?: MembershipQuestionViolationOptions;\n violationType?: ViolationType;\n }\n /** @oneof */\n interface ViolationViolationOptionsOneOf {\n eventsOptions?: EventsViolationOptions;\n pricingPlansOptions?: PricingPlanViolationOptions;\n membershipQuestionsOptions?: MembershipQuestionViolationOptions;\n }\n interface SubmitJoinGroupRequestRequest {\n /** ID of the group requested to join. */\n groupId: string;\n /** Answers to membership questions. They can be empty, but submit join group request will fail if an answer to a required question is omitted. */\n membershipQuestionAnswers?: MembershipQuestionAnswer[];\n }\n interface SubmitJoinGroupRequestResponse {\n /** Submitted join group request. */\n joinGroupRequest?: JoinGroupRequest;\n }\n interface CancelJoinGroupRequestRequest {\n /** ID of the group requested to join. */\n groupId: string;\n }\n interface CancelJoinGroupRequestResponse {\n /** Cancelled join group request. */\n joinGroupRequest?: JoinGroupRequest;\n }\n interface JoinGroupRequestCancelled {\n /** Group ID for which join request was cancelled. */\n groupId?: string;\n /** Cancelled join group request. */\n joinGroupRequest?: JoinGroupRequest;\n }\n interface ApproveJoinGroupRequestsRequest {\n /** ID of the group requested to join. */\n groupId: string;\n /**\n * @Internal\n * @Internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /** IDs of the site members to approve. */\n memberIds?: string[];\n }\n enum ItemsToUpdate {\n /** Take into account only items which are listed in request. */\n BY_ID = \"BY_ID\",\n /** Update all items. */\n ALL_ITEMS = \"ALL_ITEMS\"\n }\n interface ApproveJoinGroupRequestsResponse {\n /** Approved join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n }\n interface JoinGroupRequestApproved {\n /** Group ID for which join request was approved. */\n groupId?: string;\n /** Approved join group request. */\n joinGroupRequest?: JoinGroupRequest;\n }\n interface RejectJoinGroupRequestsRequest {\n /** ID of the group requested to join. */\n groupId: string;\n /** Rejection data. */\n rejections?: Rejection[];\n }\n interface Rejection {\n /** Member ID to reject. */\n memberId?: string;\n /** Reason the request to join a group was rejected. Text written by the request reviewer that is displayed when the group is rejected (max 1,000 characters). */\n reason?: string | null;\n }\n interface RejectJoinGroupRequestsResponse {\n /** Rejected join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n }\n interface JoinGroupRequestRejected {\n /** Group ID for which join request was rejected. */\n groupId?: string;\n /** Rejected join group request. */\n joinGroupRequest?: JoinGroupRequest;\n }\n interface ListJoinGroupRequestsRequest {\n /** ID of the group requested to join. */\n groupId: string;\n limit?: number | null;\n offset?: number | null;\n }\n enum OwnershipFilter {\n /** All items. */\n ALL = \"ALL\",\n /** Items for current site member. */\n CURRENT_MEMBER = \"CURRENT_MEMBER\"\n }\n interface ListJoinGroupRequestsResponse {\n /** Join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n metadata?: PagingMetadata;\n }\n interface PagingMetadata {\n /** Number of items in the current results page. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface QueryJoinGroupRequestsRequest {\n /** ID of the group requested to join. */\n groupId: string;\n query?: Query;\n }\n interface Query {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryJoinGroupRequestsResponse {\n /** Requests to join a group. */\n joinGroupRequests?: JoinGroupRequest[];\n metadata?: PagingMetadata;\n }\n interface RejectAllJoinGroupRequestsRequest {\n }\n interface RejectAllJoinGroupRequestsResponse {\n /** Rejected join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n }\n interface ApproveAllJoinGroupRequestsRequest {\n }\n interface ApproveAllJoinGroupRequestsResponse {\n /** Rejected join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n }\n interface ListAllJoinGroupRequestsRequest {\n query?: Query;\n }\n interface ListAllJoinGroupRequestsResponse {\n /** Join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n metadata?: PagingMetadata;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface GetJoinRequirementsOptions {\n /** Answers to membership questions. They can be empty, but submit join group request will fail if an answer to a required question is omitted. */\n membershipQuestionAnswers?: MembershipQuestionAnswer[];\n autoInviteId?: string | null;\n }\n interface SubmitJoinGroupRequestOptions {\n /** Answers to membership questions. They can be empty, but submit join group request will fail if an answer to a required question is omitted. */\n membershipQuestionAnswers?: MembershipQuestionAnswer[];\n }\n /**\n * Approves requests to join a group.\n *\n * > **Note:** This function is only relevant for private groups.\n *\n * The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.\n * Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.\n *\n * \n * @param memberIds - IDs of the site members to approve.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @param groupId - ID of the group requested to join.\n * @adminMethod\n */\n function approveJoinGroupRequests(groupId: string, memberIds: string[], options?: ApproveJoinGroupRequestsOptions): Promise;\n interface ApproveJoinGroupRequestsOptions {\n /**\n * @Internal\n * @Internal\n * @deprecated\n */\n siteMemberIds?: string[];\n }\n /**\n * Rejects requests to join a group.\n *\n * > **Note:** This function is only relevant for private groups.\n *\n * The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.\n * Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.\n *\n * \n *\n * @param rejections - Rejection data.\n * @public\n * @requiredField groupId\n * @requiredField rejections\n * @param groupId - ID of the group requested to join.\n * @adminMethod\n */\n function rejectJoinGroupRequests(groupId: string, rejections: Rejection[], options?: RejectJoinGroupRequestsOptions): Promise;\n interface RejectJoinGroupRequestsOptions {\n }\n /**\n * Lists requests to join a group.\n *\n * > **Note:** This function is only relevant for private groups.\n *\n * The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.\n * Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.\n *\n * > **Notes:**\n * \n * @public\n * @requiredField groupId\n * @param groupId - ID of the group requested to join.\n * @adminMethod\n */\n function listJoinGroupRequests(groupId: string, options?: ListJoinGroupRequestsOptions): Promise;\n interface ListJoinGroupRequestsOptions {\n limit?: number | null;\n offset?: number | null;\n }\n /**\n * Creates a query to retrieve a list of join requests.\n *\n * > **Notes:**\n * > + This function is only relevant for private groups.\n * > + For `SECRET` groups, only site admins and group admins can query requests to join their group. \n *\n * The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a `JoinGroupRequestsQueryBuilder` object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](/join-group-requests-query-builder/find) function.\n *\n * You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.\n *\n * The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.\n *\n * `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:\n * + [`limit(100)`](/join-group-requests-query-builder/limit)\n *\n * The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](/join-group-requests-query-result/items) property in `JoinGroupRequestsQueryResult`.\n *\n * @public\n * @requiredField groupId\n * @param groupId - Group ID.\n * @adminMethod\n */\n function queryJoinGroupRequests(groupId: string, options?: QueryJoinGroupRequestsOptions): JoinGroupRequestsQueryBuilder;\n interface QueryJoinGroupRequestsOptions {\n }\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface JoinGroupRequestsQueryResult extends QueryOffsetResult {\n items: JoinGroupRequest[];\n query: JoinGroupRequestsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface JoinGroupRequestsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"status\", value: any) => JoinGroupRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"status\", value: any) => JoinGroupRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: \"status\", value: any[]) => JoinGroupRequestsQueryBuilder;\n in: (propertyName: \"status\", value: any) => JoinGroupRequestsQueryBuilder;\n exists: (propertyName: \"status\", value: boolean) => JoinGroupRequestsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => JoinGroupRequestsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => JoinGroupRequestsQueryBuilder;\n find: () => Promise;\n }\n interface ListAllJoinGroupRequestsOptions {\n query?: Query;\n }\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequest = JoinGroupRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RequestStatus = RequestStatus;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RequestStatus: typeof RequestStatus;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RequestDetails = RequestDetails;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SocialGroupsEvent = SocialGroupsEvent;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SocialGroupsEventPayloadOneOf = SocialGroupsEventPayloadOneOf;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MemberJoinedGroup = MemberJoinedGroup;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembersAddedToGroup = MembersAddedToGroup;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinRequestsApproved = JoinRequestsApproved;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembersInvitedToGroup = MembersInvitedToGroup;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_GetJoinRequirementsRequest = GetJoinRequirementsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembershipQuestionAnswer = MembershipQuestionAnswer;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_GetJoinRequirementsResponse = GetJoinRequirementsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_PaidPlan = PaidPlan;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ViolationType = ViolationType;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ViolationType: typeof ViolationType;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EventsViolationOptions = EventsViolationOptions;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_PricingPlanViolationOptions = PricingPlanViolationOptions;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembershipQuestionViolationOptions = MembershipQuestionViolationOptions;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Violation = Violation;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ViolationViolationOptionsOneOf = ViolationViolationOptionsOneOf;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SubmitJoinGroupRequestRequest = SubmitJoinGroupRequestRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SubmitJoinGroupRequestResponse = SubmitJoinGroupRequestResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_CancelJoinGroupRequestRequest = CancelJoinGroupRequestRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_CancelJoinGroupRequestResponse = CancelJoinGroupRequestResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestCancelled = JoinGroupRequestCancelled;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveJoinGroupRequestsRequest = ApproveJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ItemsToUpdate = ItemsToUpdate;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ItemsToUpdate: typeof ItemsToUpdate;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveJoinGroupRequestsResponse = ApproveJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestApproved = JoinGroupRequestApproved;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectJoinGroupRequestsRequest = RejectJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Rejection = Rejection;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectJoinGroupRequestsResponse = RejectJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestRejected = JoinGroupRequestRejected;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListJoinGroupRequestsRequest = ListJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_OwnershipFilter = OwnershipFilter;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_OwnershipFilter: typeof OwnershipFilter;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListJoinGroupRequestsResponse = ListJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_PagingMetadata = PagingMetadata;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_QueryJoinGroupRequestsRequest = QueryJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Query = Query;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Sorting = Sorting;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SortOrder = SortOrder;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SortOrder: typeof SortOrder;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Paging = Paging;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_QueryJoinGroupRequestsResponse = QueryJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectAllJoinGroupRequestsRequest = RejectAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectAllJoinGroupRequestsResponse = RejectAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveAllJoinGroupRequestsRequest = ApproveAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveAllJoinGroupRequestsResponse = ApproveAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListAllJoinGroupRequestsRequest = ListAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListAllJoinGroupRequestsResponse = ListAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_DomainEvent = DomainEvent;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RestoreInfo = RestoreInfo;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ActionEvent = ActionEvent;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MessageEnvelope = MessageEnvelope;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_IdentificationData = IdentificationData;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_WebhookIdentityType = WebhookIdentityType;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_GetJoinRequirementsOptions = GetJoinRequirementsOptions;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SubmitJoinGroupRequestOptions = SubmitJoinGroupRequestOptions;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_approveJoinGroupRequests: typeof approveJoinGroupRequests;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveJoinGroupRequestsOptions = ApproveJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_rejectJoinGroupRequests: typeof rejectJoinGroupRequests;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectJoinGroupRequestsOptions = RejectJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_listJoinGroupRequests: typeof listJoinGroupRequests;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListJoinGroupRequestsOptions = ListJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_queryJoinGroupRequests: typeof queryJoinGroupRequests;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_QueryJoinGroupRequestsOptions = QueryJoinGroupRequestsOptions;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestsQueryResult = JoinGroupRequestsQueryResult;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestsQueryBuilder = JoinGroupRequestsQueryBuilder;\n type socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListAllJoinGroupRequestsOptions = ListAllJoinGroupRequestsOptions;\n namespace socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d {\n export { socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequest as JoinGroupRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RequestStatus as RequestStatus, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RequestDetails as RequestDetails, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SocialGroupsEvent as SocialGroupsEvent, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SocialGroupsEventPayloadOneOf as SocialGroupsEventPayloadOneOf, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MemberJoinedGroup as MemberJoinedGroup, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembersAddedToGroup as MembersAddedToGroup, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinRequestsApproved as JoinRequestsApproved, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembersInvitedToGroup as MembersInvitedToGroup, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_GetJoinRequirementsRequest as GetJoinRequirementsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembershipQuestionAnswer as MembershipQuestionAnswer, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_GetJoinRequirementsResponse as GetJoinRequirementsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_PaidPlan as PaidPlan, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ViolationType as ViolationType, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EventsViolationOptions as EventsViolationOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_PricingPlanViolationOptions as PricingPlanViolationOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MembershipQuestionViolationOptions as MembershipQuestionViolationOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Violation as Violation, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ViolationViolationOptionsOneOf as ViolationViolationOptionsOneOf, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SubmitJoinGroupRequestRequest as SubmitJoinGroupRequestRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SubmitJoinGroupRequestResponse as SubmitJoinGroupRequestResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_CancelJoinGroupRequestRequest as CancelJoinGroupRequestRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_CancelJoinGroupRequestResponse as CancelJoinGroupRequestResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestCancelled as JoinGroupRequestCancelled, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveJoinGroupRequestsRequest as ApproveJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ItemsToUpdate as ItemsToUpdate, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveJoinGroupRequestsResponse as ApproveJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestApproved as JoinGroupRequestApproved, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectJoinGroupRequestsRequest as RejectJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Rejection as Rejection, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectJoinGroupRequestsResponse as RejectJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestRejected as JoinGroupRequestRejected, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListJoinGroupRequestsRequest as ListJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_OwnershipFilter as OwnershipFilter, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListJoinGroupRequestsResponse as ListJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_PagingMetadata as PagingMetadata, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_QueryJoinGroupRequestsRequest as QueryJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Query as Query, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Sorting as Sorting, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SortOrder as SortOrder, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_Paging as Paging, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_QueryJoinGroupRequestsResponse as QueryJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectAllJoinGroupRequestsRequest as RejectAllJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectAllJoinGroupRequestsResponse as RejectAllJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveAllJoinGroupRequestsRequest as ApproveAllJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveAllJoinGroupRequestsResponse as ApproveAllJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListAllJoinGroupRequestsRequest as ListAllJoinGroupRequestsRequest, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListAllJoinGroupRequestsResponse as ListAllJoinGroupRequestsResponse, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_DomainEvent as DomainEvent, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EntityCreatedEvent as EntityCreatedEvent, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RestoreInfo as RestoreInfo, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_EntityDeletedEvent as EntityDeletedEvent, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ActionEvent as ActionEvent, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_MessageEnvelope as MessageEnvelope, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_IdentificationData as IdentificationData, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_WebhookIdentityType as WebhookIdentityType, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_GetJoinRequirementsOptions as GetJoinRequirementsOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_SubmitJoinGroupRequestOptions as SubmitJoinGroupRequestOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_approveJoinGroupRequests as approveJoinGroupRequests, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ApproveJoinGroupRequestsOptions as ApproveJoinGroupRequestsOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_rejectJoinGroupRequests as rejectJoinGroupRequests, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_RejectJoinGroupRequestsOptions as RejectJoinGroupRequestsOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_listJoinGroupRequests as listJoinGroupRequests, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListJoinGroupRequestsOptions as ListJoinGroupRequestsOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_queryJoinGroupRequests as queryJoinGroupRequests, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_QueryJoinGroupRequestsOptions as QueryJoinGroupRequestsOptions, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestsQueryResult as JoinGroupRequestsQueryResult, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_JoinGroupRequestsQueryBuilder as JoinGroupRequestsQueryBuilder, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d_ListAllJoinGroupRequestsOptions as ListAllJoinGroupRequestsOptions, };\n }\n export { socialGroupsV2GroupGroups_universal_d as groups, socialGroupsV2JoinGroupRequestJoinGroupRequests_universal_d as joinGroupRequests, socialGroupsV2GroupMemberMembers_universal_d as members, socialGroupsV2GroupRoleRoles_universal_d as roles };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-marketing.v2.d.ts", "content": "declare module \"wix-marketing.v2\" {\n /**\n * The `Coupon` object represents all information available for a coupon\n * including its basic definition and runtime information.\n */\n interface Coupon {\n /** Coupon ID. */\n _id?: string;\n /** Basic coupon info. */\n specification?: Specification;\n /** Time the coupon was created (UNIX Epoch time in milliseconds). */\n dateCreated?: string;\n /** Whether the coupon is expired. */\n expired?: boolean;\n /** How many times this coupon has been used. */\n numberOfUsages?: number;\n /** Coupon display information. */\n displayData?: DisplayData;\n /**\n * ID of the app that created the coupon. Empty if created by the site owner.\n * @readonly\n */\n appId?: string | null;\n }\n interface MediaItem {\n /** Media item URL. */\n url?: string;\n /** Media item width. */\n width?: number;\n /** Media item height. */\n height?: number;\n }\n /** Coupon information */\n interface Specification extends SpecificationScopeOrMinSubtotalOneOf, SpecificationBehaviorOneOf {\n /** Specifies the type of line items this coupon will apply to. See the [introduction](#introduction) for a table of currently supported coupon scopes. */\n scope?: Scope;\n /** The coupon is only applicable when the order subtotal is over this amount. */\n minimumSubtotal?: number | null;\n /** Discount as a fixed amount. */\n moneyOffAmount?: number;\n /** Discount as a percentage. */\n percentOffRate?: number;\n /**\n * Free shipping.\n *\n * If `true`, the coupon applies to all items in all `namespaces`.\n */\n freeShipping?: boolean;\n /** Fixed sale price. */\n fixedPriceAmount?: number;\n /**\n * Receive free products when making a purchase.\n *\n * For example, purchase `x` number of products and receive `y` number of products for free.\n */\n buyXGetY?: BuyXGetY;\n /** Name of coupon. */\n name?: string | null;\n /**\n * Coupon code. Must be unique for all coupons on your site.\n *\n * Max: 20 characters\n */\n code?: string | null;\n /** Coupon valid from this date and time. */\n startTime?: string | null;\n /** Coupon expires at this date and time. */\n expirationTime?: string | null;\n /**\n * Maximum number of times the coupon can be used.\n *\n * >**Note:** Multiple purchases by the same customer or purchases by different customers are both counted toward `usageLimit`.\n */\n usageLimit?: number | null;\n /** Maximum number of times the coupon can be used per customer. */\n limitPerCustomer?: number | null;\n /**\n * Whether the coupon is limited to one item.\n *\n * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.\n * Coupons with a `bookings` `scope.namespace` are always limited to one item.\n */\n limitedToOneItem?: boolean | null;\n /**\n * Whether the coupon applies to subscription products.\n *\n * If set to `true`, the discount will apply to all billing cycles.\n */\n appliesToSubscriptions?: boolean | null;\n /**\n * Specifies the amount of discounted cycles for a subscription item.\n *\n * + Can only be set when `scope.namespace = pricingPlans`.\n * + If `discountedCycleCount` is empty, the coupon applies to all available cycles.\n * + `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.\n *\n * Max: `999`\n */\n discountedCycleCount?: number | null;\n /**\n * Whether the coupon is currently [active](https://support.wix.com/en/article/wix-stores-activating-and-deactivating-coupons).\n *\n * Default: `true`\n */\n active?: boolean | null;\n /** Coupon type. Read-only. */\n type?: string;\n }\n /** @oneof */\n interface SpecificationScopeOrMinSubtotalOneOf {\n /** Specifies the type of line items this coupon will apply to. See the [introduction](#introduction) for a table of currently supported coupon scopes. */\n scope?: Scope;\n /** The coupon is only applicable when the order subtotal is over this amount. */\n minimumSubtotal?: number | null;\n }\n /** @oneof */\n interface SpecificationBehaviorOneOf {\n /** Discount as a fixed amount. */\n moneyOffAmount?: number;\n /** Discount as a percentage. */\n percentOffRate?: number;\n /**\n * Free shipping.\n *\n * If `true`, the coupon applies to all items in all `namespaces`.\n */\n freeShipping?: boolean;\n /** Fixed sale price. */\n fixedPriceAmount?: number;\n /**\n * Receive free products when making a purchase.\n *\n * For example, purchase `x` number of products and receive `y` number of products for free.\n */\n buyXGetY?: BuyXGetY;\n }\n interface Scope {\n /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */\n namespace?: string;\n /** Group within a `namespace` for which the coupon is applicable. If no group is specified, the coupon applies to all items in the namespace. `group` is required in some cases. See the table in the [introduction](#introduction) for a list of currently supported groups for each namespace. */\n group?: Group;\n }\n interface Group {\n /** Name of coupon scope's group (e.g., product or collection in Wix Stores). See the [introduction](#introduction) for a table of currently supported coupon scopes. */\n name?: string;\n /** ID of the specific item in the group for which the coupon is applicable. If no `entityId` is specified, the coupon applies to all items in the group. In some cases when a group is specified, an `entityId` is required. See the [introduction](#introduction) for a list of currently supported entities for each namespace and group. */\n entityId?: string | null;\n }\n /** Coupon type. */\n interface BuyXGetY {\n /** Number of purchased items required to receive free items. */\n x?: number;\n /** Number of items received for free if required number of items were purchased. */\n y?: number;\n }\n interface DisplayData {\n /** Coupon name to be displayed. */\n name?: string;\n /** Displayed media item information. */\n mediaItem?: MediaItem;\n /** Formatted price for display. */\n formattedPrice?: string | null;\n }\n interface CreateCouponRequest {\n /** Coupon to create. */\n specification?: Specification;\n }\n interface CreateCouponResponse {\n /** ID of the newly created coupon. */\n _id?: string;\n }\n interface UpdateCouponRequest {\n /** ID of the coupon to update. */\n _id: string;\n /** Coupon information to update. */\n specification?: Specification;\n }\n interface UpdateCouponResponse {\n }\n interface GetCouponRequest {\n /** ID of the coupon to retrieve. */\n _id: string;\n }\n interface GetCouponResponse {\n /** Retrieved coupon. */\n coupon?: Coupon;\n }\n interface DeleteCouponRequest {\n /** ID of the coupon to delete. */\n _id: string;\n }\n interface DeleteCouponResponse {\n }\n interface QueryCouponsRequest {\n query?: Query;\n }\n interface Query {\n /** Optional pagination parameters */\n paging?: Paging;\n /** Filter string (e.g., when {\"expired\":\"true\"}, expired coupons will be returned). */\n filter?: string | null;\n /** Sort string. */\n sort?: string | null;\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Offset since the beginning of the collection. */\n offset?: number | null;\n }\n interface QueryCouponsResponse {\n /** Returned coupons. */\n coupons?: Coupon[];\n /** Total results. */\n totalResults?: number | null;\n }\n interface CalculateRequest extends CalculateRequestCalculateByOneOf {\n /** For calculating by coupon ID (usually for cart calculate phase). */\n _id?: string;\n /** For calculating by coupon code (usually for apply coupon phase - for validation). */\n code: string;\n /** Type of in-memory discount that can be applied when coupon doesn't exist. */\n discount?: Specification;\n /** Cart to which the coupon will be applied. */\n cart?: Cart;\n /** Currency symbol for error message and applied coupon. */\n currencySymbol?: string;\n /** Round the result to places after the decimal dot. Defaults to 2 if not provided. */\n precision?: number | null;\n /** Unique identifier of a buyer that applied the coupon. Used to limit coupon use per customer. */\n uniqueUserIdentifier?: string | null;\n }\n /** @oneof */\n interface CalculateRequestCalculateByOneOf {\n /** For calculating by coupon ID (usually for cart calculate phase). */\n _id?: string;\n /** For calculating by coupon code (usually for apply coupon phase - for validation). */\n code?: string;\n /** Type of in-memory discount that can be applied when coupon doesn't exist. */\n discount?: Specification;\n }\n /**\n * Cart is passed to coupon service's apply function in order to\n * apply the coupons calculation on it\n */\n interface Cart {\n /** Array of cart line items. */\n lineItems?: LineItem[];\n /** Cart shipping information. */\n shipping?: Shipping;\n /** Summary of cart totals. */\n totals?: Totals;\n }\n interface AppliedDiscount {\n /** Discount amount, in case discount is applied per line. */\n discountAmount?: number;\n /** Line item price after applied discount. */\n afterDiscountAmount?: number;\n }\n /** represents a single line in the cart */\n interface LineItem {\n /** Cart line item ID - represents index position (required). */\n lineId?: string;\n /** Item ID in the external system - will usually be a product ID. */\n externalId?: string;\n /** Line item amount (while quantity = 1). */\n amount?: number;\n /** Line item quantity. Must be greater than 0. */\n quantity?: number;\n /** Coupon scopes this line item applies to. */\n scopes?: Scope[];\n /** Applied discount on line item after calculation. */\n appliedDiscount?: AppliedDiscount;\n /** Whether the line item is of type subscription. */\n subscription?: boolean;\n }\n /**\n * represents the shipping line in the cart\n * the coupons need to know about it because of the free shipping coupon\n */\n interface Shipping {\n /** Shipping price before applying the coupon. */\n amount?: number;\n /** Discount on shipping price. */\n appliedDiscount?: AppliedDiscount;\n }\n interface Totals {\n /** Cart subtotal. */\n subTotal?: number;\n /** Sum of all discounts. */\n discount?: number;\n total?: number;\n }\n interface CalculateResponse {\n /** Cart after applying the coupon. */\n cart?: Cart;\n /** Applied coupon information. */\n appliedCoupon?: AppliedCoupon;\n /** Errors, in case call failed. */\n error?: Error[];\n }\n interface AppliedCoupon {\n /** Name of the coupon applied. */\n name?: string;\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Whether the coupon type entitles free shipping. */\n isFreeShipping?: boolean;\n /** Coupon type (e.g., moneyOffAmount, buyXGetY, percentOffRate). */\n couponType?: string;\n /** Discount value (e.g., $10, 10%). */\n discountValue?: string;\n /** Amount of discounted cycles for subscription item. None specifies for all cycles. */\n discountedCycleCount?: number | null;\n }\n interface Error {\n /** error code */\n code?: string;\n /** descriptive error message */\n message?: string;\n }\n interface IncreaseUsageRequest {\n /** Coupon ID. */\n _id: string;\n /** Unique ID of the entity that the coupon was applied to (e.g., orderId). */\n usedBy?: string | null;\n /** Unique identifier of a buyer that applied the coupon. Used to limit coupon use per customer. */\n uniqueUserIdentifier?: string | null;\n /** ID of app that applied the coupon (e.g. bookings appDefId). */\n wixAppId?: string | null;\n }\n interface IncreaseUsageResponse {\n /** Errors, in case call failed. */\n error?: Error[];\n }\n interface CouponApplied {\n /** Applied coupon information. */\n coupon?: Coupon;\n /**\n * ID of Wix app that applied the coupon. Supported values:\n * + Wix Stores - `1380b703-ce81-ff05-f115-39571d94dfcd`\n * + Wix Bookings - `13d21c63-b5ec-5912-8397-c3a5ddb27a97`\n * + Wix Events - `140603ad-af8d-84a5-2c80-a0f60cb47351`\n */\n wixAppId?: string;\n /** ID of the entity that the coupon was applied to (orderId, bookingId, etc.). */\n wixAppOrderId?: string;\n }\n interface HasCouponsRequest {\n }\n interface HasCouponsResponse {\n /** True if site has ever had a coupon. */\n hasCoupons?: boolean;\n }\n interface BulkDeleteCouponsRequest {\n /** IDs of coupons to delete. */\n ids?: string[];\n }\n interface BulkDeleteCouponsResponse {\n /** Item metadata. */\n results?: ItemMetadata[];\n /** Bulk action metadata. */\n deleteMetadata?: BulkActionMetadata;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkCreateCouponsRequest {\n /** List of coupon specifications to be created. */\n specifications?: Specification[];\n /**\n * Whether to return full coupon entity in the response.\n *\n * Default: `false`\n */\n returnFullEntity?: boolean;\n }\n interface BulkCreateCouponsResponse {\n /** Items created by bulk action. */\n results?: BulkCreateCouponResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCreateCouponResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n /** New coupons. */\n coupon?: Coupon;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new coupon.\n *\n * The `createCoupon()` function returns a Promise that resolves to the new coupon when it is created.\n *\n * When creating a coupon, the `specification` object must contain values for `name`, `code`, `startTime`, and either `scope` or `minimumSubtotal`. The exception is for a `freeShipping` coupon type, for which you cannot apply a `scope` and `minimumSubtotal` is optional.\n *\n * The coupon `scope` defines the items a coupon applies to. A coupon can apply to all items in a specific Wix application, a group within the application, or a single item within a group. See the [introduction](#introduction) for a table of currently supported coupon scopes.\n *\n * The `specification` object must also contain a value for exactly 1 of the following coupon properties. This defines the coupon type.\n *\n * + `\"moneyOffAmount\"`\n * + `\"percentOffRate\"`\n * + `\"freeShipping\"`\n * + `\"fixedPriceAmount\"`\n * + `\"buyXGetY\"`\n * @param specification - Coupon to create.\n * @public\n * @requiredField specification\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function createCoupon(specification: Specification): Promise;\n /**\n * Updates a coupon.\n *\n * The `updateCoupon()` function returns a Promise that resolves when the coupon is updated.\n *\n * Only the properties passed in the `specification` object will be updated. All other properties will remain the same.\n *\n * To remove a value from the coupon, pass its corresponding property with a value of `null`.\n *\n * When updating a coupon, you cannot change the coupon's `type`. For example, if the coupon's `type` is `moneyOffAmount`, you cannot change it to `fixedPriceAmount`. You can update the coupon type's value. For example, you can change the value of `moneyOffAmount` from `5` to `10`.\n *\n * The coupon `scope` defines the items a coupon applies to. A coupon can apply to all items in a specific Wix application, a group within the application, or a single item within a group.\n * See the [introduction](#introduction) for a table of currently supported coupon scopes.\n * @param _id - ID of the coupon to update.\n * @param specification - Coupon information to update.\n * @param fieldMask - Field mask of fields to update (required - passing an empty `fieldMask` will return an error). Valid field masks are any of those in the `specification` field.\n * @public\n * @requiredField _id\n * @requiredField fieldMask\n * @requiredField specification\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateCoupon(_id: string, specification: Specification, fieldMask: string[]): Promise;\n /**\n * Retrieves a coupon by ID.\n *\n * The `getCoupon()` function returns a Promise that resolves when the specified coupon is retrieved.\n * @param _id - ID of the coupon to retrieve.\n * @public\n * @requiredField _id\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Retrieved coupon.\n */\n function getCoupon(_id: string): Promise;\n /**\n * Deletes a coupon.\n *\n * The `deleteCoupon()` function returns a Promise that resolves when the specified coupon is deleted.\n * @param _id - ID of the coupon to delete.\n * @public\n * @requiredField _id\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteCoupon(_id: string): Promise;\n /**\n * Retrieves a list of up to 100 coupons with pagination and filters.\n *\n * The `queryCoupons()` function returns a Promise that resolves when the coupons are retrieved.\n * @public\n * @requiredField query\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function queryCoupons(query: Query): Promise;\n interface CalculateCartOptions extends CalculateRequestCalculateByOneOf {\n /** For calculating by coupon ID (usually for cart calculate phase). */\n _id?: string;\n /** Type of in-memory discount that can be applied when coupon doesn't exist. */\n discount?: Specification;\n /** Cart to which the coupon will be applied. */\n cart?: Cart;\n /** Currency symbol for error message and applied coupon. */\n currencySymbol?: string;\n /** Round the result to places after the decimal dot. Defaults to 2 if not provided. */\n precision?: number | null;\n /** Unique identifier of a buyer that applied the coupon. Used to limit coupon use per customer. */\n uniqueUserIdentifier?: string | null;\n }\n interface IncreaseUsageOptions {\n /** Unique ID of the entity that the coupon was applied to (e.g., orderId). */\n usedBy?: string | null;\n /** Unique identifier of a buyer that applied the coupon. Used to limit coupon use per customer. */\n uniqueUserIdentifier?: string | null;\n /** ID of app that applied the coupon (e.g. bookings appDefId). */\n wixAppId?: string | null;\n }\n /**\n * Deletes the specified coupons.\n *\n * The `bulkDeleteCoupons()` function returns a Promise that resolves when the coupons are deleted.\n * @param ids - IDs of coupons to delete.\n * @public\n * @requiredField ids\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteCoupons(ids: string[]): Promise;\n /**\n * Creates multiple coupons.\n *\n * The `bulkCreateCoupons()` function returns a Promise that resolves when the coupons are created.\n * @param specifications - List of coupon specifications to be created.\n * @public\n * @requiredField specifications\n * @permissionScope Manage Coupons\n * @permissionScopeId SCOPE.DC-COUPONS.MANAGE-COUPONS\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateCoupons(specifications: Specification[], options?: BulkCreateCouponsOptions): Promise;\n interface BulkCreateCouponsOptions {\n /**\n * Whether to return full coupon entity in the response.\n *\n * Default: `false`\n */\n returnFullEntity?: boolean;\n }\n type ecommerceCouponsV2CouponCoupons_universal_d_Coupon = Coupon;\n type ecommerceCouponsV2CouponCoupons_universal_d_MediaItem = MediaItem;\n type ecommerceCouponsV2CouponCoupons_universal_d_Specification = Specification;\n type ecommerceCouponsV2CouponCoupons_universal_d_SpecificationScopeOrMinSubtotalOneOf = SpecificationScopeOrMinSubtotalOneOf;\n type ecommerceCouponsV2CouponCoupons_universal_d_SpecificationBehaviorOneOf = SpecificationBehaviorOneOf;\n type ecommerceCouponsV2CouponCoupons_universal_d_Scope = Scope;\n type ecommerceCouponsV2CouponCoupons_universal_d_Group = Group;\n type ecommerceCouponsV2CouponCoupons_universal_d_BuyXGetY = BuyXGetY;\n type ecommerceCouponsV2CouponCoupons_universal_d_DisplayData = DisplayData;\n type ecommerceCouponsV2CouponCoupons_universal_d_CreateCouponRequest = CreateCouponRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_CreateCouponResponse = CreateCouponResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_UpdateCouponRequest = UpdateCouponRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_UpdateCouponResponse = UpdateCouponResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_GetCouponRequest = GetCouponRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_GetCouponResponse = GetCouponResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_DeleteCouponRequest = DeleteCouponRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_DeleteCouponResponse = DeleteCouponResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_QueryCouponsRequest = QueryCouponsRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_Query = Query;\n type ecommerceCouponsV2CouponCoupons_universal_d_Paging = Paging;\n type ecommerceCouponsV2CouponCoupons_universal_d_QueryCouponsResponse = QueryCouponsResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_CalculateRequest = CalculateRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_CalculateRequestCalculateByOneOf = CalculateRequestCalculateByOneOf;\n type ecommerceCouponsV2CouponCoupons_universal_d_Cart = Cart;\n type ecommerceCouponsV2CouponCoupons_universal_d_AppliedDiscount = AppliedDiscount;\n type ecommerceCouponsV2CouponCoupons_universal_d_LineItem = LineItem;\n type ecommerceCouponsV2CouponCoupons_universal_d_Shipping = Shipping;\n type ecommerceCouponsV2CouponCoupons_universal_d_Totals = Totals;\n type ecommerceCouponsV2CouponCoupons_universal_d_CalculateResponse = CalculateResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_AppliedCoupon = AppliedCoupon;\n type ecommerceCouponsV2CouponCoupons_universal_d_Error = Error;\n type ecommerceCouponsV2CouponCoupons_universal_d_IncreaseUsageRequest = IncreaseUsageRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_IncreaseUsageResponse = IncreaseUsageResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_CouponApplied = CouponApplied;\n type ecommerceCouponsV2CouponCoupons_universal_d_HasCouponsRequest = HasCouponsRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_HasCouponsResponse = HasCouponsResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkDeleteCouponsRequest = BulkDeleteCouponsRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkDeleteCouponsResponse = BulkDeleteCouponsResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_ItemMetadata = ItemMetadata;\n type ecommerceCouponsV2CouponCoupons_universal_d_ApplicationError = ApplicationError;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkActionMetadata = BulkActionMetadata;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponsRequest = BulkCreateCouponsRequest;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponsResponse = BulkCreateCouponsResponse;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponResult = BulkCreateCouponResult;\n type ecommerceCouponsV2CouponCoupons_universal_d_DomainEvent = DomainEvent;\n type ecommerceCouponsV2CouponCoupons_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type ecommerceCouponsV2CouponCoupons_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type ecommerceCouponsV2CouponCoupons_universal_d_RestoreInfo = RestoreInfo;\n type ecommerceCouponsV2CouponCoupons_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type ecommerceCouponsV2CouponCoupons_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type ecommerceCouponsV2CouponCoupons_universal_d_ActionEvent = ActionEvent;\n type ecommerceCouponsV2CouponCoupons_universal_d_MessageEnvelope = MessageEnvelope;\n type ecommerceCouponsV2CouponCoupons_universal_d_IdentificationData = IdentificationData;\n type ecommerceCouponsV2CouponCoupons_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type ecommerceCouponsV2CouponCoupons_universal_d_WebhookIdentityType = WebhookIdentityType;\n const ecommerceCouponsV2CouponCoupons_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const ecommerceCouponsV2CouponCoupons_universal_d_createCoupon: typeof createCoupon;\n const ecommerceCouponsV2CouponCoupons_universal_d_updateCoupon: typeof updateCoupon;\n const ecommerceCouponsV2CouponCoupons_universal_d_getCoupon: typeof getCoupon;\n const ecommerceCouponsV2CouponCoupons_universal_d_deleteCoupon: typeof deleteCoupon;\n const ecommerceCouponsV2CouponCoupons_universal_d_queryCoupons: typeof queryCoupons;\n type ecommerceCouponsV2CouponCoupons_universal_d_CalculateCartOptions = CalculateCartOptions;\n type ecommerceCouponsV2CouponCoupons_universal_d_IncreaseUsageOptions = IncreaseUsageOptions;\n const ecommerceCouponsV2CouponCoupons_universal_d_bulkDeleteCoupons: typeof bulkDeleteCoupons;\n const ecommerceCouponsV2CouponCoupons_universal_d_bulkCreateCoupons: typeof bulkCreateCoupons;\n type ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponsOptions = BulkCreateCouponsOptions;\n namespace ecommerceCouponsV2CouponCoupons_universal_d {\n export { ecommerceCouponsV2CouponCoupons_universal_d_Coupon as Coupon, ecommerceCouponsV2CouponCoupons_universal_d_MediaItem as MediaItem, ecommerceCouponsV2CouponCoupons_universal_d_Specification as Specification, ecommerceCouponsV2CouponCoupons_universal_d_SpecificationScopeOrMinSubtotalOneOf as SpecificationScopeOrMinSubtotalOneOf, ecommerceCouponsV2CouponCoupons_universal_d_SpecificationBehaviorOneOf as SpecificationBehaviorOneOf, ecommerceCouponsV2CouponCoupons_universal_d_Scope as Scope, ecommerceCouponsV2CouponCoupons_universal_d_Group as Group, ecommerceCouponsV2CouponCoupons_universal_d_BuyXGetY as BuyXGetY, ecommerceCouponsV2CouponCoupons_universal_d_DisplayData as DisplayData, ecommerceCouponsV2CouponCoupons_universal_d_CreateCouponRequest as CreateCouponRequest, ecommerceCouponsV2CouponCoupons_universal_d_CreateCouponResponse as CreateCouponResponse, ecommerceCouponsV2CouponCoupons_universal_d_UpdateCouponRequest as UpdateCouponRequest, ecommerceCouponsV2CouponCoupons_universal_d_UpdateCouponResponse as UpdateCouponResponse, ecommerceCouponsV2CouponCoupons_universal_d_GetCouponRequest as GetCouponRequest, ecommerceCouponsV2CouponCoupons_universal_d_GetCouponResponse as GetCouponResponse, ecommerceCouponsV2CouponCoupons_universal_d_DeleteCouponRequest as DeleteCouponRequest, ecommerceCouponsV2CouponCoupons_universal_d_DeleteCouponResponse as DeleteCouponResponse, ecommerceCouponsV2CouponCoupons_universal_d_QueryCouponsRequest as QueryCouponsRequest, ecommerceCouponsV2CouponCoupons_universal_d_Query as Query, ecommerceCouponsV2CouponCoupons_universal_d_Paging as Paging, ecommerceCouponsV2CouponCoupons_universal_d_QueryCouponsResponse as QueryCouponsResponse, ecommerceCouponsV2CouponCoupons_universal_d_CalculateRequest as CalculateRequest, ecommerceCouponsV2CouponCoupons_universal_d_CalculateRequestCalculateByOneOf as CalculateRequestCalculateByOneOf, ecommerceCouponsV2CouponCoupons_universal_d_Cart as Cart, ecommerceCouponsV2CouponCoupons_universal_d_AppliedDiscount as AppliedDiscount, ecommerceCouponsV2CouponCoupons_universal_d_LineItem as LineItem, ecommerceCouponsV2CouponCoupons_universal_d_Shipping as Shipping, ecommerceCouponsV2CouponCoupons_universal_d_Totals as Totals, ecommerceCouponsV2CouponCoupons_universal_d_CalculateResponse as CalculateResponse, ecommerceCouponsV2CouponCoupons_universal_d_AppliedCoupon as AppliedCoupon, ecommerceCouponsV2CouponCoupons_universal_d_Error as Error, ecommerceCouponsV2CouponCoupons_universal_d_IncreaseUsageRequest as IncreaseUsageRequest, ecommerceCouponsV2CouponCoupons_universal_d_IncreaseUsageResponse as IncreaseUsageResponse, ecommerceCouponsV2CouponCoupons_universal_d_CouponApplied as CouponApplied, ecommerceCouponsV2CouponCoupons_universal_d_HasCouponsRequest as HasCouponsRequest, ecommerceCouponsV2CouponCoupons_universal_d_HasCouponsResponse as HasCouponsResponse, ecommerceCouponsV2CouponCoupons_universal_d_BulkDeleteCouponsRequest as BulkDeleteCouponsRequest, ecommerceCouponsV2CouponCoupons_universal_d_BulkDeleteCouponsResponse as BulkDeleteCouponsResponse, ecommerceCouponsV2CouponCoupons_universal_d_ItemMetadata as ItemMetadata, ecommerceCouponsV2CouponCoupons_universal_d_ApplicationError as ApplicationError, ecommerceCouponsV2CouponCoupons_universal_d_BulkActionMetadata as BulkActionMetadata, ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponsRequest as BulkCreateCouponsRequest, ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponsResponse as BulkCreateCouponsResponse, ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponResult as BulkCreateCouponResult, ecommerceCouponsV2CouponCoupons_universal_d_DomainEvent as DomainEvent, ecommerceCouponsV2CouponCoupons_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, ecommerceCouponsV2CouponCoupons_universal_d_EntityCreatedEvent as EntityCreatedEvent, ecommerceCouponsV2CouponCoupons_universal_d_RestoreInfo as RestoreInfo, ecommerceCouponsV2CouponCoupons_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, ecommerceCouponsV2CouponCoupons_universal_d_EntityDeletedEvent as EntityDeletedEvent, ecommerceCouponsV2CouponCoupons_universal_d_ActionEvent as ActionEvent, ecommerceCouponsV2CouponCoupons_universal_d_MessageEnvelope as MessageEnvelope, ecommerceCouponsV2CouponCoupons_universal_d_IdentificationData as IdentificationData, ecommerceCouponsV2CouponCoupons_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, ecommerceCouponsV2CouponCoupons_universal_d_WebhookIdentityType as WebhookIdentityType, ecommerceCouponsV2CouponCoupons_universal_d_createCoupon as createCoupon, ecommerceCouponsV2CouponCoupons_universal_d_updateCoupon as updateCoupon, ecommerceCouponsV2CouponCoupons_universal_d_getCoupon as getCoupon, ecommerceCouponsV2CouponCoupons_universal_d_deleteCoupon as deleteCoupon, ecommerceCouponsV2CouponCoupons_universal_d_queryCoupons as queryCoupons, ecommerceCouponsV2CouponCoupons_universal_d_CalculateCartOptions as CalculateCartOptions, ecommerceCouponsV2CouponCoupons_universal_d_IncreaseUsageOptions as IncreaseUsageOptions, ecommerceCouponsV2CouponCoupons_universal_d_bulkDeleteCoupons as bulkDeleteCoupons, ecommerceCouponsV2CouponCoupons_universal_d_bulkCreateCoupons as bulkCreateCoupons, ecommerceCouponsV2CouponCoupons_universal_d_BulkCreateCouponsOptions as BulkCreateCouponsOptions, };\n }\n export { ecommerceCouponsV2CouponCoupons_universal_d as coupons };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-ecom.v2.d.ts", "content": "declare module \"wix-ecom.v2\" {\n interface CurrencyRate {\n }\n interface ListCurrenciesRequest {\n }\n interface ListCurrenciesResponse {\n /** Supported currencies. */\n currencies?: Currency[];\n }\n interface Currency {\n /** A 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. */\n code?: string;\n /** Currency symbol. */\n symbol?: string;\n }\n interface ConvertCurrencyRequest {\n /** Amounts to convert. */\n amounts?: DecimalValue[];\n /** Original currency to convert from as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `from` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n from: string;\n /** Target currency to convert to as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `to` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n to: string;\n }\n interface DecimalValue {\n /** The value without decimal points. For example, the number `10.95` becomes `1095`. */\n value?: string;\n /** Decimal places to apply. For example, the number of decimal places for `10.95` is `2`. */\n decimalPlaces?: number;\n }\n interface ConvertCurrencyResponse {\n /** Converted amounts. */\n amounts?: DecimalValue[];\n /** Date and time the conversion rate was last updated. */\n rateTimestamp?: Date;\n }\n interface ConversionRateRequest {\n /** Original currency to get the rate for as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `from` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n from: string;\n /** Target currency to get the rate for as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `to` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n to: string;\n }\n interface ConversionRateResponse {\n /** Conversion rate between 2 currencies. */\n rate?: DecimalValue;\n /** Date and time the conversion rate was last updated. */\n rateTimestamp?: Date;\n }\n /**\n * Returns an array of currencies. The array lists all currencies for which Wix supports conversion and their symbols.\n * @public\n * @permissionScope Manage Currencies\n * @permissionScopeId SCOPE.DC-CURRENCY-CONVERTER.MANAGE-CURRENCIES\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function listCurrencies(): Promise;\n /**\n * Returns an array of amounts converted from the original (`from`) currency to the target (`to`) currency and the timestamp for the conversion rate used.\n *\n *\n * Use the `convertCurrency()` function to convert an array of one or more amounts between two currencies. The `convertCurrency()` function returns an array of converted amounts and the timestamp for the conversion rate used.\n *\n * > **Note**: The currency codes used must exist in the array of supported currencies returned by the [`listCurrencies()`](#listcurrencies) function.\n *\n * @param amounts - Amounts to convert.\n * @public\n * @requiredField amounts\n * @requiredField identifiers\n * @requiredField identifiers.from\n * @requiredField identifiers.to\n * @param identifiers - Identifying details needed to determine which currency rate to convert. The combination of the `from` and `to` properties together comprise the unique ID.\n * @param options - Options to use when converting currency.\n * @permissionScope Manage Currencies\n * @permissionScopeId SCOPE.DC-CURRENCY-CONVERTER.MANAGE-CURRENCIES\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function convertCurrency(identifiers: ConvertCurrencyIdentifiers, amounts: DecimalValue[]): Promise;\n interface ConvertCurrencyIdentifiers {\n /** Original currency to convert from as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `from` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n from: string;\n /** Target currency to convert to as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `to` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n to: string;\n }\n /**\n * Returns the conversion rate between 2 currencies.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.from\n * @requiredField identifiers.to\n * @param identifiers - Identifying details needed to get the conversion rate. The combination of the `from` and `to` properties together comprise the unique ID.\n * @permissionScope Manage Currencies\n * @permissionScopeId SCOPE.DC-CURRENCY-CONVERTER.MANAGE-CURRENCIES\n * @permissionScope Manage Stores - all permissions\n * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES\n * @applicableIdentity APP\n * @adminMethod\n */\n function getConversionRate(identifiers: GetConversionRateIdentifiers): Promise;\n interface GetConversionRateIdentifiers {\n /** Original currency to get the rate for as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `from` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n from: string;\n /** Target currency to get the rate for as a 3-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) code. The `to` currency code must exist in the array returned by the [`listCurrencies()`](#listcurrencies) function. */\n to: string;\n }\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_CurrencyRate = CurrencyRate;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ListCurrenciesRequest = ListCurrenciesRequest;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ListCurrenciesResponse = ListCurrenciesResponse;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_Currency = Currency;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConvertCurrencyRequest = ConvertCurrencyRequest;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_DecimalValue = DecimalValue;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConvertCurrencyResponse = ConvertCurrencyResponse;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConversionRateRequest = ConversionRateRequest;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConversionRateResponse = ConversionRateResponse;\n const ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_listCurrencies: typeof listCurrencies;\n const ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_convertCurrency: typeof convertCurrency;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConvertCurrencyIdentifiers = ConvertCurrencyIdentifiers;\n const ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_getConversionRate: typeof getConversionRate;\n type ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_GetConversionRateIdentifiers = GetConversionRateIdentifiers;\n namespace ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d {\n export { ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_CurrencyRate as CurrencyRate, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ListCurrenciesRequest as ListCurrenciesRequest, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ListCurrenciesResponse as ListCurrenciesResponse, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_Currency as Currency, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConvertCurrencyRequest as ConvertCurrencyRequest, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_DecimalValue as DecimalValue, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConvertCurrencyResponse as ConvertCurrencyResponse, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConversionRateRequest as ConversionRateRequest, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConversionRateResponse as ConversionRateResponse, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_listCurrencies as listCurrencies, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_convertCurrency as convertCurrency, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_ConvertCurrencyIdentifiers as ConvertCurrencyIdentifiers, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_getConversionRate as getConversionRate, ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d_GetConversionRateIdentifiers as GetConversionRateIdentifiers, };\n }\n export { ecommerceCurrencyConverterV1CurrencyRateCurrencies_universal_d as currencies };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/interfaces-automations-v1-action-provider.d.ts", "content": "declare module \"interfaces-automations-v1-action-provider\" {\n type BusinessError = {\n __tag: \"BusinessError\";\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n interface ActionProvider {\n }\n interface ValidateConfigurationRequest {\n /**\n * Action key as defined in your app's action configuration in the Wix Developers Center.\n * For example, `send-email` or `generate-invoice`.\n */\n actionKey: string;\n /**\n * Stringified object representing the mapping a site contributor made between keys in the input schema and their expected\n * values when running the automation. A field can be a static value mapping, or an expression that will be evaluated\n * dynamically on each activation.\n */\n inputMapping: string;\n }\n interface ValidateConfigurationResponse {\n /** Whether the action configuration is valid. */\n valid?: boolean;\n /** Error details for an invalid action configuration. */\n configurationErrors?: ProviderConfigurationError[];\n }\n interface ProviderConfigurationError {\n /** Key corresponding to the field in the schema. */\n fieldKey?: string | null;\n /** Error message. */\n message?: string;\n /** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */\n ctaLabel?: string | null;\n /** URL to redirect to when the call-to-action button is clicked. */\n ctaUrl?: string | null;\n /** Title for the error. */\n title?: string;\n }\n interface DuplicateInputMappingRequest {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mapping to duplicate */\n inputMapping: string;\n }\n interface DuplicateInputMappingResponse {\n /** Duplicated action input mapping */\n inputMapping?: string;\n }\n interface GenerateApplicationAutomationInputMappingRequest {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mapping to generate from */\n inputMapping: string;\n }\n interface GenerateApplicationAutomationInputMappingResponse {\n /** Generated action input mapping */\n inputMapping?: string;\n }\n interface GetQuotaInfoRequest {\n /**\n * Action key as defined in your app's action configuration in the Wix Developers Center.\n * For example, `send-email` or `generate-invoice`.\n */\n actionKey: string;\n }\n interface GetQuotaInfoResponse {\n /** Details about the quotas for your action */\n actionQuotaInfo?: ActionQuotaInfo;\n }\n interface ActionQuotaInfo {\n /** Whether the quotas for your action are enforced */\n enforced?: boolean;\n /** The plans your service provides together with the quotas enforced by each plan. */\n quotaInfo?: QuotaInfo[];\n }\n interface QuotaInfo {\n /** Plan details. */\n plans?: Plan[];\n /** Quota details. */\n quotas?: Quota[];\n /** Details for a call-to-action button. Displayed in the site contributor’s dashboard together with the quota details. */\n upgradeCta?: UpgradeCTA;\n }\n interface Plan {\n /** Plan ID. */\n _id?: string;\n /** Plan name displayed in the site contributor’s dashboard. */\n name?: string;\n }\n interface Quota {\n /** Name of the feature the quota is related to. */\n featureName?: string;\n /** Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */\n renewalDate?: Date;\n /** The user's current quota usage. */\n currentUsage?: string;\n /** Quota limit data. */\n limit?: string | null;\n /** Additional information about the quota. Displayed as a tooltip in the site contributor’s dashboard. */\n additionalInfo?: AdditionalInfo;\n }\n interface CTA {\n /** Call-to-action redirect URL. */\n url?: string;\n /** Call-to-action label. */\n label?: string;\n }\n interface AdditionalInfo {\n /** Tooltip content. */\n description?: string;\n /** Details for an options call-to-action link that appears in the tooltip. */\n cta?: CTA;\n }\n interface UpgradeCTA {\n /** CTA button redirect URL. */\n url?: string;\n /** CTA button label. */\n label?: string;\n }\n interface InvokeRequest {\n /**\n * Data for executing your action.\n * Structured according to the [input schema]()\n * you provided when configuring the action in the Wix Developer’s Center.\n */\n actionParams: Record | null;\n /**\n * Action key as defined in your app's action configuration in the Wix Developers Center.\n * For example, `send-email` or `generate-invoice`.\n */\n actionKey: string;\n }\n interface ActivationContext {\n activationId?: string | null;\n esbConfigurationId?: string | null;\n triggerKey?: string | null;\n triggerAppId?: string | null;\n actionId?: string | null;\n payload?: Record | null;\n }\n interface InvokeResponse {\n /**\n * If the action has no output schema this should be empty.\n * If the action defines an output schema, the result should be a JSON object that correlates to the output schema.\n */\n result?: Record | null;\n }\n interface ResetActionRequest {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mapping to reset */\n inputMapping: string;\n }\n interface ResetActionResponse {\n }\n interface OnRemoveActionRequest {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mappings to remove */\n inputMappings: Record[] | null;\n }\n interface OnRemoveActionResponse {\n }\n interface OnBeforeSaveRequest {\n /** Identifier for this action - human readable action key - unique per app def id */\n actionKey: string;\n /** list of action input mappings */\n inputMappings: string[];\n }\n interface OnBeforeSaveResponse {\n }\n interface GenerateActionInputMappingFromTemplateRequest {\n /** action input mapping template the action spi provider will generate input mapping from */\n actionInputMappingTemplate: Record | null;\n }\n interface GenerateActionInputMappingFromTemplateResponse {\n /** generated action input mapping spi provider returns */\n generatedActionInputMapping?: Record | null;\n }\n interface ActionProviderSPIConfig {\n /** Action SPI configuration */\n actionConfig?: ActionSPIConfig;\n }\n interface ActionSPIConfig {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey?: string;\n /**\n * The action expects the following input\n * The schema is described according to the JSON Schema standard: https://json-schema.org/\n *\n * Example - Add Label to Contact Action input schema:\n * {\n * \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n * \"type\": \"object\",\n * \"title\": \"Add label to contact input schema\",\n * \"description\": \"The schema of the JSON that is sent when invoking this add label to contact action\",\n * \"default\": {},\n * \"examples\": [\n * {\n * \"contactId\": \"a647eb32-c5f4-11ec-9d64-0242ac120002\",\n * \"labelId\": \"1e8b5e5e-dba2-11ec-9d64-0242ac120002\"\n * }\n * ],\n * \"required\": [\n * \"contactId\",\n * \"labelId\"\n * ],\n * \"properties\": {\n * \"contactId\": {\n * \"$id\": \"#/properties/contactId\",\n * \"type\": \"string\",\n * \"format\": \"uuid\",\n * \"title\": \"Contact Id\",\n * \"description\": \"The ID of the contact to apply the label to\",\n * \"default\": \"\",\n * \"identityType\": \"contact\" // can be contact/visitor/user, limited to 1 type per identity.\n * },\n * \"labelId\": {\n * \"$id\": \"#/properties/labelId\",\n * \"type\": \"string\",\n * \"format\": \"uuid\",\n * \"title\": \"Label Id\",\n * \"description\": \"The ID of the label to apply\",\n * \"default\": \"\",\n * }\n * }\n * }\n */\n inputSchema?: Record | null;\n /**\n * The output of the action, which will be added to the payload after execution.\n * The schema is described according to the JSON Schema standard: https://json-schema.org/\n *\n * Example - Output of create task action\n * {\n * \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n * \"type\": \"object\",\n * \"title\": \"Create task action schema\",\n * \"description\": \"The schema of the JSON that is sent when invoking this create task action\",\n * \"default\": {},\n * \"examples\": [\n * {\n * \"taskId\": \"a647eb32-c5f4-11ec-9d64-0242ac120002\",\n * }\n * ],\n * \"required\": [\n * \"taskId\"\n * ],\n * \"properties\": {\n * \"taskId\": {\n * \"$id\": \"#/properties/taskId\",\n * \"type\": \"string\",\n * \"format\": \"uuid\",\n * \"title\": \"Contact Id\",\n * \"description\": \"The ID of the task created\",\n * \"default\": \"\",\n * }\n * }\n * }\n */\n outputSchema?: Record | null;\n /** Actions display name - human-readable field. Ex. - \"Send SMS\" */\n displayName?: string | null;\n description?: string | null;\n /** Specifies which optional methods were implemented */\n implementedMethods?: ImplementedMethods;\n /**\n * Indicates whether we should wait for the action to complete before executing the next actions or finish and\n * expect a callback in the actionCompleted method\n */\n executionType?: ExecutionType;\n /** Chosen interface for action */\n interfaceConfiguration?: InterfaceConfiguration;\n /** Icon representing the action in the UI */\n icon?: string;\n }\n enum Type {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n WIDGET_COMPONENT = \"WIDGET_COMPONENT\",\n GENERIC = \"GENERIC\"\n }\n interface WidgetComponentOptions {\n /** Name of provided component */\n componentName?: string;\n }\n interface GenericOptions {\n /** UI schema */\n uiSchema?: Record | null;\n }\n interface ImplementedMethods {\n /** Implements ValidateConfiguration */\n validateConfiguration?: boolean;\n /** Implements DuplicateInputMapping */\n duplicateInputMapping?: boolean;\n /** Implements GenerateApplicationAutomationInputMapping */\n generateApplicationAutomationInputMapping?: boolean;\n /** Implements GetQuotaInfo */\n getQuotaInfo?: boolean;\n /** Implements OnBeforeSave */\n onBeforeSave?: boolean;\n /** Implements OnReset */\n onReset?: boolean;\n /** implements generateActionInputMappingFromTemplate */\n generateActionInputMappingFromTemplate?: boolean;\n /** implements OnRemove */\n onRemove?: boolean;\n }\n enum ExecutionType {\n UNKNOWN_EXECUTION_TYPE = \"UNKNOWN_EXECUTION_TYPE\",\n SYNC = \"SYNC\",\n ASYNC = \"ASYNC\"\n }\n interface Metadata {\n /** Show action only to advanced mode users (Wix staff) */\n hidden?: boolean;\n }\n interface InterfaceConfiguration extends InterfaceConfigurationOptionsOneOf {\n widgetComponentOptions?: WidgetComponentOptions;\n genericOptions?: GenericOptions;\n /** Type of chosen interface */\n type?: Type;\n }\n /** @oneof */\n interface InterfaceConfigurationOptionsOneOf {\n widgetComponentOptions?: WidgetComponentOptions;\n genericOptions?: GenericOptions;\n }\n /**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled(event: OrderCanceledEvent, context: Context) {\n * ...\n * }\n * ```\n */\n interface Context {\n /** A unique identifier for each request. Can be used for logging / troubleshooting */\n requestId?: string | null;\n /** 3 capital letters string representing a currency according to ISO-4217 */\n currency?: string | null;\n /** The identification type and identity data */\n identity?: IdentificationData;\n /** A string representing a language and region in the format of \"xx-XX\". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2 */\n languages?: string[];\n /** App instance ID of SPI in context */\n instanceId?: string | null;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: IdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n interface ValidateConfigurationOptions {\n /**\n * Action key as defined in your app's action configuration in the Wix Developers Center.\n * For example, `send-email` or `generate-invoice`.\n */\n actionKey: string;\n /**\n * Stringified object representing the mapping a site contributor made between keys in the input schema and their expected\n * values when running the automation. A field can be a static value mapping, or an expression that will be evaluated\n * dynamically on each activation.\n */\n inputMapping: string;\n }\n interface DuplicateInputMappingOptions {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mapping to duplicate */\n inputMapping: string;\n }\n interface GenerateApplicationAutomationInputMappingOptions {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mapping to generate from */\n inputMapping: string;\n }\n interface GetQuotaInfoOptions {\n /**\n * Action key as defined in your app's action configuration in the Wix Developers Center.\n * For example, `send-email` or `generate-invoice`.\n */\n actionKey: string;\n }\n interface InvokeOptions {\n /**\n * Data for executing your action.\n * Structured according to the [input schema]()\n * you provided when configuring the action in the Wix Developer’s Center.\n */\n actionParams: Record | null;\n /**\n * Action key as defined in your app's action configuration in the Wix Developers Center.\n * For example, `send-email` or `generate-invoice`.\n */\n actionKey: string;\n }\n interface ResetActionOptions {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mapping to reset */\n inputMapping: string;\n }\n interface OnRemoveActionOptions {\n /** Identifier for this action - human-readable action key - unique per app def ID */\n actionKey: string;\n /** Action input mappings to remove */\n inputMappings: Record[] | null;\n }\n interface OnBeforeSaveOptions {\n /** Identifier for this action - human readable action key - unique per app def id */\n actionKey: string;\n /** list of action input mappings */\n inputMappings: string[];\n }\n interface GenerateActionInputMappingFromTemplateOptions {\n /** action input mapping template the action spi provider will generate input mapping from */\n actionInputMappingTemplate: Record | null;\n }\n export { ActionProvider, ActionProviderSPIConfig, ActionQuotaInfo, ActionSPIConfig, ActivationContext, AdditionalInfo, BusinessError, CTA, Context, DuplicateInputMappingOptions, DuplicateInputMappingRequest, DuplicateInputMappingResponse, ExecutionType, GenerateActionInputMappingFromTemplateOptions, GenerateActionInputMappingFromTemplateRequest, GenerateActionInputMappingFromTemplateResponse, GenerateApplicationAutomationInputMappingOptions, GenerateApplicationAutomationInputMappingRequest, GenerateApplicationAutomationInputMappingResponse, GenericOptions, GetQuotaInfoOptions, GetQuotaInfoRequest, GetQuotaInfoResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, ImplementedMethods, InterfaceConfiguration, InterfaceConfigurationOptionsOneOf, InvokeOptions, InvokeRequest, InvokeResponse, Metadata, OnBeforeSaveOptions, OnBeforeSaveRequest, OnBeforeSaveResponse, OnRemoveActionOptions, OnRemoveActionRequest, OnRemoveActionResponse, Plan, ProviderConfigurationError, Quota, QuotaInfo, ResetActionOptions, ResetActionRequest, ResetActionResponse, Type, UpgradeCTA, ValidateConfigurationOptions, ValidateConfigurationRequest, ValidateConfigurationResponse, WidgetComponentOptions };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-data.v2.d.ts", "content": "declare module \"wix-data.v2\" {\n /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */\n interface Index$1 {\n /** Name of the index. */\n name?: string;\n /**\n * Fields for which the index is defined.\n *\n * Max: 3 fields (for a unique index: 1 field)\n */\n fields?: Field$1[];\n /**\n * Current status of the index.\n * @readonly\n */\n status?: Status$1;\n /**\n * Contains details about the reasons for failure when `status` is `FAILED`.\n * @readonly\n */\n failure?: Failure$1;\n /**\n * Whether the index enforces uniqueness of values in the field for which it is defined.\n * If `true`, the index can have only one field.\n *\n * Default: `false`\n */\n unique?: boolean;\n /**\n * Whether the index ignores case.\n *\n * Default: `false`\n */\n caseInsensitive?: boolean;\n }\n /**\n * Order determines how values are ordered in the index. This is important when\n * ordering and/or range querying by indexed fields.\n */\n enum Order$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Field$1 {\n /** Path of the field to index. For example: `title` or `options.price`. */\n path?: string;\n /**\n * Sort order for the index. Base on how the data is regularly queried.\n *\n * Default: `ASC`\n */\n order?: Order$1;\n }\n enum Status$1 {\n /** Place holder. Never returned by the service. */\n UNKNOWN = \"UNKNOWN\",\n /** Index creation is in progress. */\n BUILDING = \"BUILDING\",\n /** Index has been successfully created and can be used in queries. */\n ACTIVE = \"ACTIVE\",\n /** Index is in the process of being dropped. */\n DROPPING = \"DROPPING\",\n /** Index has been dropped successfully. */\n DROPPED = \"DROPPED\",\n /** Index creation has failed. */\n FAILED = \"FAILED\",\n /** Index contains incorrectly indexed data. */\n INVALID = \"INVALID\"\n }\n interface Failure$1 {\n /**\n * Error code.\n * - `WDE0112`: Unknown error while building collection index.\n * - `WDE0113`: Duplicate key error while building collection index.\n * - `WDE0114`: Document too large while building collection index.\n */\n code?: string;\n /** Description of the failure. */\n description?: string;\n /**\n * ID of the data item that caused the failure.\n * For example, if `unique` is `true`, the ID of an item containing a duplicate value.\n */\n itemId?: string | null;\n }\n interface CreateIndexRequest {\n /** Details of the index to be created. */\n index: Index$1;\n /** ID of the data collection for which to generate the index. */\n dataCollectionId: string;\n }\n enum Environment {\n LIVE = \"LIVE\",\n SANDBOX = \"SANDBOX\",\n SANDBOX_PREFERRED = \"SANDBOX_PREFERRED\"\n }\n interface CreateIndexResponse {\n /** Details of the index being generated. */\n index?: Index$1;\n }\n interface DropIndexRequest {\n /** Name of the index to drop. */\n indexName: string;\n /** ID of the data collection for which the index to be dropped is defined. */\n dataCollectionId: string;\n }\n interface DropIndexResponse {\n }\n interface ListIndexesRequest {\n /** ID of the data collection for which to list indexes. */\n dataCollectionId: string;\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n }\n interface Paging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListIndexesResponse {\n /** List of all indexes for the requested data collection. */\n indexes?: Index$1[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadata$1;\n }\n interface PagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface ListAvailableIndexesRequest {\n /** Data collection to show available indexes for */\n dataCollectionId: string;\n }\n interface ListAvailableIndexesResponse {\n /**\n * limit of regular single-field indexes, even if 0 1-field indices may be created using\n * 3-field quota (if available)\n */\n regular1Field?: number;\n /** limit of regular indexes up to 3-fields (in addition to 1-field indexes quota) */\n regular3Field?: number;\n /** limit of unique indexes */\n unique1Field?: number;\n /** Overall index limit, missing value means there's no overall limit */\n total?: number | null;\n }\n /**\n * Creates an index for a data collection.\n *\n * The index can't be used immediately, as the process of generating the index takes time.\n * You can check whether an index is ready by calling List Indexes.\n *\n * Note that when an index fails to create, the failed index still occupies a slot.\n * To remove the failed index and free up the slot for a new index, call Drop Index.\n * @param dataCollectionId - ID of the data collection for which to generate the index.\n * @param index - Details of the index to be created.\n * @public\n * @requiredField dataCollectionId\n * @requiredField index\n * @requiredField index.fields\n * @requiredField index.fields.path\n * @requiredField index.name\n * @param options - Options for creating an index.\n * @permissionId WIX_DATA.CREATE_INDEX\n * @permissionScope Manage Data Indexes\n * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n * @returns Details of the index being generated.\n */\n function createIndex(dataCollectionId: string, index: Index$1, options?: CreateIndexOptions): Promise;\n interface CreateIndexOptions {\n }\n /**\n * Removes an index from a data collection.\n *\n * The process of dropping an index from a collection takes time.\n * You can check whether an index has been dropped by calling List Indexes.\n * @param dataCollectionId - ID of the data collection for which the index to be dropped is defined.\n * @param indexName - Name of the index to drop.\n * @public\n * @requiredField dataCollectionId\n * @requiredField indexName\n * @param options - Options for dropping an index.\n * @permissionId WIX_DATA.DROP_INDEX\n * @permissionScope Manage Data Indexes\n * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n */\n function dropIndex(dataCollectionId: string, indexName: string, options?: DropIndexOptions): Promise;\n interface DropIndexOptions {\n }\n /**\n * Lists all indexes defined for a data collection.\n *\n * When an index's status is `ACTIVE`, it is ready to use.\n * While it is still being created, its status is `BUILDING`.\n *\n * When an index's status is `DROPPED`, it has been dropped successfully.\n * While it is still in the process of being removed, its status is `DROPPING`.\n * @param dataCollectionId - ID of the data collection for which to list indexes.\n * @public\n * @requiredField dataCollectionId\n * @param options - Options for retrieving a list of indexes.\n * @permissionId WIX_DATA.LIST_INDEXES\n * @permissionScope Manage Data Indexes\n * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n */\n function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise;\n interface ListIndexesOptions {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n }\n type dataV2IndexIndexes_universal_d_CreateIndexRequest = CreateIndexRequest;\n type dataV2IndexIndexes_universal_d_Environment = Environment;\n const dataV2IndexIndexes_universal_d_Environment: typeof Environment;\n type dataV2IndexIndexes_universal_d_CreateIndexResponse = CreateIndexResponse;\n type dataV2IndexIndexes_universal_d_DropIndexRequest = DropIndexRequest;\n type dataV2IndexIndexes_universal_d_DropIndexResponse = DropIndexResponse;\n type dataV2IndexIndexes_universal_d_ListIndexesRequest = ListIndexesRequest;\n type dataV2IndexIndexes_universal_d_ListIndexesResponse = ListIndexesResponse;\n type dataV2IndexIndexes_universal_d_ListAvailableIndexesRequest = ListAvailableIndexesRequest;\n type dataV2IndexIndexes_universal_d_ListAvailableIndexesResponse = ListAvailableIndexesResponse;\n const dataV2IndexIndexes_universal_d_createIndex: typeof createIndex;\n type dataV2IndexIndexes_universal_d_CreateIndexOptions = CreateIndexOptions;\n const dataV2IndexIndexes_universal_d_dropIndex: typeof dropIndex;\n type dataV2IndexIndexes_universal_d_DropIndexOptions = DropIndexOptions;\n const dataV2IndexIndexes_universal_d_listIndexes: typeof listIndexes;\n type dataV2IndexIndexes_universal_d_ListIndexesOptions = ListIndexesOptions;\n namespace dataV2IndexIndexes_universal_d {\n export { Index$1 as Index, Order$1 as Order, Field$1 as Field, Status$1 as Status, Failure$1 as Failure, dataV2IndexIndexes_universal_d_CreateIndexRequest as CreateIndexRequest, dataV2IndexIndexes_universal_d_Environment as Environment, dataV2IndexIndexes_universal_d_CreateIndexResponse as CreateIndexResponse, dataV2IndexIndexes_universal_d_DropIndexRequest as DropIndexRequest, dataV2IndexIndexes_universal_d_DropIndexResponse as DropIndexResponse, dataV2IndexIndexes_universal_d_ListIndexesRequest as ListIndexesRequest, Paging$2 as Paging, dataV2IndexIndexes_universal_d_ListIndexesResponse as ListIndexesResponse, PagingMetadata$1 as PagingMetadata, dataV2IndexIndexes_universal_d_ListAvailableIndexesRequest as ListAvailableIndexesRequest, dataV2IndexIndexes_universal_d_ListAvailableIndexesResponse as ListAvailableIndexesResponse, dataV2IndexIndexes_universal_d_createIndex as createIndex, dataV2IndexIndexes_universal_d_CreateIndexOptions as CreateIndexOptions, dataV2IndexIndexes_universal_d_dropIndex as dropIndex, dataV2IndexIndexes_universal_d_DropIndexOptions as DropIndexOptions, dataV2IndexIndexes_universal_d_listIndexes as listIndexes, dataV2IndexIndexes_universal_d_ListIndexesOptions as ListIndexesOptions, };\n }\n /** A data collection determines the structure of data to be stored in a database. */\n interface DataCollection {\n /** Collection ID. For example, `my-first-collection`. May include a namespace. */\n _id?: string;\n /**\n * Collection type. Indicates how the collection was created and is stored.\n *\n * * `NATIVE`: User-created collection.\n * * `WIX_APP`: [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.\n * * `BLOCKS_APP`: Collection created by a Wix Blocks app.\n * * `EXTERNAL`: Collection located in externally connected storage.\n * @readonly\n */\n collectionType?: CollectionType;\n /**\n * ID of the app that defined this collection. For user-defined collections, this value is null.\n * @readonly\n */\n ownerAppId?: string | null;\n /**\n * Maximum number of items returned in a single query, based on the underlying storage.\n * Native collections have a maximum page size of 1000 for offset-based queries or 100 for cursor-based queries.\n * External collections' maximum page size defaults to 50, but an external provider can set any maximum value up to 1000.\n * @readonly\n */\n maxPageSize?: number | null;\n /** Collection's display name as shown in the CMS. For example, `My First Collection`. */\n displayName?: string | null;\n /**\n * Indicates how the collection's items are sorted by default when a query doesn't specify an order.\n * @readonly\n */\n defaultDisplayOrder?: Sort;\n /**\n * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.\n * Empty for all data collections not owned by internal Wix apps.\n * @readonly\n */\n displayNamespace?: string | null;\n /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */\n displayField?: string | null;\n /**\n * Capabilities the collection supports.\n * @readonly\n */\n capabilities?: CollectionCapabilities;\n /** Collection's field structure. */\n fields?: Field[];\n /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */\n permissions?: Permissions;\n /**\n * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.\n * @readonly\n */\n revision?: string | null;\n /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */\n plugins?: Plugin[];\n /**\n * All paging modes the collection supports. In native collections, offset-based paging is supported by default.\n * @readonly\n */\n pagingModes?: PagingMode[];\n /**\n * Date the collection was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date the collection was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n enum CollectionType {\n /** User-created collection. */\n NATIVE = \"NATIVE\",\n /** [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app when it is installed. This type of collection can be modified dynamically by that app (for example, Wix Forms). */\n WIX_APP = \"WIX_APP\",\n /** Collection created by a Wix Blocks app. */\n BLOCKS_APP = \"BLOCKS_APP\",\n /** Collection located in externally connected storage. */\n EXTERNAL = \"EXTERNAL\"\n }\n interface Sort {\n /** Field to sort by. */\n fieldKey?: string;\n /**\n * Sort order. Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Default: `ASC`\n */\n direction?: Direction;\n }\n enum Direction {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CollectionCapabilities {\n /**\n * Data operations the collection supports. The listed operations can be performed on data the collection contains.\n *\n * Supported values: `AGGREGATE`, `BULK_INSERT`, `BULK_REMOVE`, `BULK_SAVE`, `BULK_UPDATE`, `COUNT`, `DISTINCT`, `FIND`, `GET`, `INSERT`, `INSERT_REFERENCE`, `IS_REFERENCED`, `QUERY_REFERENCED`, `REMOVE`, `REMOVE_REFERENCE`, `REPLACE_REFERENCES`, `SAVE`, `TRUNCATE`, `UPDATE`.\n */\n dataOperations?: DataOperation[];\n /**\n * Collection operations supported. The listed operations can be performed on the collection itself.\n * + `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.\n * + `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted.\n */\n collectionOperations?: CollectionOperation[];\n /** Maximum number of indexes for the collection. */\n indexLimits?: IndexLimits;\n }\n enum DataOperation {\n AGGREGATE = \"AGGREGATE\",\n BULK_INSERT = \"BULK_INSERT\",\n BULK_REMOVE = \"BULK_REMOVE\",\n BULK_SAVE = \"BULK_SAVE\",\n BULK_UPDATE = \"BULK_UPDATE\",\n COUNT = \"COUNT\",\n DISTINCT = \"DISTINCT\",\n FIND = \"FIND\",\n GET = \"GET\",\n INSERT = \"INSERT\",\n INSERT_REFERENCE = \"INSERT_REFERENCE\",\n IS_REFERENCED = \"IS_REFERENCED\",\n QUERY_REFERENCED = \"QUERY_REFERENCED\",\n REMOVE = \"REMOVE\",\n REMOVE_REFERENCE = \"REMOVE_REFERENCE\",\n REPLACE_REFERENCES = \"REPLACE_REFERENCES\",\n SAVE = \"SAVE\",\n TRUNCATE = \"TRUNCATE\",\n UPDATE = \"UPDATE\"\n }\n enum CollectionOperation {\n /** Supports updating this collection. */\n UPDATE = \"UPDATE\",\n /** Supports removing this collections. */\n REMOVE = \"REMOVE\"\n }\n interface IndexLimits {\n /** Maximum number of regular (non-unique) indexes allowed for this collection. */\n regular?: number;\n /** Maximum number of unique indexes allowed for this collection. */\n unique?: number;\n /** Maximum number of regular and unique indexes allowed for this collection. */\n total?: number;\n }\n interface Field extends FieldRangeValidationsOneOf {\n /** Range of possible values for a numerical field. */\n numberRange?: NumberRange;\n /** Length range permitted for a text field. Relevant for fields that hold strings, such as those of type `TEXT` or `RICH_TEXT`. */\n stringLengthRange?: StringLengthRange;\n /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */\n arraySizeRange?: ArraySizeRange;\n /** Unique identifier for the field. For example, `firstName`. */\n key?: string;\n /** Field's display name when shown in the CMS. For example, `First Name`. */\n displayName?: string | null;\n /** Field's data type. */\n type?: Type;\n /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */\n typeMetadata?: TypeMetadata;\n /**\n * Whether the field is a system field (created automatically).\n * @readonly\n */\n systemField?: boolean;\n /**\n * Capabilities the field supports.\n * @readonly\n */\n capabilities?: FieldCapabilities;\n /** Indicates if field is encrypted. */\n encrypted?: boolean;\n /** Description of the field. */\n description?: string | null;\n plugin?: string | null;\n /**\n * Whether the field is read-only. A read-only field can't be changed.\n *\n * Default: `false`\n */\n readOnly?: boolean | null;\n /**\n * Whether the field is immutable. An immutable field can be set once, but then cannot be updated.\n *\n * Default: `false`\n */\n immutable?: boolean | null;\n /**\n * Whether the field is required.\n *\n * Default: `false`\n */\n required?: boolean | null;\n /** Additional optional plugins for the field. */\n plugins?: FieldPlugin[];\n }\n /** @oneof */\n interface FieldRangeValidationsOneOf {\n /** Range of possible values for a numerical field. */\n numberRange?: NumberRange;\n /** Length range permitted for a text field. Relevant for fields that hold strings, such as those of type `TEXT` or `RICH_TEXT`. */\n stringLengthRange?: StringLengthRange;\n /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */\n arraySizeRange?: ArraySizeRange;\n }\n enum Type {\n UNKNOWN_FIELD_TYPE = \"UNKNOWN_FIELD_TYPE\",\n TEXT = \"TEXT\",\n NUMBER = \"NUMBER\",\n DATE = \"DATE\",\n DATETIME = \"DATETIME\",\n IMAGE = \"IMAGE\",\n BOOLEAN = \"BOOLEAN\",\n DOCUMENT = \"DOCUMENT\",\n URL = \"URL\",\n RICH_TEXT = \"RICH_TEXT\",\n VIDEO = \"VIDEO\",\n ANY = \"ANY\",\n ARRAY_STRING = \"ARRAY_STRING\",\n ARRAY_DOCUMENT = \"ARRAY_DOCUMENT\",\n AUDIO = \"AUDIO\",\n TIME = \"TIME\",\n LANGUAGE = \"LANGUAGE\",\n RICH_CONTENT = \"RICH_CONTENT\",\n MEDIA_GALLERY = \"MEDIA_GALLERY\",\n ADDRESS = \"ADDRESS\",\n PAGE_LINK = \"PAGE_LINK\",\n REFERENCE = \"REFERENCE\",\n MULTI_REFERENCE = \"MULTI_REFERENCE\",\n OBJECT = \"OBJECT\",\n ARRAY = \"ARRAY\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_TIME = \"LEGACY_TIME\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_BOOK = \"LEGACY_BOOK\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_EXTERNAL_URL = \"LEGACY_EXTERNAL_URL\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_BROKEN_REFERENCE = \"LEGACY_BROKEN_REFERENCE\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_IMAGE = \"LEGACY_IMAGE\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_COLOR = \"LEGACY_COLOR\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_EXTERNAL_VIDEO = \"LEGACY_EXTERNAL_VIDEO\"\n }\n interface TypeMetadata extends TypeMetadataMetadataOneOf {\n /** Metadata for a reference field. */\n reference?: Reference;\n /** Metadata for a multi-reference field. */\n multiReference?: MultiReference;\n /** Metadata for an object field. */\n object?: _Object;\n /** Metadata for an array field. */\n array?: _Array;\n /** Metadata for a page link field. */\n pageLink?: PageLink;\n }\n /** @oneof */\n interface TypeMetadataMetadataOneOf {\n /** Metadata for a reference field. */\n reference?: Reference;\n /** Metadata for a multi-reference field. */\n multiReference?: MultiReference;\n /** Metadata for an object field. */\n object?: _Object;\n /** Metadata for an array field. */\n array?: _Array;\n /** Metadata for a page link field. */\n pageLink?: PageLink;\n }\n interface FieldCapabilities {\n /**\n * Whether the collection can be sorted by this field.\n *\n * Default: `false`\n */\n sortable?: boolean;\n /**\n * Query operators that can be used for this field.\n *\n * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.\n */\n queryOperators?: QueryOperator[];\n }\n enum QueryOperator {\n EQ = \"EQ\",\n LT = \"LT\",\n GT = \"GT\",\n NE = \"NE\",\n LTE = \"LTE\",\n GTE = \"GTE\",\n STARTS_WITH = \"STARTS_WITH\",\n ENDS_WITH = \"ENDS_WITH\",\n CONTAINS = \"CONTAINS\",\n HAS_SOME = \"HAS_SOME\",\n HAS_ALL = \"HAS_ALL\",\n EXISTS = \"EXISTS\",\n URLIZED = \"URLIZED\"\n }\n interface ObjectField {\n /** Field key. */\n key?: string;\n /** Display name for the field. */\n displayName?: string | null;\n /** Field type. */\n type?: Type;\n /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */\n typeMetadata?: TypeMetadata;\n /**\n * Capabilities the object field supports.\n * @readonly\n */\n capabilities?: FieldCapabilities;\n }\n interface FieldsPattern {\n pattern?: string;\n lowercase?: boolean;\n }\n interface UrlizedOnlyPattern {\n pattern?: string;\n }\n interface Calculator extends CalculatorPatternOneOf {\n /** Value is calculated according to pattern, whitespaces are replaced with dash [-]. */\n fieldsPattern?: FieldsPattern;\n /** Value is only URL encoded. */\n urlizedOnlyPattern?: UrlizedOnlyPattern;\n }\n /** @oneof */\n interface CalculatorPatternOneOf {\n /** Value is calculated according to pattern, whitespaces are replaced with dash [-]. */\n fieldsPattern?: FieldsPattern;\n /** Value is only URL encoded. */\n urlizedOnlyPattern?: UrlizedOnlyPattern;\n }\n interface Reference {\n /** Referenced collection ID. */\n referencedCollectionId?: string;\n }\n interface MultiReference {\n /** Referenced collection ID. */\n referencedCollectionId?: string;\n /** Referencing field key. */\n referencingFieldKey?: string;\n /** Display name in the CMS for the referenced data. */\n referencingDisplayName?: string;\n }\n interface _Object {\n /** Fields within the object. */\n fields?: ObjectField[];\n }\n interface _Array {\n /** Element's data type. */\n elementType?: Type;\n /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */\n typeMetadata?: TypeMetadata;\n }\n interface PageLink {\n calculator?: Calculator;\n /** Defines reference to router pattern in the site document. */\n linkedRouterPage?: string | null;\n }\n interface NumberRange {\n /**\n * Minimum permitted value for a numerical field.\n *\n * Default: No validation\n */\n min?: number | null;\n /**\n * Maximum permitted value for a numerical field.\n *\n * Default: No validation\n */\n max?: number | null;\n }\n interface StringLengthRange {\n /**\n * Minimum permitted length for a text field.\n *\n * Default: No validation\n */\n minLength?: number | null;\n /**\n * Maximum permitted length for a text field.\n *\n * Default: No validation\n */\n maxLength?: number | null;\n }\n interface ArraySizeRange {\n /**\n * Minimum permitted number of items in an array field. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`.\n *\n * Default: No validation\n */\n minSize?: number | null;\n /**\n * Maximum permitted number of items in an array field. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`.\n *\n * Default: No validation\n */\n maxSize?: number | null;\n }\n /** Optional plug-in aspects for fields */\n interface FieldPlugin extends FieldPluginOptionsOneOf {\n /** Options for the CMS plugin. */\n cmsOptions?: CmsOptions;\n type?: FieldPluginType;\n }\n /** @oneof */\n interface FieldPluginOptionsOneOf {\n /** Options for the CMS plugin. */\n cmsOptions?: CmsOptions;\n }\n enum FieldPluginType {\n UNKNOWN = \"UNKNOWN\",\n /** CMS-related field attributes */\n CMS = \"CMS\"\n }\n /** Options for the CMS plugin. */\n interface CmsOptions {\n /**\n * Indicates an internal CMS field. The CMS does not display internal fields.\n *\n * Default: `false`\n */\n internal?: boolean;\n }\n /** Permissions defined by the lowest role needed to perform each action. */\n interface Permissions {\n /** Lowest role needed to add a collection. */\n insert?: Role;\n /** Lowest role needed to update a collection. */\n update?: Role;\n /** Lowest role needed to remove a collection. */\n remove?: Role;\n /** Lowest role needed to read a collection. */\n read?: Role;\n }\n enum Role {\n /** Unknown. */\n UNKNOWN_ROLE = \"UNKNOWN_ROLE\",\n /** Site administrator. */\n ADMIN = \"ADMIN\",\n /** Signed-in user who added content to this collection. */\n SITE_MEMBER_AUTHOR = \"SITE_MEMBER_AUTHOR\",\n /** Any signed-in user. */\n SITE_MEMBER = \"SITE_MEMBER\",\n /** Any site visitor. */\n ANYONE = \"ANYONE\"\n }\n interface Plugin extends PluginOptionsOneOf {\n /** Options for the Publish plugin. */\n publishOptions?: PublishPluginOptions;\n /** Options for the Single Item plugin. */\n singleItemOptions?: SingleItemPluginOptions;\n /** Options for the Urlized plugin. */\n urlizedOptions?: UrlizedPluginOptions;\n /** Options for the Multilingual plugin. */\n multilingualOptions?: MultilingualOptions;\n /** Options for the PageLink plugin. */\n editablePageLinkOptions?: PageLinkPluginOptions;\n /** Options for the CMS plugin. */\n cmsOptions?: PluginCmsOptions;\n /**\n * Plugin types. The following plugins are supported:\n *\n * * `PUBLISH`: Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors.\n * * `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.\n * * `URLIZED`: Generates item URLs for collections used by dynamic pages.\n * * `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n * * `CMS`: Contains CMS-related collection attributes\n */\n type?: PluginType;\n }\n /** @oneof */\n interface PluginOptionsOneOf {\n /** Options for the Publish plugin. */\n publishOptions?: PublishPluginOptions;\n /** Options for the Single Item plugin. */\n singleItemOptions?: SingleItemPluginOptions;\n /** Options for the Urlized plugin. */\n urlizedOptions?: UrlizedPluginOptions;\n /** Options for the Multilingual plugin. */\n multilingualOptions?: MultilingualOptions;\n /** Options for the PageLink plugin. */\n editablePageLinkOptions?: PageLinkPluginOptions;\n /** Options for the CMS plugin. */\n cmsOptions?: PluginCmsOptions;\n }\n enum Status {\n UNKNOWN_PUBLISH_PLUGIN_STATUS = \"UNKNOWN_PUBLISH_PLUGIN_STATUS\",\n PUBLISHED = \"PUBLISHED\",\n DRAFT = \"DRAFT\"\n }\n enum Format {\n UNKNOWN_URLIZED_PLUGIN_FORMAT = \"UNKNOWN_URLIZED_PLUGIN_FORMAT\",\n ORIGINAL = \"ORIGINAL\",\n PLAIN = \"PLAIN\"\n }\n /** if CMS-defined sort is enabled and should be used in site */\n interface SiteSort {\n /** Field and order for the site sort. */\n sort?: Sort[];\n }\n enum PluginType {\n /** Unknown plugin type. */\n UNKNOWN_PLUGIN_TYPE = \"UNKNOWN_PLUGIN_TYPE\",\n /** Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors. */\n PUBLISH = \"PUBLISH\",\n /** Ensures the collection can have one item at most. Can only be applied to a new collection. */\n SINGLE_ITEM = \"SINGLE_ITEM\",\n /** Generates item URLs for collections used by dynamic pages. */\n URLIZED = \"URLIZED\",\n /** Deprecated. Will be removed in the future. */\n GRIDAPPLESS = \"GRIDAPPLESS\",\n /** Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). */\n MULTILINGUAL = \"MULTILINGUAL\",\n /** Indicates that collection is shared with current site */\n SHARED = \"SHARED\",\n /** Indicates that page link fields are persisted and can be updated */\n EDITABLE_PAGE_LINK = \"EDITABLE_PAGE_LINK\",\n /** CMS-specific collection properties */\n CMS = \"CMS\"\n }\n interface PublishPluginOptions {\n /** Default status. */\n defaultStatus?: Status;\n }\n interface SingleItemPluginOptions {\n /** ID of the single item in this collection. If you insert or update an item, its ID value is always changed to this. */\n singleItemId?: string;\n }\n interface UrlizedPluginOptions {\n /**\n * Encoding method for generating a URL in ASCII characters.\n *\n * * `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.\n * * `PLAIN`: No changes are made before generating the encoded URL.\n */\n format?: Format;\n }\n interface MultilingualOptions {\n /** IDs of fields to allow translation. */\n translatableFieldKeys?: string[];\n }\n interface PageLinkPluginOptions {\n isPersisted?: boolean;\n isMutable?: boolean;\n }\n interface PluginCmsOptions {\n /** CMS sort, applied when a collection is displayed on a site. */\n siteSort?: SiteSort;\n }\n enum PagingMode {\n /** Offset-based paging. */\n OFFSET = \"OFFSET\",\n /** Cursor-based paging. */\n CURSOR = \"CURSOR\"\n }\n interface DataCollectionClonedEvent {\n /** original instance collection is cloned from */\n originInstanceId?: string;\n /** original collection ID, may be same as current one */\n originId?: string;\n }\n interface DataCollectionChangedEvent {\n /** list of new fields */\n fieldsAdded?: Field[];\n /** list of changed fields */\n fieldsUpdated?: FieldUpdate[];\n /** list of removed fields */\n fieldsRemoved?: Field[];\n /** list of new plugins */\n pluginsAdded?: Plugin[];\n /** list of changed plugins */\n pluginsUpdated?: PluginUpdate[];\n /** list of removed plugins */\n pluginsRemoved?: Plugin[];\n }\n interface FieldUpdate {\n /** previous state of the field */\n previous?: Field;\n /** current state of the field */\n current?: Field;\n }\n interface PluginUpdate {\n /** previous state of the plugin */\n previous?: Plugin;\n /** current state of the plugin */\n current?: Plugin;\n }\n interface CreateDataCollectionRequest {\n /** Collection details. */\n collection: DataCollection;\n }\n interface CreateDataCollectionResponse {\n /** Details of collection created. */\n collection?: DataCollection;\n }\n interface GetDataCollectionRequest {\n /** ID of the collection to retrieve. */\n dataCollectionId: string;\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n }\n interface GetDataCollectionResponse {\n /** Details of the collection requested. */\n collection?: DataCollection;\n /**\n * Details of collections referenced by the collection requested.\n * Only populated when `includeReferencedCollections` is `true` in the request.\n */\n referencedCollections?: DataCollection[];\n }\n interface ListDataCollectionsRequest {\n /**\n * Defines how collections in the response are sorted.\n *\n * Default: Ordered by ID in ascending order.\n */\n sort?: Sorting;\n /** Pagination information. */\n paging?: Paging$1;\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListDataCollectionsResponse {\n /** List of collections. */\n collections?: DataCollection[];\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface BulkGetDataCollectionsRequest {\n /** IDs of the collections to retrieve. */\n dataCollectionIds?: string[];\n /**\n * Whether to include deleted collections.\n *\n * Default: `false`\n */\n showDeletedCollections?: boolean;\n /**\n * Whether the returned collection list should include referenced collections.\n *\n * Default: `false`\n */\n includeReferencedCollections?: boolean;\n /** Sorting preferences. */\n sort?: Sorting;\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n }\n interface BulkGetDataCollectionsResponse {\n /**\n * List of requested collections.\n * When `include_referenced_collections` is `true` in the request, referenced collections are included here.\n */\n activeCollections?: DataCollection[];\n /** List of requested deleted collections. Only populated when `showDeletedCollections` is true in the request. */\n deletedCollections?: DataCollection[];\n }\n interface UpdateDataCollectionRequest {\n /** Updated collection details. The existing collection is replaced with this version. */\n collection: DataCollection;\n }\n interface UpdateDataCollectionResponse {\n /** Updated collection details. */\n collection?: DataCollection;\n }\n interface DeleteDataCollectionRequest {\n /** ID of the collection to delete. */\n dataCollectionId: string;\n }\n interface DeleteDataCollectionResponse {\n }\n interface CreateDataCollectionFieldRequest {\n /** ID of data collection to update */\n dataCollectionId: string;\n /** field to create */\n field: Field;\n }\n interface CreateDataCollectionFieldResponse {\n /** updated data collection */\n dataCollection?: DataCollection;\n }\n interface UpdateDataCollectionFieldRequest {\n /** ID of data collection to update */\n dataCollectionId: string;\n /** Field to update */\n field: Field;\n }\n interface UpdateDataCollectionFieldResponse {\n /** updated data collection */\n dataCollection?: DataCollection;\n }\n interface DeleteDataCollectionFieldRequest {\n /** ID of data collection to update */\n dataCollectionId: string;\n /** Field key to delete */\n fieldKey: string;\n }\n interface DeleteDataCollectionFieldResponse {\n /** updated data collection */\n dataCollection?: DataCollection;\n }\n interface BulkGetDataCollectionsPageBySnapshotsRequest {\n /** Ids of schema snapshot */\n snapshotIds?: string[];\n /** Pagination information. */\n paging?: Paging$1;\n }\n interface BulkGetDataCollectionsPageBySnapshotsResponse {\n /** List of snapshot collection map */\n snapshotCollections?: SnapshotCollection[];\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface SnapshotCollection {\n /** snapshot to which collection belongs */\n snapshotId?: string;\n /** snapshot collection */\n collection?: DataCollection;\n /** snapshot of collection indexes */\n indexes?: Index[];\n }\n /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */\n interface Index {\n /** Name of the index. */\n name?: string;\n /**\n * Fields for which the index is defined.\n *\n * Max: 3 fields (for a unique index: 1 field)\n */\n fields?: IndexField[];\n /**\n * Current status of the index.\n * - `BUILDING`: Index creation is in progress.\n * - `ACTIVE`: Index has been successfully created and can be used in queries.\n * - `DROPPING`: Index is in the process of being dropped.\n * - `DROPPED`: Index has been dropped successfully.\n * - `FAILED`: Index creation has failed.\n * - `INVALID`: Index contains incorrectly indexed data.\n * @readonly\n */\n status?: IndexStatus;\n /**\n * Contains details about the reasons for failure when `status` is `FAILED`.\n * @readonly\n */\n failure?: Failure;\n /**\n * Whether the index enforces uniqueness of values in the field for which it is defined.\n * If `true`, the index can have only one field.\n *\n * Default: `false`\n */\n unique?: boolean;\n /**\n * Whether the index ignores case.\n *\n * Default: `false`\n */\n caseInsensitive?: boolean;\n }\n /**\n * Order determines how values are ordered in the index. This is important when\n * ordering and/or range querying by indexed fields.\n */\n enum Order {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface IndexField {\n /** Path of the field to index. For example: `title` or `options.price`. */\n path?: string;\n /**\n * Sort order for the index. Base on how the data is regularly queried.\n *\n * Default: `ASC`\n */\n order?: Order;\n }\n enum IndexStatus {\n /** Place holder. Never returned by the service. */\n UNKNOWN = \"UNKNOWN\",\n /** Index creation is in progress. */\n BUILDING = \"BUILDING\",\n /** Index has been successfully created and can be used in queries. */\n ACTIVE = \"ACTIVE\",\n /** Index is in the process of being dropped. */\n DROPPING = \"DROPPING\",\n /** Index has been dropped successfully. */\n DROPPED = \"DROPPED\",\n /** Index creation has failed. */\n FAILED = \"FAILED\",\n /** Index contains incorrectly indexed data. */\n INVALID = \"INVALID\"\n }\n interface Failure {\n /**\n * Error code.\n * - `WDE0112`: Unknown error while building collection index.\n * - `WDE0113`: Duplicate key error while building collection index.\n * - `WDE0114`: Document too large while building collection index.\n */\n code?: string;\n /** Description of the failure. */\n description?: string;\n /**\n * ID of the data item that caused the failure.\n * For example, if `unique` is `true`, the ID of an item containing a duplicate value.\n */\n itemId?: string | null;\n }\n interface CreateDataCollectionsSnapshotRequest {\n }\n interface CreateDataCollectionsSnapshotResponse {\n /** created snapshot ID */\n snapshotId?: string;\n /** data collections in snapshot */\n snapshotCollections?: DataCollection[];\n }\n interface RestoreDataCollectionsFromSnapshotRequest {\n /** snapshot ID to restore */\n snapshotId?: string;\n /** collection IDs to restore, if empty – all collections would be restored */\n dataCollectionIds?: string[];\n }\n interface RestoreDataCollectionsFromSnapshotResponse {\n /** restored collections */\n restoredCollections?: DataCollection[];\n }\n interface DeleteDataCollectionsSnapshotRequest {\n /** snapshot ID to delete */\n snapshotId?: string;\n }\n interface DeleteDataCollectionsSnapshotResponse {\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new data collection.\n *\n * The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.\n * @param collection - Collection details.\n * @public\n * @requiredField collection\n * @requiredField collection._id\n * @requiredField collection.fields.key\n * @requiredField collection.fields.type\n * @requiredField collection.permissions.insert\n * @requiredField collection.permissions.read\n * @requiredField collection.permissions.remove\n * @requiredField collection.permissions.update\n * @param options - Options for creating a data collection.\n * @permissionScope Manage Data Collections\n * @permissionScopeId SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n * @returns Details of collection created.\n */\n function createDataCollection(collection: DataCollection): Promise;\n /**\n * Retrieves a data collection by ID.\n * @param dataCollectionId - ID of the collection to retrieve.\n * @public\n * @requiredField dataCollectionId\n * @param options - Options for retrieving a data collection.\n * @permissionScope Manage Data Collections\n * @permissionScopeId SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Details of the collection requested.\n */\n function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise;\n interface GetDataCollectionOptions {\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n }\n /**\n * Retrieves a list of all data collections associated with the site or project.\n *\n * By default, the list is ordered by ID in ascending order.\n * @public\n * @param options - Options for retrieving a list of data collections.\n * @permissionScope Manage Data Collections\n * @permissionScopeId SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n */\n function listDataCollections(options?: ListDataCollectionsOptions): Promise;\n interface ListDataCollectionsOptions {\n /**\n * Defines how collections in the response are sorted.\n *\n * Default: Ordered by ID in ascending order.\n */\n sort?: Sorting;\n /** Pagination information. */\n paging?: Paging$1;\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n }\n interface BulkGetDataCollectionsOptions {\n /** IDs of the collections to retrieve. */\n dataCollectionIds?: string[];\n /**\n * Whether to include deleted collections.\n *\n * Default: `false`\n */\n showDeletedCollections?: boolean;\n /**\n * Whether the returned collection list should include referenced collections.\n *\n * Default: `false`\n */\n includeReferencedCollections?: boolean;\n /** Sorting preferences. */\n sort?: Sorting;\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean;\n }\n /**\n * Updates a data collection.\n *\n * A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.\n * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.\n * Otherwise, the request fails.\n *\n * When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.\n *\n * > **Note:**\n * > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties\n * > aren't included in the updated collection details, their values are lost.\n * @param collection - Updated collection details. The existing collection is replaced with this version.\n * @public\n * @requiredField collection\n * @requiredField collection._id\n * @requiredField collection.fields.key\n * @requiredField collection.fields.type\n * @requiredField collection.permissions.insert\n * @requiredField collection.permissions.read\n * @requiredField collection.permissions.remove\n * @requiredField collection.permissions.update\n * @requiredField collection.revision\n * @param options - Options for updating a data collection.\n * @permissionScope Manage Data Collections\n * @permissionScopeId SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated collection details.\n */\n function updateDataCollection(collection: DataCollection): Promise;\n /**\n * Deletes a data collection.\n *\n * > **Note:**\n * > Once a collection is deleted, it can't be restored.\n * @param dataCollectionId - ID of the collection to delete.\n * @public\n * @requiredField dataCollectionId\n * @permissionScope Manage Data Collections\n * @permissionScopeId SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteDataCollection(dataCollectionId: string): Promise;\n interface CreateDataCollectionFieldOptions {\n /** field to create */\n field: Field;\n }\n interface UpdateDataCollectionFieldOptions {\n /** Field to update */\n field: Field;\n }\n interface DeleteDataCollectionFieldOptions {\n /** Field key to delete */\n fieldKey: string;\n }\n type dataV2DataCollectionCollections_universal_d_DataCollection = DataCollection;\n type dataV2DataCollectionCollections_universal_d_CollectionType = CollectionType;\n const dataV2DataCollectionCollections_universal_d_CollectionType: typeof CollectionType;\n type dataV2DataCollectionCollections_universal_d_Sort = Sort;\n type dataV2DataCollectionCollections_universal_d_Direction = Direction;\n const dataV2DataCollectionCollections_universal_d_Direction: typeof Direction;\n type dataV2DataCollectionCollections_universal_d_CollectionCapabilities = CollectionCapabilities;\n type dataV2DataCollectionCollections_universal_d_DataOperation = DataOperation;\n const dataV2DataCollectionCollections_universal_d_DataOperation: typeof DataOperation;\n type dataV2DataCollectionCollections_universal_d_CollectionOperation = CollectionOperation;\n const dataV2DataCollectionCollections_universal_d_CollectionOperation: typeof CollectionOperation;\n type dataV2DataCollectionCollections_universal_d_IndexLimits = IndexLimits;\n type dataV2DataCollectionCollections_universal_d_Field = Field;\n type dataV2DataCollectionCollections_universal_d_FieldRangeValidationsOneOf = FieldRangeValidationsOneOf;\n type dataV2DataCollectionCollections_universal_d_Type = Type;\n const dataV2DataCollectionCollections_universal_d_Type: typeof Type;\n type dataV2DataCollectionCollections_universal_d_TypeMetadata = TypeMetadata;\n type dataV2DataCollectionCollections_universal_d_TypeMetadataMetadataOneOf = TypeMetadataMetadataOneOf;\n type dataV2DataCollectionCollections_universal_d_FieldCapabilities = FieldCapabilities;\n type dataV2DataCollectionCollections_universal_d_QueryOperator = QueryOperator;\n const dataV2DataCollectionCollections_universal_d_QueryOperator: typeof QueryOperator;\n type dataV2DataCollectionCollections_universal_d_ObjectField = ObjectField;\n type dataV2DataCollectionCollections_universal_d_FieldsPattern = FieldsPattern;\n type dataV2DataCollectionCollections_universal_d_UrlizedOnlyPattern = UrlizedOnlyPattern;\n type dataV2DataCollectionCollections_universal_d_Calculator = Calculator;\n type dataV2DataCollectionCollections_universal_d_CalculatorPatternOneOf = CalculatorPatternOneOf;\n type dataV2DataCollectionCollections_universal_d_Reference = Reference;\n type dataV2DataCollectionCollections_universal_d_MultiReference = MultiReference;\n type dataV2DataCollectionCollections_universal_d__Object = _Object;\n type dataV2DataCollectionCollections_universal_d__Array = _Array;\n type dataV2DataCollectionCollections_universal_d_PageLink = PageLink;\n type dataV2DataCollectionCollections_universal_d_NumberRange = NumberRange;\n type dataV2DataCollectionCollections_universal_d_StringLengthRange = StringLengthRange;\n type dataV2DataCollectionCollections_universal_d_ArraySizeRange = ArraySizeRange;\n type dataV2DataCollectionCollections_universal_d_FieldPlugin = FieldPlugin;\n type dataV2DataCollectionCollections_universal_d_FieldPluginOptionsOneOf = FieldPluginOptionsOneOf;\n type dataV2DataCollectionCollections_universal_d_FieldPluginType = FieldPluginType;\n const dataV2DataCollectionCollections_universal_d_FieldPluginType: typeof FieldPluginType;\n type dataV2DataCollectionCollections_universal_d_CmsOptions = CmsOptions;\n type dataV2DataCollectionCollections_universal_d_Permissions = Permissions;\n type dataV2DataCollectionCollections_universal_d_Role = Role;\n const dataV2DataCollectionCollections_universal_d_Role: typeof Role;\n type dataV2DataCollectionCollections_universal_d_Plugin = Plugin;\n type dataV2DataCollectionCollections_universal_d_PluginOptionsOneOf = PluginOptionsOneOf;\n type dataV2DataCollectionCollections_universal_d_Status = Status;\n const dataV2DataCollectionCollections_universal_d_Status: typeof Status;\n type dataV2DataCollectionCollections_universal_d_Format = Format;\n const dataV2DataCollectionCollections_universal_d_Format: typeof Format;\n type dataV2DataCollectionCollections_universal_d_SiteSort = SiteSort;\n type dataV2DataCollectionCollections_universal_d_PluginType = PluginType;\n const dataV2DataCollectionCollections_universal_d_PluginType: typeof PluginType;\n type dataV2DataCollectionCollections_universal_d_PublishPluginOptions = PublishPluginOptions;\n type dataV2DataCollectionCollections_universal_d_SingleItemPluginOptions = SingleItemPluginOptions;\n type dataV2DataCollectionCollections_universal_d_UrlizedPluginOptions = UrlizedPluginOptions;\n type dataV2DataCollectionCollections_universal_d_MultilingualOptions = MultilingualOptions;\n type dataV2DataCollectionCollections_universal_d_PageLinkPluginOptions = PageLinkPluginOptions;\n type dataV2DataCollectionCollections_universal_d_PluginCmsOptions = PluginCmsOptions;\n type dataV2DataCollectionCollections_universal_d_PagingMode = PagingMode;\n const dataV2DataCollectionCollections_universal_d_PagingMode: typeof PagingMode;\n type dataV2DataCollectionCollections_universal_d_DataCollectionClonedEvent = DataCollectionClonedEvent;\n type dataV2DataCollectionCollections_universal_d_DataCollectionChangedEvent = DataCollectionChangedEvent;\n type dataV2DataCollectionCollections_universal_d_FieldUpdate = FieldUpdate;\n type dataV2DataCollectionCollections_universal_d_PluginUpdate = PluginUpdate;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionRequest = CreateDataCollectionRequest;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionResponse = CreateDataCollectionResponse;\n type dataV2DataCollectionCollections_universal_d_GetDataCollectionRequest = GetDataCollectionRequest;\n type dataV2DataCollectionCollections_universal_d_GetDataCollectionResponse = GetDataCollectionResponse;\n type dataV2DataCollectionCollections_universal_d_ListDataCollectionsRequest = ListDataCollectionsRequest;\n type dataV2DataCollectionCollections_universal_d_Sorting = Sorting;\n type dataV2DataCollectionCollections_universal_d_SortOrder = SortOrder;\n const dataV2DataCollectionCollections_universal_d_SortOrder: typeof SortOrder;\n type dataV2DataCollectionCollections_universal_d_ListDataCollectionsResponse = ListDataCollectionsResponse;\n type dataV2DataCollectionCollections_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsRequest = BulkGetDataCollectionsRequest;\n type dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsResponse = BulkGetDataCollectionsResponse;\n type dataV2DataCollectionCollections_universal_d_UpdateDataCollectionRequest = UpdateDataCollectionRequest;\n type dataV2DataCollectionCollections_universal_d_UpdateDataCollectionResponse = UpdateDataCollectionResponse;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionRequest = DeleteDataCollectionRequest;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionResponse = DeleteDataCollectionResponse;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionFieldRequest = CreateDataCollectionFieldRequest;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionFieldResponse = CreateDataCollectionFieldResponse;\n type dataV2DataCollectionCollections_universal_d_UpdateDataCollectionFieldRequest = UpdateDataCollectionFieldRequest;\n type dataV2DataCollectionCollections_universal_d_UpdateDataCollectionFieldResponse = UpdateDataCollectionFieldResponse;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionFieldRequest = DeleteDataCollectionFieldRequest;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionFieldResponse = DeleteDataCollectionFieldResponse;\n type dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsPageBySnapshotsRequest = BulkGetDataCollectionsPageBySnapshotsRequest;\n type dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsPageBySnapshotsResponse = BulkGetDataCollectionsPageBySnapshotsResponse;\n type dataV2DataCollectionCollections_universal_d_SnapshotCollection = SnapshotCollection;\n type dataV2DataCollectionCollections_universal_d_Index = Index;\n type dataV2DataCollectionCollections_universal_d_Order = Order;\n const dataV2DataCollectionCollections_universal_d_Order: typeof Order;\n type dataV2DataCollectionCollections_universal_d_IndexField = IndexField;\n type dataV2DataCollectionCollections_universal_d_IndexStatus = IndexStatus;\n const dataV2DataCollectionCollections_universal_d_IndexStatus: typeof IndexStatus;\n type dataV2DataCollectionCollections_universal_d_Failure = Failure;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionsSnapshotRequest = CreateDataCollectionsSnapshotRequest;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionsSnapshotResponse = CreateDataCollectionsSnapshotResponse;\n type dataV2DataCollectionCollections_universal_d_RestoreDataCollectionsFromSnapshotRequest = RestoreDataCollectionsFromSnapshotRequest;\n type dataV2DataCollectionCollections_universal_d_RestoreDataCollectionsFromSnapshotResponse = RestoreDataCollectionsFromSnapshotResponse;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionsSnapshotRequest = DeleteDataCollectionsSnapshotRequest;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionsSnapshotResponse = DeleteDataCollectionsSnapshotResponse;\n const dataV2DataCollectionCollections_universal_d_createDataCollection: typeof createDataCollection;\n const dataV2DataCollectionCollections_universal_d_getDataCollection: typeof getDataCollection;\n type dataV2DataCollectionCollections_universal_d_GetDataCollectionOptions = GetDataCollectionOptions;\n const dataV2DataCollectionCollections_universal_d_listDataCollections: typeof listDataCollections;\n type dataV2DataCollectionCollections_universal_d_ListDataCollectionsOptions = ListDataCollectionsOptions;\n type dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsOptions = BulkGetDataCollectionsOptions;\n const dataV2DataCollectionCollections_universal_d_updateDataCollection: typeof updateDataCollection;\n const dataV2DataCollectionCollections_universal_d_deleteDataCollection: typeof deleteDataCollection;\n type dataV2DataCollectionCollections_universal_d_CreateDataCollectionFieldOptions = CreateDataCollectionFieldOptions;\n type dataV2DataCollectionCollections_universal_d_UpdateDataCollectionFieldOptions = UpdateDataCollectionFieldOptions;\n type dataV2DataCollectionCollections_universal_d_DeleteDataCollectionFieldOptions = DeleteDataCollectionFieldOptions;\n namespace dataV2DataCollectionCollections_universal_d {\n export { dataV2DataCollectionCollections_universal_d_DataCollection as DataCollection, dataV2DataCollectionCollections_universal_d_CollectionType as CollectionType, dataV2DataCollectionCollections_universal_d_Sort as Sort, dataV2DataCollectionCollections_universal_d_Direction as Direction, dataV2DataCollectionCollections_universal_d_CollectionCapabilities as CollectionCapabilities, dataV2DataCollectionCollections_universal_d_DataOperation as DataOperation, dataV2DataCollectionCollections_universal_d_CollectionOperation as CollectionOperation, dataV2DataCollectionCollections_universal_d_IndexLimits as IndexLimits, dataV2DataCollectionCollections_universal_d_Field as Field, dataV2DataCollectionCollections_universal_d_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, dataV2DataCollectionCollections_universal_d_Type as Type, dataV2DataCollectionCollections_universal_d_TypeMetadata as TypeMetadata, dataV2DataCollectionCollections_universal_d_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, dataV2DataCollectionCollections_universal_d_FieldCapabilities as FieldCapabilities, dataV2DataCollectionCollections_universal_d_QueryOperator as QueryOperator, dataV2DataCollectionCollections_universal_d_ObjectField as ObjectField, dataV2DataCollectionCollections_universal_d_FieldsPattern as FieldsPattern, dataV2DataCollectionCollections_universal_d_UrlizedOnlyPattern as UrlizedOnlyPattern, dataV2DataCollectionCollections_universal_d_Calculator as Calculator, dataV2DataCollectionCollections_universal_d_CalculatorPatternOneOf as CalculatorPatternOneOf, dataV2DataCollectionCollections_universal_d_Reference as Reference, dataV2DataCollectionCollections_universal_d_MultiReference as MultiReference, dataV2DataCollectionCollections_universal_d__Object as _Object, dataV2DataCollectionCollections_universal_d__Array as _Array, dataV2DataCollectionCollections_universal_d_PageLink as PageLink, dataV2DataCollectionCollections_universal_d_NumberRange as NumberRange, dataV2DataCollectionCollections_universal_d_StringLengthRange as StringLengthRange, dataV2DataCollectionCollections_universal_d_ArraySizeRange as ArraySizeRange, dataV2DataCollectionCollections_universal_d_FieldPlugin as FieldPlugin, dataV2DataCollectionCollections_universal_d_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, dataV2DataCollectionCollections_universal_d_FieldPluginType as FieldPluginType, dataV2DataCollectionCollections_universal_d_CmsOptions as CmsOptions, dataV2DataCollectionCollections_universal_d_Permissions as Permissions, dataV2DataCollectionCollections_universal_d_Role as Role, dataV2DataCollectionCollections_universal_d_Plugin as Plugin, dataV2DataCollectionCollections_universal_d_PluginOptionsOneOf as PluginOptionsOneOf, dataV2DataCollectionCollections_universal_d_Status as Status, dataV2DataCollectionCollections_universal_d_Format as Format, dataV2DataCollectionCollections_universal_d_SiteSort as SiteSort, dataV2DataCollectionCollections_universal_d_PluginType as PluginType, dataV2DataCollectionCollections_universal_d_PublishPluginOptions as PublishPluginOptions, dataV2DataCollectionCollections_universal_d_SingleItemPluginOptions as SingleItemPluginOptions, dataV2DataCollectionCollections_universal_d_UrlizedPluginOptions as UrlizedPluginOptions, dataV2DataCollectionCollections_universal_d_MultilingualOptions as MultilingualOptions, dataV2DataCollectionCollections_universal_d_PageLinkPluginOptions as PageLinkPluginOptions, dataV2DataCollectionCollections_universal_d_PluginCmsOptions as PluginCmsOptions, dataV2DataCollectionCollections_universal_d_PagingMode as PagingMode, dataV2DataCollectionCollections_universal_d_DataCollectionClonedEvent as DataCollectionClonedEvent, dataV2DataCollectionCollections_universal_d_DataCollectionChangedEvent as DataCollectionChangedEvent, dataV2DataCollectionCollections_universal_d_FieldUpdate as FieldUpdate, dataV2DataCollectionCollections_universal_d_PluginUpdate as PluginUpdate, dataV2DataCollectionCollections_universal_d_CreateDataCollectionRequest as CreateDataCollectionRequest, dataV2DataCollectionCollections_universal_d_CreateDataCollectionResponse as CreateDataCollectionResponse, dataV2DataCollectionCollections_universal_d_GetDataCollectionRequest as GetDataCollectionRequest, dataV2DataCollectionCollections_universal_d_GetDataCollectionResponse as GetDataCollectionResponse, dataV2DataCollectionCollections_universal_d_ListDataCollectionsRequest as ListDataCollectionsRequest, dataV2DataCollectionCollections_universal_d_Sorting as Sorting, dataV2DataCollectionCollections_universal_d_SortOrder as SortOrder, Paging$1 as Paging, dataV2DataCollectionCollections_universal_d_ListDataCollectionsResponse as ListDataCollectionsResponse, dataV2DataCollectionCollections_universal_d_PagingMetadataV2 as PagingMetadataV2, dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, dataV2DataCollectionCollections_universal_d_UpdateDataCollectionRequest as UpdateDataCollectionRequest, dataV2DataCollectionCollections_universal_d_UpdateDataCollectionResponse as UpdateDataCollectionResponse, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionRequest as DeleteDataCollectionRequest, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionResponse as DeleteDataCollectionResponse, dataV2DataCollectionCollections_universal_d_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, dataV2DataCollectionCollections_universal_d_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, dataV2DataCollectionCollections_universal_d_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, dataV2DataCollectionCollections_universal_d_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, dataV2DataCollectionCollections_universal_d_SnapshotCollection as SnapshotCollection, dataV2DataCollectionCollections_universal_d_Index as Index, dataV2DataCollectionCollections_universal_d_Order as Order, dataV2DataCollectionCollections_universal_d_IndexField as IndexField, dataV2DataCollectionCollections_universal_d_IndexStatus as IndexStatus, dataV2DataCollectionCollections_universal_d_Failure as Failure, dataV2DataCollectionCollections_universal_d_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, dataV2DataCollectionCollections_universal_d_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, dataV2DataCollectionCollections_universal_d_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, dataV2DataCollectionCollections_universal_d_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, dataV2DataCollectionCollections_universal_d_createDataCollection as createDataCollection, dataV2DataCollectionCollections_universal_d_getDataCollection as getDataCollection, dataV2DataCollectionCollections_universal_d_GetDataCollectionOptions as GetDataCollectionOptions, dataV2DataCollectionCollections_universal_d_listDataCollections as listDataCollections, dataV2DataCollectionCollections_universal_d_ListDataCollectionsOptions as ListDataCollectionsOptions, dataV2DataCollectionCollections_universal_d_BulkGetDataCollectionsOptions as BulkGetDataCollectionsOptions, dataV2DataCollectionCollections_universal_d_updateDataCollection as updateDataCollection, dataV2DataCollectionCollections_universal_d_deleteDataCollection as deleteDataCollection, dataV2DataCollectionCollections_universal_d_CreateDataCollectionFieldOptions as CreateDataCollectionFieldOptions, dataV2DataCollectionCollections_universal_d_UpdateDataCollectionFieldOptions as UpdateDataCollectionFieldOptions, dataV2DataCollectionCollections_universal_d_DeleteDataCollectionFieldOptions as DeleteDataCollectionFieldOptions, };\n }\n /** An external database connection defines a connection between an external database and a Wix site. */\n interface ExternalDatabaseConnection {\n /**\n * Name of the external database connection.\n *\n * An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`.\n */\n name?: string;\n /** Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`. */\n endpoint?: string | null;\n /**\n * Settings specified to the external database connection as part of each request.\n *\n * These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API.\n */\n configuration?: Record | null;\n /**\n * Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.\n * @readonly\n */\n connectionStatus?: ConnectionStatus;\n /**\n * Public key used to validate requests to the external database.\n * @readonly\n */\n publicKey?: string | null;\n /**\n * Capabilities of the external database.\n * @readonly\n */\n capabilities?: Capabilities;\n }\n enum CauseOfFailure {\n /** No connection failure. */\n NONE = \"NONE\",\n /** General communication failure. */\n COMMUNICATION_FAILURE = \"COMMUNICATION_FAILURE\",\n /** External database host is unreachable. */\n DESTINATION_HOST_UNREACHABLE = \"DESTINATION_HOST_UNREACHABLE\",\n /** Unauthorized to access the external database. */\n UNAUTHORIZED = \"UNAUTHORIZED\",\n /** `endpoint` is not set. */\n DESTINATION_ENDPOINT_NOT_DEFINED = \"DESTINATION_ENDPOINT_NOT_DEFINED\"\n }\n enum CollectionsFound {\n /** Attempt to connect to the external database failed, so status is unknown. */\n UNKNOWN = \"UNKNOWN\",\n /** External database has collections. */\n YES = \"YES\",\n /** External database does not have any collections. */\n NO = \"NO\"\n }\n enum FieldType {\n UNKNOWN_FIELD_TYPE = \"UNKNOWN_FIELD_TYPE\",\n TEXT = \"TEXT\",\n NUMBER = \"NUMBER\",\n DATE = \"DATE\",\n DATETIME = \"DATETIME\",\n IMAGE = \"IMAGE\",\n BOOLEAN = \"BOOLEAN\",\n DOCUMENT = \"DOCUMENT\",\n URL = \"URL\",\n RICH_TEXT = \"RICH_TEXT\",\n VIDEO = \"VIDEO\",\n ANY = \"ANY\",\n ARRAY_STRING = \"ARRAY_STRING\",\n ARRAY_DOCUMENT = \"ARRAY_DOCUMENT\",\n AUDIO = \"AUDIO\",\n TIME = \"TIME\",\n LANGUAGE = \"LANGUAGE\",\n RICH_CONTENT = \"RICH_CONTENT\",\n MEDIA_GALLERY = \"MEDIA_GALLERY\",\n ADDRESS = \"ADDRESS\",\n PAGE_LINK = \"PAGE_LINK\",\n REFERENCE = \"REFERENCE\",\n MULTI_REFERENCE = \"MULTI_REFERENCE\",\n OBJECT = \"OBJECT\",\n ARRAY = \"ARRAY\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_TIME = \"LEGACY_TIME\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_BOOK = \"LEGACY_BOOK\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_EXTERNAL_URL = \"LEGACY_EXTERNAL_URL\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_BROKEN_REFERENCE = \"LEGACY_BROKEN_REFERENCE\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_IMAGE = \"LEGACY_IMAGE\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_COLOR = \"LEGACY_COLOR\",\n /** Deprecated - can’t be added to collections. Can only appear in older collections. */\n LEGACY_EXTERNAL_VIDEO = \"LEGACY_EXTERNAL_VIDEO\"\n }\n interface ConnectionStatus {\n /** Whether the connection was established successfully. */\n successful?: boolean;\n /** Whether and why the connection attempt failed. */\n causeOfFailure?: CauseOfFailure;\n /**\n * Whether the external database has collections.\n * @readonly\n */\n hasCollections?: CollectionsFound;\n }\n enum ProtocolVersion {\n UNKNOWN_PROTOCOL_VERSION = \"UNKNOWN_PROTOCOL_VERSION\",\n V1 = \"V1\",\n V2 = \"V2\",\n V3 = \"V3\"\n }\n interface Capabilities {\n /** Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. */\n collectionModificationsSupported?: boolean;\n /** Field types the external database supports. Applies only when `collectionModificationsSupported` is set to `true`. */\n fieldTypes?: FieldType[];\n }\n interface GetExternalDatabaseConnectionRequest {\n /** Name of the external database connection to retrieve. */\n name: string;\n }\n interface GetExternalDatabaseConnectionResponse {\n /** Details of the retrieved external database connection. */\n externalDatabaseConnection?: ExternalDatabaseConnection;\n }\n interface ListExternalDatabaseConnectionsRequest {\n /** Paging metadata. */\n paging?: Paging;\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface ListExternalDatabaseConnectionsResponse {\n /** List of external database connections. */\n externalDatabaseConnections?: ExternalDatabaseConnection[];\n /** Paging metadata. */\n pagingMetadata?: PagingMetadata;\n }\n interface PagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n }\n interface CreateExternalDatabaseConnectionRequest {\n /** External database connection details. */\n externalDatabaseConnection: ExternalDatabaseConnection;\n /**\n * Connection type. The connection type determines the type of adaptor by which the external collection is integrated with the site.\n *\n * Learn more about [external database adaptors](https://dev.wix.com/docs/rest/business-solutions/cms/external-database-connection/introduction#about-external-database-adaptors).\n */\n connectionType: ConnectionType;\n }\n enum ConnectionType {\n /** Unknown connection type. */\n UNKNOWN_CONNECTION_TYPE = \"UNKNOWN_CONNECTION_TYPE\",\n /** External database connection based on the legacy [external database collection service plugin](https://dev.wix.com/docs/velo/api-reference/wix-data-v2/service-plugins-spis/external-database-collection-legacy/introduction). */\n STANDALONE = \"STANDALONE\",\n /** External database connection based on the [external database service plugin](https://dev.wix.com/docs/rest/business-solutions/cms/service-plugins/external-database-service-plugin/introduction). */\n WIX_SERVICE_PLUGIN = \"WIX_SERVICE_PLUGIN\"\n }\n interface CreateExternalDatabaseConnectionResponse {\n /** Details of the created external database connection. */\n externalDatabaseConnection?: ExternalDatabaseConnection;\n }\n interface UpdateExternalDatabaseConnectionRequest {\n /** Updated external database connection. The existing connection is replaced with this version. */\n externalDatabaseConnection: ExternalDatabaseConnection;\n }\n interface UpdateExternalDatabaseConnectionResponse {\n /** Details of the updated external database connection. */\n externalDatabaseConnection?: ExternalDatabaseConnection;\n }\n interface DeleteExternalDatabaseConnectionRequest {\n /** Name of the external database connection to delete. */\n name: string;\n }\n interface DeleteExternalDatabaseConnectionResponse {\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves the specified external database connection.\n * @param name - Name of the external database connection to retrieve.\n * @public\n * @requiredField name\n * @permissionId WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION\n * @permissionScope Manage External Database Connections\n * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE\n * @permissionScope Manage All Data Resources\n * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL\n * @applicableIdentity APP\n * @adminMethod\n * @returns Details of the retrieved external database connection.\n * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.GetExternalDatabaseConnection\n */\n function getExternalDatabaseConnection(name: string): Promise;\n /**\n * Lists the site's external database connections.\n *\n * > **Note**: The method lists both [adaptor types](https://dev.wix.com/docs/rest/business-solutions/cms/external-database-connection/introduction#about-external-database-adaptors).\n * @public\n * @permissionId WIX_DATA.LIST_EXTERNAL_DATABASE_CONNECTIONS\n * @permissionScope Manage External Database Connections\n * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE\n * @permissionScope Manage All Data Resources\n * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.ListExternalDatabaseConnections\n */\n function listExternalDatabaseConnections(options?: ListExternalDatabaseConnectionsOptions): Promise;\n interface ListExternalDatabaseConnectionsOptions {\n /** Paging metadata. */\n paging?: Paging;\n }\n /**\n * Creates a new external database connection.\n *\n * The `externalDatabaseConnection` parameter must include a `name`, `endpoint`, and `configuration` details for the external database.\n * If any of these are missing, the external database connection isn't created.\n * @param externalDatabaseConnection - External database connection details.\n * @param connectionType - Connection type. The connection type determines the type of adaptor by which the external collection is integrated with the site.\n *\n * Learn more about [external database adaptors](https://dev.wix.com/docs/rest/business-solutions/cms/external-database-connection/introduction#about-external-database-adaptors).\n * @public\n * @requiredField connectionType\n * @requiredField externalDatabaseConnection\n * @requiredField externalDatabaseConnection.name\n * @param options - Options for creating an external database connection.\n * @permissionId WIX_DATA.CREATE_EXTERNAL_DATABASE_CONNECTION\n * @permissionScope Manage External Database Connections\n * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE\n * @permissionScope Manage All Data Resources\n * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL\n * @applicableIdentity APP\n * @adminMethod\n * @returns Details of the created external database connection.\n * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.CreateExternalDatabaseConnection\n */\n function createExternalDatabaseConnection(externalDatabaseConnection: ExternalDatabaseConnection, connectionType: ConnectionType, options?: CreateExternalDatabaseConnectionOptions): Promise;\n interface CreateExternalDatabaseConnectionOptions {\n }\n /**\n * Updates an external database connection.\n *\n * An external database collection name must be provided in `name`.\n * If an existing external database connection is found with the same name, that connection's details are updated.\n * If no external database connection has that name, the request fails.\n *\n * > **Note:** After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.\n * @param name - Name of the external database connection.\n *\n * An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`.\n * @public\n * @requiredField externalDatabaseConnection\n * @requiredField name\n * @param options - Options for updating an external database connection.\n * @param externalDatabaseConnection - Updated external database connection details. The existing connection is replaced with this version.\n * @permissionId WIX_DATA.UPDATE_EXTERNAL_DATABASE_CONNECTION\n * @permissionScope Manage External Database Connections\n * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE\n * @permissionScope Manage All Data Resources\n * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL\n * @applicableIdentity APP\n * @adminMethod\n * @returns Details of the updated external database connection.\n * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.UpdateExternalDatabaseConnection\n */\n function updateExternalDatabaseConnection(name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection): Promise;\n interface UpdateExternalDatabaseConnection {\n /** Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`. */\n endpoint?: string | null;\n /**\n * Settings specified to the external database connection as part of each request.\n *\n * These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API.\n */\n configuration?: Record | null;\n /**\n * Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.\n * @readonly\n */\n connectionStatus?: ConnectionStatus;\n /**\n * Public key used to validate requests to the external database.\n * @readonly\n */\n publicKey?: string | null;\n /**\n * Capabilities of the external database.\n * @readonly\n */\n capabilities?: Capabilities;\n }\n /**\n * Deletes an external database connection.\n *\n * > **Note:** Once an external database connection is deleted, it can't be restored. To reconnect the database you need to create a new external database connection.\n * @param name - Name of the external database connection to delete.\n * @public\n * @requiredField name\n * @permissionId WIX_DATA.DELETE_EXTERNAL_DATABASE_CONNECTION\n * @permissionScope Manage External Database Connections\n * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE\n * @permissionScope Manage All Data Resources\n * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.DeleteExternalDatabaseConnection\n */\n function deleteExternalDatabaseConnection(name: string): Promise;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ExternalDatabaseConnection = ExternalDatabaseConnection;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CauseOfFailure = CauseOfFailure;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CauseOfFailure: typeof CauseOfFailure;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CollectionsFound = CollectionsFound;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CollectionsFound: typeof CollectionsFound;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_FieldType = FieldType;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_FieldType: typeof FieldType;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ConnectionStatus = ConnectionStatus;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ProtocolVersion = ProtocolVersion;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ProtocolVersion: typeof ProtocolVersion;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_Capabilities = Capabilities;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_GetExternalDatabaseConnectionRequest = GetExternalDatabaseConnectionRequest;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_GetExternalDatabaseConnectionResponse = GetExternalDatabaseConnectionResponse;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ListExternalDatabaseConnectionsRequest = ListExternalDatabaseConnectionsRequest;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_Paging = Paging;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ListExternalDatabaseConnectionsResponse = ListExternalDatabaseConnectionsResponse;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_PagingMetadata = PagingMetadata;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CreateExternalDatabaseConnectionRequest = CreateExternalDatabaseConnectionRequest;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ConnectionType = ConnectionType;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ConnectionType: typeof ConnectionType;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CreateExternalDatabaseConnectionResponse = CreateExternalDatabaseConnectionResponse;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_UpdateExternalDatabaseConnectionRequest = UpdateExternalDatabaseConnectionRequest;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_UpdateExternalDatabaseConnectionResponse = UpdateExternalDatabaseConnectionResponse;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DeleteExternalDatabaseConnectionRequest = DeleteExternalDatabaseConnectionRequest;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DeleteExternalDatabaseConnectionResponse = DeleteExternalDatabaseConnectionResponse;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DomainEvent = DomainEvent;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_RestoreInfo = RestoreInfo;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ActionEvent = ActionEvent;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_MessageEnvelope = MessageEnvelope;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_IdentificationData = IdentificationData;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_WebhookIdentityType = WebhookIdentityType;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_listExternalDatabaseConnections: typeof listExternalDatabaseConnections;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ListExternalDatabaseConnectionsOptions = ListExternalDatabaseConnectionsOptions;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CreateExternalDatabaseConnectionOptions = CreateExternalDatabaseConnectionOptions;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;\n type dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_UpdateExternalDatabaseConnection = UpdateExternalDatabaseConnection;\n const dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;\n namespace dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d {\n export { dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ExternalDatabaseConnection as ExternalDatabaseConnection, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CauseOfFailure as CauseOfFailure, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CollectionsFound as CollectionsFound, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_FieldType as FieldType, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ConnectionStatus as ConnectionStatus, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ProtocolVersion as ProtocolVersion, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_Capabilities as Capabilities, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_GetExternalDatabaseConnectionRequest as GetExternalDatabaseConnectionRequest, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_GetExternalDatabaseConnectionResponse as GetExternalDatabaseConnectionResponse, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ListExternalDatabaseConnectionsRequest as ListExternalDatabaseConnectionsRequest, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_Paging as Paging, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ListExternalDatabaseConnectionsResponse as ListExternalDatabaseConnectionsResponse, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_PagingMetadata as PagingMetadata, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CreateExternalDatabaseConnectionRequest as CreateExternalDatabaseConnectionRequest, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ConnectionType as ConnectionType, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CreateExternalDatabaseConnectionResponse as CreateExternalDatabaseConnectionResponse, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_UpdateExternalDatabaseConnectionRequest as UpdateExternalDatabaseConnectionRequest, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_UpdateExternalDatabaseConnectionResponse as UpdateExternalDatabaseConnectionResponse, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DeleteExternalDatabaseConnectionRequest as DeleteExternalDatabaseConnectionRequest, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DeleteExternalDatabaseConnectionResponse as DeleteExternalDatabaseConnectionResponse, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DomainEvent as DomainEvent, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_EntityCreatedEvent as EntityCreatedEvent, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_RestoreInfo as RestoreInfo, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_EntityDeletedEvent as EntityDeletedEvent, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ActionEvent as ActionEvent, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_MessageEnvelope as MessageEnvelope, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_IdentificationData as IdentificationData, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_WebhookIdentityType as WebhookIdentityType, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_getExternalDatabaseConnection as getExternalDatabaseConnection, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_listExternalDatabaseConnections as listExternalDatabaseConnections, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_ListExternalDatabaseConnectionsOptions as ListExternalDatabaseConnectionsOptions, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_createExternalDatabaseConnection as createExternalDatabaseConnection, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_CreateExternalDatabaseConnectionOptions as CreateExternalDatabaseConnectionOptions, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_updateExternalDatabaseConnection as updateExternalDatabaseConnection, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_UpdateExternalDatabaseConnection as UpdateExternalDatabaseConnection, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, };\n }\n export { dataV2DataCollectionCollections_universal_d as collections, dataV1ExternalDatabaseConnectionExternalDatabaseConnections_universal_d as externalDatabaseConnections, dataV2IndexIndexes_universal_d as indexes };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-application-backend.d.ts", "content": "declare module \"wix-application-backend\" {\n const getDecodedAppInstance: () => Promise | null>;\n export { getDecodedAppInstance };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-workflows.v2.d.ts", "content": "declare module \"wix-workflows.v2\" {\n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Card$2 {\n /** Card details. */\n info?: CardInfo$2;\n }\n /** entity representing a card-info */\n interface CardInfo$2 {\n /**\n * Card ID.\n * @readonly\n */\n _id?: string | null;\n /** Display name shown at the top of the card. */\n name?: string | null;\n /** Card description. */\n description?: string | null;\n /** Details about the contact attached to the card. */\n primaryAttachment?: Attachment$2;\n /** Due date. */\n dueDate?: Date;\n /** Name of the app or service that created the contact. */\n source?: string | null;\n /**\n * ID of the phase that currently holds the card.\n * @readonly\n */\n phaseId?: string | null;\n /**\n * Date and time the card was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the card was updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface Attachment$2 {\n /**\n * Attachment ID. For internal use.\n * @readonly\n */\n attachmentId?: string;\n /** ID of the contact attached to the card. */\n contactId?: string;\n }\n /** describes the supported types of attachments (currently only supports Contact which is the default type) */\n enum AttachmentType$2 {\n ContactType = \"ContactType\"\n }\n interface QueryCardsRequest {\n /** Query, sort, and paging options. */\n query?: Query$2;\n }\n interface Query$2 {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$2[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$2 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryCardsResponse {\n /** List of cards that matched the query criteria. */\n cards?: Card$2[];\n /** Metadata for the page of results. */\n pagination?: PaginationResponse$2;\n }\n interface PaginationResponse$2 {\n /** Number of items that were skipped in the current sort order. */\n offset?: number;\n /** Total number of items that matched the filter. */\n total?: number;\n /** Number of returned items. */\n count?: number;\n }\n interface ListCardsRequest {\n /** ID of the workflow whose cards will be listed. */\n workflowId: string;\n /** Filters for cards in the specified phase. */\n phaseId?: string | null;\n /**\n * Number of items to return.\n *\n * Defaults to `50`.\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n /** Filters for cards with the specified contact ID. */\n attachmentValue?: string | null;\n /**\n * Filters for archived cards.\n * If set to `true`,\n * only archived cards are returned.\n * If set to `false`,\n * only cards that are not archived are returned.\n *\n * Defaults to `false`.\n */\n fetchArchived?: boolean | null;\n /**\n * Supported fields:\n * `id`, `name`, `createdDate`, `updatedDate`, `phaseId`\n *\n * List of fields to sort by.\n * Formatted as `field:direction`,\n * where field is the field name\n * and direction is `asc` (ascending) or `desc` (descending).\n *\n * Sorting is applied lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n */\n sort?: string[];\n }\n interface ListCardsResponse {\n /** List of cards. */\n cards?: Card$2[];\n /** Metadata for the page of results. */\n pagination?: PaginationResponse$2;\n }\n interface GetCardRequest {\n /** ID of the card to retrieve. */\n _id: string;\n }\n interface GetCardResponse {\n /** Requested card. */\n card?: Card$2;\n }\n interface UpdateCardRequest {\n /** ID of the card to update. */\n _id: string;\n /** Card details. */\n cardInfo?: CardInfo$2;\n }\n interface UpdateCardResponse {\n }\n interface CreateCardRequest {\n /** ID of the workflow to create the card in. */\n workflowId: string;\n /** ID of the phase to create the card in. */\n phaseId: string;\n /** Card details. */\n card?: CardInfo$2;\n /**\n * Card position, where the first card is `0`.\n *\n * If a card already occupies the specified position,\n * that card and any subsequent cards are shifted to the right by 1.\n *\n * Defaults to the last position.\n */\n position?: number | null;\n }\n interface CreateCardResponse {\n /** ID of the newly created card. */\n _id?: string | null;\n }\n interface DeleteCardRequest {\n /** ID of the card to delete. */\n _id: string;\n }\n interface DeleteCardResponse {\n }\n interface MoveCardRequest {\n /** ID of the card to move. */\n _id: string;\n /** ID of the phase to move the card to. */\n newPhaseId?: string | null;\n /** Position of the card in the phase, where the first card is `0`. */\n newPosition?: number | null;\n }\n interface MoveCardResponse {\n }\n interface RestoreCardRequest {\n /** ID of the card to restore. */\n _id: string;\n /** ID of the phase to restore the card to. */\n newPhaseId: string;\n /**\n * Position of the restored card in the phase,\n * where the first card is `0`.\n */\n newPosition?: number | null;\n }\n interface RestoreCardResponse {\n }\n interface ArchiveCardRequest {\n /** ID of the card to archive. */\n _id: string;\n }\n interface ArchiveCardResponse {\n }\n interface QueryCardsOptions {\n /** Query, sort, and paging options. */\n query?: Query$2;\n }\n /**\n * Retrieves a list of a workflow's cards.\n *\n *\n * The `listCards()` function returns a Promise that resolves to a list of the specified workflow's cards.\n *\n *\n * Use the `options` parameter to specify which cards to retrieve and in which order to retrieve them. Must use either `phaseId` or `fetchOnlyArchived`.\n *\n *\n * Cards can be sorted based on their `\"id\"`, `\"name\"`, `\"phaseId\"`, `\"createdDate\"`, `\"updatedDate\"`, `\"source\"`, and `\"position\"`.\n *\n *\n * If no `limit` parameter is passed, the first 50 cards are returned.\n *\n *\n * Sort order defaults to by `\"phaseId\"` and then by `\"position\"` ascending.\n *\n *\n * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param workflowId - ID of the workflow whose cards will be listed.\n * @public\n * @requiredField workflowId\n * @param options - Options to use when retrieving the list of cards.\n * @adminMethod\n */\n function listCards(workflowId: string, options?: ListCardsOptions): Promise;\n interface ListCardsOptions {\n /** Filters for cards in the specified phase. */\n phaseId?: string | null;\n /**\n * Number of items to return.\n *\n * Defaults to `50`.\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n /** Filters for cards with the specified contact ID. */\n attachmentValue?: string | null;\n /**\n * Filters for archived cards.\n * If set to `true`,\n * only archived cards are returned.\n * If set to `false`,\n * only cards that are not archived are returned.\n *\n * Defaults to `false`.\n */\n fetchArchived?: boolean | null;\n /**\n * Supported fields:\n * `id`, `name`, `createdDate`, `updatedDate`, `phaseId`\n *\n * List of fields to sort by.\n * Formatted as `field:direction`,\n * where field is the field name\n * and direction is `asc` (ascending) or `desc` (descending).\n *\n * Sorting is applied lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n */\n sort?: string[];\n }\n /**\n * Retrieves a workflow card by ID.\n *\n *\n * The `getCard()` function returns a Promise that resolves to the card with the specified ID.\n *\n *\n * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the card to retrieve.\n * @public\n * @requiredField _id\n * @adminMethod\n */\n function getCard(_id: string): Promise;\n /**\n * Updates an existing workflow card.\n *\n *\n * The `updateCard()` function returns a Promise that resolves when the card has been updated with the specified values.\n *\n *\n * `contactId` is not a required field, but if the parameter is not passed, the field will default to empty and the card will not be associated with any contact.\n *\n *\n * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the card to update.\n * @param cardInfo - Card details.\n * @public\n * @requiredField _id\n * @requiredField cardInfo\n * @param options - Options to use when updating a card.\n * @adminMethod\n */\n function updateCard(_id: string, cardInfo: CardInfo$2, options?: UpdateCardOptions): Promise;\n interface UpdateCardOptions {\n }\n /**\n * Creates a new workflow card.\n *\n *\n * The `createCard()` function returns a Promise that resolves to the created card's ID when the card is created in the specified workflow phase.\n *\n * Pass a value for the `position` parameter to specify the newly created card's position within the specified phase. Positions are zero-based, meaning the first position is `0`.\n *\n * When omitted, the newly created card is added to the specified phase as the top card within the phase.\n *\n *\n * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * > **Note:**\n * > Each workflow is limited to 5,000 cards.\n * > If this limit is reached, `createCard()` throws an error.\n * > [Archive cards](#archivecard) when they're no longer needed\n * > to reduce card count and avoid hitting the limit.\n *\n * This function is not a universal function and runs only on the backend.\n * @param card - Card details.\n * @public\n * @requiredField card\n * @requiredField identifiers\n * @requiredField identifiers.phaseId\n * @requiredField identifiers.workflowId\n * @param options - Options to use when creating a card.\n * @adminMethod\n */\n function createCard(identifiers: CreateCardIdentifiers, card: CardInfo$2, options?: CreateCardOptions): Promise;\n interface CreateCardIdentifiers {\n /** ID of the workflow to create the card in. */\n workflowId: string;\n /** ID of the phase to create the card in. */\n phaseId: string;\n }\n interface CreateCardOptions {\n /**\n * Card position, where the first card is `0`.\n *\n * If a card already occupies the specified position,\n * that card and any subsequent cards are shifted to the right by 1.\n *\n * Defaults to the last position.\n */\n position?: number | null;\n }\n /**\n * Deletes a workflow card by ID.\n *\n *\n * The `deleteCard()` function returns a Promise when the specified card has been deleted.\n *\n * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the card to delete.\n * @public\n * @requiredField _id\n * @adminMethod\n */\n function deleteCard(_id: string): Promise;\n /**\n * Moves a card to a new position within a workflow.\n *\n *\n * The `moveCard()` function returns a Promise when the specified card has been moved to the new position.\n *\n * Use the `options` parameter to specify the phase and position within that phase to move the card to. Positions are zero-based, meaning the first position is `0`.\n *\n * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the card to move.\n * @public\n * @requiredField _id\n * @param options - Information about where to move the card.\n * @adminMethod\n */\n function moveCard(_id: string, options?: MoveCardOptions): Promise;\n interface MoveCardOptions {\n /** ID of the phase to move the card to. */\n newPhaseId?: string | null;\n /** Position of the card in the phase, where the first card is `0`. */\n newPosition?: number | null;\n }\n /**\n * Restores an archived workflow card.\n *\n *\n * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.\n *\n *\n * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n *\n * > **Note:**\n * > Each workflow is limited to 5,000 cards.\n * > If this limit is reached, `createCard()` throws an error.\n * > [Archive cards](#archivecard) when they're no longer needed\n * > to reduce card count and avoid hitting the limit.\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the card to restore.\n * @param newPhaseId - ID of the phase to restore the card to.\n * @public\n * @requiredField _id\n * @requiredField newPhaseId\n * @param options - Options to use when restoring a card.\n * @adminMethod\n */\n function restoreCard(_id: string, newPhaseId: string, options?: RestoreCardOptions): Promise;\n interface RestoreCardOptions {\n /**\n * Position of the restored card in the phase,\n * where the first card is `0`.\n */\n newPosition?: number | null;\n }\n /**\n * Archives a workflow card.\n *\n *\n * The `archiveCard()` function returns a Promise that resolves when the card has been archived.\n *\n *\n * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the card to archive.\n * @public\n * @requiredField _id\n * @adminMethod\n */\n function archiveCard(_id: string): Promise;\n type workflowsV1Card_universal_d_QueryCardsRequest = QueryCardsRequest;\n type workflowsV1Card_universal_d_QueryCardsResponse = QueryCardsResponse;\n type workflowsV1Card_universal_d_ListCardsRequest = ListCardsRequest;\n type workflowsV1Card_universal_d_ListCardsResponse = ListCardsResponse;\n type workflowsV1Card_universal_d_GetCardRequest = GetCardRequest;\n type workflowsV1Card_universal_d_GetCardResponse = GetCardResponse;\n type workflowsV1Card_universal_d_UpdateCardRequest = UpdateCardRequest;\n type workflowsV1Card_universal_d_UpdateCardResponse = UpdateCardResponse;\n type workflowsV1Card_universal_d_CreateCardRequest = CreateCardRequest;\n type workflowsV1Card_universal_d_CreateCardResponse = CreateCardResponse;\n type workflowsV1Card_universal_d_DeleteCardRequest = DeleteCardRequest;\n type workflowsV1Card_universal_d_DeleteCardResponse = DeleteCardResponse;\n type workflowsV1Card_universal_d_MoveCardRequest = MoveCardRequest;\n type workflowsV1Card_universal_d_MoveCardResponse = MoveCardResponse;\n type workflowsV1Card_universal_d_RestoreCardRequest = RestoreCardRequest;\n type workflowsV1Card_universal_d_RestoreCardResponse = RestoreCardResponse;\n type workflowsV1Card_universal_d_ArchiveCardRequest = ArchiveCardRequest;\n type workflowsV1Card_universal_d_ArchiveCardResponse = ArchiveCardResponse;\n type workflowsV1Card_universal_d_QueryCardsOptions = QueryCardsOptions;\n const workflowsV1Card_universal_d_listCards: typeof listCards;\n type workflowsV1Card_universal_d_ListCardsOptions = ListCardsOptions;\n const workflowsV1Card_universal_d_getCard: typeof getCard;\n const workflowsV1Card_universal_d_updateCard: typeof updateCard;\n type workflowsV1Card_universal_d_UpdateCardOptions = UpdateCardOptions;\n const workflowsV1Card_universal_d_createCard: typeof createCard;\n type workflowsV1Card_universal_d_CreateCardIdentifiers = CreateCardIdentifiers;\n type workflowsV1Card_universal_d_CreateCardOptions = CreateCardOptions;\n const workflowsV1Card_universal_d_deleteCard: typeof deleteCard;\n const workflowsV1Card_universal_d_moveCard: typeof moveCard;\n type workflowsV1Card_universal_d_MoveCardOptions = MoveCardOptions;\n const workflowsV1Card_universal_d_restoreCard: typeof restoreCard;\n type workflowsV1Card_universal_d_RestoreCardOptions = RestoreCardOptions;\n const workflowsV1Card_universal_d_archiveCard: typeof archiveCard;\n namespace workflowsV1Card_universal_d {\n export { __debug$2 as __debug, Card$2 as Card, CardInfo$2 as CardInfo, Attachment$2 as Attachment, AttachmentType$2 as AttachmentType, workflowsV1Card_universal_d_QueryCardsRequest as QueryCardsRequest, Query$2 as Query, Sorting$2 as Sorting, SortOrder$2 as SortOrder, Paging$2 as Paging, workflowsV1Card_universal_d_QueryCardsResponse as QueryCardsResponse, PaginationResponse$2 as PaginationResponse, workflowsV1Card_universal_d_ListCardsRequest as ListCardsRequest, workflowsV1Card_universal_d_ListCardsResponse as ListCardsResponse, workflowsV1Card_universal_d_GetCardRequest as GetCardRequest, workflowsV1Card_universal_d_GetCardResponse as GetCardResponse, workflowsV1Card_universal_d_UpdateCardRequest as UpdateCardRequest, workflowsV1Card_universal_d_UpdateCardResponse as UpdateCardResponse, workflowsV1Card_universal_d_CreateCardRequest as CreateCardRequest, workflowsV1Card_universal_d_CreateCardResponse as CreateCardResponse, workflowsV1Card_universal_d_DeleteCardRequest as DeleteCardRequest, workflowsV1Card_universal_d_DeleteCardResponse as DeleteCardResponse, workflowsV1Card_universal_d_MoveCardRequest as MoveCardRequest, workflowsV1Card_universal_d_MoveCardResponse as MoveCardResponse, workflowsV1Card_universal_d_RestoreCardRequest as RestoreCardRequest, workflowsV1Card_universal_d_RestoreCardResponse as RestoreCardResponse, workflowsV1Card_universal_d_ArchiveCardRequest as ArchiveCardRequest, workflowsV1Card_universal_d_ArchiveCardResponse as ArchiveCardResponse, workflowsV1Card_universal_d_QueryCardsOptions as QueryCardsOptions, workflowsV1Card_universal_d_listCards as listCards, workflowsV1Card_universal_d_ListCardsOptions as ListCardsOptions, workflowsV1Card_universal_d_getCard as getCard, workflowsV1Card_universal_d_updateCard as updateCard, workflowsV1Card_universal_d_UpdateCardOptions as UpdateCardOptions, workflowsV1Card_universal_d_createCard as createCard, workflowsV1Card_universal_d_CreateCardIdentifiers as CreateCardIdentifiers, workflowsV1Card_universal_d_CreateCardOptions as CreateCardOptions, workflowsV1Card_universal_d_deleteCard as deleteCard, workflowsV1Card_universal_d_moveCard as moveCard, workflowsV1Card_universal_d_MoveCardOptions as MoveCardOptions, workflowsV1Card_universal_d_restoreCard as restoreCard, workflowsV1Card_universal_d_RestoreCardOptions as RestoreCardOptions, workflowsV1Card_universal_d_archiveCard as archiveCard, };\n }\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Phase$1 {\n /** Phase information. */\n info?: PhaseInfo$1;\n /** Cards contained in the phase. */\n cardsList?: CardsList$1;\n }\n interface PhaseInfo$1 {\n /**\n * Phase ID.\n * @readonly\n */\n _id?: string | null;\n /** Display name shown at the top of the phase. */\n name?: string | null;\n }\n /** a list of cards (a page) along with the total number */\n interface CardsList$1 {\n /** Total number of cards in the phase. */\n total?: number;\n /**\n * List of cards in the phase.\n * Sorted according to the card display order, from top to bottom.\n */\n cards?: Card$1[];\n }\n interface Card$1 {\n /** Card details. */\n info?: CardInfo$1;\n }\n /** entity representing a card-info */\n interface CardInfo$1 {\n /**\n * Card ID.\n * @readonly\n */\n _id?: string | null;\n /** Display name shown at the top of the card. */\n name?: string | null;\n /** Card description. */\n description?: string | null;\n /** Details about the contact attached to the card. */\n primaryAttachment?: Attachment$1;\n /** Due date. */\n dueDate?: Date;\n /** Name of the app or service that created the contact. */\n source?: string | null;\n /**\n * ID of the phase that currently holds the card.\n * @readonly\n */\n phaseId?: string | null;\n /**\n * Date and time the card was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the card was updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface Attachment$1 {\n /**\n * Attachment ID. For internal use.\n * @readonly\n */\n attachmentId?: string;\n /** ID of the contact attached to the card. */\n contactId?: string;\n }\n /** describes the supported types of attachments (currently only supports Contact which is the default type) */\n enum AttachmentType$1 {\n ContactType = \"ContactType\"\n }\n interface QueryPhasesRequest {\n /** Query, sort, and paging options. */\n query?: Query$1;\n }\n interface Query$1 {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$1[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryPhasesResponse {\n /** List of phases that matched the query criteria. */\n phases?: Phase$1[];\n /** Metadata for the page of results. */\n pagination?: PaginationResponse$1;\n }\n interface PaginationResponse$1 {\n /** Number of items that were skipped in the current sort order. */\n offset?: number;\n /** Total number of items that matched the filter. */\n total?: number;\n /** Number of returned items. */\n count?: number;\n }\n interface ListPhasesRequest {\n /** ID of the workflow whose phases will be listed. */\n workflowId: string;\n /** Number of items to return. */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n /**\n * Supported fields:\n * `id`, `name`\n *\n * List of fields to sort by.\n * Formatted as `field:direction`,\n * where field is the field name\n * and direction is `asc` (ascending) or `desc` (descending).\n *\n * Sorting is applied lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n */\n sort?: string[];\n }\n interface ListPhasesResponse {\n /** List of phases. */\n phases?: Phase$1[];\n /** Metadata for the page of results. */\n pagination?: PaginationResponse$1;\n }\n interface GetPhaseRequest {\n /** ID of the phase to retrieve. */\n _id: string;\n }\n interface GetPhaseResponse {\n /** Requested phase. */\n phase?: Phase$1;\n }\n interface UpdatePhaseRequest {\n /** ID of the phase to update. */\n _id: string;\n /** Phase details to update. */\n phase?: PhaseInfo$1;\n }\n interface UpdatePhaseResponse {\n }\n interface CreatePhaseRequest {\n /** ID of the workflow to create the phase in. */\n workflowId: string;\n /** Phase details. */\n phase?: PhaseInfo$1;\n /**\n * Phase position, where the first phase is `0`.\n *\n * If a phase already occupies the specified position,\n * that phase and any subsequent phases\n * are shifted to the right by 1.\n *\n * Defaults to the last position,\n * which is displayed before the win phase.\n */\n position?: number | null;\n }\n interface CreatePhaseResponse {\n /** ID of the newly created phase. */\n _id?: string | null;\n }\n interface DeletePhaseRequest {\n /** ID of the phase to delete. */\n _id: string;\n }\n interface DeletePhaseResponse {\n }\n interface MovePhaseRequest {\n /** ID of the workflow that contains the phase to move. */\n workflowId: string;\n /** ID of the phase to move. */\n _id: string;\n /**\n * New phase position, where the first phase is `0`.\n *\n * If a phase already occupies the specified position,\n * that phase and any subsequent phases\n * are shifted to the right by 1.\n */\n newPosition: number | null;\n }\n interface MovePhaseResponse {\n }\n interface QueryPhasesOptions {\n /** Query, sort, and paging options. */\n query?: Query$1;\n }\n /**\n * Retrieves a list of a workflow's phases.\n *\n *\n * The `listPhases()` function returns a Promise that resolves to a list containing information about the specified workflow's phases.\n *\n *\n * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `\"id\"`, `\"name\"`, and `\"position\"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `\"position\"` ascending.\n *\n *\n * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param workflowId - ID of the workflow whose phases will be listed.\n * @public\n * @requiredField workflowId\n * @param options - Options to use when retrieving the list of workflow phases.\n * @adminMethod\n */\n function listPhases(workflowId: string, options?: ListPhasesOptions): Promise;\n interface ListPhasesOptions {\n /** Number of items to return. */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n /**\n * Supported fields:\n * `id`, `name`\n *\n * List of fields to sort by.\n * Formatted as `field:direction`,\n * where field is the field name\n * and direction is `asc` (ascending) or `desc` (descending).\n *\n * Sorting is applied lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n */\n sort?: string[];\n }\n /**\n * Retrieves a phase by ID.\n *\n *\n * The `getPhase()` function returns a Promise that resolves to the phase with the specified ID.\n *\n * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the phase to retrieve.\n * @public\n * @requiredField _id\n * @adminMethod\n */\n function getPhase(_id: string): Promise;\n /**\n * Updates an existing workflow phase.\n *\n *\n * The `updatePhase()` function returns a Promise that resolves when the phase has been updated with the specified values.\n *\n *\n * Only the properties passed in the `phase` object will be updated. All other properties will remain the same.\n *\n *\n * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the phase to update.\n * @param phase - Phase details to update.\n * @public\n * @requiredField _id\n * @requiredField phase\n * @param options - Phase information to update.\n * @adminMethod\n */\n function updatePhase(_id: string, phase: PhaseInfo$1): Promise;\n /**\n * Creates a new workflow phase.\n *\n *\n * The `createPhase()` function returns a Promise that resolves to the created phase ID when the phase is created in the specified workflow.\n *\n *\n * Pass a value for the `position` parameter to specify the newly created phase's position within the specified workflow. Positions are zero-based, meaning the first position is `0`.\n *\n *\n * When omitted, the newly created phase is added as the last non-win phase.\n *\n *\n * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param workflowId - ID of the workflow to create the phase in.\n * @param phase - Phase details.\n * @public\n * @requiredField phase\n * @requiredField phase.name\n * @requiredField workflowId\n * @param options - Options to use when creating workflow phases.\n * @adminMethod\n */\n function createPhase(workflowId: string, phase: PhaseInfo$1, options?: CreatePhaseOptions): Promise;\n interface CreatePhaseOptions {\n /**\n * Phase position, where the first phase is `0`.\n *\n * If a phase already occupies the specified position,\n * that phase and any subsequent phases\n * are shifted to the right by 1.\n *\n * Defaults to the last position,\n * which is displayed before the win phase.\n */\n position?: number | null;\n }\n /**\n * Deletes a workflow phase.\n *\n *\n * The `deletePhase()` function returns a Promise when the specified phase has been deleted.\n *\n *\n * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the phase to delete.\n * @public\n * @requiredField _id\n * @adminMethod\n */\n function deletePhase(_id: string): Promise;\n /**\n * Moves a phase to a new position with a workflow.\n *\n *\n * The `movePhase()` function returns a Promise when the specified phase has been moved to the new position.\n *\n *\n * Use the `newPosition` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.\n *\n *\n * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param newPosition - New phase position, where the first phase is `0`.\n *\n * If a phase already occupies the specified position,\n * that phase and any subsequent phases\n * are shifted to the right by 1.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.id\n * @requiredField identifiers.workflowId\n * @requiredField newPosition\n * @adminMethod\n */\n function movePhase(identifiers: MovePhaseIdentifiers, newPosition: number | null): Promise;\n interface MovePhaseIdentifiers {\n /** ID of the workflow that contains the phase to move. */\n workflowId: string;\n /** ID of the phase to move. */\n _id: string;\n }\n type workflowsV1Phase_universal_d_QueryPhasesRequest = QueryPhasesRequest;\n type workflowsV1Phase_universal_d_QueryPhasesResponse = QueryPhasesResponse;\n type workflowsV1Phase_universal_d_ListPhasesRequest = ListPhasesRequest;\n type workflowsV1Phase_universal_d_ListPhasesResponse = ListPhasesResponse;\n type workflowsV1Phase_universal_d_GetPhaseRequest = GetPhaseRequest;\n type workflowsV1Phase_universal_d_GetPhaseResponse = GetPhaseResponse;\n type workflowsV1Phase_universal_d_UpdatePhaseRequest = UpdatePhaseRequest;\n type workflowsV1Phase_universal_d_UpdatePhaseResponse = UpdatePhaseResponse;\n type workflowsV1Phase_universal_d_CreatePhaseRequest = CreatePhaseRequest;\n type workflowsV1Phase_universal_d_CreatePhaseResponse = CreatePhaseResponse;\n type workflowsV1Phase_universal_d_DeletePhaseRequest = DeletePhaseRequest;\n type workflowsV1Phase_universal_d_DeletePhaseResponse = DeletePhaseResponse;\n type workflowsV1Phase_universal_d_MovePhaseRequest = MovePhaseRequest;\n type workflowsV1Phase_universal_d_MovePhaseResponse = MovePhaseResponse;\n type workflowsV1Phase_universal_d_QueryPhasesOptions = QueryPhasesOptions;\n const workflowsV1Phase_universal_d_listPhases: typeof listPhases;\n type workflowsV1Phase_universal_d_ListPhasesOptions = ListPhasesOptions;\n const workflowsV1Phase_universal_d_getPhase: typeof getPhase;\n const workflowsV1Phase_universal_d_updatePhase: typeof updatePhase;\n const workflowsV1Phase_universal_d_createPhase: typeof createPhase;\n type workflowsV1Phase_universal_d_CreatePhaseOptions = CreatePhaseOptions;\n const workflowsV1Phase_universal_d_deletePhase: typeof deletePhase;\n const workflowsV1Phase_universal_d_movePhase: typeof movePhase;\n type workflowsV1Phase_universal_d_MovePhaseIdentifiers = MovePhaseIdentifiers;\n namespace workflowsV1Phase_universal_d {\n export { __debug$1 as __debug, Phase$1 as Phase, PhaseInfo$1 as PhaseInfo, CardsList$1 as CardsList, Card$1 as Card, CardInfo$1 as CardInfo, Attachment$1 as Attachment, AttachmentType$1 as AttachmentType, workflowsV1Phase_universal_d_QueryPhasesRequest as QueryPhasesRequest, Query$1 as Query, Sorting$1 as Sorting, SortOrder$1 as SortOrder, Paging$1 as Paging, workflowsV1Phase_universal_d_QueryPhasesResponse as QueryPhasesResponse, PaginationResponse$1 as PaginationResponse, workflowsV1Phase_universal_d_ListPhasesRequest as ListPhasesRequest, workflowsV1Phase_universal_d_ListPhasesResponse as ListPhasesResponse, workflowsV1Phase_universal_d_GetPhaseRequest as GetPhaseRequest, workflowsV1Phase_universal_d_GetPhaseResponse as GetPhaseResponse, workflowsV1Phase_universal_d_UpdatePhaseRequest as UpdatePhaseRequest, workflowsV1Phase_universal_d_UpdatePhaseResponse as UpdatePhaseResponse, workflowsV1Phase_universal_d_CreatePhaseRequest as CreatePhaseRequest, workflowsV1Phase_universal_d_CreatePhaseResponse as CreatePhaseResponse, workflowsV1Phase_universal_d_DeletePhaseRequest as DeletePhaseRequest, workflowsV1Phase_universal_d_DeletePhaseResponse as DeletePhaseResponse, workflowsV1Phase_universal_d_MovePhaseRequest as MovePhaseRequest, workflowsV1Phase_universal_d_MovePhaseResponse as MovePhaseResponse, workflowsV1Phase_universal_d_QueryPhasesOptions as QueryPhasesOptions, workflowsV1Phase_universal_d_listPhases as listPhases, workflowsV1Phase_universal_d_ListPhasesOptions as ListPhasesOptions, workflowsV1Phase_universal_d_getPhase as getPhase, workflowsV1Phase_universal_d_updatePhase as updatePhase, workflowsV1Phase_universal_d_createPhase as createPhase, workflowsV1Phase_universal_d_CreatePhaseOptions as CreatePhaseOptions, workflowsV1Phase_universal_d_deletePhase as deletePhase, workflowsV1Phase_universal_d_movePhase as movePhase, workflowsV1Phase_universal_d_MovePhaseIdentifiers as MovePhaseIdentifiers, };\n }\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Workflow {\n /** Workflow information and metadata. */\n info?: WorkflowInfo;\n /**\n * Final phase of the workflow.\n * Cards in `winPhase` are treated as if they are not part of the workflow.\n *\n * Normally, a contact can be attached to only 1 card in the workflow.\n * Moving a contact's card to `winPhase`\n * frees up the contact to be attached to another card in the workflow.\n */\n winPhase?: Phase;\n /** Phases that make up the workflow. */\n phasesList?: PhasesList;\n }\n interface WorkflowInfo {\n /**\n * Workflow ID.\n * @readonly\n */\n _id?: string | null;\n /** Display name for the workflow. */\n name?: string | null;\n /**\n * Workflow description,\n * shown below the workflow's display name in the dashboard.\n */\n description?: string | null;\n /**\n * Indicates whether the workflow can be deleted.\n * @readonly\n */\n isDeletable?: boolean | null;\n /**\n * Date and time the workflow was created.\n * @readonly\n */\n _createdDate?: Date;\n }\n interface Phase {\n /** Phase information. */\n info?: PhaseInfo;\n /** Cards contained in the phase. */\n cardsList?: CardsList;\n }\n interface PhaseInfo {\n /**\n * Phase ID.\n * @readonly\n */\n _id?: string | null;\n /** Display name shown at the top of the phase. */\n name?: string | null;\n }\n /** a list of cards (a page) along with the total number */\n interface CardsList {\n /** Total number of cards in the phase. */\n total?: number;\n /**\n * List of cards in the phase.\n * Sorted according to the card display order, from top to bottom.\n */\n cards?: Card[];\n }\n interface Card {\n /** Card details. */\n info?: CardInfo;\n }\n /** entity representing a card-info */\n interface CardInfo {\n /**\n * Card ID.\n * @readonly\n */\n _id?: string | null;\n /** Display name shown at the top of the card. */\n name?: string | null;\n /** Card description. */\n description?: string | null;\n /** Details about the contact attached to the card. */\n primaryAttachment?: Attachment;\n /** Due date. */\n dueDate?: Date;\n /** Name of the app or service that created the contact. */\n source?: string | null;\n /**\n * ID of the phase that currently holds the card.\n * @readonly\n */\n phaseId?: string | null;\n /**\n * Date and time the card was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the card was updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface Attachment {\n /**\n * Attachment ID. For internal use.\n * @readonly\n */\n attachmentId?: string;\n /** ID of the contact attached to the card. */\n contactId?: string;\n }\n /** describes the supported types of attachments (currently only supports Contact which is the default type) */\n enum AttachmentType {\n ContactType = \"ContactType\"\n }\n /** a list of phases (a page) along with the total number */\n interface PhasesList {\n /** Total number of phases in the workflow, excluding `winPhase`. */\n total?: number;\n /**\n * List of phases in the workflow.\n * Sorted according to the phase display order, from left to right.\n */\n phases?: Phase[];\n }\n interface ListWorkflowsRequest {\n /**\n * Number of workflows to return.\n * If omitted, all results are returned.\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n /**\n * Supported fields:\n * `id`, `name`, `description`, `createdDate`\n *\n * List of fields to sort by.\n * Formatted as `field:direction`,\n * where field is the field name\n * and direction is `asc` (ascending) or `desc` (descending).\n *\n * Sorting is applied lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n */\n sort?: string[];\n }\n interface ListWorkflowsResponse {\n /** Retrieved list of workflows. */\n workflows?: WorkflowInfo[];\n /** Metadata for the page of results. */\n pagination?: PaginationResponse;\n }\n interface PaginationResponse {\n /** Number of items that were skipped in the current sort order. */\n offset?: number;\n /** Total number of items that matched the filter. */\n total?: number;\n /** Number of returned items. */\n count?: number;\n }\n interface QueryWorkflowsRequest {\n /** Query options. */\n query?: Query;\n }\n interface Query {\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryWorkflowsResponse {\n /** List of workflows that matched the query. */\n workflows?: Workflow[];\n /** Metadata for the paginated results. */\n pagination?: PaginationResponse;\n }\n interface GetWorkflowRequest {\n /** ID of the workflow to retrieve. */\n _id: string;\n /**\n * Maximum number of cards to return per phase.\n * To retrieve additional pages of cards, use\n * [List Cards](../cards/listCards)\n * (in the Cards API).\n */\n cardsPerPhase?: number | null;\n }\n interface GetWorkflowResponse {\n /** Requested workflow. */\n workflow?: Workflow;\n }\n interface UpdateWorkflowRequest {\n /** ID of the workflow to update. */\n _id: string;\n /** Workflow info. */\n workflow?: WorkflowInfo;\n }\n interface UpdateWorkflowResponse {\n }\n interface CreateWorkflowRequest {\n /** Workflow details. */\n workflow?: WorkflowInfo;\n }\n interface CreateWorkflowResponse {\n /** ID of the new workflow. */\n _id?: string | null;\n }\n interface DeleteWorkflowRequest {\n /** ID of the workflow to delete. */\n _id: string;\n }\n interface DeleteWorkflowResponse {\n }\n interface SetupWorkflowRequest {\n }\n interface SetupWorkflowResponse {\n }\n /**\n * Retrieves a list of the site's workflows info.\n *\n *\n * The `listWorkflows()` function returns a Promise that resolves to a list containing information about the site's workflows.\n *\n *\n * Use the `options` parameter to specify which workflows to retrieve and in which order to retrieve them. Workflows can be sorted based on their `\"name\"`.\n *\n *\n * If no `limit` parameter is passed, the first 100 workflows are returned. Sort order defaults to by `\"name\"` ascending.\n *\n * This function is not a universal function and runs only on the backend.\n * @public\n * @param options - Options to use when retrieving a list of workflows.\n * @adminMethod\n */\n function listWorkflows(options?: ListWorkflowsOptions): Promise;\n interface ListWorkflowsOptions {\n /**\n * Number of workflows to return.\n * If omitted, all results are returned.\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n /**\n * Supported fields:\n * `id`, `name`, `description`, `createdDate`\n *\n * List of fields to sort by.\n * Formatted as `field:direction`,\n * where field is the field name\n * and direction is `asc` (ascending) or `desc` (descending).\n *\n * Sorting is applied lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n */\n sort?: string[];\n }\n interface QueryWorkflowsOptions {\n /** Query options. */\n query?: Query;\n }\n /**\n * Retrieves a workflow by ID.\n *\n *\n * The `getWorkflow()` function returns a Promise that resolves to the workflow info with the specified ID.\n *\n *\n * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the workflow to retrieve.\n * @param cardsPerPhase - Maximum number of cards to return per phase.\n * To retrieve additional pages of cards, use\n * [List Cards](../cards/listCards)\n * (in the Cards API).\n * @public\n * @requiredField _id\n * @requiredField cardsPerPhase\n * @param options - Options to use when retrieving a workflow.\n * @adminMethod\n */\n function getWorkflow(_id: string, cardsPerPhase: number | null, options?: GetWorkflowOptions): Promise;\n interface GetWorkflowOptions {\n }\n /**\n * Updates an existing workflow.\n *\n *\n * The `updateWorkflow()` function returns a Promise that resolves when the workflow has been updated with the specified values.\n *\n *\n * Only the properties passed in the `workflow` object will be updated. All other properties will remain the same.\n *\n *\n * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the workflow to update.\n * @param workflow - Workflow info.\n * @public\n * @requiredField _id\n * @requiredField workflow\n * @param options - Options to use when updating a workflow.\n * @adminMethod\n */\n function updateWorkflow(_id: string, workflow: WorkflowInfo): Promise;\n /**\n * Creates a new workflow.\n *\n *\n * The `createWorkflow()` function returns a Promise that resolves to the created workflow ID.\n *\n * This function is not a universal function and runs only on the backend.\n * @param workflow - Workflow details.\n * @public\n * @requiredField workflow\n * @requiredField workflow.name\n * @param options - Options to use when creating a workflow.\n * @adminMethod\n */\n function createWorkflow(workflow: WorkflowInfo): Promise;\n /**\n * Deletes a workflow.\n *\n *\n * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.\n *\n *\n * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - ID of the workflow to delete.\n * @public\n * @requiredField _id\n * @adminMethod\n */\n function deleteWorkflow(_id: string): Promise;\n const workflowsV1Workflow_universal_d___debug: typeof __debug;\n type workflowsV1Workflow_universal_d_Workflow = Workflow;\n type workflowsV1Workflow_universal_d_WorkflowInfo = WorkflowInfo;\n type workflowsV1Workflow_universal_d_Phase = Phase;\n type workflowsV1Workflow_universal_d_PhaseInfo = PhaseInfo;\n type workflowsV1Workflow_universal_d_CardsList = CardsList;\n type workflowsV1Workflow_universal_d_Card = Card;\n type workflowsV1Workflow_universal_d_CardInfo = CardInfo;\n type workflowsV1Workflow_universal_d_Attachment = Attachment;\n type workflowsV1Workflow_universal_d_AttachmentType = AttachmentType;\n const workflowsV1Workflow_universal_d_AttachmentType: typeof AttachmentType;\n type workflowsV1Workflow_universal_d_PhasesList = PhasesList;\n type workflowsV1Workflow_universal_d_ListWorkflowsRequest = ListWorkflowsRequest;\n type workflowsV1Workflow_universal_d_ListWorkflowsResponse = ListWorkflowsResponse;\n type workflowsV1Workflow_universal_d_PaginationResponse = PaginationResponse;\n type workflowsV1Workflow_universal_d_QueryWorkflowsRequest = QueryWorkflowsRequest;\n type workflowsV1Workflow_universal_d_Query = Query;\n type workflowsV1Workflow_universal_d_Sorting = Sorting;\n type workflowsV1Workflow_universal_d_SortOrder = SortOrder;\n const workflowsV1Workflow_universal_d_SortOrder: typeof SortOrder;\n type workflowsV1Workflow_universal_d_Paging = Paging;\n type workflowsV1Workflow_universal_d_QueryWorkflowsResponse = QueryWorkflowsResponse;\n type workflowsV1Workflow_universal_d_GetWorkflowRequest = GetWorkflowRequest;\n type workflowsV1Workflow_universal_d_GetWorkflowResponse = GetWorkflowResponse;\n type workflowsV1Workflow_universal_d_UpdateWorkflowRequest = UpdateWorkflowRequest;\n type workflowsV1Workflow_universal_d_UpdateWorkflowResponse = UpdateWorkflowResponse;\n type workflowsV1Workflow_universal_d_CreateWorkflowRequest = CreateWorkflowRequest;\n type workflowsV1Workflow_universal_d_CreateWorkflowResponse = CreateWorkflowResponse;\n type workflowsV1Workflow_universal_d_DeleteWorkflowRequest = DeleteWorkflowRequest;\n type workflowsV1Workflow_universal_d_DeleteWorkflowResponse = DeleteWorkflowResponse;\n type workflowsV1Workflow_universal_d_SetupWorkflowRequest = SetupWorkflowRequest;\n type workflowsV1Workflow_universal_d_SetupWorkflowResponse = SetupWorkflowResponse;\n const workflowsV1Workflow_universal_d_listWorkflows: typeof listWorkflows;\n type workflowsV1Workflow_universal_d_ListWorkflowsOptions = ListWorkflowsOptions;\n type workflowsV1Workflow_universal_d_QueryWorkflowsOptions = QueryWorkflowsOptions;\n const workflowsV1Workflow_universal_d_getWorkflow: typeof getWorkflow;\n type workflowsV1Workflow_universal_d_GetWorkflowOptions = GetWorkflowOptions;\n const workflowsV1Workflow_universal_d_updateWorkflow: typeof updateWorkflow;\n const workflowsV1Workflow_universal_d_createWorkflow: typeof createWorkflow;\n const workflowsV1Workflow_universal_d_deleteWorkflow: typeof deleteWorkflow;\n namespace workflowsV1Workflow_universal_d {\n export { workflowsV1Workflow_universal_d___debug as __debug, workflowsV1Workflow_universal_d_Workflow as Workflow, workflowsV1Workflow_universal_d_WorkflowInfo as WorkflowInfo, workflowsV1Workflow_universal_d_Phase as Phase, workflowsV1Workflow_universal_d_PhaseInfo as PhaseInfo, workflowsV1Workflow_universal_d_CardsList as CardsList, workflowsV1Workflow_universal_d_Card as Card, workflowsV1Workflow_universal_d_CardInfo as CardInfo, workflowsV1Workflow_universal_d_Attachment as Attachment, workflowsV1Workflow_universal_d_AttachmentType as AttachmentType, workflowsV1Workflow_universal_d_PhasesList as PhasesList, workflowsV1Workflow_universal_d_ListWorkflowsRequest as ListWorkflowsRequest, workflowsV1Workflow_universal_d_ListWorkflowsResponse as ListWorkflowsResponse, workflowsV1Workflow_universal_d_PaginationResponse as PaginationResponse, workflowsV1Workflow_universal_d_QueryWorkflowsRequest as QueryWorkflowsRequest, workflowsV1Workflow_universal_d_Query as Query, workflowsV1Workflow_universal_d_Sorting as Sorting, workflowsV1Workflow_universal_d_SortOrder as SortOrder, workflowsV1Workflow_universal_d_Paging as Paging, workflowsV1Workflow_universal_d_QueryWorkflowsResponse as QueryWorkflowsResponse, workflowsV1Workflow_universal_d_GetWorkflowRequest as GetWorkflowRequest, workflowsV1Workflow_universal_d_GetWorkflowResponse as GetWorkflowResponse, workflowsV1Workflow_universal_d_UpdateWorkflowRequest as UpdateWorkflowRequest, workflowsV1Workflow_universal_d_UpdateWorkflowResponse as UpdateWorkflowResponse, workflowsV1Workflow_universal_d_CreateWorkflowRequest as CreateWorkflowRequest, workflowsV1Workflow_universal_d_CreateWorkflowResponse as CreateWorkflowResponse, workflowsV1Workflow_universal_d_DeleteWorkflowRequest as DeleteWorkflowRequest, workflowsV1Workflow_universal_d_DeleteWorkflowResponse as DeleteWorkflowResponse, workflowsV1Workflow_universal_d_SetupWorkflowRequest as SetupWorkflowRequest, workflowsV1Workflow_universal_d_SetupWorkflowResponse as SetupWorkflowResponse, workflowsV1Workflow_universal_d_listWorkflows as listWorkflows, workflowsV1Workflow_universal_d_ListWorkflowsOptions as ListWorkflowsOptions, workflowsV1Workflow_universal_d_QueryWorkflowsOptions as QueryWorkflowsOptions, workflowsV1Workflow_universal_d_getWorkflow as getWorkflow, workflowsV1Workflow_universal_d_GetWorkflowOptions as GetWorkflowOptions, workflowsV1Workflow_universal_d_updateWorkflow as updateWorkflow, workflowsV1Workflow_universal_d_createWorkflow as createWorkflow, workflowsV1Workflow_universal_d_deleteWorkflow as deleteWorkflow, };\n }\n export { workflowsV1Card_universal_d as cards, workflowsV1Phase_universal_d as phases, workflowsV1Workflow_universal_d as workflows };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-crm.v2.d.ts", "content": "declare module \"wix-crm.v2\" {\n interface Task {\n /**\n * Task ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the task is updated. To prevent conflicting changes, the existing `revision` must be used when updating a task.\n * @readonly\n */\n revision?: string | null;\n /** Title of the task. */\n title?: string | null;\n /** Description of the task. */\n description?: string | null;\n /**\n * Date and time the task was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the task was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Due date for the task. */\n dueDate?: Date | null;\n /**\n * Status of the task.\n *\n * Default: `ACTION_NEEDED`\n */\n status?: TaskStatus;\n /** Details about the task source. */\n source?: TaskSource;\n /** Information about the contact associated with the task. */\n contact?: ContactInfo$1;\n }\n /** Possible statuses in which the task may be. */\n enum TaskStatus {\n /** Undefined task status. */\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Action needed. */\n ACTION_NEEDED = \"ACTION_NEEDED\",\n /** Task completed. */\n COMPLETED = \"COMPLETED\"\n }\n interface TaskSource {\n /**\n * How the task was created.\n * @readonly\n */\n sourceType?: SourceType;\n /**\n * App ID, if the task was created by an app.\n * @readonly\n */\n appId?: string | null;\n /**\n * User ID, if the task was created by a Wix user.\n * @readonly\n */\n userId?: string | null;\n }\n /** Possible sources that can create tasks. */\n enum SourceType {\n /** Undefined source type. */\n UNKNOWN_SOURCE_TYPE = \"UNKNOWN_SOURCE_TYPE\",\n /** Task was created by an app. */\n APP = \"APP\",\n /** Task was created by a Wix user. */\n USER = \"USER\"\n }\n interface ContactInfo$1 {\n /** ID of the contact associated with the task. */\n _id?: string | null;\n /**\n * Contact's first name.\n * @readonly\n */\n firstName?: string | null;\n /**\n * Contact's last name.\n * @readonly\n */\n lastName?: string | null;\n /**\n * Contact's image URL.\n * @readonly\n */\n imageUrl?: string | null;\n /**\n * Contact's primary email.\n * @readonly\n */\n email?: string | null;\n /**\n * Contact's primary phone.\n * @readonly\n */\n phone?: string | null;\n }\n interface DeleteCompletedTasksRequest {\n /** Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used. */\n taskIds?: string[];\n /** An optional filter of tasks to count. See 'queryTasks' for supported filter options. */\n filter?: Record | null;\n }\n interface DeleteCompletedTasksResponse {\n }\n interface SendTasksReminderRequest {\n /** Ids of the tasks to remind */\n taskIds?: string[];\n /** The reminder type */\n reminderType?: ReminderType;\n }\n enum ReminderType {\n UNKNOWN_REMINDER_TYPE = \"UNKNOWN_REMINDER_TYPE\",\n FIRST_REMINDER = \"FIRST_REMINDER\",\n LAST_REMINDER = \"LAST_REMINDER\"\n }\n interface SendTasksReminderResponse {\n }\n interface RepositionTask {\n /** The id of the last task that was re-positioned */\n taskId?: string | null;\n /** The position of the last task that was re-positioned */\n position?: string | null;\n }\n interface TaskOverdue {\n /** The overdue task. */\n task?: Task;\n }\n interface TaskAssigned {\n /** The id of the assignee */\n assigneeId?: string;\n /** The task that was assigned */\n task?: Task;\n }\n interface CreateTaskRequest {\n /** Task to create. */\n task: Task;\n }\n interface CreateTaskResponse {\n /** The created task. */\n task?: Task;\n }\n interface ContactNotFoundError {\n contactId?: string;\n }\n interface GetTaskRequest {\n /** ID of the task to retrieve. */\n taskId: string;\n }\n interface GetTaskResponse {\n /** The retrieved task. */\n task?: Task;\n }\n interface UpdateTaskRequest {\n /** Task to update. */\n task: Task;\n }\n interface UpdateTaskResponse {\n /** The updated task. */\n task?: Task;\n }\n interface DeleteTaskRequest {\n /** ID of the task to delete. */\n taskId: string;\n }\n interface DeleteTaskResponse {\n }\n interface QueryTasksRequest {\n /** Query options. */\n query?: CursorQuery;\n }\n interface CursorQuery extends CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n }\n enum SortOrder$3 {\n /** Sort by ascending order. */\n ASC = \"ASC\",\n /** Sort by descending order. */\n DESC = \"DESC\"\n }\n interface CursorPaging$1 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryTasksResponse {\n /** The retrieved tasks. */\n tasks?: Task[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$1;\n }\n interface CursorPagingMetadata$1 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$1;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$1 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface CountTasksRequest {\n /**\n * Filter which tasks to count. See the list of supported filters in `queryContacts`.\n *\n * Filterable fields include:\n * - `_id`\n * - `_createdDate`\n * - `_updatedDate`\n * - `dueDate`\n * - `status`\n * - `contact.id`\n */\n filter?: Record | null;\n }\n interface CountTasksResponse {\n /** The number of tasks that match the specified filter. */\n count?: number;\n }\n interface QueryTasksInternalRequest {\n /** WQL expression */\n query?: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$3;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n /** 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. */\n fields?: string[];\n /** 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. */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$3;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$1;\n }\n interface Paging$3 {\n /** Number of items to load. */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n interface QueryTasksInternalResponse {\n /** The retrieved tasks. */\n tasks?: Task[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors$1;\n }\n interface MoveTaskAfterRequest {\n /** ID of the task to move. */\n taskId: string;\n /**\n * The ID of the task after which the moved task is positioned in the task display.\n * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.\n */\n beforeTaskId?: string | null;\n }\n interface MoveTaskAfterResponse {\n }\n interface TaskNotFoundError {\n /** The task id that was not found */\n taskId?: string;\n }\n interface Empty {\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n }\n interface RestoreInfo$3 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$3;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new task.\n *\n * All fields in the `task` object are optional. If you don't pass any fields in the `task` object, the function returns a task with the following core properties:\n * - `_id`\n * - `_createdDate`\n * - `_updatedDate`\n * - `status`\n * - `source`\n * - `revision`\n *\n * @param task - Task to create.\n * @public\n * @requiredField task\n * @permissionId CRM_TASKS.TASK_CREATE\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The created task.\n * @fqn wix.crm.tasks.v2.Tasks.CreateTask\n */\n function createTask(task: Task): Promise;\n /**\n * Retrieves a task by ID.\n * @param taskId - ID of the task to retrieve.\n * @public\n * @requiredField taskId\n * @permissionId CRM_TASKS.TASK_READ\n * @permissionScope Read Tasks\n * @permissionScopeId SCOPE.DC-CRM.READ-TASKS\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The retrieved task.\n * @fqn wix.crm.tasks.v2.Tasks.GetTask\n */\n function getTask(taskId: string): Promise;\n /**\n * Updates a task.\n *\n * Each time the task is updated, `revision` increments by 1.\n * The existing `revision` must be included when updating the task.\n * This ensures you're working with the latest task\n * and prevents unintended overwrites.\n * @param _id - Task ID.\n * @public\n * @requiredField _id\n * @requiredField task\n * @requiredField task.revision\n * @param task - Task to update.\n * @permissionId CRM_TASKS.TASK_UPDATE\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated task.\n * @fqn wix.crm.tasks.v2.Tasks.UpdateTask\n */\n function updateTask(_id: string | null, task: UpdateTask, options?: UpdateTaskOptions): Promise;\n interface UpdateTask {\n /**\n * Task ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the task is updated. To prevent conflicting changes, the existing `revision` must be used when updating a task.\n * @readonly\n */\n revision?: string | null;\n /** Title of the task. */\n title?: string | null;\n /** Description of the task. */\n description?: string | null;\n /**\n * Date and time the task was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the task was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Due date for the task. */\n dueDate?: Date | null;\n /**\n * Status of the task.\n *\n * Default: `ACTION_NEEDED`\n */\n status?: TaskStatus;\n /** Details about the task source. */\n source?: TaskSource;\n /** Information about the contact associated with the task. */\n contact?: ContactInfo$1;\n }\n interface UpdateTaskOptions {\n }\n /**\n * Deletes a task by ID.\n * @param taskId - ID of the task to delete.\n * @public\n * @requiredField taskId\n * @permissionId CRM_TASKS.TASK_DELETE\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.crm.tasks.v2.Tasks.DeleteTask\n */\n function deleteTask(taskId: string): Promise;\n /**\n * Creates a query to retrieve a list of tasks.\n *\n * The `queryTasks()` function builds a query to retrieve a list of tasks and returns a `TasksQueryBuilder` object.\n *\n * The returned object contains the query definition which is typically used to run the query using the `find()` function. You can refine the query by chaining `TasksQueryBuilder` functions onto the query. `TasksQueryBuilder` functions enable you to sort, filter, and control the results that `queryTasks()` returns.\n *\n * `queryTasks()` runs with these `TasksQueryBuilder` defaults, which you can override:\n * - `limit(50)`\n * - `descending('_createdDate')`\n *\n * The functions that are chained to `queryTasks()` 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.\n *\n * The following `TasksQueryBuilder` functions are supported for `queryTasks()`. For a full description of the `task` object, see the object returned for the `items` property in `TasksQueryResult`.\n * @public\n * @permissionScope Read Tasks\n * @permissionScopeId SCOPE.DC-CRM.READ-TASKS\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @permissionId CRM_TASKS.TASK_READ\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.crm.tasks.v2.Tasks.QueryTasks\n */\n function queryTasks(): TasksQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TasksQueryResult extends QueryCursorResult {\n items: Task[];\n query: TasksQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface TasksQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"dueDate\" | \"status\" | \"contact.id\", value: any) => TasksQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"dueDate\" | \"status\" | \"contact.id\", value: any) => TasksQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"dueDate\", value: any) => TasksQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"dueDate\", value: any) => TasksQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"dueDate\", value: any) => TasksQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"dueDate\", value: any) => TasksQueryBuilder;\n in: (propertyName: \"_id\" | \"status\" | \"contact.id\", value: any) => TasksQueryBuilder;\n exists: (propertyName: \"contact.id\", value: boolean) => TasksQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"_createdDate\" | \"_updatedDate\" | \"dueDate\">) => TasksQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"_createdDate\" | \"_updatedDate\" | \"dueDate\">) => TasksQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => TasksQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => TasksQueryBuilder;\n find: () => Promise;\n }\n /**\n * Counts the number of tasks.\n *\n *\n * This method returns the count of all tasks regardless of their `status`.\n *\n * Optionally, you can specify a filter to count only tasks that meet certain criteria.\n * @public\n * @param options - Filtering options.\n * @permissionId CRM_TASKS.TASK_READ\n * @permissionScope Read Tasks\n * @permissionScopeId SCOPE.DC-CRM.READ-TASKS\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.crm.tasks.v2.Tasks.CountTasks\n */\n function countTasks(options?: CountTasksOptions): Promise;\n interface CountTasksOptions {\n /**\n * Filter which tasks to count. See the list of supported filters in `queryContacts`.\n *\n * Filterable fields include:\n * - `_id`\n * - `_createdDate`\n * - `_updatedDate`\n * - `dueDate`\n * - `status`\n * - `contact.id`\n */\n filter?: Record | null;\n }\n /**\n * Moves a task specified by ID to be placed after another task in the task display.\n *\n * You can reposition a task to be first in the display by omitting `beforeTaskId`.\n * @param taskId - ID of the task to move.\n * @public\n * @requiredField taskId\n * @param options - Options for moving the task.\n * @permissionId CRM_TASKS.TASK_UPDATE\n * @permissionScope Manage Tasks\n * @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn wix.crm.tasks.v2.Tasks.MoveTaskAfter\n */\n function moveTaskAfter(taskId: string, options?: MoveTaskAfterOptions): Promise;\n interface MoveTaskAfterOptions {\n /**\n * The ID of the task after which the moved task is positioned in the task display.\n * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.\n */\n beforeTaskId?: string | null;\n }\n type crmTasksV2TaskTasks_universal_d_Task = Task;\n type crmTasksV2TaskTasks_universal_d_TaskStatus = TaskStatus;\n const crmTasksV2TaskTasks_universal_d_TaskStatus: typeof TaskStatus;\n type crmTasksV2TaskTasks_universal_d_TaskSource = TaskSource;\n type crmTasksV2TaskTasks_universal_d_SourceType = SourceType;\n const crmTasksV2TaskTasks_universal_d_SourceType: typeof SourceType;\n type crmTasksV2TaskTasks_universal_d_DeleteCompletedTasksRequest = DeleteCompletedTasksRequest;\n type crmTasksV2TaskTasks_universal_d_DeleteCompletedTasksResponse = DeleteCompletedTasksResponse;\n type crmTasksV2TaskTasks_universal_d_SendTasksReminderRequest = SendTasksReminderRequest;\n type crmTasksV2TaskTasks_universal_d_ReminderType = ReminderType;\n const crmTasksV2TaskTasks_universal_d_ReminderType: typeof ReminderType;\n type crmTasksV2TaskTasks_universal_d_SendTasksReminderResponse = SendTasksReminderResponse;\n type crmTasksV2TaskTasks_universal_d_RepositionTask = RepositionTask;\n type crmTasksV2TaskTasks_universal_d_TaskOverdue = TaskOverdue;\n type crmTasksV2TaskTasks_universal_d_TaskAssigned = TaskAssigned;\n type crmTasksV2TaskTasks_universal_d_CreateTaskRequest = CreateTaskRequest;\n type crmTasksV2TaskTasks_universal_d_CreateTaskResponse = CreateTaskResponse;\n type crmTasksV2TaskTasks_universal_d_ContactNotFoundError = ContactNotFoundError;\n type crmTasksV2TaskTasks_universal_d_GetTaskRequest = GetTaskRequest;\n type crmTasksV2TaskTasks_universal_d_GetTaskResponse = GetTaskResponse;\n type crmTasksV2TaskTasks_universal_d_UpdateTaskRequest = UpdateTaskRequest;\n type crmTasksV2TaskTasks_universal_d_UpdateTaskResponse = UpdateTaskResponse;\n type crmTasksV2TaskTasks_universal_d_DeleteTaskRequest = DeleteTaskRequest;\n type crmTasksV2TaskTasks_universal_d_DeleteTaskResponse = DeleteTaskResponse;\n type crmTasksV2TaskTasks_universal_d_QueryTasksRequest = QueryTasksRequest;\n type crmTasksV2TaskTasks_universal_d_CursorQuery = CursorQuery;\n type crmTasksV2TaskTasks_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type crmTasksV2TaskTasks_universal_d_QueryTasksResponse = QueryTasksResponse;\n type crmTasksV2TaskTasks_universal_d_CountTasksRequest = CountTasksRequest;\n type crmTasksV2TaskTasks_universal_d_CountTasksResponse = CountTasksResponse;\n type crmTasksV2TaskTasks_universal_d_QueryTasksInternalRequest = QueryTasksInternalRequest;\n type crmTasksV2TaskTasks_universal_d_QueryV2 = QueryV2;\n type crmTasksV2TaskTasks_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type crmTasksV2TaskTasks_universal_d_QueryTasksInternalResponse = QueryTasksInternalResponse;\n type crmTasksV2TaskTasks_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type crmTasksV2TaskTasks_universal_d_MoveTaskAfterRequest = MoveTaskAfterRequest;\n type crmTasksV2TaskTasks_universal_d_MoveTaskAfterResponse = MoveTaskAfterResponse;\n type crmTasksV2TaskTasks_universal_d_TaskNotFoundError = TaskNotFoundError;\n type crmTasksV2TaskTasks_universal_d_Empty = Empty;\n const crmTasksV2TaskTasks_universal_d_createTask: typeof createTask;\n const crmTasksV2TaskTasks_universal_d_getTask: typeof getTask;\n const crmTasksV2TaskTasks_universal_d_updateTask: typeof updateTask;\n type crmTasksV2TaskTasks_universal_d_UpdateTask = UpdateTask;\n type crmTasksV2TaskTasks_universal_d_UpdateTaskOptions = UpdateTaskOptions;\n const crmTasksV2TaskTasks_universal_d_deleteTask: typeof deleteTask;\n const crmTasksV2TaskTasks_universal_d_queryTasks: typeof queryTasks;\n type crmTasksV2TaskTasks_universal_d_TasksQueryResult = TasksQueryResult;\n type crmTasksV2TaskTasks_universal_d_TasksQueryBuilder = TasksQueryBuilder;\n const crmTasksV2TaskTasks_universal_d_countTasks: typeof countTasks;\n type crmTasksV2TaskTasks_universal_d_CountTasksOptions = CountTasksOptions;\n const crmTasksV2TaskTasks_universal_d_moveTaskAfter: typeof moveTaskAfter;\n type crmTasksV2TaskTasks_universal_d_MoveTaskAfterOptions = MoveTaskAfterOptions;\n namespace crmTasksV2TaskTasks_universal_d {\n export { crmTasksV2TaskTasks_universal_d_Task as Task, crmTasksV2TaskTasks_universal_d_TaskStatus as TaskStatus, crmTasksV2TaskTasks_universal_d_TaskSource as TaskSource, crmTasksV2TaskTasks_universal_d_SourceType as SourceType, ContactInfo$1 as ContactInfo, crmTasksV2TaskTasks_universal_d_DeleteCompletedTasksRequest as DeleteCompletedTasksRequest, crmTasksV2TaskTasks_universal_d_DeleteCompletedTasksResponse as DeleteCompletedTasksResponse, crmTasksV2TaskTasks_universal_d_SendTasksReminderRequest as SendTasksReminderRequest, crmTasksV2TaskTasks_universal_d_ReminderType as ReminderType, crmTasksV2TaskTasks_universal_d_SendTasksReminderResponse as SendTasksReminderResponse, crmTasksV2TaskTasks_universal_d_RepositionTask as RepositionTask, crmTasksV2TaskTasks_universal_d_TaskOverdue as TaskOverdue, crmTasksV2TaskTasks_universal_d_TaskAssigned as TaskAssigned, crmTasksV2TaskTasks_universal_d_CreateTaskRequest as CreateTaskRequest, crmTasksV2TaskTasks_universal_d_CreateTaskResponse as CreateTaskResponse, crmTasksV2TaskTasks_universal_d_ContactNotFoundError as ContactNotFoundError, crmTasksV2TaskTasks_universal_d_GetTaskRequest as GetTaskRequest, crmTasksV2TaskTasks_universal_d_GetTaskResponse as GetTaskResponse, crmTasksV2TaskTasks_universal_d_UpdateTaskRequest as UpdateTaskRequest, crmTasksV2TaskTasks_universal_d_UpdateTaskResponse as UpdateTaskResponse, crmTasksV2TaskTasks_universal_d_DeleteTaskRequest as DeleteTaskRequest, crmTasksV2TaskTasks_universal_d_DeleteTaskResponse as DeleteTaskResponse, crmTasksV2TaskTasks_universal_d_QueryTasksRequest as QueryTasksRequest, crmTasksV2TaskTasks_universal_d_CursorQuery as CursorQuery, crmTasksV2TaskTasks_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, Sorting$3 as Sorting, SortOrder$3 as SortOrder, CursorPaging$1 as CursorPaging, crmTasksV2TaskTasks_universal_d_QueryTasksResponse as QueryTasksResponse, CursorPagingMetadata$1 as CursorPagingMetadata, Cursors$1 as Cursors, crmTasksV2TaskTasks_universal_d_CountTasksRequest as CountTasksRequest, crmTasksV2TaskTasks_universal_d_CountTasksResponse as CountTasksResponse, crmTasksV2TaskTasks_universal_d_QueryTasksInternalRequest as QueryTasksInternalRequest, crmTasksV2TaskTasks_universal_d_QueryV2 as QueryV2, crmTasksV2TaskTasks_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, Paging$3 as Paging, crmTasksV2TaskTasks_universal_d_QueryTasksInternalResponse as QueryTasksInternalResponse, crmTasksV2TaskTasks_universal_d_PagingMetadataV2 as PagingMetadataV2, crmTasksV2TaskTasks_universal_d_MoveTaskAfterRequest as MoveTaskAfterRequest, crmTasksV2TaskTasks_universal_d_MoveTaskAfterResponse as MoveTaskAfterResponse, crmTasksV2TaskTasks_universal_d_TaskNotFoundError as TaskNotFoundError, crmTasksV2TaskTasks_universal_d_Empty as Empty, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$3 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, MessageEnvelope$3 as MessageEnvelope, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, crmTasksV2TaskTasks_universal_d_createTask as createTask, crmTasksV2TaskTasks_universal_d_getTask as getTask, crmTasksV2TaskTasks_universal_d_updateTask as updateTask, crmTasksV2TaskTasks_universal_d_UpdateTask as UpdateTask, crmTasksV2TaskTasks_universal_d_UpdateTaskOptions as UpdateTaskOptions, crmTasksV2TaskTasks_universal_d_deleteTask as deleteTask, crmTasksV2TaskTasks_universal_d_queryTasks as queryTasks, crmTasksV2TaskTasks_universal_d_TasksQueryResult as TasksQueryResult, crmTasksV2TaskTasks_universal_d_TasksQueryBuilder as TasksQueryBuilder, crmTasksV2TaskTasks_universal_d_countTasks as countTasks, crmTasksV2TaskTasks_universal_d_CountTasksOptions as CountTasksOptions, crmTasksV2TaskTasks_universal_d_moveTaskAfter as moveTaskAfter, crmTasksV2TaskTasks_universal_d_MoveTaskAfterOptions as MoveTaskAfterOptions, };\n }\n /** Label that was found or created. */\n interface ContactLabel {\n /**\n * Label namespace.\n *\n * Labels created by calling the Find Or Create Label method\n * are automatically assigned to the `custom` namespace.\n * @readonly\n */\n namespace?: string | null;\n /**\n * Display name for the namespace,\n * used to organize the list of labels in the site dashboard.\n * @readonly\n */\n namespaceDisplayName?: string | null;\n /**\n * Label key.\n *\n * `key` is generated when the label is created.\n * It can't be modified, even if `displayName` is updated.\n * @readonly\n */\n key?: string;\n /** Label display name shown in the dashboard. */\n displayName?: string;\n /**\n * Label type indicating how the label was created.\n * @readonly\n */\n labelType?: LabelType;\n /**\n * Date and time the label was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the label was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n enum LabelType {\n /** Fetch all labels. */\n UNKNOWN = \"UNKNOWN\",\n /** Default system label for the contact list. */\n SYSTEM = \"SYSTEM\",\n /** Label created by calling the Find Or Create Label method. */\n USER_DEFINED = \"USER_DEFINED\",\n /** Label created by an app built by Wix. */\n WIX_APP_DEFINED = \"WIX_APP_DEFINED\"\n }\n /** Label filter options. */\n interface ListLabelsRequest {\n /** Filter for labels of the specified type. */\n labelType?: LabelType;\n /** Filter for labels in the specified namespace. */\n namespace?: string | null;\n /** Filter for labels where `displayName` starts with the specified case-sensitive string. */\n startsWith?: string | null;\n /** Sorting options. */\n sort?: Sorting$2;\n /** Paging options. */\n paging?: Paging$2;\n language?: string | null;\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Default: `ASC`.\n */\n order?: SortOrder$2;\n }\n enum SortOrder$2 {\n /** Sort by ascending order. */\n ASC = \"ASC\",\n /** Sort by descending order. */\n DESC = \"DESC\"\n }\n interface Paging$2 {\n /**\n * Number of items to return.\n *\n * Defaults to `1000`.
      \n * Maximum: `2000`.\n */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n /** List of labels. */\n interface ListLabelsResponse {\n /** List of labels. */\n labels?: ContactLabel[];\n /** Metadata for the page of results. */\n metadata?: PagingMetadata$2;\n }\n interface PagingMetadata$2 {\n /** Number of items returned. */\n count?: number | null;\n /** Requested offset. */\n offset?: number | null;\n /** Number of items that matched the query. */\n total?: number | null;\n /**\n * Indicates if `total` calculation timed out before the response was sent.\n * Typically this happens if there is a large set of results.\n */\n tooManyToCount?: boolean | null;\n }\n /** Label to find or create. */\n interface FindOrCreateLabelRequest {\n /**\n * Display name to retrieve or create.\n *\n * If an existing label is an exact match\n * for the specified display name,\n * the existing label is returned.\n * If not, a new label is created and returned.\n */\n displayName: string;\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n /** Label that was found or created. */\n interface FindOrCreateLabelResponse {\n /** Label that was found or created. */\n label?: ContactLabel;\n /**\n * Indicates whether the label was just created or already existed.\n *\n * Returns `true` if the label was just created.\n */\n newLabel?: boolean;\n }\n interface LabelsQuotaReached {\n /** The maximum number of labels allowed for the site. */\n labelsQuota?: string | null;\n /** The current total number of labels on the site. */\n labelsCurrentTotal?: string | null;\n }\n interface ListLabelNamespacesRequest {\n /** Language for localization */\n language?: string | null;\n }\n interface ListLabelNamespacesResponse {\n /** List of namespaces */\n namespaces?: ContactLabelNamespace[];\n }\n interface ContactLabelNamespace {\n /**\n * Namespace key\n * @readonly\n */\n key?: string;\n /**\n * Namespace display name\n * @readonly\n */\n displayName?: string | null;\n }\n interface GetLabelRequest {\n /**\n * Label key.\n *\n * `key` is generated when the label is created.\n * It can't be modified, even if `displayName` is updated.\n */\n key: string;\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n /** The specified label. */\n interface GetLabelResponse {\n /** The specified label. */\n label?: ContactLabel;\n }\n interface GetLabelByLegacyIdRequest {\n /** Legacy id of the label */\n legacyId?: string;\n /** Language for localization */\n language?: string | null;\n }\n interface GetLabelByLegacyIdResponse {\n /** Requested label */\n label?: ContactLabel;\n }\n interface UpdateLabelRequest {\n /** Label to rename. */\n label?: ContactLabel;\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n /** Updated label. */\n interface UpdateLabelResponse {\n /** Renamed label. */\n label?: ContactLabel;\n }\n interface DeleteLabelRequest {\n /** Label key to delete. */\n key: string;\n }\n interface DeleteLabelResponse {\n }\n interface PurgeRequest$1 {\n /** Contacts Instance ID of the site. */\n instanceId?: string;\n /** Labels to exclude from the purge. */\n exludingLabelKeys?: string[];\n }\n interface PurgeResponse$1 {\n /** Number of deleted items */\n deletedItems?: number;\n }\n interface GdprListRequest$1 {\n /** Contacts Instance ID of the site. */\n instanceId?: string;\n }\n interface GdprListResponse$1 {\n /** List of labels */\n labels?: ContactLabel[];\n }\n interface QueryLabelsRequest {\n /** Query options. */\n query?: Query$2;\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n interface Query$2 {\n /**\n * ilter object.\n *\n * Possible filters: `$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n *\n * For a detailed list of supported filters, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).\n *\n * Example: `{ \"filter\": {\n * \"displayName\": {\n * \"$startsWith\": \"Referral\"\n * }\n * }\n * }`\n */\n filter?: Record | null;\n /**\n * Sorting options. For a list of fields that can be sorted, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).\n *\n * Example: `{ \"sort\": [{\"fieldName\": \"displayName\", \"order\": \"DESC\"}] }`\n */\n sort?: Sorting$2[];\n /** Pagination options. */\n paging?: Paging$2;\n }\n interface QueryLabelsResponse {\n /** List of labels */\n labels?: ContactLabel[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata$2;\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n }\n interface RestoreInfo$2 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$2 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$2 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$2 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$2;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$2;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$2 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface ListLabelsOptions {\n /** Filter for labels of the specified type. */\n labelType?: LabelType;\n /** Filter for labels in the specified namespace. */\n namespace?: string | null;\n /** Filter for labels where `displayName` starts with the specified case-sensitive string. */\n startsWith?: string | null;\n /** Sorting options. */\n sort?: Sorting$2;\n /** Paging options. */\n paging?: Paging$2;\n language?: string | null;\n }\n /**\n * Retrieves a label with a specified name, or creates one if it doesn't exist.\n *\n * Successful calls to this method always return a label,\n * which can be specified in subsequent calls.\n *\n * For example, in the Contacts API, Label Contact and Unlabel Contact\n * calls will fail if you include a non-existent label.\n * To ensure successful calls, you can call this method first,\n * and then use the response in the Label Contact and Unlabel Contact calls.\n *\n * To find an existing label without potentially creating a new one, call\n * Get Label or Query Labels.\n * @param displayName - Display name to retrieve or create.\n *\n * If an existing label is an exact match\n * for the specified display name,\n * the existing label is returned.\n * If not, a new label is created and returned.\n * @public\n * @requiredField displayName\n * @param options - Language options.\n * @permissionId CONTACTS_LABELS.MODIFY\n * @permissionScope Manage Contact Labels\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Label that was found or created.\n * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.FindOrCreateLabel\n */\n function findOrCreateLabel(displayName: string, options?: FindOrCreateLabelOptions): Promise;\n interface FindOrCreateLabelOptions {\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n interface ListLabelNamespacesOptions {\n /** Language for localization */\n language?: string | null;\n }\n /**\n * Retrieves a label by the specified label key.\n * @param key - Label key.\n *\n * `key` is generated when the label is created.\n * It can't be modified, even if `displayName` is updated.\n * @public\n * @requiredField key\n * @param options - Language options.\n * @permissionId CONTACTS_LABELS.VIEW\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Contact Labels\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The specified label.\n * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.GetLabel\n */\n function getLabel(key: string, options?: GetLabelOptions): Promise;\n interface GetLabelOptions {\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n /**\n * Renames a label.\n * @param key - Label key.\n *\n * `key` is generated when the label is created.\n * It can't be modified, even if `displayName` is updated.\n * @public\n * @requiredField key\n * @requiredField label\n * @requiredField label.displayName\n * @param options - Language options.\n * @param label - Label to rename.\n * @permissionId CONTACTS_LABELS.MODIFY\n * @permissionScope Manage Contact Labels\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Renamed label.\n * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.UpdateLabel\n */\n function renameLabel(key: string, label: RenameLabel, options?: RenameLabelOptions): Promise;\n interface RenameLabel {\n /**\n * Label namespace.\n *\n * Labels created by calling the Find Or Create Label method\n * are automatically assigned to the `custom` namespace.\n * @readonly\n */\n namespace?: string | null;\n /**\n * Display name for the namespace,\n * used to organize the list of labels in the site dashboard.\n * @readonly\n */\n namespaceDisplayName?: string | null;\n /** Label display name shown in the dashboard. */\n displayName?: string;\n /**\n * Label type indicating how the label was created.\n * @readonly\n */\n labelType?: LabelType;\n /**\n * Date and time the label was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the label was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface RenameLabelOptions {\n /**\n * Language for localization.\n * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.\n */\n language?: string | null;\n }\n /**\n * Deletes the specified label from a site and removes it from the contacts it applies to.\n * @param key - Label key to delete.\n * @public\n * @requiredField key\n * @permissionId CONTACTS_LABELS.MODIFY\n * @permissionScope Manage Contact Labels\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.DeleteLabel\n */\n function deleteLabel(key: string): Promise;\n /**\n * Creates a query to retrieve a list of labels.\n *\n * The `queryLabels()` method builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to call the query using the `find()` method.\n *\n * You can refine the query by chaining `LabelsQueryBuilder` methods onto the query. `LabelsQueryBuilder` methods enable you to filter, sort, and control the response that `queryLabels()` returns.\n *\n * `queryLabels()` is called with the following `LabelsQueryBuilder` defaults, which you can override:\n * - `skip(0)`\n * - `limit(50)`\n * - `descending('_createdDate')`\n *\n * The following `LabelsQueryBuilder` methods are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` field in `LabelsQueryResult`.\n *\n *\n * @public\n * @param options - Language options.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Contact Labels\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @permissionId CONTACTS_LABELS.VIEW\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.QueryLabels\n */\n function queryLabels(options?: QueryLabelsOptions): LabelsQueryBuilder;\n interface QueryLabelsOptions {\n /**\n * Language for localization.\n *\n * 2-letter language code in\n * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null | undefined;\n }\n interface QueryOffsetResult$2 {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LabelsQueryResult extends QueryOffsetResult$2 {\n items: ContactLabel[];\n query: LabelsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LabelsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"namespace\" | \"key\" | \"displayName\" | \"labelType\" | \"_createdDate\" | \"_updatedDate\", value: any) => LabelsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"namespace\" | \"key\" | \"displayName\" | \"_createdDate\" | \"_updatedDate\", value: any) => LabelsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LabelsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LabelsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LabelsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => LabelsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"displayName\", value: string) => LabelsQueryBuilder;\n in: (propertyName: \"key\" | \"displayName\", value: any) => LabelsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"displayName\" | \"_createdDate\" | \"_updatedDate\">) => LabelsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"displayName\" | \"_createdDate\" | \"_updatedDate\">) => LabelsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => LabelsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => LabelsQueryBuilder;\n find: () => Promise;\n }\n type contactsV4LabelLabels_universal_d_ContactLabel = ContactLabel;\n type contactsV4LabelLabels_universal_d_LabelType = LabelType;\n const contactsV4LabelLabels_universal_d_LabelType: typeof LabelType;\n type contactsV4LabelLabels_universal_d_ListLabelsRequest = ListLabelsRequest;\n type contactsV4LabelLabels_universal_d_ListLabelsResponse = ListLabelsResponse;\n type contactsV4LabelLabels_universal_d_FindOrCreateLabelRequest = FindOrCreateLabelRequest;\n type contactsV4LabelLabels_universal_d_FindOrCreateLabelResponse = FindOrCreateLabelResponse;\n type contactsV4LabelLabels_universal_d_LabelsQuotaReached = LabelsQuotaReached;\n type contactsV4LabelLabels_universal_d_ListLabelNamespacesRequest = ListLabelNamespacesRequest;\n type contactsV4LabelLabels_universal_d_ListLabelNamespacesResponse = ListLabelNamespacesResponse;\n type contactsV4LabelLabels_universal_d_ContactLabelNamespace = ContactLabelNamespace;\n type contactsV4LabelLabels_universal_d_GetLabelRequest = GetLabelRequest;\n type contactsV4LabelLabels_universal_d_GetLabelResponse = GetLabelResponse;\n type contactsV4LabelLabels_universal_d_GetLabelByLegacyIdRequest = GetLabelByLegacyIdRequest;\n type contactsV4LabelLabels_universal_d_GetLabelByLegacyIdResponse = GetLabelByLegacyIdResponse;\n type contactsV4LabelLabels_universal_d_UpdateLabelRequest = UpdateLabelRequest;\n type contactsV4LabelLabels_universal_d_UpdateLabelResponse = UpdateLabelResponse;\n type contactsV4LabelLabels_universal_d_DeleteLabelRequest = DeleteLabelRequest;\n type contactsV4LabelLabels_universal_d_DeleteLabelResponse = DeleteLabelResponse;\n type contactsV4LabelLabels_universal_d_QueryLabelsRequest = QueryLabelsRequest;\n type contactsV4LabelLabels_universal_d_QueryLabelsResponse = QueryLabelsResponse;\n type contactsV4LabelLabels_universal_d_ListLabelsOptions = ListLabelsOptions;\n const contactsV4LabelLabels_universal_d_findOrCreateLabel: typeof findOrCreateLabel;\n type contactsV4LabelLabels_universal_d_FindOrCreateLabelOptions = FindOrCreateLabelOptions;\n type contactsV4LabelLabels_universal_d_ListLabelNamespacesOptions = ListLabelNamespacesOptions;\n const contactsV4LabelLabels_universal_d_getLabel: typeof getLabel;\n type contactsV4LabelLabels_universal_d_GetLabelOptions = GetLabelOptions;\n const contactsV4LabelLabels_universal_d_renameLabel: typeof renameLabel;\n type contactsV4LabelLabels_universal_d_RenameLabel = RenameLabel;\n type contactsV4LabelLabels_universal_d_RenameLabelOptions = RenameLabelOptions;\n const contactsV4LabelLabels_universal_d_deleteLabel: typeof deleteLabel;\n const contactsV4LabelLabels_universal_d_queryLabels: typeof queryLabels;\n type contactsV4LabelLabels_universal_d_QueryLabelsOptions = QueryLabelsOptions;\n type contactsV4LabelLabels_universal_d_LabelsQueryResult = LabelsQueryResult;\n type contactsV4LabelLabels_universal_d_LabelsQueryBuilder = LabelsQueryBuilder;\n namespace contactsV4LabelLabels_universal_d {\n export { contactsV4LabelLabels_universal_d_ContactLabel as ContactLabel, contactsV4LabelLabels_universal_d_LabelType as LabelType, contactsV4LabelLabels_universal_d_ListLabelsRequest as ListLabelsRequest, Sorting$2 as Sorting, SortOrder$2 as SortOrder, Paging$2 as Paging, contactsV4LabelLabels_universal_d_ListLabelsResponse as ListLabelsResponse, PagingMetadata$2 as PagingMetadata, contactsV4LabelLabels_universal_d_FindOrCreateLabelRequest as FindOrCreateLabelRequest, contactsV4LabelLabels_universal_d_FindOrCreateLabelResponse as FindOrCreateLabelResponse, contactsV4LabelLabels_universal_d_LabelsQuotaReached as LabelsQuotaReached, contactsV4LabelLabels_universal_d_ListLabelNamespacesRequest as ListLabelNamespacesRequest, contactsV4LabelLabels_universal_d_ListLabelNamespacesResponse as ListLabelNamespacesResponse, contactsV4LabelLabels_universal_d_ContactLabelNamespace as ContactLabelNamespace, contactsV4LabelLabels_universal_d_GetLabelRequest as GetLabelRequest, contactsV4LabelLabels_universal_d_GetLabelResponse as GetLabelResponse, contactsV4LabelLabels_universal_d_GetLabelByLegacyIdRequest as GetLabelByLegacyIdRequest, contactsV4LabelLabels_universal_d_GetLabelByLegacyIdResponse as GetLabelByLegacyIdResponse, contactsV4LabelLabels_universal_d_UpdateLabelRequest as UpdateLabelRequest, contactsV4LabelLabels_universal_d_UpdateLabelResponse as UpdateLabelResponse, contactsV4LabelLabels_universal_d_DeleteLabelRequest as DeleteLabelRequest, contactsV4LabelLabels_universal_d_DeleteLabelResponse as DeleteLabelResponse, PurgeRequest$1 as PurgeRequest, PurgeResponse$1 as PurgeResponse, GdprListRequest$1 as GdprListRequest, GdprListResponse$1 as GdprListResponse, contactsV4LabelLabels_universal_d_QueryLabelsRequest as QueryLabelsRequest, Query$2 as Query, contactsV4LabelLabels_universal_d_QueryLabelsResponse as QueryLabelsResponse, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, RestoreInfo$2 as RestoreInfo, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, MessageEnvelope$2 as MessageEnvelope, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, contactsV4LabelLabels_universal_d_ListLabelsOptions as ListLabelsOptions, contactsV4LabelLabels_universal_d_findOrCreateLabel as findOrCreateLabel, contactsV4LabelLabels_universal_d_FindOrCreateLabelOptions as FindOrCreateLabelOptions, contactsV4LabelLabels_universal_d_ListLabelNamespacesOptions as ListLabelNamespacesOptions, contactsV4LabelLabels_universal_d_getLabel as getLabel, contactsV4LabelLabels_universal_d_GetLabelOptions as GetLabelOptions, contactsV4LabelLabels_universal_d_renameLabel as renameLabel, contactsV4LabelLabels_universal_d_RenameLabel as RenameLabel, contactsV4LabelLabels_universal_d_RenameLabelOptions as RenameLabelOptions, contactsV4LabelLabels_universal_d_deleteLabel as deleteLabel, contactsV4LabelLabels_universal_d_queryLabels as queryLabels, contactsV4LabelLabels_universal_d_QueryLabelsOptions as QueryLabelsOptions, contactsV4LabelLabels_universal_d_LabelsQueryResult as LabelsQueryResult, contactsV4LabelLabels_universal_d_LabelsQueryBuilder as LabelsQueryBuilder, };\n }\n interface Contact {\n /**\n * Contact ID.\n * @readonly\n */\n _id?: string;\n /**\n * Revision number, which increments by 1 each time the contact is updated.\n * To prevent conflicting changes,\n * the existing `revision` must be specified when updating a contact.\n * @readonly\n */\n revision?: number;\n /**\n * Details about the contact's source.\n * @readonly\n */\n source?: ContactSource;\n /**\n * Date and time the contact was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the contact was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Details about the contact's last action in the site.\n * @readonly\n */\n lastActivity?: ContactActivity;\n /**\n * Contact's primary phone and email.\n * @readonly\n */\n primaryInfo?: PrimaryContactInfo;\n /** Contact's details. */\n info?: ContactInfo;\n }\n interface ContactSource {\n /**\n * Source type.\n * @readonly\n */\n sourceType?: ContactSourceType;\n /**\n * App ID, if the contact was created by an app.\n * @readonly\n */\n appId?: string | null;\n }\n enum ContactSourceType {\n OTHER = \"OTHER\",\n ADMIN = \"ADMIN\",\n WIX_APP = \"WIX_APP\",\n IMPORT = \"IMPORT\",\n THIRD_PARTY = \"THIRD_PARTY\",\n WIX_BOOKINGS = \"WIX_BOOKINGS\",\n WIX_CHAT = \"WIX_CHAT\",\n WIX_EMAIL_MARKETING = \"WIX_EMAIL_MARKETING\",\n WIX_EVENTS = \"WIX_EVENTS\",\n WIX_FORMS = \"WIX_FORMS\",\n WIX_GROUPS = \"WIX_GROUPS\",\n WIX_HOTELS = \"WIX_HOTELS\",\n WIX_MARKET_PLACE = \"WIX_MARKET_PLACE\",\n WIX_MUSIC = \"WIX_MUSIC\",\n WIX_RESTAURANTS = \"WIX_RESTAURANTS\",\n WIX_SITE_MEMBERS = \"WIX_SITE_MEMBERS\",\n WIX_STORES = \"WIX_STORES\",\n WIX_CODE = \"WIX_CODE\",\n HOPP = \"HOPP\"\n }\n interface ContactActivity {\n /** Date and time of the last action. */\n activityDate?: Date | null;\n /** Contact's last action in the site. */\n activityType?: ContactActivityType;\n }\n enum ContactActivityType {\n /** Visited the site. */\n GENERAL = \"GENERAL\",\n /** Became a new contact. */\n CONTACT_CREATED = \"CONTACT_CREATED\",\n /** Logged in. */\n MEMBER_LOGIN = \"MEMBER_LOGIN\",\n /** Requested a site membership. */\n MEMBER_REGISTER = \"MEMBER_REGISTER\",\n /** Was approved, blocked, or unblocked. */\n MEMBER_STATUS_CHANGED = \"MEMBER_STATUS_CHANGED\",\n /** Submitted a form. */\n FORM_SUBMITTED = \"FORM_SUBMITTED\",\n /** Started a chat. */\n INBOX_FORM_SUBMITTED = \"INBOX_FORM_SUBMITTED\",\n /** Paid a payment request. */\n INBOX_PAYMENT_REQUEST_PAID = \"INBOX_PAYMENT_REQUEST_PAID\",\n /** Received a message from the site. */\n INBOX_MESSAGE_TO_CUSTOMER = \"INBOX_MESSAGE_TO_CUSTOMER\",\n /** Sent a new message to the site. */\n INBOX_MESSAGE_FROM_CUSTOMER = \"INBOX_MESSAGE_FROM_CUSTOMER\",\n /** Subscribed to a site newsletter through a form. */\n NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = \"NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED\",\n /** Unsubscribed from a site newsletter. */\n NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = \"NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE\",\n /** Made a purchase. */\n ECOM_PURCHASE = \"ECOM_PURCHASE\",\n /** Abandoned a shopping cart. */\n ECOM_CART_ABANDON = \"ECOM_CART_ABANDON\",\n /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */\n ECOM_CHECKOUT_BUYER = \"ECOM_CHECKOUT_BUYER\",\n /** Booked an appointment. */\n BOOKINGS_APPOINTMENT = \"BOOKINGS_APPOINTMENT\",\n /** Made a Wix Hotels reservation. */\n HOTELS_RESERVATION = \"HOTELS_RESERVATION\",\n /** Paid for a Wix Hotels reservation. */\n HOTELS_PURCHASE = \"HOTELS_PURCHASE\",\n /** Confirmed a Wix Hotels reservation. */\n HOTELS_CONFIRMATION = \"HOTELS_CONFIRMATION\",\n /** Canceled a Wix Hotels reservation. */\n HOTELS_CANCEL = \"HOTELS_CANCEL\",\n /** Purchased a video. */\n VIDEO_PURCHASE = \"VIDEO_PURCHASE\",\n /** Rented a video. */\n VIDEO_RENT = \"VIDEO_RENT\",\n /** Made a purchase with a pay button. */\n CASHIER_BUTTON_PURCHASE = \"CASHIER_BUTTON_PURCHASE\",\n /** Became a new Wix Marketplace lead. */\n ARENA_NEW_LEAD = \"ARENA_NEW_LEAD\",\n /** RSVP'd to an event. */\n EVENTS_RSVP = \"EVENTS_RSVP\",\n /** Paid an invoice. */\n INVOICE_PAY = \"INVOICE_PAY\",\n /** An invoice is now overdue. */\n INVOICE_OVERDUE = \"INVOICE_OVERDUE\",\n /** Accepted a price quote. */\n PRICE_QUOTE_ACCEPT = \"PRICE_QUOTE_ACCEPT\",\n /** A price quote has expired. */\n PRICE_QUOTE_EXPIRE = \"PRICE_QUOTE_EXPIRE\",\n /** Ordered food with Wix Restaurants. */\n RESTAURANTS_ORDER = \"RESTAURANTS_ORDER\",\n /** Made a Wix Restaurants reservation. */\n RESTAURANTS_RESERVATION = \"RESTAURANTS_RESERVATION\",\n /** Opened an email from the site. */\n SHOUTOUT_OPEN = \"SHOUTOUT_OPEN\",\n /** Clicked a link in an email from the site. */\n SHOUTOUT_CLICK = \"SHOUTOUT_CLICK\",\n /** Merged with another contact. */\n CONTACT_MERGED = \"CONTACT_MERGED\",\n /** Subscribed to a site newsletter. */\n NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = \"NEWSLETTER_SUBSCRIPTION_SUBSCRIBE\",\n /** Subscription status to site newsletters is pending confirmation. */\n NEWSLETTER_SUBSCRIPTION_PENDING = \"NEWSLETTER_SUBSCRIPTION_PENDING\",\n /** Subscription status to site newsletters is not set. */\n NEWSLETTER_SUBSCRIPTION_NOT_SET = \"NEWSLETTER_SUBSCRIPTION_NOT_SET\",\n /** Subscribed to phone notifications. */\n PHONE_SUBSCRIPTION_SUBSCRIBE = \"PHONE_SUBSCRIPTION_SUBSCRIBE\",\n /** Subscription to phone notificatons is pending confirmation. */\n PHONE_SUBSCRIPTION_PENDING = \"PHONE_SUBSCRIPTION_PENDING\",\n /** Subscription to phone notificatons is not set. */\n PHONE_SUBSCRIPTION_NOT_SET = \"PHONE_SUBSCRIPTION_NOT_SET\",\n /** Subscribed to phone notifications. */\n PHONE_SUBSCRIPTION_UNSUBSCRIBE = \"PHONE_SUBSCRIPTION_UNSUBSCRIBE\"\n }\n interface ActivityIcon {\n /** Icon name */\n name?: string | null;\n /** Icon url */\n url?: string | null;\n }\n interface PrimaryContactInfo {\n /**\n * Primary email address.\n *\n * This property reflects the email address in `info.emails`\n * where `primary` is `true`.\n * @readonly\n */\n email?: string | null;\n /**\n * Primary phone number.\n *\n * This property reflects the phone number in `info.phones`\n * where `primary` is `true`.\n * @readonly\n */\n phone?: string | null;\n }\n interface ContactInfo {\n /** Contact's first and last name. */\n name?: ContactName;\n /** Contact's email addresses. */\n emails?: ContactEmailsWrapper;\n /** Contact's phone numbers. */\n phones?: ContactPhonesWrapper;\n /** Contact's street addresses. */\n addresses?: ContactAddressesWrapper;\n /** Contact's company name. */\n company?: string | null;\n /** Contact's job title. */\n jobTitle?: string | null;\n /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */\n birthdate?: string | null;\n /**\n * Locale in\n * [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Typically, this is a lowercase 2-letter language code,\n * followed by a hyphen, followed by an uppercase 2-letter country code.\n * For example, `en-US` for U.S. English, and `de-DE` for Germany German.\n */\n locale?: string | null;\n /**\n * List of contact's labels.\n *\n * Labels are used to organize contacts. Labels can be\n * added and removed using Label Contact and Unlabel Contact, respectively.\n *\n * To view or manage contact labels, use the Labels API.\n */\n labelKeys?: LabelsWrapper;\n /**\n * Additional custom fields.\n *\n * Empty fields are not returned.\n */\n extendedFields?: ExtendedFieldsWrapper;\n /** Contact's profile picture. */\n picture?: ContactPicture;\n }\n interface ContactName {\n /** Contact's first name. */\n first?: string | null;\n /** Contact's last name. */\n last?: string | null;\n }\n interface ContactEmailsWrapper {\n /** List of up to 50 email addresses. */\n items?: ContactEmail[];\n }\n interface ContactEmail {\n /**\n * Email ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Email type.\n *\n * `UNTAGGED` is shown as \"Other\" in the Contact List.\n */\n tag?: EmailTag;\n /** Email address. */\n email?: string;\n /**\n * Indicates whether this is the contact's primary email address.\n * When changing `primary` to `true` for an email,\n * the contact's other emails become `false`.\n * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.\n */\n primary?: boolean | null;\n }\n enum EmailTag {\n UNTAGGED = \"UNTAGGED\",\n MAIN = \"MAIN\",\n HOME = \"HOME\",\n WORK = \"WORK\"\n }\n interface ContactPhonesWrapper {\n /** List of up to 50 phone numbers. */\n items?: ContactPhone[];\n }\n interface ContactPhone {\n /**\n * Phone ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Phone type.\n *\n * `UNTAGGED` is shown as \"Other\" in the Contact List.\n */\n tag?: PhoneTag;\n /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */\n countryCode?: string | null;\n /** Phone number. */\n phone?: string;\n /**\n * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)\n * phone number.\n * Automatically generated using `phone` and `countryCode`, pending both values are valid.\n * @readonly\n */\n e164Phone?: string | null;\n /**\n * Indicates whether this is the contact's primary phone number.\n * When changing `primary` to `true` for a phone,\n * the contact's `primary` field for other phones becomes `false`.\n * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.\n */\n primary?: boolean | null;\n }\n enum PhoneTag {\n UNTAGGED = \"UNTAGGED\",\n MAIN = \"MAIN\",\n HOME = \"HOME\",\n MOBILE = \"MOBILE\",\n WORK = \"WORK\",\n FAX = \"FAX\"\n }\n interface ContactAddressesWrapper {\n /** List of up to 50 addresses. */\n items?: ContactAddress[];\n }\n interface ContactAddress {\n /**\n * Street address ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Address type.\n * `UNTAGGED` is shown as \"Other\" in the Contact List.\n */\n tag?: AddressTag;\n /** Street address. */\n address?: Address;\n }\n enum AddressTag {\n UNTAGGED = \"UNTAGGED\",\n HOME = \"HOME\",\n WORK = \"WORK\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\n /** Street address object, with number and name in separate fields. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine1?: string | null;\n /**\n * 2-letter country code in an\n * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n */\n country?: string | null;\n /**\n * Code for a subdivision (such as state, prefecture, or province) in an\n * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.\n */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Postal or zip code. */\n postalCode?: string | null;\n /**\n * Free text providing more detailed address information,\n * such as apartment, suite, or floor.\n */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf {\n /** Street address object, with number and name in separate fields. */\n streetAddress?: StreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation {\n /** Address's latitude. */\n latitude?: number | null;\n /** Address's longitude. */\n longitude?: number | null;\n }\n interface Subdivision {\n /** subdivision short code */\n code?: string;\n /** Full subdivision name. */\n name?: string;\n }\n enum SubdivisionType {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface AssigneesWrapper {\n /** List of site contributor user IDs. */\n items?: string[];\n }\n interface LabelsWrapper {\n /**\n * List of contact label keys.\n *\n * Contact labels help categorize contacts. Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with Find or Create Label or List Labels.\n */\n items?: string[];\n }\n interface ExtendedFieldsWrapper {\n /**\n * Contact's extended fields,\n * where each key is the field key,\n * and each value is the field's value for the contact.\n *\n * To view and manage extended fields, use the Extended Fields API.\n */\n items?: Record;\n }\n interface LocationsWrapper {\n /** List of location ids. */\n items?: string[];\n }\n /** TEST contact picture description */\n interface ContactPicture {\n /**\n * Image.\n * This can contain an image URL or a Wix Media image ID.\n */\n image?: string;\n }\n enum ImageProvider {\n UNKNOWN = \"UNKNOWN\",\n /** Image stored outside Wix */\n EXTERNAL = \"EXTERNAL\",\n /** Stored in wix media platform, Must be uploaded by using `GeneratePictureUploadUrl` */\n WIX_MEDIA = \"WIX_MEDIA\"\n }\n interface SegmentsWrapper {\n /** List of Contact segment IDs */\n items?: string[];\n }\n interface PrimaryEmail {\n /**\n * Primary email address.\n *\n * This property reflects the email address in `info.emails`\n * where `primary` is `true`.\n * @readonly\n */\n email?: string | null;\n /**\n * Indicates the recipient's opt-in or opt-out status for marketing emails.\n *\n * - `NOT_SET`: No status specified. Default.\n * - `PENDING`: Subscription confirmation was requested,\n * but recipient hasn't confirmed yet.\n * - `SUBSCRIBED`: Recipient has opted in to marketing emails.\n * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.\n * @readonly\n */\n subscriptionStatus?: SubscriptionStatus;\n /**\n * Indicates last reported status of sent emails.\n *\n * - `NOT_SET`: No status reported. Default.\n * - `VALID`: Emails are being successfully delivered.\n * - `BOUNCED`: The last email to the recipient bounced or was rejected.\n * - `SPAM_COMPLAINT`: Recipient registered a spam complaint\n * with their email provider.\n * - `INACTIVE`: Multiple emails have been delivered without any kind of engagement from the recipient.\n * @readonly\n */\n deliverabilityStatus?: EmailDeliverabilityStatus;\n }\n enum SubscriptionStatus {\n NO_SUBSCRIPTION_STATUS = \"NO_SUBSCRIPTION_STATUS\",\n NOT_SET = \"NOT_SET\",\n PENDING = \"PENDING\",\n SUBSCRIBED = \"SUBSCRIBED\",\n UNSUBSCRIBED = \"UNSUBSCRIBED\"\n }\n enum EmailDeliverabilityStatus {\n UNKNOWN_EMAIL_DELIVERABILITY_STATUS = \"UNKNOWN_EMAIL_DELIVERABILITY_STATUS\",\n NOT_SET = \"NOT_SET\",\n VALID = \"VALID\",\n BOUNCED = \"BOUNCED\",\n SPAM_COMPLAINT = \"SPAM_COMPLAINT\",\n INACTIVE = \"INACTIVE\"\n }\n interface PrimaryPhone {\n /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the primary phone. */\n countryCode?: string | null;\n /**\n * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)\n * phone number.\n * Automatically generated using `phone` and `countryCode`,\n * as long as both of those values are valid.\n * @readonly\n */\n e164Phone?: string | null;\n /**\n * Formatted phone. Automatically generated using phone and countryCode.\n * @readonly\n */\n formattedPhone?: string | null;\n /**\n * Indicates the recipient's opt-in or opt-out status for SMS messages.\n *\n * - `NO_SUBSCRIPTION_STATUS`: No status exists. This is the status when the phone is not a valid E164 phone.\n * - `NOT_SET`: No status specified. Default when the phone is a valid E164 phone.\n * - `PENDING`: Subscription confirmation was requested,\n * but recipient hasn't confirmed yet.\n * - `SUBSCRIBED`: Recipient has opted in to SMS messages.\n * - `UNSUBSCRIBED`: Recipient has opted out of SMS messages.\n * @readonly\n */\n subscriptionStatus?: SubscriptionStatus;\n /**\n * Primary phone number.\n *\n * This property reflects the phone number in `info.phones`\n * where `primary` is `true`.\n * @readonly\n */\n phone?: string | null;\n }\n enum PhoneDeliverabilityStatus {\n NO_PHONE_DELIVERABILITY_STATUS = \"NO_PHONE_DELIVERABILITY_STATUS\",\n NOT_SET = \"NOT_SET\"\n }\n interface MemberInfo {\n /** Member ID */\n memberId?: string | null;\n /** Signup date */\n signupDate?: Date | null;\n /** Login email */\n email?: string | null;\n /** Indicate whether the email is verified */\n emailVerified?: boolean | null;\n /** Indicates whether the member is required to verify their email */\n emailVerificationRequired?: boolean | null;\n /**\n * Member status.\n * - `PENDING`: Member created and is waiting for approval by site owner.\n * - `ACTIVE`: Member can log in to the site.\n * - `OFFLINE`: Member is a [managed writer](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and cannot log in to the site.\n * - `BLOCKED': Member is blocked and cannot log in to the site.\n */\n status?: MemberStatus;\n /** Profile info */\n profileInfo?: ProfileInfo;\n /** User info */\n userInfo?: UserInfo;\n /** Session info */\n sessionInfo?: SessionInfo;\n /** Group info */\n groupInfo?: GroupInfo;\n }\n enum MemberStatus {\n UNKNOWN_MEMBER_STATUS = \"UNKNOWN_MEMBER_STATUS\",\n PENDING = \"PENDING\",\n ACTIVE = \"ACTIVE\",\n DELETED = \"DELETED\",\n BLOCKED = \"BLOCKED\",\n OFFLINE = \"OFFLINE\"\n }\n interface ProfileInfo {\n /** Nickname */\n nickname?: string | null;\n /** Privacy status */\n privacyStatus?: PrivacyStatus;\n /** Indicate whether the member is reported */\n reported?: boolean | null;\n /** Indicate whether the member is muted */\n muted?: boolean | null;\n /** Profile photo */\n photo?: string;\n }\n enum PrivacyStatus {\n UNKNOWN_PRIVACY_STATUS = \"UNKNOWN_PRIVACY_STATUS\",\n PRIVATE = \"PRIVATE\",\n PUBLIC = \"PUBLIC\"\n }\n interface UserInfo {\n /** User ID */\n userId?: string;\n /** The user's role on the website */\n role?: Role;\n }\n enum Role {\n UNSPECIFIED_ROLE = \"UNSPECIFIED_ROLE\",\n OWNER = \"OWNER\",\n CONTRIBUTOR = \"CONTRIBUTOR\"\n }\n interface SessionInfo {\n /** Last time the member logged in to the website */\n lastWebLogin?: Date | null;\n /** Last time the member logged in to one of the mobile apps */\n lastMobileLogin?: Date | null;\n /** List of mobile apps that the member has ever logged in to */\n mobileAppNames?: string[];\n }\n interface GroupInfo {\n /** Group IDs */\n groupIds?: string[];\n }\n interface ContactSubmitted {\n /** Pass through data, submitted with the contact */\n passThroughData?: string | null;\n /** Submitted activity */\n activity?: ContactActivity;\n /** Submitted Contact (after processing) */\n contact?: Contact;\n }\n interface ContactChanged {\n /** The Contact before the changes */\n previousContact?: Contact;\n /** The Contact after the changes */\n currentContact?: Contact;\n }\n interface ContactEmailSubscriptionUpdated {\n /** The updated contact ID. */\n contactId?: string;\n /** The revision of the contact. */\n revision?: number;\n /** The primary email of the contact with the updated subscription and deliverability status. */\n primaryEmail?: PrimaryEmail;\n /** Date and time the contact was updated with the email subscription or deliverability status. */\n _updatedDate?: Date | null;\n }\n interface ContactPhoneSubscriptionUpdated {\n /** The updated contact ID. */\n contactId?: string;\n /** The revision of the contact. */\n revision?: number;\n /** The primary phone of the contact with the updated subscription status. */\n primaryPhone?: PrimaryPhone;\n /** Date and time the contact was updated with the SMS subscription status. */\n _updatedDate?: Date | null;\n }\n /**\n * This message is an internal message used by this app and it is used to trigger\n * the update of the subscription status of the contact asynchronously.\n * It is published after a contact is created/updated/merged.\n */\n interface ContactPrimaryInfoUpdated {\n /** The updated contact ID. */\n contactId?: string;\n /** Indication whether the primary email was updated. */\n primaryEmailUpdated?: boolean;\n /** Indication whether primary phone was updated. */\n primaryPhoneUpdated?: boolean;\n /** previous primary email subscription status */\n previousPrimaryEmailSubscriptionStatus?: PrimarySubscriptionStatus;\n /** previous primary phone subscription status */\n previousPrimaryPhoneSubscriptionStatus?: PrimarySubscriptionStatus;\n }\n interface PrimarySubscriptionStatus {\n /** subscription status */\n subscriptionStatus?: SubscriptionStatus;\n }\n /**\n * This message is an internal message used by this app and it is used to trigger\n * the update of the contact's last activity is done asynchronously.\n */\n interface LastActivityUpdate {\n /** The contact ID. */\n contactId?: string;\n /** Activity date. */\n activityDate?: Date | null;\n /** Activity translation key. */\n activityTranslationKey?: string;\n /** Activity icon. */\n icon?: string | null;\n }\n /** Contact creation options. */\n interface CreateContactRequest {\n /** Contact info. */\n info: ContactInfo;\n /**\n * Controls whether the call will succeed\n * if the new contact information contains an email or a phone number already used by another contact.\n *\n * If set to `true`,\n * the call will succeed even if an email address or phone number is used by another contact.\n * If set to `false`,\n * the call will fail if the given email address is used by another contact or,\n * if the email address is not given and the given phone number is used by another contact.\n *\n * Default: `false`\n */\n allowDuplicates?: boolean;\n }\n /** Contact. */\n interface CreateContactResponse {\n /** Contact. */\n contact?: Contact;\n }\n interface DuplicateContactExists {\n duplicateContactId?: string | null;\n duplicateEmail?: string | null;\n duplicatePhone?: string | null;\n }\n interface UpdateContactRequest {\n /** ID of the contact to update. */\n contactId: string;\n /**\n * Revision number.\n * When updating, include the existing `revision`\n * to prevent conflicting updates.\n */\n revision: number | null;\n /**\n * Controls whether the call will succeed\n * if the new contact information contains an email or a phone number already used by another contact.\n *\n * If set to `true`,\n * the call will succeed even if an email address or phone number is used by another contact.\n * If set to `false`,\n * the call will fail if the given email address is used by another contact or,\n * if the email address is not given and the given phone number is used by another contact.\n *\n * Default: `false`\n */\n allowDuplicates?: boolean;\n /** Contact info. */\n info: ContactInfo;\n }\n /** Updated contact. */\n interface UpdateContactResponse {\n /** Updated contact. */\n contact?: Contact;\n }\n interface MergeContactsRequest {\n /** Target contact ID. */\n targetContactId: string;\n /**\n * Target contact revision number, which increments by 1 each time the contact is updated.\n * To prevent conflicting changes,\n * the target contact's current `revision` must be specified.\n */\n targetContactRevision: number | null;\n /**\n * IDs of up to 5 contacts to merge into the target contact.\n * When you merge more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n }\n interface MergeContactsResponse {\n /** Updated target contact. */\n contact?: Contact;\n }\n interface ContactMerged {\n /** ID of the contact the source contacts were merged into. */\n targetContactId?: string;\n /** IDs of contacts that were merged into the target contact. */\n sourceContactIds?: string[];\n /** Updated target contact. */\n targetContact?: Contact;\n }\n interface PreviewMergeContactsRequest {\n /** Target contact ID. */\n targetContactId: string;\n /**\n * IDs of up to 5 contacts to merge into the target contact.\n * When you merge more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n }\n interface PreviewMergeContactsResponse {\n /** Preview of the updated target contact. */\n contact?: Contact;\n }\n interface DeleteContactRequest {\n /** ID of the contact to delete. */\n contactId: string;\n }\n interface DeleteContactResponse {\n }\n interface LabelContactRequest {\n /** ID of the contact to add labels to. */\n contactId: string;\n /**\n * List of label keys to add to the contact.\n *\n * Label keys must exist to be added to the contact.\n * Use the Labels API to create or retrieve labels.\n */\n labelKeys: string[];\n }\n /** Updated contact. */\n interface LabelContactResponse {\n /** Updated contact. */\n contact?: Contact;\n }\n interface UnlabelContactRequest {\n /** ID of the contact to remove labels from. */\n contactId: string;\n /** List of label keys to remove from the contact. */\n labelKeys: string[];\n }\n /** Updated contact. */\n interface UnlabelContactResponse {\n /** Updated contact. */\n contact?: Contact;\n }\n interface LabelAndUnlabelContactRequest {\n /** Contact ID. */\n contactId: string;\n /**\n * List of label keys to add to the contact.\n *\n * Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with\n * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\n * or\n * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).\n */\n labelKeysToAdd: string[];\n /** List of label keys to remove from the contact. */\n labelKeysToRemove: string[];\n }\n interface LabelAndUnlabelContactResponse {\n /** Updated contact. */\n contact?: Contact;\n }\n interface ListContactsRequest {\n /** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */\n sort?: Sorting$1;\n /** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */\n paging?: Paging$1;\n /**\n * List of projected fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n * `id` and `revision` are always returned.\n *\n * Supported properties:\n * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n * `info.labelKeys`, `info.locations`, `info.extendedFields`\n */\n fields?: string[];\n fieldsets?: ContactFieldSet[];\n }\n interface Sorting$1 {\n /**\n * Field to sort by.\n *\n * Supported properties:\n * `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`, `info.name.first`, `info.name.last`, `info.company`,\n * `info.jobTitle`, `info.birthdate`\n */\n fieldName?: string;\n /**\n * Sort order.\n * Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Defaults to `ASC`.\n */\n order?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\n /**\n * Number of items to return. Learn more about pagination in API Query Language([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language)|[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).\n *\n * Default: `50`.
      \n * Maximum: `1000`.\n */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n enum ContactFieldSet {\n /** name, primaryEmail, primaryPhone */\n BASIC = \"BASIC\",\n /** name, phones, emails, addresses */\n COMMUNICATION_DETAILS = \"COMMUNICATION_DETAILS\",\n /** name, primaryInfo(email, phone), extendedFields */\n EXTENDED = \"EXTENDED\",\n /** Full contact object */\n FULL = \"FULL\"\n }\n /** List of contacts. */\n interface ListContactsResponse {\n /** List of contacts. */\n contacts?: Contact[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata$1;\n }\n interface PagingMetadata$1 {\n /** The number of items returned in this response. */\n count?: number | null;\n /** The offset which was requested. */\n offset?: number | null;\n /** The total number of items that match the query. */\n total?: number | null;\n /** A flag that indicates the server failed to calculate 'total' field. */\n tooManyToCount?: boolean | null;\n }\n interface QueryContactsRequest {\n /** Query options. */\n query?: Query$1;\n }\n interface Query$1 {\n /**\n * Filter object.\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * for more information.\n *\n * For a detailed list of supported filters, see\n * [Supported Filters](https://dev.wix.com/api/rest/contacts/contacts/supported-filters).\n */\n filter?: Record | null;\n /**\n * Sorting options.\n * See [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination)\n * for more information.\n *\n * Max: 1 sort object\n */\n sort?: Sorting$1[];\n /** Pagination options. */\n paging?: Paging$1;\n /**\n * List of projected fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n * `id` and `revision` are always returned.\n *\n * Supported properties:\n * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n * `info.labelKeys`, `info.locations`, `info.extendedFields`\n */\n fields?: string[];\n /**\n * Predefined sets of fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n *\n * - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n * - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n * - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n * - `FULL`: Returns all fields.\n *\n * Default: If `fields` is omitted from the request, `FULL`.\n */\n fieldsets?: ContactFieldSet[];\n }\n /** List of contacts. */\n interface QueryContactsResponse {\n /** List of contacts. */\n contacts?: Contact[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata$1;\n }\n interface ListFacetsRequest {\n /** Pagination options. */\n paging?: Paging$1;\n /** Language for localization. */\n language?: string | null;\n }\n interface ListFacetsResponse {\n /** List of facets. */\n facets?: ContactsFacet[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata$1;\n }\n interface ContactsFacet {\n /** Type of facet. */\n facetType?: ContactsFacetType;\n /**\n * Scope for facet keys.\n * When a facet key exists in a namespace,\n * each key is unique within that namespace.\n *\n * Currently, facets not created by Wix are in the `custom` namespace.\n */\n namespace?: string | null;\n /** Human-readable display name. */\n namespaceDisplayName?: string | null;\n /** Facet key, automatically generated. */\n facetKey?: string | null;\n /** Human-readable name. Shown in the Wix UI. */\n facetDisplayName?: string | null;\n /** Number of contacts the facet applies to. */\n count?: number | null;\n /** Filter used to query contacts of this facet. */\n queryFilter?: Record | null;\n }\n enum ContactsFacetType {\n UNKNOWN = \"UNKNOWN\",\n ALL_CONTACTS = \"ALL_CONTACTS\",\n NOT_LABELED = \"NOT_LABELED\",\n LABEL = \"LABEL\",\n SUBSCRIPTION_STATUS = \"SUBSCRIPTION_STATUS\",\n MEMBERSHIP_STATUS = \"MEMBERSHIP_STATUS\"\n }\n interface QueryFacetsRequest {\n /** Pagination options. */\n paging?: Paging$1;\n /** Language for localization. */\n language?: string | null;\n /**\n * Filterable fields:\n * - `'info.extendedFields.emailSubscriptions.effectiveEmail'` (`$exists`).\n * - `'info.extendedFields.emailSubscriptions.subscriptionStatus'` (`$eq`, `$ne`, `$in`, `$nin`).\n * - `'info.extendedFields.emailSubscriptions.deliverabilityStatus'` (`$eq`, `$ne`, `$in`, `$nin`).\n */\n filter?: Record | null;\n }\n interface QueryFacetsResponse {\n /** List of facets. */\n facets?: ContactsFacet[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata$1;\n }\n interface BulkDeleteContactsRequest {\n /**\n * Filter object.\n *\n * Possible filters:\n * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n *\n * See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a detailed list of supported filters for contact properties, extended fields, and custom fields.\n *\n *\n * Example:\n * `{ \"filter\": { \"info.name.last\": \"Smith\" } }`\n */\n filter?: Record | null;\n /**\n * Plain text search for an exact match, up to 100 characters.\n *\n * Searchable fields:\n *\n * - `info.name.first`\n * - `info.name.last`\n * - `info.emails.email`\n * - `info.phones.phone`\n */\n search?: string | null;\n }\n interface BulkDeleteContactsResponse {\n /**\n * Bulk job ID.\n * The job's status can be retrieved with Get Bulk Job.\n */\n jobId?: string;\n }\n interface BulkUpdateContactsRequest {\n /**\n * Filter object.\n *\n * Possible filters:\n * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n *\n * See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a detailed list of supported filters for contact properties, extended fields, and custom fields.\n *\n *\n * Example:\n * `{ \"filter\": { \"info.name.last\": \"Smith\" } }`\n */\n filter?: Record | null;\n /**\n * Plain text search for an exact match, up to 100 characters.\n *\n * Searchable fields:\n *\n * - `info.name.first`\n * - `info.name.last`\n * - `info.emails.email`\n * - `info.phones.phone`\n */\n search?: string | null;\n /** Contact info. */\n info?: ContactInfo;\n }\n interface BulkUpdateContactsResponse {\n /**\n * Bulk job ID.\n * The job's status can be retrieved with Get Bulk Job.\n */\n jobId?: string;\n }\n interface BulkLabelAndUnlabelContactsRequest {\n /**\n * Filter options.\n * Labels will be removed from contacts that meet the `filter` and `search` criteria.\n *\n * See\n * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a list of supported filters and fields.\n */\n filter?: Record | null;\n /**\n * Plain text search for an exact match, up to 100 characters.\n * Labels will be removed from contacts that meet the `filter` and `search` criteria.\n *\n * See\n * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a list of searchable fields.\n */\n search?: string | null;\n /**\n * List of label keys to add to the contacts.\n *\n * Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with\n * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\n * or\n * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)\n */\n labelKeysToAdd?: string[];\n /** List of label keys to remove from the contacts. */\n labelKeysToRemove?: string[];\n }\n interface BulkLabelAndUnlabelContactsResponse {\n /**\n * Bulk job ID.\n * The job's status can be retrieved with Get Bulk Job.\n */\n jobId?: string;\n }\n interface BulkUpsertContactsRequest {\n info?: ContactInfo[];\n returnFullEntity?: boolean;\n }\n interface BulkUpsertContactsResponse {\n results?: Item[];\n metadata?: BulkUpsertContactsResponseMetadata;\n }\n enum Action {\n UNKNOWN = \"UNKNOWN\",\n UPDATED = \"UPDATED\",\n CREATED = \"CREATED\"\n }\n interface Error {\n /** Error code. */\n code?: string;\n /** Error details. */\n message?: string | null;\n }\n interface Metadata {\n _id?: string | null;\n originalIndex?: number;\n action?: Action;\n success?: boolean;\n error?: Error;\n }\n interface Item {\n contact?: Contact;\n metadata?: Metadata;\n }\n interface BulkUpsertContactsResponseMetadata {\n totalSuccess?: number;\n totalFailure?: number;\n totalCreated?: number;\n totalUpdated?: number;\n }\n interface UpsertContactRequest {\n info: ContactInfo;\n }\n interface UpsertContactResponse {\n /** Upserted contact. */\n contact?: Contact;\n action?: UpsertContactResponseAction;\n }\n enum UpsertContactResponseAction {\n UNKNOWN = \"UNKNOWN\",\n UPDATED = \"UPDATED\",\n CREATED = \"CREATED\"\n }\n interface GeneratePictureUploadUrlRequest {\n /** ID of the contact whose picture is being updated. */\n contactId: string;\n /**\n * Mime Type. Must be one of:\n * `image/png`, `image/jpeg`.\n * Defaults to `image/png`.\n */\n mimeType?: string | null;\n }\n interface GeneratePictureUploadUrlResponse {\n /** URL to upload the image */\n uploadUrl?: string;\n }\n interface GetContactRequest {\n /** ID of the contact to retrieve. */\n _id: string;\n /**\n * List of projected fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n * `id` and `revision` are always returned.\n *\n * Supported properties:\n * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n * `info.labelKeys`, `info.locations`, `info.extendedFields`\n */\n fields?: string[];\n /**\n * Predefined sets of fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n *\n * - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n * - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n * - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n * - `FULL`: Returns all fields.\n *\n * Default: If `fields` is omitted from the request, `FULL`.\n */\n fieldsets?: ContactFieldSet[];\n }\n /** The requested contact. */\n interface GetContactResponse {\n /** The requested contact. */\n contact?: Contact;\n /** Contact response type. */\n responseType?: GetContactResponseType;\n }\n enum GetContactResponseType {\n /** The specified contact was returned. */\n REGULAR = \"REGULAR\",\n /** Not used. */\n IMPLICIT = \"IMPLICIT\",\n /** The specified contact was previously merged with another contact and the new contact was returned. */\n MERGED = \"MERGED\"\n }\n interface SyncSubmitContactRequest {\n contactInfo?: ContactInfo;\n activity?: ContactActivity;\n passThroughData?: string | null;\n contactId?: string;\n submitOperation?: SubmitOperation;\n /** Need to resolve source in allocator, because of server sign */\n sourceType?: ContactSourceType;\n sourceId?: string | null;\n hideFromContactList?: boolean;\n }\n enum SubmitOperation {\n UNKNOWN = \"UNKNOWN\",\n CREATE = \"CREATE\",\n UPDATE = \"UPDATE\"\n }\n interface SyncSubmitContactResponse {\n }\n interface CountContactsRequest {\n }\n interface CountContactsResponse {\n count?: number;\n }\n interface SearchContactsRequest {\n /** Search object. Encapsulates filter, sorting, paging and other details */\n search?: Search;\n }\n interface Search extends SearchPagingMethodOneOf {\n /** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */\n cursorPaging?: CursorPaging;\n /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */\n filter?: Record | null;\n /** Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}] */\n sort?: Sorting$1[];\n /**\n * List of projected fields to return.\n *\n * If used in the request,\n * all the fields contained in `fields` and `fieldsets` are returned.\n * If left blank, `fieldsets` is used to determine which fields to return.\n *\n * For a list of valid projected fields, see\n * [Valid Contact Projection Fields](https://dev.wix.com/api/rest/contacts/contacts/fieldsets-and-projected-fields#contacts_contacts_fieldsets-and-projected-fields_valid-contact-projection-fields).\n */\n fields?: string[];\n /**\n * Predefined sets of fields to return.\n *\n * Defaults to `FULL`.\n * Ignored if left empty when `fields` is used in the request.\n *\n * For more information,\n * see [Contact Fieldsets](https://dev.wix.com/api/rest/contacts/contacts/fieldsets-and-projected-fields#contacts_contacts_fieldsets-and-projected-fields_contact-fieldsets).\n */\n fieldsets?: string[];\n /** free text to match in searchable fields */\n search?: SearchDetails;\n }\n /** @oneof */\n interface SearchPagingMethodOneOf {\n /** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */\n cursorPaging?: CursorPaging;\n }\n interface SearchDetails {\n /** boolean search mode. Default is `OR` */\n mode?: Mode;\n /** search term or expression */\n expression?: string | null;\n /**\n * fields to search in. if empty - server will search in own default fieldsDefault searchable fields:\n *\n * - `info.name.first`\n * - `info.name.last`\n * - `info.emails.email`\n * - `info.phones.phone`\n */\n fields?: string[];\n /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */\n fuzzy?: boolean;\n }\n enum Mode {\n /** any */\n OR = \"OR\",\n /** all */\n AND = \"AND\"\n }\n interface CursorPaging {\n /** The number of contacts to load (default = 50, max = 1000) */\n limit?: number | null;\n /** Cursor returned in last query response. Should not be provided on first page request */\n cursor?: string | null;\n }\n interface SearchContactsResponse {\n /** List of contacts. */\n contacts?: Contact[];\n /** Details on the paged set of results returned. */\n cursorPagingMetadata?: CursorPagingMetadata;\n }\n /** This is the preferred message for cursor-paging enabled services */\n interface CursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors {\n /** Cursor pointing to next result page */\n next?: string | null;\n /** Cursor pointing to previous result page */\n prev?: string | null;\n }\n interface BulkAddSegmentToContactsRequest {\n /** Segment id */\n segmentId?: string;\n /** List of Contact ids */\n contactIds?: string[];\n /** List of existing segment ids */\n existsSegmentIds?: string[];\n }\n interface BulkAddSegmentToContactsResponse {\n /** List of action results */\n results?: ItemMetadata[];\n /** Metadata on the bulk action */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface ContactAddedToSegment {\n /** Id of the segment to which the contact was added */\n segmentId?: string;\n /** The contact that was added */\n contact?: Contact;\n }\n interface BulkRemoveSegmentFromContactsRequest {\n /** Segment id */\n segmentId?: string;\n /** List of Contact ids */\n contactIds?: string[];\n }\n interface BulkRemoveSegmentFromContactsResponse {\n /** List of action results */\n results?: ItemMetadata[];\n /** Metadata on the bulk action */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ContactRemovedFromSegment {\n /** Id of the segment from which the contact was removed */\n segmentId?: string;\n /** The contact that was removed */\n contact?: Contact;\n }\n interface ListContactIdsBySegmentRequest {\n /** Segment id */\n segmentId?: string;\n /** Cursor paging. */\n cursorPaging?: CursorPaging;\n }\n interface ListContactIdsBySegmentResponse {\n /** List of contact IDs */\n contactIds?: string[];\n /** Paging metadata */\n cursorPagingMetadata?: CursorPagingMetadata;\n }\n interface DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n }\n interface RestoreInfo$1 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$1 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$1 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$1 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a new contact.\n *\n * The `info` object must include at least one of the following:\n * - Name\n * - Phone number\n * - Email address\n *\n * By default, if the call contains an email already in use by another contact,\n * the new contact won't be created. To override this behavior, set `allowDuplicates` to `true`.\n * @param info - Contact info.\n * @public\n * @requiredField info\n * @param options - Create contact options.\n * @permissionId CONTACTS.MODIFY\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Contact.\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.CreateContact\n */\n function createContact(info: ContactInfo, options?: CreateContactOptions): Promise;\n interface CreateContactOptions {\n /**\n * Controls whether the call will succeed\n * if the new contact information contains an email or a phone number already used by another contact.\n *\n * If set to `true`,\n * the call will succeed even if an email address or phone number is used by another contact.\n * If set to `false`,\n * the call will fail if the given email address is used by another contact or,\n * if the email address is not given and the given phone number is used by another contact.\n *\n * Default: `false`\n */\n allowDuplicates?: boolean;\n }\n /**\n * Updates a contact.\n *\n * Each time the contact is updated,\n * `revision` increments by 1.\n * The existing `revision` must be included when updating the contact.\n * This ensures you're working with the latest contact information,\n * and it prevents unintended overwrites.\n *\n * You can't call Update Contact to update the `primaryEmail` of a contact who is also a member.\n * Instead, use the Members API to update the member's login email, which will also update the contact's primary email.\n *\n * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers. Make sure to specifiy the contact ID when calling Update Contact.\n * @param contactId - ID of the contact to update.\n * @param info - Contact info.\n * @param revision - Revision number.\n * When updating, include the existing `revision`\n * to prevent conflicting updates.\n * @public\n * @requiredField contactId\n * @requiredField info\n * @requiredField revision\n * @param options - Contact update options.\n * @permissionId CONTACTS.MODIFY\n * @permissionId CONTACTS.MODIFY_MEMBERSHIP_STATUS\n * @permissionId CONTACTS.MODIFY_MEMBER_PRIMARY_EMAIL_PERMISSION\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated contact.\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.UpdateContact\n */\n function updateContact(contactId: string, info: ContactInfo, revision: number | null, options?: UpdateContactOptions): Promise;\n interface UpdateContactOptions {\n /**\n * Controls whether the call will succeed\n * if the new contact information contains an email or a phone number already used by another contact.\n *\n * If set to `true`,\n * the call will succeed even if an email address or phone number is used by another contact.\n * If set to `false`,\n * the call will fail if the given email address is used by another contact or,\n * if the email address is not given and the given phone number is used by another contact.\n *\n * Default: `false`\n */\n allowDuplicates?: boolean;\n }\n /**\n * Merges source contacts into a target contact.\n *\n * Merging contacts has the following effects on the target contact:\n *\n * - No target contact data is overwritten or deleted.\n * - Arrays (emails, phone numbers, addresses, and labels) from the source contacts are added to the target contact's arrays.\n * - If you merge more than one source contact, the 1st source contact specified is added first, then the 2nd, and so on.\n * - If there is duplicate information between the target contact and the source contact, the information isn't duplicated in the target contact's arrays.\n *\n *
      \n *\n * __Important:__\n * Merges cannot be undone.\n * In REST, call Preview Merge Contacts to test before merging.\n *\n *
      \n *\n * When you merge contacts, source contacts are typically deleted.\n * However, if a source contact is a site member or a Wix user,\n * the merge will fail because site members and Wix users can't be deleted.\n * This means that site members and Wix users can only be specified as target contacts in a merge.\n *\n * After merging, calling Get Contact with a deleted source contact ID returns the target contact ID.\n * Specifying a deleted source contact ID is not supported on any other method.\n *\n * When contacts are merged:\n *\n * - The Contact Merged event is triggered.\n * - The Contact Updated event is triggered for the target contact. `originatedFrom` is set to `merge`.\n * - The Contact Deleted event is triggered for each source contact. `originatedFrom` is set to `merge`.\n * @param targetContactId - Target contact ID.\n * @param targetContactRevision - Target contact revision number, which increments by 1 each time the contact is updated.\n * To prevent conflicting changes,\n * the target contact's current `revision` must be specified.\n * @public\n * @requiredField targetContactId\n * @requiredField targetContactRevision\n * @param options - Merge contacts options.\n * @permissionId CONTACTS.MERGE\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.MergeContacts\n */\n function mergeContacts(targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions): Promise;\n interface MergeContactsOptions {\n /**\n * IDs of up to 5 contacts to merge into the target contact.\n * When you merge more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n }\n interface PreviewMergeContactsOptions {\n /**\n * IDs of up to 5 contacts to merge into the target contact.\n * When you merge more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n }\n /**\n * Deletes a contact.\n *\n * Deleting a contact permanently removes it from the contact list.\n * If a contact is also a site member or Wix user, or has a valid billing subscription,\n * the contact can't be deleted. The related site member or Wix user must first be deleted\n * and any valid billing subscriptions must be canceled, before the contact can be deleted.\n *\n * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.\n * Make sure to specify the contact ID when calling Delete Contact.\n * @param contactId - ID of the contact to delete.\n * @public\n * @requiredField contactId\n * @permissionId CONTACTS.MODIFY\n * @permissionId MEMBERS.MEMBER_DELETE\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @permissionScope Manage Members\n * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.DeleteContact\n */\n function deleteContact(contactId: string, options?: DeleteContactOptions): Promise;\n interface DeleteContactOptions {\n }\n /**\n * Adds labels to a contact.\n *\n * Use the Labels API to create or retrieve labels.\n *\n * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.\n * Make sure to specify the contact ID when calling Label Contact.\n * @param contactId - ID of the contact to add labels to.\n * @param labelKeys - List of label keys to add to the contact.\n *\n * Label keys must exist to be added to the contact.\n * Use the Labels API to create or retrieve labels.\n * @public\n * @requiredField contactId\n * @requiredField labelKeys\n * @permissionId CONTACTS.MODIFY\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated contact.\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.LabelContact\n */\n function labelContact(contactId: string, labelKeys: string[], options?: LabelContactOptions): Promise;\n interface LabelContactOptions {\n }\n /**\n * Removes labels from a contact.\n *\n * If a label is no longer needed\n * and you want to remove it from all contacts,\n * you can delete by calling Delete Label from the Labels API.\n *\n * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.\n * Make sure to specify the contact ID when calling Unlabel Contact.\n * @param contactId - ID of the contact to remove labels from.\n * @param labelKeys - List of label keys to remove from the contact.\n * @public\n * @requiredField contactId\n * @requiredField labelKeys\n * @permissionId CONTACTS.MODIFY\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated contact.\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.UnlabelContact\n */\n function unlabelContact(contactId: string, labelKeys: string[], options?: UnlabelContactOptions): Promise;\n interface UnlabelContactOptions {\n }\n interface LabelAndUnlabelContactOptions {\n /** List of label keys to remove from the contact. */\n labelKeysToRemove: string[];\n }\n interface ListContactsOptions {\n /** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */\n sort?: Sorting$1;\n /** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */\n paging?: Paging$1;\n /**\n * List of projected fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n * `id` and `revision` are always returned.\n *\n * Supported properties:\n * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n * `info.labelKeys`, `info.locations`, `info.extendedFields`\n */\n fields?: string[];\n fieldsets?: ContactFieldSet[];\n }\n /**\n * Creates a query to retrieve a list of contacts.\n *\n * The `queryContacts()` function builds a query to retrieve a list of contacts and returns a `ContactsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `ContactsQueryBuilder` functions onto the query. `ContactsQueryBuilder` functions enable you to sort, filter, and control the results `queryContacts()` returns.\n *\n * `queryContacts()` runs with these `ContactsQueryBuilder` defaults, which you can override:\n *\n * - `skip(0)`\n * - `limit(50)`\n * - `descending(\\\"_createdDate\\\")`\n *\n * The functions that are chained to `queryContacts()` are applied in the order they are called. For example, if you apply `ascending('info.company')` and then `descending('info.name.last')`, the results are sorted first by the company name, and then, if there are multiple results with the same company, the items are sorted by last name.\n * @public\n * @param options - Query contact options.\n * @permissionScope Read Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.READ-CONTACTS\n * @permissionScope Read Members and Contacts - all read permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @permissionId CONTACTS.VIEW\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.QueryContacts\n */\n function queryContacts(options?: QueryContactsOptions): ContactsQueryBuilder;\n interface QueryContactsOptions {\n }\n interface QueryOffsetResult$1 {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ContactsQueryResult extends QueryOffsetResult$1 {\n items: Contact[];\n query: ContactsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ContactsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"lastActivity.activityDate\" | \"primaryInfo.email\" | \"primaryInfo.phone\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\" | \"info.birthdate\" | \"info.locale\", value: any) => ContactsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"lastActivity.activityDate\" | \"primaryInfo.email\" | \"primaryInfo.phone\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\" | \"info.birthdate\" | \"info.locale\", value: any) => ContactsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"lastActivity.activityDate\", value: any) => ContactsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"lastActivity.activityDate\", value: any) => ContactsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"lastActivity.activityDate\", value: any) => ContactsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\" | \"lastActivity.activityDate\", value: any) => ContactsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"primaryInfo.email\" | \"primaryInfo.phone\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\", value: string) => ContactsQueryBuilder;\n in: (propertyName: \"_id\" | \"primaryInfo.email\" | \"primaryInfo.phone\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\" | \"info.locale\", value: any) => ContactsQueryBuilder;\n exists: (propertyName: \"_id\" | \"primaryInfo.email\" | \"primaryInfo.phone\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\" | \"info.locale\", value: boolean) => ContactsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_createdDate\" | \"lastActivity.activityDate\" | \"primaryInfo.email\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\" | \"info.birthdate\">) => ContactsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_createdDate\" | \"lastActivity.activityDate\" | \"primaryInfo.email\" | \"info.name.first\" | \"info.name.last\" | \"info.company\" | \"info.jobTitle\" | \"info.birthdate\">) => ContactsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => ContactsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => ContactsQueryBuilder;\n find: () => Promise;\n }\n interface ListFacetsOptions {\n /** Pagination options. */\n paging?: Paging$1;\n /** Language for localization. */\n language?: string | null;\n }\n interface QueryFacetsOptions {\n /** Pagination options. */\n paging?: Paging$1;\n /** Language for localization. */\n language?: string | null;\n /**\n * Filterable fields:\n * - `'info.extendedFields.emailSubscriptions.effectiveEmail'` (`$exists`).\n * - `'info.extendedFields.emailSubscriptions.subscriptionStatus'` (`$eq`, `$ne`, `$in`, `$nin`).\n * - `'info.extendedFields.emailSubscriptions.deliverabilityStatus'` (`$eq`, `$ne`, `$in`, `$nin`).\n */\n filter?: Record | null;\n }\n interface BulkDeleteContactsOptions {\n /**\n * Filter object.\n *\n * Possible filters:\n * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n *\n * See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a detailed list of supported filters for contact properties, extended fields, and custom fields.\n *\n *\n * Example:\n * `{ \"filter\": { \"info.name.last\": \"Smith\" } }`\n */\n filter?: Record | null;\n /**\n * Plain text search for an exact match, up to 100 characters.\n *\n * Searchable fields:\n *\n * - `info.name.first`\n * - `info.name.last`\n * - `info.emails.email`\n * - `info.phones.phone`\n */\n search?: string | null;\n }\n interface BulkUpdateContactsOptions {\n /**\n * Filter object.\n *\n * Possible filters:\n * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n *\n * See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a detailed list of supported filters for contact properties, extended fields, and custom fields.\n *\n *\n * Example:\n * `{ \"filter\": { \"info.name.last\": \"Smith\" } }`\n */\n filter?: Record | null;\n /**\n * Plain text search for an exact match, up to 100 characters.\n *\n * Searchable fields:\n *\n * - `info.name.first`\n * - `info.name.last`\n * - `info.emails.email`\n * - `info.phones.phone`\n */\n search?: string | null;\n /** Contact info. */\n info?: ContactInfo;\n }\n interface BulkLabelAndUnlabelContactsOptions {\n /**\n * Filter options.\n * Labels will be removed from contacts that meet the `filter` and `search` criteria.\n *\n * See\n * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a list of supported filters and fields.\n */\n filter?: Record | null;\n /**\n * Plain text search for an exact match, up to 100 characters.\n * Labels will be removed from contacts that meet the `filter` and `search` criteria.\n *\n * See\n * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)\n * for a list of searchable fields.\n */\n search?: string | null;\n /**\n * List of label keys to add to the contacts.\n *\n * Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with\n * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\n * or\n * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)\n */\n labelKeysToAdd?: string[];\n /** List of label keys to remove from the contacts. */\n labelKeysToRemove?: string[];\n }\n interface BulkUpsertContactsOptions {\n info?: ContactInfo[];\n returnFullEntity?: boolean;\n }\n interface GeneratePictureUploadUrlOptions {\n /**\n * Mime Type. Must be one of:\n * `image/png`, `image/jpeg`.\n * Defaults to `image/png`.\n */\n mimeType?: string | null;\n }\n /**\n * Retrieves a contact.\n *\n * #### Getting Merged Contacts\n *\n * When a source contact is merged\n * with a target contact, the source contact is deleted.\n * When calling Get Contact for a merged contact,\n * you can use the source or target contact ID.\n * In both bases, the target contact is returned.\n *\n * This is supported only when calling Get Contact on merged contacts.\n * Previously deleted source contact IDs can't be used for any other method.\n * @param _id - ID of the contact to retrieve.\n * @public\n * @requiredField _id\n * @param options - Get contact options.\n * @permissionId CONTACTS.VIEW\n * @permissionScope Read Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.READ-CONTACTS\n * @permissionScope Read Members and Contacts - all read permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n * @permissionScope Manage Contacts\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The requested contact.\n * @fqn com.wixpress.contacts.core.api.v4.ContactsServiceV4.GetContact\n */\n function getContact(_id: string, options?: GetContactOptions): Promise;\n interface GetContactOptions {\n /**\n * List of projected fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n * `id` and `revision` are always returned.\n *\n * Supported properties:\n * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n * `info.labelKeys`, `info.locations`, `info.extendedFields`\n */\n fields?: string[];\n /**\n * Predefined sets of fields to return.\n * If both `fields` and `fieldsets` are sent in the request,\n * the union of both lists is returned.\n *\n * - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n * - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n * - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n * - `FULL`: Returns all fields.\n *\n * Default: If `fields` is omitted from the request, `FULL`.\n */\n fieldsets?: ContactFieldSet[];\n }\n interface SearchContactsOptions {\n /** Search object. Encapsulates filter, sorting, paging and other details */\n search?: Search;\n }\n type contactsV4ContactContacts_universal_d_Contact = Contact;\n type contactsV4ContactContacts_universal_d_ContactSource = ContactSource;\n type contactsV4ContactContacts_universal_d_ContactSourceType = ContactSourceType;\n const contactsV4ContactContacts_universal_d_ContactSourceType: typeof ContactSourceType;\n type contactsV4ContactContacts_universal_d_ContactActivity = ContactActivity;\n type contactsV4ContactContacts_universal_d_ContactActivityType = ContactActivityType;\n const contactsV4ContactContacts_universal_d_ContactActivityType: typeof ContactActivityType;\n type contactsV4ContactContacts_universal_d_ActivityIcon = ActivityIcon;\n type contactsV4ContactContacts_universal_d_PrimaryContactInfo = PrimaryContactInfo;\n type contactsV4ContactContacts_universal_d_ContactInfo = ContactInfo;\n type contactsV4ContactContacts_universal_d_ContactName = ContactName;\n type contactsV4ContactContacts_universal_d_ContactEmailsWrapper = ContactEmailsWrapper;\n type contactsV4ContactContacts_universal_d_ContactEmail = ContactEmail;\n type contactsV4ContactContacts_universal_d_EmailTag = EmailTag;\n const contactsV4ContactContacts_universal_d_EmailTag: typeof EmailTag;\n type contactsV4ContactContacts_universal_d_ContactPhonesWrapper = ContactPhonesWrapper;\n type contactsV4ContactContacts_universal_d_ContactPhone = ContactPhone;\n type contactsV4ContactContacts_universal_d_PhoneTag = PhoneTag;\n const contactsV4ContactContacts_universal_d_PhoneTag: typeof PhoneTag;\n type contactsV4ContactContacts_universal_d_ContactAddressesWrapper = ContactAddressesWrapper;\n type contactsV4ContactContacts_universal_d_ContactAddress = ContactAddress;\n type contactsV4ContactContacts_universal_d_AddressTag = AddressTag;\n const contactsV4ContactContacts_universal_d_AddressTag: typeof AddressTag;\n type contactsV4ContactContacts_universal_d_Address = Address;\n type contactsV4ContactContacts_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type contactsV4ContactContacts_universal_d_StreetAddress = StreetAddress;\n type contactsV4ContactContacts_universal_d_AddressLocation = AddressLocation;\n type contactsV4ContactContacts_universal_d_Subdivision = Subdivision;\n type contactsV4ContactContacts_universal_d_SubdivisionType = SubdivisionType;\n const contactsV4ContactContacts_universal_d_SubdivisionType: typeof SubdivisionType;\n type contactsV4ContactContacts_universal_d_AssigneesWrapper = AssigneesWrapper;\n type contactsV4ContactContacts_universal_d_LabelsWrapper = LabelsWrapper;\n type contactsV4ContactContacts_universal_d_ExtendedFieldsWrapper = ExtendedFieldsWrapper;\n type contactsV4ContactContacts_universal_d_LocationsWrapper = LocationsWrapper;\n type contactsV4ContactContacts_universal_d_ContactPicture = ContactPicture;\n type contactsV4ContactContacts_universal_d_ImageProvider = ImageProvider;\n const contactsV4ContactContacts_universal_d_ImageProvider: typeof ImageProvider;\n type contactsV4ContactContacts_universal_d_SegmentsWrapper = SegmentsWrapper;\n type contactsV4ContactContacts_universal_d_PrimaryEmail = PrimaryEmail;\n type contactsV4ContactContacts_universal_d_SubscriptionStatus = SubscriptionStatus;\n const contactsV4ContactContacts_universal_d_SubscriptionStatus: typeof SubscriptionStatus;\n type contactsV4ContactContacts_universal_d_EmailDeliverabilityStatus = EmailDeliverabilityStatus;\n const contactsV4ContactContacts_universal_d_EmailDeliverabilityStatus: typeof EmailDeliverabilityStatus;\n type contactsV4ContactContacts_universal_d_PrimaryPhone = PrimaryPhone;\n type contactsV4ContactContacts_universal_d_PhoneDeliverabilityStatus = PhoneDeliverabilityStatus;\n const contactsV4ContactContacts_universal_d_PhoneDeliverabilityStatus: typeof PhoneDeliverabilityStatus;\n type contactsV4ContactContacts_universal_d_MemberInfo = MemberInfo;\n type contactsV4ContactContacts_universal_d_MemberStatus = MemberStatus;\n const contactsV4ContactContacts_universal_d_MemberStatus: typeof MemberStatus;\n type contactsV4ContactContacts_universal_d_ProfileInfo = ProfileInfo;\n type contactsV4ContactContacts_universal_d_PrivacyStatus = PrivacyStatus;\n const contactsV4ContactContacts_universal_d_PrivacyStatus: typeof PrivacyStatus;\n type contactsV4ContactContacts_universal_d_UserInfo = UserInfo;\n type contactsV4ContactContacts_universal_d_Role = Role;\n const contactsV4ContactContacts_universal_d_Role: typeof Role;\n type contactsV4ContactContacts_universal_d_SessionInfo = SessionInfo;\n type contactsV4ContactContacts_universal_d_GroupInfo = GroupInfo;\n type contactsV4ContactContacts_universal_d_ContactSubmitted = ContactSubmitted;\n type contactsV4ContactContacts_universal_d_ContactChanged = ContactChanged;\n type contactsV4ContactContacts_universal_d_ContactEmailSubscriptionUpdated = ContactEmailSubscriptionUpdated;\n type contactsV4ContactContacts_universal_d_ContactPhoneSubscriptionUpdated = ContactPhoneSubscriptionUpdated;\n type contactsV4ContactContacts_universal_d_ContactPrimaryInfoUpdated = ContactPrimaryInfoUpdated;\n type contactsV4ContactContacts_universal_d_PrimarySubscriptionStatus = PrimarySubscriptionStatus;\n type contactsV4ContactContacts_universal_d_LastActivityUpdate = LastActivityUpdate;\n type contactsV4ContactContacts_universal_d_CreateContactRequest = CreateContactRequest;\n type contactsV4ContactContacts_universal_d_CreateContactResponse = CreateContactResponse;\n type contactsV4ContactContacts_universal_d_DuplicateContactExists = DuplicateContactExists;\n type contactsV4ContactContacts_universal_d_UpdateContactRequest = UpdateContactRequest;\n type contactsV4ContactContacts_universal_d_UpdateContactResponse = UpdateContactResponse;\n type contactsV4ContactContacts_universal_d_MergeContactsRequest = MergeContactsRequest;\n type contactsV4ContactContacts_universal_d_MergeContactsResponse = MergeContactsResponse;\n type contactsV4ContactContacts_universal_d_ContactMerged = ContactMerged;\n type contactsV4ContactContacts_universal_d_PreviewMergeContactsRequest = PreviewMergeContactsRequest;\n type contactsV4ContactContacts_universal_d_PreviewMergeContactsResponse = PreviewMergeContactsResponse;\n type contactsV4ContactContacts_universal_d_DeleteContactRequest = DeleteContactRequest;\n type contactsV4ContactContacts_universal_d_DeleteContactResponse = DeleteContactResponse;\n type contactsV4ContactContacts_universal_d_LabelContactRequest = LabelContactRequest;\n type contactsV4ContactContacts_universal_d_LabelContactResponse = LabelContactResponse;\n type contactsV4ContactContacts_universal_d_UnlabelContactRequest = UnlabelContactRequest;\n type contactsV4ContactContacts_universal_d_UnlabelContactResponse = UnlabelContactResponse;\n type contactsV4ContactContacts_universal_d_LabelAndUnlabelContactRequest = LabelAndUnlabelContactRequest;\n type contactsV4ContactContacts_universal_d_LabelAndUnlabelContactResponse = LabelAndUnlabelContactResponse;\n type contactsV4ContactContacts_universal_d_ListContactsRequest = ListContactsRequest;\n type contactsV4ContactContacts_universal_d_ContactFieldSet = ContactFieldSet;\n const contactsV4ContactContacts_universal_d_ContactFieldSet: typeof ContactFieldSet;\n type contactsV4ContactContacts_universal_d_ListContactsResponse = ListContactsResponse;\n type contactsV4ContactContacts_universal_d_QueryContactsRequest = QueryContactsRequest;\n type contactsV4ContactContacts_universal_d_QueryContactsResponse = QueryContactsResponse;\n type contactsV4ContactContacts_universal_d_ListFacetsRequest = ListFacetsRequest;\n type contactsV4ContactContacts_universal_d_ListFacetsResponse = ListFacetsResponse;\n type contactsV4ContactContacts_universal_d_ContactsFacet = ContactsFacet;\n type contactsV4ContactContacts_universal_d_ContactsFacetType = ContactsFacetType;\n const contactsV4ContactContacts_universal_d_ContactsFacetType: typeof ContactsFacetType;\n type contactsV4ContactContacts_universal_d_QueryFacetsRequest = QueryFacetsRequest;\n type contactsV4ContactContacts_universal_d_QueryFacetsResponse = QueryFacetsResponse;\n type contactsV4ContactContacts_universal_d_BulkDeleteContactsRequest = BulkDeleteContactsRequest;\n type contactsV4ContactContacts_universal_d_BulkDeleteContactsResponse = BulkDeleteContactsResponse;\n type contactsV4ContactContacts_universal_d_BulkUpdateContactsRequest = BulkUpdateContactsRequest;\n type contactsV4ContactContacts_universal_d_BulkUpdateContactsResponse = BulkUpdateContactsResponse;\n type contactsV4ContactContacts_universal_d_BulkLabelAndUnlabelContactsRequest = BulkLabelAndUnlabelContactsRequest;\n type contactsV4ContactContacts_universal_d_BulkLabelAndUnlabelContactsResponse = BulkLabelAndUnlabelContactsResponse;\n type contactsV4ContactContacts_universal_d_BulkUpsertContactsRequest = BulkUpsertContactsRequest;\n type contactsV4ContactContacts_universal_d_BulkUpsertContactsResponse = BulkUpsertContactsResponse;\n type contactsV4ContactContacts_universal_d_Action = Action;\n const contactsV4ContactContacts_universal_d_Action: typeof Action;\n type contactsV4ContactContacts_universal_d_Error = Error;\n type contactsV4ContactContacts_universal_d_Metadata = Metadata;\n type contactsV4ContactContacts_universal_d_Item = Item;\n type contactsV4ContactContacts_universal_d_BulkUpsertContactsResponseMetadata = BulkUpsertContactsResponseMetadata;\n type contactsV4ContactContacts_universal_d_UpsertContactRequest = UpsertContactRequest;\n type contactsV4ContactContacts_universal_d_UpsertContactResponse = UpsertContactResponse;\n type contactsV4ContactContacts_universal_d_UpsertContactResponseAction = UpsertContactResponseAction;\n const contactsV4ContactContacts_universal_d_UpsertContactResponseAction: typeof UpsertContactResponseAction;\n type contactsV4ContactContacts_universal_d_GeneratePictureUploadUrlRequest = GeneratePictureUploadUrlRequest;\n type contactsV4ContactContacts_universal_d_GeneratePictureUploadUrlResponse = GeneratePictureUploadUrlResponse;\n type contactsV4ContactContacts_universal_d_GetContactRequest = GetContactRequest;\n type contactsV4ContactContacts_universal_d_GetContactResponse = GetContactResponse;\n type contactsV4ContactContacts_universal_d_GetContactResponseType = GetContactResponseType;\n const contactsV4ContactContacts_universal_d_GetContactResponseType: typeof GetContactResponseType;\n type contactsV4ContactContacts_universal_d_SyncSubmitContactRequest = SyncSubmitContactRequest;\n type contactsV4ContactContacts_universal_d_SubmitOperation = SubmitOperation;\n const contactsV4ContactContacts_universal_d_SubmitOperation: typeof SubmitOperation;\n type contactsV4ContactContacts_universal_d_SyncSubmitContactResponse = SyncSubmitContactResponse;\n type contactsV4ContactContacts_universal_d_CountContactsRequest = CountContactsRequest;\n type contactsV4ContactContacts_universal_d_CountContactsResponse = CountContactsResponse;\n type contactsV4ContactContacts_universal_d_SearchContactsRequest = SearchContactsRequest;\n type contactsV4ContactContacts_universal_d_Search = Search;\n type contactsV4ContactContacts_universal_d_SearchPagingMethodOneOf = SearchPagingMethodOneOf;\n type contactsV4ContactContacts_universal_d_SearchDetails = SearchDetails;\n type contactsV4ContactContacts_universal_d_Mode = Mode;\n const contactsV4ContactContacts_universal_d_Mode: typeof Mode;\n type contactsV4ContactContacts_universal_d_CursorPaging = CursorPaging;\n type contactsV4ContactContacts_universal_d_SearchContactsResponse = SearchContactsResponse;\n type contactsV4ContactContacts_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type contactsV4ContactContacts_universal_d_Cursors = Cursors;\n type contactsV4ContactContacts_universal_d_BulkAddSegmentToContactsRequest = BulkAddSegmentToContactsRequest;\n type contactsV4ContactContacts_universal_d_BulkAddSegmentToContactsResponse = BulkAddSegmentToContactsResponse;\n type contactsV4ContactContacts_universal_d_ItemMetadata = ItemMetadata;\n type contactsV4ContactContacts_universal_d_ApplicationError = ApplicationError;\n type contactsV4ContactContacts_universal_d_BulkActionMetadata = BulkActionMetadata;\n type contactsV4ContactContacts_universal_d_ContactAddedToSegment = ContactAddedToSegment;\n type contactsV4ContactContacts_universal_d_BulkRemoveSegmentFromContactsRequest = BulkRemoveSegmentFromContactsRequest;\n type contactsV4ContactContacts_universal_d_BulkRemoveSegmentFromContactsResponse = BulkRemoveSegmentFromContactsResponse;\n type contactsV4ContactContacts_universal_d_ContactRemovedFromSegment = ContactRemovedFromSegment;\n type contactsV4ContactContacts_universal_d_ListContactIdsBySegmentRequest = ListContactIdsBySegmentRequest;\n type contactsV4ContactContacts_universal_d_ListContactIdsBySegmentResponse = ListContactIdsBySegmentResponse;\n const contactsV4ContactContacts_universal_d_createContact: typeof createContact;\n type contactsV4ContactContacts_universal_d_CreateContactOptions = CreateContactOptions;\n const contactsV4ContactContacts_universal_d_updateContact: typeof updateContact;\n type contactsV4ContactContacts_universal_d_UpdateContactOptions = UpdateContactOptions;\n const contactsV4ContactContacts_universal_d_mergeContacts: typeof mergeContacts;\n type contactsV4ContactContacts_universal_d_MergeContactsOptions = MergeContactsOptions;\n type contactsV4ContactContacts_universal_d_PreviewMergeContactsOptions = PreviewMergeContactsOptions;\n const contactsV4ContactContacts_universal_d_deleteContact: typeof deleteContact;\n type contactsV4ContactContacts_universal_d_DeleteContactOptions = DeleteContactOptions;\n const contactsV4ContactContacts_universal_d_labelContact: typeof labelContact;\n type contactsV4ContactContacts_universal_d_LabelContactOptions = LabelContactOptions;\n const contactsV4ContactContacts_universal_d_unlabelContact: typeof unlabelContact;\n type contactsV4ContactContacts_universal_d_UnlabelContactOptions = UnlabelContactOptions;\n type contactsV4ContactContacts_universal_d_LabelAndUnlabelContactOptions = LabelAndUnlabelContactOptions;\n type contactsV4ContactContacts_universal_d_ListContactsOptions = ListContactsOptions;\n const contactsV4ContactContacts_universal_d_queryContacts: typeof queryContacts;\n type contactsV4ContactContacts_universal_d_QueryContactsOptions = QueryContactsOptions;\n type contactsV4ContactContacts_universal_d_ContactsQueryResult = ContactsQueryResult;\n type contactsV4ContactContacts_universal_d_ContactsQueryBuilder = ContactsQueryBuilder;\n type contactsV4ContactContacts_universal_d_ListFacetsOptions = ListFacetsOptions;\n type contactsV4ContactContacts_universal_d_QueryFacetsOptions = QueryFacetsOptions;\n type contactsV4ContactContacts_universal_d_BulkDeleteContactsOptions = BulkDeleteContactsOptions;\n type contactsV4ContactContacts_universal_d_BulkUpdateContactsOptions = BulkUpdateContactsOptions;\n type contactsV4ContactContacts_universal_d_BulkLabelAndUnlabelContactsOptions = BulkLabelAndUnlabelContactsOptions;\n type contactsV4ContactContacts_universal_d_BulkUpsertContactsOptions = BulkUpsertContactsOptions;\n type contactsV4ContactContacts_universal_d_GeneratePictureUploadUrlOptions = GeneratePictureUploadUrlOptions;\n const contactsV4ContactContacts_universal_d_getContact: typeof getContact;\n type contactsV4ContactContacts_universal_d_GetContactOptions = GetContactOptions;\n type contactsV4ContactContacts_universal_d_SearchContactsOptions = SearchContactsOptions;\n namespace contactsV4ContactContacts_universal_d {\n export { contactsV4ContactContacts_universal_d_Contact as Contact, contactsV4ContactContacts_universal_d_ContactSource as ContactSource, contactsV4ContactContacts_universal_d_ContactSourceType as ContactSourceType, contactsV4ContactContacts_universal_d_ContactActivity as ContactActivity, contactsV4ContactContacts_universal_d_ContactActivityType as ContactActivityType, contactsV4ContactContacts_universal_d_ActivityIcon as ActivityIcon, contactsV4ContactContacts_universal_d_PrimaryContactInfo as PrimaryContactInfo, contactsV4ContactContacts_universal_d_ContactInfo as ContactInfo, contactsV4ContactContacts_universal_d_ContactName as ContactName, contactsV4ContactContacts_universal_d_ContactEmailsWrapper as ContactEmailsWrapper, contactsV4ContactContacts_universal_d_ContactEmail as ContactEmail, contactsV4ContactContacts_universal_d_EmailTag as EmailTag, contactsV4ContactContacts_universal_d_ContactPhonesWrapper as ContactPhonesWrapper, contactsV4ContactContacts_universal_d_ContactPhone as ContactPhone, contactsV4ContactContacts_universal_d_PhoneTag as PhoneTag, contactsV4ContactContacts_universal_d_ContactAddressesWrapper as ContactAddressesWrapper, contactsV4ContactContacts_universal_d_ContactAddress as ContactAddress, contactsV4ContactContacts_universal_d_AddressTag as AddressTag, contactsV4ContactContacts_universal_d_Address as Address, contactsV4ContactContacts_universal_d_AddressStreetOneOf as AddressStreetOneOf, contactsV4ContactContacts_universal_d_StreetAddress as StreetAddress, contactsV4ContactContacts_universal_d_AddressLocation as AddressLocation, contactsV4ContactContacts_universal_d_Subdivision as Subdivision, contactsV4ContactContacts_universal_d_SubdivisionType as SubdivisionType, contactsV4ContactContacts_universal_d_AssigneesWrapper as AssigneesWrapper, contactsV4ContactContacts_universal_d_LabelsWrapper as LabelsWrapper, contactsV4ContactContacts_universal_d_ExtendedFieldsWrapper as ExtendedFieldsWrapper, contactsV4ContactContacts_universal_d_LocationsWrapper as LocationsWrapper, contactsV4ContactContacts_universal_d_ContactPicture as ContactPicture, contactsV4ContactContacts_universal_d_ImageProvider as ImageProvider, contactsV4ContactContacts_universal_d_SegmentsWrapper as SegmentsWrapper, contactsV4ContactContacts_universal_d_PrimaryEmail as PrimaryEmail, contactsV4ContactContacts_universal_d_SubscriptionStatus as SubscriptionStatus, contactsV4ContactContacts_universal_d_EmailDeliverabilityStatus as EmailDeliverabilityStatus, contactsV4ContactContacts_universal_d_PrimaryPhone as PrimaryPhone, contactsV4ContactContacts_universal_d_PhoneDeliverabilityStatus as PhoneDeliverabilityStatus, contactsV4ContactContacts_universal_d_MemberInfo as MemberInfo, contactsV4ContactContacts_universal_d_MemberStatus as MemberStatus, contactsV4ContactContacts_universal_d_ProfileInfo as ProfileInfo, contactsV4ContactContacts_universal_d_PrivacyStatus as PrivacyStatus, contactsV4ContactContacts_universal_d_UserInfo as UserInfo, contactsV4ContactContacts_universal_d_Role as Role, contactsV4ContactContacts_universal_d_SessionInfo as SessionInfo, contactsV4ContactContacts_universal_d_GroupInfo as GroupInfo, contactsV4ContactContacts_universal_d_ContactSubmitted as ContactSubmitted, contactsV4ContactContacts_universal_d_ContactChanged as ContactChanged, contactsV4ContactContacts_universal_d_ContactEmailSubscriptionUpdated as ContactEmailSubscriptionUpdated, contactsV4ContactContacts_universal_d_ContactPhoneSubscriptionUpdated as ContactPhoneSubscriptionUpdated, contactsV4ContactContacts_universal_d_ContactPrimaryInfoUpdated as ContactPrimaryInfoUpdated, contactsV4ContactContacts_universal_d_PrimarySubscriptionStatus as PrimarySubscriptionStatus, contactsV4ContactContacts_universal_d_LastActivityUpdate as LastActivityUpdate, contactsV4ContactContacts_universal_d_CreateContactRequest as CreateContactRequest, contactsV4ContactContacts_universal_d_CreateContactResponse as CreateContactResponse, contactsV4ContactContacts_universal_d_DuplicateContactExists as DuplicateContactExists, contactsV4ContactContacts_universal_d_UpdateContactRequest as UpdateContactRequest, contactsV4ContactContacts_universal_d_UpdateContactResponse as UpdateContactResponse, contactsV4ContactContacts_universal_d_MergeContactsRequest as MergeContactsRequest, contactsV4ContactContacts_universal_d_MergeContactsResponse as MergeContactsResponse, contactsV4ContactContacts_universal_d_ContactMerged as ContactMerged, contactsV4ContactContacts_universal_d_PreviewMergeContactsRequest as PreviewMergeContactsRequest, contactsV4ContactContacts_universal_d_PreviewMergeContactsResponse as PreviewMergeContactsResponse, contactsV4ContactContacts_universal_d_DeleteContactRequest as DeleteContactRequest, contactsV4ContactContacts_universal_d_DeleteContactResponse as DeleteContactResponse, contactsV4ContactContacts_universal_d_LabelContactRequest as LabelContactRequest, contactsV4ContactContacts_universal_d_LabelContactResponse as LabelContactResponse, contactsV4ContactContacts_universal_d_UnlabelContactRequest as UnlabelContactRequest, contactsV4ContactContacts_universal_d_UnlabelContactResponse as UnlabelContactResponse, contactsV4ContactContacts_universal_d_LabelAndUnlabelContactRequest as LabelAndUnlabelContactRequest, contactsV4ContactContacts_universal_d_LabelAndUnlabelContactResponse as LabelAndUnlabelContactResponse, contactsV4ContactContacts_universal_d_ListContactsRequest as ListContactsRequest, Sorting$1 as Sorting, SortOrder$1 as SortOrder, Paging$1 as Paging, contactsV4ContactContacts_universal_d_ContactFieldSet as ContactFieldSet, contactsV4ContactContacts_universal_d_ListContactsResponse as ListContactsResponse, PagingMetadata$1 as PagingMetadata, contactsV4ContactContacts_universal_d_QueryContactsRequest as QueryContactsRequest, Query$1 as Query, contactsV4ContactContacts_universal_d_QueryContactsResponse as QueryContactsResponse, contactsV4ContactContacts_universal_d_ListFacetsRequest as ListFacetsRequest, contactsV4ContactContacts_universal_d_ListFacetsResponse as ListFacetsResponse, contactsV4ContactContacts_universal_d_ContactsFacet as ContactsFacet, contactsV4ContactContacts_universal_d_ContactsFacetType as ContactsFacetType, contactsV4ContactContacts_universal_d_QueryFacetsRequest as QueryFacetsRequest, contactsV4ContactContacts_universal_d_QueryFacetsResponse as QueryFacetsResponse, contactsV4ContactContacts_universal_d_BulkDeleteContactsRequest as BulkDeleteContactsRequest, contactsV4ContactContacts_universal_d_BulkDeleteContactsResponse as BulkDeleteContactsResponse, contactsV4ContactContacts_universal_d_BulkUpdateContactsRequest as BulkUpdateContactsRequest, contactsV4ContactContacts_universal_d_BulkUpdateContactsResponse as BulkUpdateContactsResponse, contactsV4ContactContacts_universal_d_BulkLabelAndUnlabelContactsRequest as BulkLabelAndUnlabelContactsRequest, contactsV4ContactContacts_universal_d_BulkLabelAndUnlabelContactsResponse as BulkLabelAndUnlabelContactsResponse, contactsV4ContactContacts_universal_d_BulkUpsertContactsRequest as BulkUpsertContactsRequest, contactsV4ContactContacts_universal_d_BulkUpsertContactsResponse as BulkUpsertContactsResponse, contactsV4ContactContacts_universal_d_Action as Action, contactsV4ContactContacts_universal_d_Error as Error, contactsV4ContactContacts_universal_d_Metadata as Metadata, contactsV4ContactContacts_universal_d_Item as Item, contactsV4ContactContacts_universal_d_BulkUpsertContactsResponseMetadata as BulkUpsertContactsResponseMetadata, contactsV4ContactContacts_universal_d_UpsertContactRequest as UpsertContactRequest, contactsV4ContactContacts_universal_d_UpsertContactResponse as UpsertContactResponse, contactsV4ContactContacts_universal_d_UpsertContactResponseAction as UpsertContactResponseAction, contactsV4ContactContacts_universal_d_GeneratePictureUploadUrlRequest as GeneratePictureUploadUrlRequest, contactsV4ContactContacts_universal_d_GeneratePictureUploadUrlResponse as GeneratePictureUploadUrlResponse, contactsV4ContactContacts_universal_d_GetContactRequest as GetContactRequest, contactsV4ContactContacts_universal_d_GetContactResponse as GetContactResponse, contactsV4ContactContacts_universal_d_GetContactResponseType as GetContactResponseType, contactsV4ContactContacts_universal_d_SyncSubmitContactRequest as SyncSubmitContactRequest, contactsV4ContactContacts_universal_d_SubmitOperation as SubmitOperation, contactsV4ContactContacts_universal_d_SyncSubmitContactResponse as SyncSubmitContactResponse, contactsV4ContactContacts_universal_d_CountContactsRequest as CountContactsRequest, contactsV4ContactContacts_universal_d_CountContactsResponse as CountContactsResponse, contactsV4ContactContacts_universal_d_SearchContactsRequest as SearchContactsRequest, contactsV4ContactContacts_universal_d_Search as Search, contactsV4ContactContacts_universal_d_SearchPagingMethodOneOf as SearchPagingMethodOneOf, contactsV4ContactContacts_universal_d_SearchDetails as SearchDetails, contactsV4ContactContacts_universal_d_Mode as Mode, contactsV4ContactContacts_universal_d_CursorPaging as CursorPaging, contactsV4ContactContacts_universal_d_SearchContactsResponse as SearchContactsResponse, contactsV4ContactContacts_universal_d_CursorPagingMetadata as CursorPagingMetadata, contactsV4ContactContacts_universal_d_Cursors as Cursors, contactsV4ContactContacts_universal_d_BulkAddSegmentToContactsRequest as BulkAddSegmentToContactsRequest, contactsV4ContactContacts_universal_d_BulkAddSegmentToContactsResponse as BulkAddSegmentToContactsResponse, contactsV4ContactContacts_universal_d_ItemMetadata as ItemMetadata, contactsV4ContactContacts_universal_d_ApplicationError as ApplicationError, contactsV4ContactContacts_universal_d_BulkActionMetadata as BulkActionMetadata, contactsV4ContactContacts_universal_d_ContactAddedToSegment as ContactAddedToSegment, contactsV4ContactContacts_universal_d_BulkRemoveSegmentFromContactsRequest as BulkRemoveSegmentFromContactsRequest, contactsV4ContactContacts_universal_d_BulkRemoveSegmentFromContactsResponse as BulkRemoveSegmentFromContactsResponse, contactsV4ContactContacts_universal_d_ContactRemovedFromSegment as ContactRemovedFromSegment, contactsV4ContactContacts_universal_d_ListContactIdsBySegmentRequest as ListContactIdsBySegmentRequest, contactsV4ContactContacts_universal_d_ListContactIdsBySegmentResponse as ListContactIdsBySegmentResponse, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, contactsV4ContactContacts_universal_d_createContact as createContact, contactsV4ContactContacts_universal_d_CreateContactOptions as CreateContactOptions, contactsV4ContactContacts_universal_d_updateContact as updateContact, contactsV4ContactContacts_universal_d_UpdateContactOptions as UpdateContactOptions, contactsV4ContactContacts_universal_d_mergeContacts as mergeContacts, contactsV4ContactContacts_universal_d_MergeContactsOptions as MergeContactsOptions, contactsV4ContactContacts_universal_d_PreviewMergeContactsOptions as PreviewMergeContactsOptions, contactsV4ContactContacts_universal_d_deleteContact as deleteContact, contactsV4ContactContacts_universal_d_DeleteContactOptions as DeleteContactOptions, contactsV4ContactContacts_universal_d_labelContact as labelContact, contactsV4ContactContacts_universal_d_LabelContactOptions as LabelContactOptions, contactsV4ContactContacts_universal_d_unlabelContact as unlabelContact, contactsV4ContactContacts_universal_d_UnlabelContactOptions as UnlabelContactOptions, contactsV4ContactContacts_universal_d_LabelAndUnlabelContactOptions as LabelAndUnlabelContactOptions, contactsV4ContactContacts_universal_d_ListContactsOptions as ListContactsOptions, contactsV4ContactContacts_universal_d_queryContacts as queryContacts, contactsV4ContactContacts_universal_d_QueryContactsOptions as QueryContactsOptions, contactsV4ContactContacts_universal_d_ContactsQueryResult as ContactsQueryResult, contactsV4ContactContacts_universal_d_ContactsQueryBuilder as ContactsQueryBuilder, contactsV4ContactContacts_universal_d_ListFacetsOptions as ListFacetsOptions, contactsV4ContactContacts_universal_d_QueryFacetsOptions as QueryFacetsOptions, contactsV4ContactContacts_universal_d_BulkDeleteContactsOptions as BulkDeleteContactsOptions, contactsV4ContactContacts_universal_d_BulkUpdateContactsOptions as BulkUpdateContactsOptions, contactsV4ContactContacts_universal_d_BulkLabelAndUnlabelContactsOptions as BulkLabelAndUnlabelContactsOptions, contactsV4ContactContacts_universal_d_BulkUpsertContactsOptions as BulkUpsertContactsOptions, contactsV4ContactContacts_universal_d_GeneratePictureUploadUrlOptions as GeneratePictureUploadUrlOptions, contactsV4ContactContacts_universal_d_getContact as getContact, contactsV4ContactContacts_universal_d_GetContactOptions as GetContactOptions, contactsV4ContactContacts_universal_d_SearchContactsOptions as SearchContactsOptions, };\n }\n /** Extended field that was found or created. */\n interface ExtendedField {\n /**\n * Extended field namespace.\n *\n * Extended fields created through by calling the Find Or Create Extended Field method\n * are automatically assigned to the `custom` namespace.\n * @readonly\n */\n namespace?: string | null;\n /**\n * Extended field key.\n *\n * When accessing contact data,\n * extended field data is available at `extendedFields[key]`.\n * For example, if the key is \"custom.notes\",\n * the value can be accessed at `extendedFields[\"custom.notes\"]`.\n *\n * `key` is generated when the extended field is created\n * and can't be modified, even if `displayName` changes.\n * @readonly\n */\n key?: string;\n /** Display name shown in the contact list. */\n displayName?: string;\n /**\n * Type of data the field holds.\n * @readonly\n */\n dataType?: FieldDataType;\n /**\n * Indicates whether the extended field is a system field or custom field.\n * @readonly\n */\n fieldType?: FieldType;\n /**\n * Date and time the field was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the field was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Field description, if the field is a system field.\n * @readonly\n */\n description?: string | null;\n }\n enum FieldDataType {\n /** Undefined data type. */\n UNKNOWN_DATA_TYPE = \"UNKNOWN_DATA_TYPE\",\n /** Accepts strings. */\n TEXT = \"TEXT\",\n /** Accepts floats. */\n NUMBER = \"NUMBER\",\n /** Accepts dates formatted as `YYYY-MM-DD`. */\n DATE = \"DATE\",\n /** Accepts strings. Prepends `https://` if no protocol is included. */\n URL = \"URL\"\n }\n enum FieldType {\n /** Undefined field type. */\n UNKNOWN = \"UNKNOWN\",\n /** Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. */\n SYSTEM = \"SYSTEM\",\n /** Field is a custom field and can be modified by calling the Update Extended Field method. */\n USER_DEFINED = \"USER_DEFINED\"\n }\n /** Extended field filter options. */\n interface ListExtendedFieldsRequest {\n /** Filter for fields of the specified type. */\n fieldType?: FieldType;\n /**\n * Filter for fields in the specified namespace.\n * Fields created by calling the Find Or Create Extended Field method\n * are automatically assigned to the `custom` namespace.\n */\n namespace?: string | null;\n /** Filter for fields where `displayName` starts with the specified case-sensitive string. */\n startsWith?: string | null;\n /** Sorting options. */\n sort?: Sorting;\n /** Paging options. */\n paging?: Paging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Default: `ASC`.\n */\n order?: SortOrder;\n }\n enum SortOrder {\n /** Sort by ascending order. */\n ASC = \"ASC\",\n /** Sort by descending order. */\n DESC = \"DESC\"\n }\n interface Paging {\n /**\n * Number of items to return.\n *\n * Defaults to `100`.\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n * Defaults to `0`.\n */\n offset?: number | null;\n }\n /** List of extended fields. */\n interface ListExtendedFieldsResponse {\n /** List of extended fields. */\n fields?: ExtendedField[];\n /** Metadata for the page of results. */\n metadata?: PagingMetadata;\n }\n interface PagingMetadata {\n /** Number of items returned. */\n count?: number | null;\n /** Requested offset. */\n offset?: number | null;\n /** Number of items that matched the query. */\n total?: number | null;\n /**\n * Indicates if `total` calculation timed out before the response was sent.\n * Typically this happens if there is a large set of results.\n */\n tooManyToCount?: boolean | null;\n }\n /** Custom field to find or create. */\n interface FindOrCreateExtendedFieldRequest {\n /**\n * Display name to retrieve or create.\n *\n * If an existing custom field is an exact match\n * for the specified display name,\n * the existing field is returned.\n * If not, a new field is created and returned.\n */\n displayName: string;\n /**\n * Type of data the field holds.\n * Ignored if an existing field is an exact match\n * for the specified display name.\n */\n dataType?: FieldDataType;\n }\n /** Extended field that was found or created. */\n interface FindOrCreateExtendedFieldResponse {\n /** Extended field that was found or created. */\n field?: ExtendedField;\n /**\n * Indicates whether the extended field was just created or already existed.\n *\n * Returns `true` if the field was just created.\n */\n newField?: boolean;\n }\n interface GetExtendedFieldRequest {\n /**\n * Extended field key.\n *\n * When accessing contact data,\n * extended field values are available at `info.extendedFields.items[key]`.\n * For example, if the key is \"custom.patronus\",\n * the value can be accessed at `info.extendedFields.items[\"custom.patronus\"]`.\n *\n * `key` is generated when the extended field is created.\n * It can't be modified, even if `displayName` is updated.\n */\n key: string;\n }\n /** The specified field. */\n interface GetExtendedFieldResponse {\n /** The specified field. */\n field?: ExtendedField;\n }\n interface GetExtendedFieldByLegacyIdRequest {\n /** Legacy ID of the extended field. */\n legacyId?: string;\n }\n interface GetExtendedFieldByLegacyIdResponse {\n /** The requested extended field. */\n field?: ExtendedField;\n }\n interface UpdateExtendedFieldRequest {\n /** Extended field to rename. */\n field?: ExtendedField;\n }\n /** Updated extended field. */\n interface UpdateExtendedFieldResponse {\n /** Renamed extended field. */\n field?: ExtendedField;\n }\n interface DeleteExtendedFieldRequest {\n /** Extended field key. */\n key: string;\n }\n interface DeleteExtendedFieldResponse {\n }\n interface PurgeRequest {\n /** Instance ID of the site. */\n instanceId?: string;\n }\n interface PurgeResponse {\n /** Number of items deleted. */\n deletedItems?: number;\n }\n interface GdprListRequest {\n /** Instance ID of the site. */\n instanceId?: string;\n }\n interface GdprListResponse {\n /** List of extended fields. */\n fields?: ExtendedField[];\n }\n interface QueryExtendedFieldsRequest {\n /** Query options. */\n query?: Query;\n }\n interface Query {\n /**\n * ilter object.\n *\n * Possible filters: `$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n *\n * For a detailed list of supported filters, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter).\n *\n * Example: `{ \"filter\": {\n * \"displayName\": {\n * \"$startsWith\": \"Referral\"\n * }\n * }\n * }`\n */\n filter?: Record | null;\n /**\n * Sorting options. Currently supports sorting on one field only.\n *\n * Example: `{ \"sort\": [{\"fieldName\": \"displayName\", \"order\": \"DESC\"}] }`\n */\n sort?: Sorting[];\n /** Pagination options. */\n paging?: Paging;\n }\n interface QueryExtendedFieldsResponse {\n /** List of extended fields. */\n fields?: ExtendedField[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface ListExtendedFieldsOptions {\n /** Filter for fields of the specified type. */\n fieldType?: FieldType;\n /**\n * Filter for fields in the specified namespace.\n * Fields created by calling the Find Or Create Extended Field method\n * are automatically assigned to the `custom` namespace.\n */\n namespace?: string | null;\n /** Filter for fields where `displayName` starts with the specified case-sensitive string. */\n startsWith?: string | null;\n /** Sorting options. */\n sort?: Sorting;\n /** Paging options. */\n paging?: Paging;\n }\n /**\n * Retrieves a custom field with a specified name, or creates one if it doesn't exist.\n * The number of custom fields is limited to 100.\n *\n * Successful calls to this method always return a field,\n * which can be specified in subsequent calls.\n *\n * To find an existing custom field without potentially creating a new one, call Get Extended Field or\n * Query Extended Fields.\n * @param displayName - Display name to retrieve or create.\n *\n * If an existing custom field is an exact match\n * for the specified display name,\n * the existing field is returned.\n * If not, a new field is created and returned.\n * @param dataType - Type of data the field holds.\n * Ignored if an existing field is an exact match\n * for the specified display name.\n * @public\n * @requiredField dataType\n * @requiredField displayName\n * @permissionId CONTACTS_SCHEMA.MODIFY\n * @permissionScope Manage Contact Extended Fields\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Extended field that was found or created.\n * @fqn com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.FindOrCreateExtendedField\n */\n function findOrCreateExtendedField(displayName: string, dataType: FieldDataType): Promise;\n /**\n * Retrieves an extended field by the specified extended field key.\n * @public\n * @requiredField key\n * @param key - null\n * @permissionId CONTACTS_SCHEMA.VIEW\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Contact Extended Fields\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The specified field.\n * @fqn com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.GetExtendedField\n */\n function getExtendedField(key: string): Promise;\n /**\n * Renames an extended field.\n * @public\n * @requiredField field\n * @requiredField field.displayName\n * @requiredField key\n * @param key - null\n * @param field - null\n * @permissionId CONTACTS_SCHEMA.MODIFY\n * @permissionScope Manage Contact Extended Fields\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Renamed extended field.\n * @fqn com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.UpdateExtendedField\n */\n function renameExtendedField(key: string, field: RenameExtendedField): Promise;\n interface RenameExtendedField {\n /**\n * Extended field namespace.\n *\n * Extended fields created through by calling the Find Or Create Extended Field method\n * are automatically assigned to the `custom` namespace.\n * @readonly\n */\n namespace?: string | null;\n /** Display name shown in the contact list. */\n displayName?: string;\n /**\n * Type of data the field holds.\n * @readonly\n */\n dataType?: FieldDataType;\n /**\n * Indicates whether the extended field is a system field or custom field.\n * @readonly\n */\n fieldType?: FieldType;\n /**\n * Date and time the field was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the field was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Field description, if the field is a system field.\n * @readonly\n */\n description?: string | null;\n }\n /**\n * Deletes an extended field.\n *\n * When an extended field is deleted,\n * any contact data stored in the field is also permanently deleted.\n * @param key - Extended field key.\n * @public\n * @requiredField key\n * @permissionId CONTACTS_SCHEMA.MODIFY\n * @permissionScope Manage Contact Extended Fields\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.DeleteExtendedField\n */\n function deleteExtendedField(key: string): Promise;\n /**\n * Creates a query to retrieve a list of extended fields.\n *\n * The `queryExtendedFields()` method builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the `find()` method.\n *\n * You can refine the query by chaining `FieldsQueryBuilder` methods onto the query. `FieldsQueryBuilder` methods enable you to filter, sort, and control the results that `queryExtendedFields()` returns.\n *\n * `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:\n * - `skip()`\n * - `limit(50)`\n * - `descending('_createdDate')`\n *\n * The following `FieldsQueryBuilder` methods are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.\n * @public\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Contact Extended Fields\n * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Members and Contacts - all permissions\n * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n * @permissionId CONTACTS_SCHEMA.VIEW\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.QueryExtendedFields\n */\n function queryExtendedFields(): FieldsQueryBuilder;\n interface QueryOffsetResult {\n currentPage: number | undefined;\n totalPages: number | undefined;\n totalCount: number | undefined;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface FieldsQueryResult extends QueryOffsetResult {\n items: ExtendedField[];\n query: FieldsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface FieldsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"namespace\" | \"key\" | \"displayName\" | \"dataType\" | \"fieldType\" | \"_createdDate\" | \"_updatedDate\", value: any) => FieldsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"namespace\" | \"key\" | \"displayName\" | \"dataType\" | \"_createdDate\" | \"_updatedDate\", value: any) => FieldsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => FieldsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => FieldsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => FieldsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => FieldsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: \"displayName\", value: string) => FieldsQueryBuilder;\n in: (propertyName: \"key\" | \"displayName\", value: any) => FieldsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"displayName\" | \"_createdDate\" | \"_updatedDate\">) => FieldsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"displayName\" | \"_createdDate\" | \"_updatedDate\">) => FieldsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => FieldsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => FieldsQueryBuilder;\n find: () => Promise;\n }\n type contactsV4ExtendedFieldExtendedFields_universal_d_ExtendedField = ExtendedField;\n type contactsV4ExtendedFieldExtendedFields_universal_d_FieldDataType = FieldDataType;\n const contactsV4ExtendedFieldExtendedFields_universal_d_FieldDataType: typeof FieldDataType;\n type contactsV4ExtendedFieldExtendedFields_universal_d_FieldType = FieldType;\n const contactsV4ExtendedFieldExtendedFields_universal_d_FieldType: typeof FieldType;\n type contactsV4ExtendedFieldExtendedFields_universal_d_ListExtendedFieldsRequest = ListExtendedFieldsRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_Sorting = Sorting;\n type contactsV4ExtendedFieldExtendedFields_universal_d_SortOrder = SortOrder;\n const contactsV4ExtendedFieldExtendedFields_universal_d_SortOrder: typeof SortOrder;\n type contactsV4ExtendedFieldExtendedFields_universal_d_Paging = Paging;\n type contactsV4ExtendedFieldExtendedFields_universal_d_ListExtendedFieldsResponse = ListExtendedFieldsResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_PagingMetadata = PagingMetadata;\n type contactsV4ExtendedFieldExtendedFields_universal_d_FindOrCreateExtendedFieldRequest = FindOrCreateExtendedFieldRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_FindOrCreateExtendedFieldResponse = FindOrCreateExtendedFieldResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldRequest = GetExtendedFieldRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldResponse = GetExtendedFieldResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldByLegacyIdRequest = GetExtendedFieldByLegacyIdRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldByLegacyIdResponse = GetExtendedFieldByLegacyIdResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_UpdateExtendedFieldRequest = UpdateExtendedFieldRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_UpdateExtendedFieldResponse = UpdateExtendedFieldResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_DeleteExtendedFieldRequest = DeleteExtendedFieldRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_DeleteExtendedFieldResponse = DeleteExtendedFieldResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_PurgeRequest = PurgeRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_PurgeResponse = PurgeResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_GdprListRequest = GdprListRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_GdprListResponse = GdprListResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_QueryExtendedFieldsRequest = QueryExtendedFieldsRequest;\n type contactsV4ExtendedFieldExtendedFields_universal_d_Query = Query;\n type contactsV4ExtendedFieldExtendedFields_universal_d_QueryExtendedFieldsResponse = QueryExtendedFieldsResponse;\n type contactsV4ExtendedFieldExtendedFields_universal_d_DomainEvent = DomainEvent;\n type contactsV4ExtendedFieldExtendedFields_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type contactsV4ExtendedFieldExtendedFields_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type contactsV4ExtendedFieldExtendedFields_universal_d_RestoreInfo = RestoreInfo;\n type contactsV4ExtendedFieldExtendedFields_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type contactsV4ExtendedFieldExtendedFields_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type contactsV4ExtendedFieldExtendedFields_universal_d_ActionEvent = ActionEvent;\n type contactsV4ExtendedFieldExtendedFields_universal_d_MessageEnvelope = MessageEnvelope;\n type contactsV4ExtendedFieldExtendedFields_universal_d_IdentificationData = IdentificationData;\n type contactsV4ExtendedFieldExtendedFields_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type contactsV4ExtendedFieldExtendedFields_universal_d_WebhookIdentityType = WebhookIdentityType;\n const contactsV4ExtendedFieldExtendedFields_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type contactsV4ExtendedFieldExtendedFields_universal_d_ListExtendedFieldsOptions = ListExtendedFieldsOptions;\n const contactsV4ExtendedFieldExtendedFields_universal_d_findOrCreateExtendedField: typeof findOrCreateExtendedField;\n const contactsV4ExtendedFieldExtendedFields_universal_d_getExtendedField: typeof getExtendedField;\n const contactsV4ExtendedFieldExtendedFields_universal_d_renameExtendedField: typeof renameExtendedField;\n type contactsV4ExtendedFieldExtendedFields_universal_d_RenameExtendedField = RenameExtendedField;\n const contactsV4ExtendedFieldExtendedFields_universal_d_deleteExtendedField: typeof deleteExtendedField;\n const contactsV4ExtendedFieldExtendedFields_universal_d_queryExtendedFields: typeof queryExtendedFields;\n type contactsV4ExtendedFieldExtendedFields_universal_d_FieldsQueryResult = FieldsQueryResult;\n type contactsV4ExtendedFieldExtendedFields_universal_d_FieldsQueryBuilder = FieldsQueryBuilder;\n namespace contactsV4ExtendedFieldExtendedFields_universal_d {\n export { contactsV4ExtendedFieldExtendedFields_universal_d_ExtendedField as ExtendedField, contactsV4ExtendedFieldExtendedFields_universal_d_FieldDataType as FieldDataType, contactsV4ExtendedFieldExtendedFields_universal_d_FieldType as FieldType, contactsV4ExtendedFieldExtendedFields_universal_d_ListExtendedFieldsRequest as ListExtendedFieldsRequest, contactsV4ExtendedFieldExtendedFields_universal_d_Sorting as Sorting, contactsV4ExtendedFieldExtendedFields_universal_d_SortOrder as SortOrder, contactsV4ExtendedFieldExtendedFields_universal_d_Paging as Paging, contactsV4ExtendedFieldExtendedFields_universal_d_ListExtendedFieldsResponse as ListExtendedFieldsResponse, contactsV4ExtendedFieldExtendedFields_universal_d_PagingMetadata as PagingMetadata, contactsV4ExtendedFieldExtendedFields_universal_d_FindOrCreateExtendedFieldRequest as FindOrCreateExtendedFieldRequest, contactsV4ExtendedFieldExtendedFields_universal_d_FindOrCreateExtendedFieldResponse as FindOrCreateExtendedFieldResponse, contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldRequest as GetExtendedFieldRequest, contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldResponse as GetExtendedFieldResponse, contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldByLegacyIdRequest as GetExtendedFieldByLegacyIdRequest, contactsV4ExtendedFieldExtendedFields_universal_d_GetExtendedFieldByLegacyIdResponse as GetExtendedFieldByLegacyIdResponse, contactsV4ExtendedFieldExtendedFields_universal_d_UpdateExtendedFieldRequest as UpdateExtendedFieldRequest, contactsV4ExtendedFieldExtendedFields_universal_d_UpdateExtendedFieldResponse as UpdateExtendedFieldResponse, contactsV4ExtendedFieldExtendedFields_universal_d_DeleteExtendedFieldRequest as DeleteExtendedFieldRequest, contactsV4ExtendedFieldExtendedFields_universal_d_DeleteExtendedFieldResponse as DeleteExtendedFieldResponse, contactsV4ExtendedFieldExtendedFields_universal_d_PurgeRequest as PurgeRequest, contactsV4ExtendedFieldExtendedFields_universal_d_PurgeResponse as PurgeResponse, contactsV4ExtendedFieldExtendedFields_universal_d_GdprListRequest as GdprListRequest, contactsV4ExtendedFieldExtendedFields_universal_d_GdprListResponse as GdprListResponse, contactsV4ExtendedFieldExtendedFields_universal_d_QueryExtendedFieldsRequest as QueryExtendedFieldsRequest, contactsV4ExtendedFieldExtendedFields_universal_d_Query as Query, contactsV4ExtendedFieldExtendedFields_universal_d_QueryExtendedFieldsResponse as QueryExtendedFieldsResponse, contactsV4ExtendedFieldExtendedFields_universal_d_DomainEvent as DomainEvent, contactsV4ExtendedFieldExtendedFields_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, contactsV4ExtendedFieldExtendedFields_universal_d_EntityCreatedEvent as EntityCreatedEvent, contactsV4ExtendedFieldExtendedFields_universal_d_RestoreInfo as RestoreInfo, contactsV4ExtendedFieldExtendedFields_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, contactsV4ExtendedFieldExtendedFields_universal_d_EntityDeletedEvent as EntityDeletedEvent, contactsV4ExtendedFieldExtendedFields_universal_d_ActionEvent as ActionEvent, contactsV4ExtendedFieldExtendedFields_universal_d_MessageEnvelope as MessageEnvelope, contactsV4ExtendedFieldExtendedFields_universal_d_IdentificationData as IdentificationData, contactsV4ExtendedFieldExtendedFields_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, contactsV4ExtendedFieldExtendedFields_universal_d_WebhookIdentityType as WebhookIdentityType, contactsV4ExtendedFieldExtendedFields_universal_d_ListExtendedFieldsOptions as ListExtendedFieldsOptions, contactsV4ExtendedFieldExtendedFields_universal_d_findOrCreateExtendedField as findOrCreateExtendedField, contactsV4ExtendedFieldExtendedFields_universal_d_getExtendedField as getExtendedField, contactsV4ExtendedFieldExtendedFields_universal_d_renameExtendedField as renameExtendedField, contactsV4ExtendedFieldExtendedFields_universal_d_RenameExtendedField as RenameExtendedField, contactsV4ExtendedFieldExtendedFields_universal_d_deleteExtendedField as deleteExtendedField, contactsV4ExtendedFieldExtendedFields_universal_d_queryExtendedFields as queryExtendedFields, contactsV4ExtendedFieldExtendedFields_universal_d_FieldsQueryResult as FieldsQueryResult, contactsV4ExtendedFieldExtendedFields_universal_d_FieldsQueryBuilder as FieldsQueryBuilder, };\n }\n export { contactsV4ContactContacts_universal_d as contacts, contactsV4ExtendedFieldExtendedFields_universal_d as extendedFields, contactsV4LabelLabels_universal_d as labels, crmTasksV2TaskTasks_universal_d as tasks };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-captcha.v2.d.ts", "content": "declare module \"wix-captcha.v2\" {\n interface CaptchaEntity {\n }\n interface CaptchaRequest {\n /** The CAPTCHA token to authorize. */\n token?: string;\n }\n interface CaptchaResponse {\n /** Value is `true` when authorization is successful. */\n success?: boolean;\n /** Error information. */\n errors?: Errors;\n }\n interface Errors {\n /** ID of error. */\n errorId?: number;\n }\n interface AssessmentResponse {\n assessment?: string;\n }\n /**\n * Authorizes the CAPTCHA token.\n *\n *\n * Following CAPTCHA verification on the client side, you must authorize the generated CAPTCHA token in the backend.\n *\n * `authorize()` checks if the token is valid, making sure it was not tampered with or timed out.\n *\n * The `authorize()` function returns a Promise that resolves to a `Success` object when the token is authorized and to an `Error` object when authorization fails.\n *\n * To understand how `authorize()` is used in a typical CAPTCHA validation lifecycle, click [here](/$w/captcha/introduction).\n *\n * If CAPTCHA token authorization fails, an error message containing a status code is returned. The following table lists the possible HTTP error status codes, based on [RFC 2616](https://tools.ietf.org/html/rfc2616#section-10):\n *\n * | Status Code | Name | Description |\n * |---|---|---|\n * | 400 | Bad Request | The request could not be understood by the server. This could occur for a number of reasons, such as:
      • The request was sent without a token.
      • The token is invalid.
      • The token has timed out.
      |\n * | 401 | Unauthenticated | No user identity found in passed request. |\n * | 500 | Internal Server Error | The server encountered an unexpected condition, such as a missing or invalid private CAPTCHA key. |\n * | 503 | Unavailable | The service is unavailable due to one of the following:
      • Throttled error: Server overload due to more than the allowed requests in a given time frame.
      • Request failed: No response following 10 retries with a 1-second interval.
      |\n * @param token - The CAPTCHA token to authorize.\n * @public\n * @documentationMaturity preview\n * @requiredField token\n * @adminMethod\n */\n function authorize(token: string, options?: AuthorizeOptions): Promise;\n interface AuthorizeOptions {\n }\n interface AuthorizeWithoutDomainValidationOptions {\n /** The CAPTCHA token to authorize. */\n token?: string;\n }\n interface AssessmentOptions {\n /** The CAPTCHA token to authorize. */\n token?: string;\n }\n type captcharatorV1CaptchaEntityCaptcha_universal_d_CaptchaEntity = CaptchaEntity;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_CaptchaRequest = CaptchaRequest;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_CaptchaResponse = CaptchaResponse;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_Errors = Errors;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_AssessmentResponse = AssessmentResponse;\n const captcharatorV1CaptchaEntityCaptcha_universal_d_authorize: typeof authorize;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_AuthorizeOptions = AuthorizeOptions;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_AuthorizeWithoutDomainValidationOptions = AuthorizeWithoutDomainValidationOptions;\n type captcharatorV1CaptchaEntityCaptcha_universal_d_AssessmentOptions = AssessmentOptions;\n namespace captcharatorV1CaptchaEntityCaptcha_universal_d {\n export { captcharatorV1CaptchaEntityCaptcha_universal_d_CaptchaEntity as CaptchaEntity, captcharatorV1CaptchaEntityCaptcha_universal_d_CaptchaRequest as CaptchaRequest, captcharatorV1CaptchaEntityCaptcha_universal_d_CaptchaResponse as CaptchaResponse, captcharatorV1CaptchaEntityCaptcha_universal_d_Errors as Errors, captcharatorV1CaptchaEntityCaptcha_universal_d_AssessmentResponse as AssessmentResponse, captcharatorV1CaptchaEntityCaptcha_universal_d_authorize as authorize, captcharatorV1CaptchaEntityCaptcha_universal_d_AuthorizeOptions as AuthorizeOptions, captcharatorV1CaptchaEntityCaptcha_universal_d_AuthorizeWithoutDomainValidationOptions as AuthorizeWithoutDomainValidationOptions, captcharatorV1CaptchaEntityCaptcha_universal_d_AssessmentOptions as AssessmentOptions, };\n }\n export { captcharatorV1CaptchaEntityCaptcha_universal_d as captcha };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-reviews.v2.d.ts", "content": "declare module \"wix-reviews.v2\" {\n /**\n * A Review object includes all of the details related to the review of an entity. An entity is a specific resource to be reviewed,\n * for example, a store product.\n * You can manage existing reviews, create new reviews, and retrieve reviews.\n * Read more about reviews in this [tutorial](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews).\n */\n interface Review {\n /** Review namespace. Currently integrated with Wix Stores, as `stores`. */\n namespace?: string;\n /** ID of the entity to review. For example, a Wix Stores product ID. */\n entityId?: string;\n /**\n * Review ID.\n * @readonly\n */\n _id?: string;\n /** Review content. */\n content?: ReviewContent;\n /**\n * Date and time the review was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the review was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Author of the review. */\n author?: Author;\n /**\n * Reply to the review.\n * @readonly\n */\n reply?: Reply;\n /**\n * Number of site visitors who found the review helpful.\n * @readonly\n */\n foundHelpful?: number;\n /**\n * Number of site visitors who found the review unhelpful.\n * @readonly\n */\n foundUnhelpful?: number;\n /**\n * Helpfulness score.\n *\n * Calculated by subtracting `foundUnhelpful` from `foundHelpful`.\n * @readonly\n */\n helpfulness?: number;\n /**\n * Moderation status of the review.\n * @readonly\n */\n moderation?: Moderation;\n /**\n * Revision number, which increments by 1 each time the review is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the review.\n * Ignored when creating a review.\n * @readonly\n */\n revision?: string | null;\n /**\n * Indicates whether the review has been verified through a Verify Product Purchase call to the Review Product catalog SPI.\n * @readonly\n */\n verified?: boolean;\n /**\n * Provides information about the origin of the review.\n * Organic reviews are created by site visitors or members.\n * App reviews are created by apps even though a site visitor or member is the author of the review.\n * Apps can not create or update organic reviews.\n * @readonly\n */\n origin?: Origin;\n /**\n * Date and time when the review was written.\n * This should match `created_date`, except for reviews imported from another system.\n */\n reviewDate?: Date | null;\n /**\n * Platform-calculated score of review's relevance to the item. Used to sort\n * reviews by relevance.\n * @readonly\n */\n relevanceScore?: number | null;\n /**\n * Counts the number of times a review has been published.\n * Reviews require approval before publishing, unless moderation is disabled.\n * When moderation is disabled, reviews are automatically approved and published.\n * @readonly\n */\n publishCount?: number;\n }\n /** The Review object. */\n interface ReviewContent {\n /** Review title. */\n title?: string | null;\n /**\n * Review body.\n *\n * Max: 3,000 characters\n */\n body?: string | null;\n /**\n * List of media items associated with the review.\n *\n * Max: 10 items\n */\n media?: Media[];\n /**\n * Rating of the review.\n *\n * Min: `1`\n *\n * Max: `5`\n */\n rating?: number;\n }\n /** Media item associated with the review. */\n interface Media extends MediaMediaOneOf {\n /** Image media item. */\n image?: string;\n /** Video media item. */\n video?: string;\n }\n /** @oneof */\n interface MediaMediaOneOf {\n /** Image media item. */\n image?: string;\n /** Video media item. */\n video?: string;\n }\n interface VideoResolution {\n /**\n * Video URL.\n * @readonly\n */\n url?: string;\n /**\n * Video height.\n * @readonly\n */\n height?: number;\n /**\n * Video width.\n * @readonly\n */\n width?: number;\n /**\n * Video thumbnail.\n * @readonly\n */\n poster?: string;\n /**\n * Video format for example, mp4, hls.\n * @readonly\n */\n format?: string;\n }\n /** Review author. */\n interface Author {\n /** Contact ID of the author. */\n contactId?: string | null;\n /** Display name of the author. */\n authorName?: string | null;\n }\n /** Supported types of review author. */\n enum AuthorType {\n UNKNOWN = \"UNKNOWN\",\n MEMBER = \"MEMBER\",\n VISITOR = \"VISITOR\"\n }\n /** Reply to the review. */\n interface Reply {\n /** Reply content. */\n message?: string;\n /**\n * Date and time the reply was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the reply was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n /** Moderation status of the review. */\n interface Moderation {\n moderationStatus?: ModerationModerationStatus;\n /**\n * Indicates whether a moderator manually changed the `moderationStatus` of the review.\n *\n * If the `moderationStatus` changed automatically because the review\n * passed the moderation rules or if moderation is turned off, this field is set to `false`.\n * @readonly\n */\n manuallyChanged?: boolean;\n }\n /** Supported states of the review. */\n enum ModerationModerationStatus {\n /** Unknown moderation status. */\n UNKNOWN = \"UNKNOWN\",\n /** The review is approved and published. */\n APPROVED = \"APPROVED\",\n /** The review is pending moderation. Moderation can be applied in the site owner's [Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending). */\n IN_MODERATION = \"IN_MODERATION\",\n /** The review is rejected and not visible on the site. */\n REJECTED = \"REJECTED\",\n /** Initial status of the review before the moderation process. */\n SUBMITTED = \"SUBMITTED\"\n }\n interface Origin {\n /** The type of the review origin. */\n type?: OriginType;\n /**\n * The app ID of the APP review origin.\n * Set only when the review origin is APP.\n */\n appId?: string | null;\n }\n /** Supported types of review origin. */\n enum OriginType {\n /** Unknown origin type. */\n UNKNOWN = \"UNKNOWN\",\n /** Review was created organically. */\n ORGANIC = \"ORGANIC\",\n /** Review was created by an application. */\n APP = \"APP\"\n }\n interface Source extends SourceSourceTypeOptionsOneOf {\n reviewRequestOptions?: ReviewRequestOptions;\n requestLinkOptions?: RequestLinkOptions;\n /** The type of the review source. */\n type?: SourceType;\n }\n /** @oneof */\n interface SourceSourceTypeOptionsOneOf {\n reviewRequestOptions?: ReviewRequestOptions;\n requestLinkOptions?: RequestLinkOptions;\n }\n enum SourceType {\n /** Unknown source type. */\n UNKNOWN_SOURCE_TYPE = \"UNKNOWN_SOURCE_TYPE\",\n /** Review was created from a review request. */\n REVIEW_REQUEST = \"REVIEW_REQUEST\",\n /** Review was created from a request link. */\n REQUEST_LINK = \"REQUEST_LINK\"\n }\n interface ReviewRequestOptions {\n /** Review request ID. */\n _id?: string | null;\n }\n interface RequestLinkOptions {\n /** Request link ID. */\n _id?: string | null;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface GetReviewRequest {\n /** Review ID. */\n reviewId: string;\n /**\n * Whether to return private (unpublished) reviews.\n *\n * Default: `false`\n */\n returnPrivateReviews?: boolean;\n }\n interface GetReviewResponse {\n /** Review. */\n review?: Review;\n }\n interface GetDeletedReviewRequest {\n /** Review ID. */\n reviewId: string;\n }\n interface GetDeletedReviewResponse {\n /** Review. */\n review?: Review;\n }\n interface CreateReviewAndContactRequest {\n /** Namespace where the review is created. */\n namespace: string;\n /** ID of the entity to review. */\n entityId: string;\n /** Name of the review author. Displayed as part of the review. Required for 3rd-party apps. */\n name?: string | null;\n /** Email address of the review author. Required for 3rd-party apps. */\n email?: string | null;\n /** Review content. */\n content: ReviewContent;\n }\n interface CreateReviewResponse {\n /** Created review. */\n review?: Review;\n }\n interface CreateReviewRequest {\n /** Review data. */\n review: Review;\n }\n /** Action describing changed review moderation status */\n interface ReviewPublished {\n /** Review entity */\n review?: Review;\n }\n interface BulkCreateReviewRequest {\n /** Reviews to create. */\n reviews: Review[];\n returnEntity?: boolean;\n }\n interface BulkCreateReviewResponse {\n /**\n * Created reviews, only returned if returnEntity is set to true.\n * Items are returned for successful operations and when returnEntity in the request is set to true.\n */\n results?: BulkReviewResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkReviewResult {\n /** ItemMetadata */\n itemMetadata?: ItemMetadata;\n /** New Reviews */\n review?: Review;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface UpdateReviewContentRequest {\n /** Review ID. */\n reviewId: string;\n /** Review content. */\n content?: ReviewContent;\n /**\n * Fieldmask for update.\n * Supported fields: content.title, content.body, content.media, content.rating\n */\n fieldMask?: string[];\n }\n interface UpdateReviewContentResponse {\n /** Updated review data. */\n review?: Review;\n }\n /** Action describing changed review moderation status */\n interface ModerationStatusChanged {\n /** Review entity */\n review?: Review;\n /**\n * The previous moderation status of the review.\n * - `APPROVED`: The review is approved and published.\n * - `IN_MODERATION`: The review is pending moderation. Moderation can be applied in the site owner's [Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).\n * - `REJECTED`: The review is rejected and not visible in the site.\n * - `SUBMITTED`: Initial status of the review before the moderation process.\n */\n previousModerationStatus?: ModerationModerationStatus;\n }\n interface UpdateReviewRequest {\n /** Review to update. */\n review?: Review;\n }\n interface UpdateReviewResponse {\n /** Updated review data. */\n review?: Review;\n }\n interface DeleteReviewRequest {\n /** Review ID. */\n reviewId: string;\n }\n interface DeleteReviewResponse {\n /** Review entity. */\n review?: Review;\n }\n interface BulkDeleteReviewsRequest {\n /**\n * Filter object.\n *\n */\n filter?: Record | null;\n }\n interface BulkDeleteReviewsResponse {\n /** Bulk job ID. */\n jobId?: string;\n }\n interface QueryReviewsRequest {\n /** Review query. */\n query?: QueryV2;\n /**\n * Whether to return private (unpublished) reviews.\n *\n * Default: `false`\n */\n returnPrivateReviews?: boolean;\n }\n interface QueryV2 {\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. */\n sort?: Sorting[];\n /** Cursor paging options. */\n cursorPaging?: CursorPaging;\n }\n /** Sort options. */\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Defaults to `ascending`.\n */\n order?: SortOrder;\n }\n enum SortOrder {\n /** Sort by ascending order. */\n ASC = \"ASC\",\n /** Sort by descending order. */\n DESC = \"DESC\"\n }\n interface CursorPaging {\n /**\n * The number of items to load.\n * Cursor token returned in the query response. To be used on the next query request, but not the first query request.\n *\n * Max: `100`
      \n * Default: `50`\n */\n limit?: number | null;\n /** Cursor returned in last query response. Should not be provided on first page request. */\n cursor?: string | null;\n }\n interface QueryReviewsResponse {\n /** Paging metadata. */\n metadata?: PagingMetadataV2;\n /** List of returned reviews. */\n reviews?: Review[];\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors;\n }\n interface Cursors {\n /** Cursor pointing to next result page. */\n next?: string | null;\n /** Cursor pointing to previous result page. */\n prev?: string | null;\n }\n interface SetReplyRequest {\n /** Review id */\n reviewId: string;\n /** Response to review author */\n message: string;\n }\n interface SetReplyResponse {\n /** Review entity */\n review?: Review;\n }\n interface RemoveReplyRequest {\n /** Review ID */\n reviewId: string;\n }\n interface RemoveReplyResponse {\n /** Review ID */\n review?: Review;\n }\n interface UpdateModerationStatusRequest {\n /** Review id */\n reviewId: string;\n /** Moderation status to set */\n status?: UpdateModerationStatusRequestModerationStatus;\n }\n enum UpdateModerationStatusRequestModerationStatus {\n UNKNOWN_MODERATION_STATUS = \"UNKNOWN_MODERATION_STATUS\",\n APPROVED = \"APPROVED\",\n REJECTED = \"REJECTED\"\n }\n interface UpdateModerationStatusResponse {\n /** Review entity */\n review?: Review;\n }\n interface BulkUpdateModerationStatusRequest {\n /** Reviews to moderate */\n filter?: Record | null;\n /** Moderation status to set */\n status?: ModerationStatus;\n }\n enum ModerationStatus {\n UNKNOWN = \"UNKNOWN\",\n APPROVED = \"APPROVED\",\n REJECTED = \"REJECTED\"\n }\n interface BulkUpdateModerationStatusResponse {\n /** Reference to async job */\n jobId?: string;\n }\n interface CountReviewsRequest {\n filter?: Record | null;\n /**\n * Whether to include private (unpublished) reviews in count results.\n *\n * Default: `false`\n */\n includePrivateReviews?: boolean;\n }\n interface CountReviewsResponse {\n /** Number of reviews. */\n count?: number;\n }\n /**\n * Retrieves a review.\n *\n *\n * The `getReview()` function returns a Promise that resolves to the retrieved review.\n *\n * By default, an unpublished review is not returned. To retrieve an unpublished review, pass `returnPrivateReviews` as `true`.\n * @param reviewId - Review ID.\n * @public\n * @requiredField reviewId\n * @param options - Information about the reviews to retrieve.\n * @permissionId REVIEWS.READ_REVIEWS\n * @permissionId REVIEWS.READ_PRIVATE_REVIEWS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.READ-REVIEWS\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Review.\n * @fqn com.wixpress.critique.reviews.Reviews.GetReview\n */\n function getReview(reviewId: string, options?: GetReviewOptions): Promise;\n interface GetReviewOptions {\n /**\n * Whether to return private (unpublished) reviews.\n *\n * Default: `false`\n */\n returnPrivateReviews?: boolean;\n }\n /**\n * Creates a new review and a new contact.\n *\n *\n * When the review author is not a contact, use this endpoint. Include `name` and `email`,\n * as they're required to create the contact. If these parameters are missing, a new contact and\n * review won't be created.\n *\n * When the review author is already a contact, use either this endpoint or [Create Review](https://dev.wix.com/api/rest/reviews/create-review).\n * A new review is created but a new contact is not created. For a 3rd-party app, include `name` and `email`.\n *\n * After a review is created, it may require [moderation](https://dev.wix.com/api/rest/reviews/introduction#reviews_introduction_moderation).\n * @param namespace - Namespace where the review is created.\n * @param entityId - ID of the entity to review.\n * @param content - Review content.\n * @public\n * @documentationMaturity preview\n * @requiredField content\n * @requiredField content.rating\n * @requiredField entityId\n * @requiredField namespace\n * @permissionId REVIEWS.CREATE_REVIEW\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.critique.reviews.Reviews.CreateReviewAndContact\n * @deprecated\n * @replacedBy com.wixpress.critique.reviews.CreateReview\n * @targetRemovalDate 2024-02-01\n */\n function createReviewAndContact(namespace: string, entityId: string, content: ReviewContent, options?: CreateReviewAndContactOptions): Promise;\n interface CreateReviewAndContactOptions {\n /** Name of the review author. Displayed as part of the review. Required for 3rd-party apps. */\n name?: string | null;\n /** Email address of the review author. Required for 3rd-party apps. */\n email?: string | null;\n }\n /**\n * Creates a review.\n *\n *\n * The `createReview()` function returns a promise that resolves to the created review.\n *\n * This function requires a `contactId`.\n *\n * If the review author does not have a contact ID, use `createReviewAndContact()`.\n *\n * If `authorName` is left empty, the member's name will be used. If the author is not a member, the field is left `null`.\n * @param review - Review data.\n * @public\n * @requiredField review\n * @requiredField review.content\n * @requiredField review.content.rating\n * @requiredField review.entityId\n * @requiredField review.namespace\n * @permissionId REVIEWS.CREATE_REVIEW\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Created review.\n * @fqn com.wixpress.critique.reviews.Reviews.CreateReview\n */\n function createReview(review: Review): Promise;\n interface BulkCreateReviewOptions {\n returnEntity?: boolean;\n }\n interface UpdateReviewContentOptions {\n /** Review content. */\n content?: ReviewContent;\n /**\n * Fieldmask for update.\n * Supported fields: content.title, content.body, content.media, content.rating\n */\n fieldMask?: string[];\n }\n /**\n * Updates a review.\n *\n *\n * The `updateReview()` function returns a promise that resolves to the updated review.\n *\n * Each time the review is updated, `revision` increments by 1. The existing `revision` must be included\n * when updating the review. This ensures you're working with the latest review information, and it prevents unintended overwrites.\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - Review ID.\n * @public\n * @requiredField _id\n * @requiredField review\n * @requiredField review.revision\n * @param options - Options to use when updating a review.\n * @param review - Review to update.\n * @permissionId REVIEWS.UPDATE_REVIEW\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated review data.\n * @fqn com.wixpress.critique.reviews.Reviews.UpdateReview\n */\n function updateReview(_id: string, review: UpdateReview, options?: UpdateReviewOptions): Promise;\n interface UpdateReview {\n /** Review namespace. Currently integrated with Wix Stores, as `stores`. */\n namespace?: string;\n /** ID of the entity to review. For example, a Wix Stores product ID. */\n entityId?: string;\n /**\n * Review ID.\n * @readonly\n */\n _id?: string;\n /** Review content. */\n content?: ReviewContent;\n /**\n * Date and time the review was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the review was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Author of the review. */\n author?: Author;\n /**\n * Reply to the review.\n * @readonly\n */\n reply?: Reply;\n /**\n * Number of site visitors who found the review helpful.\n * @readonly\n */\n foundHelpful?: number;\n /**\n * Number of site visitors who found the review unhelpful.\n * @readonly\n */\n foundUnhelpful?: number;\n /**\n * Helpfulness score.\n *\n * Calculated by subtracting `foundUnhelpful` from `foundHelpful`.\n * @readonly\n */\n helpfulness?: number;\n /**\n * Moderation status of the review.\n * @readonly\n */\n moderation?: Moderation;\n /**\n * Revision number, which increments by 1 each time the review is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the review.\n * Ignored when creating a review.\n * @readonly\n */\n revision?: string | null;\n /**\n * Indicates whether the review has been verified through a Verify Product Purchase call to the Review Product catalog SPI.\n * @readonly\n */\n verified?: boolean;\n /**\n * Provides information about the origin of the review.\n * Organic reviews are created by site visitors or members.\n * App reviews are created by apps even though a site visitor or member is the author of the review.\n * Apps can not create or update organic reviews.\n * @readonly\n */\n origin?: Origin;\n /**\n * Date and time when the review was written.\n * This should match `created_date`, except for reviews imported from another system.\n */\n reviewDate?: Date | null;\n /**\n * Platform-calculated score of review's relevance to the item. Used to sort\n * reviews by relevance.\n * @readonly\n */\n relevanceScore?: number | null;\n /**\n * Counts the number of times a review has been published.\n * Reviews require approval before publishing, unless moderation is disabled.\n * When moderation is disabled, reviews are automatically approved and published.\n * @readonly\n */\n publishCount?: number;\n }\n interface UpdateReviewOptions {\n }\n /**\n * Deletes a review.\n *\n *\n * The `deleteReview()` function returns a promise that resolves to the deleted review.\n * @param reviewId - Review ID.\n * @public\n * @requiredField reviewId\n * @permissionId REVIEWS.DELETE_REVIEW\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @applicableIdentity APP\n * @adminMethod\n * @fqn com.wixpress.critique.reviews.Reviews.DeleteReview\n */\n function deleteReview(reviewId: string): Promise;\n interface BulkDeleteReviewsOptions {\n /** Filter object. */\n filter?: Record | null;\n }\n /**\n * Creates a query to retrieve a list of reviews.\n *\n *\n * The `queryReviews()` function builds a query to retrieve a list of reviews and returns a `ReviewsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the `find()` function.\n *\n * You can refine the query by chaining `ReviewsQueryBuilder` functions onto the query.\n *\n * `ReviewsQueryBuilder` functions enable you to sort, filter,\n * and control the results that `queryReviews()` returns.\n *\n * The `queryReviews()` function runs with the following defaults, which you can override:\n *\n * - `ascending(\"_createdDate\")`\n * - `limit(100)`\n *\n * The functions that are chained to `queryReviews()` are applied in the order they're called. For example, if you apply `descending(\"_createdDate\")` and then `descending(\"content.rating\")`, the results are sorted first by the `_createdDate`, and then, if there are multiple results with the same `_createdDate`, the items are sorted by `content.rating`.\n * @public\n * @param options - Information about the reviews to retrieve.\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.READ-REVIEWS\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @permissionId REVIEWS.READ_REVIEWS\n * @permissionId REVIEWS.READ_PRIVATE_REVIEWS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.critique.reviews.Reviews.QueryReviews\n */\n function queryReviews(options?: QueryReviewsOptions): ReviewsQueryBuilder;\n interface QueryReviewsOptions {\n /**\n * Whether to return private (unpublished) reviews.\n *\n * Default: `false`\n */\n returnPrivateReviews?: boolean | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ReviewsQueryResult extends QueryCursorResult {\n items: Review[];\n query: ReviewsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ReviewsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"namespace\" | \"entityId\" | \"_id\" | \"content.rating\" | \"_createdDate\" | \"author.contactId\" | \"helpfulness\" | \"moderation.moderationStatus\" | \"verified\" | \"origin.type\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"namespace\" | \"entityId\" | \"_id\" | \"content.rating\" | \"_createdDate\" | \"author.contactId\" | \"helpfulness\" | \"moderation.moderationStatus\" | \"verified\" | \"origin.type\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"content.rating\" | \"_createdDate\" | \"helpfulness\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"content.rating\" | \"_createdDate\" | \"helpfulness\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"content.rating\" | \"_createdDate\" | \"helpfulness\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"content.rating\" | \"_createdDate\" | \"helpfulness\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n in: (propertyName: \"namespace\" | \"entityId\" | \"_id\" | \"content.rating\" | \"_createdDate\" | \"author.contactId\" | \"helpfulness\" | \"moderation.moderationStatus\" | \"relevanceScore\", value: any) => ReviewsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"content.rating\" | \"_createdDate\" | \"helpfulness\" | \"verified\" | \"origin.type\" | \"relevanceScore\">) => ReviewsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"content.rating\" | \"_createdDate\" | \"helpfulness\" | \"verified\" | \"origin.type\" | \"relevanceScore\">) => ReviewsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => ReviewsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => ReviewsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Set reply on a review\n * @param reviewId - Review id\n * @param message - Response to review author\n * @public\n * @documentationMaturity preview\n * @requiredField message\n * @requiredField reviewId\n * @permissionId REVIEWS.SET_REPLY\n * @adminMethod\n * @fqn com.wixpress.critique.reviews.Reviews.SetReply\n */\n function setReply(reviewId: string, message: string): Promise;\n /**\n * Removes reply from review\n * @param reviewId - Review ID\n * @public\n * @documentationMaturity preview\n * @requiredField reviewId\n * @permissionId REVIEWS.REMOVE_REPLY\n * @adminMethod\n * @fqn com.wixpress.critique.reviews.Reviews.RemoveReply\n */\n function removeReply(reviewId: string): Promise;\n interface UpdateModerationStatusOptions {\n /** Moderation status to set */\n status?: UpdateModerationStatusRequestModerationStatus;\n }\n interface BulkUpdateModerationStatusOptions {\n /** Reviews to moderate */\n filter?: Record | null;\n /** Moderation status to set */\n status?: ModerationStatus;\n }\n /** @public\n * @documentationMaturity preview\n * @permissionId REVIEWS.READ_REVIEWS\n * @permissionId REVIEWS.READ_PRIVATE_REVIEWS\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Read reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.READ-REVIEWS\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionScope Manage Reviews\n * @permissionScopeId SCOPE.DC-REVIEWS.MANAGE-REVIEWS\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn com.wixpress.critique.reviews.Reviews.CountReviews\n */\n function countReviews(options?: CountReviewsOptions): Promise;\n interface CountReviewsOptions {\n filter?: Record | null;\n /**\n * Whether to include private (unpublished) reviews in count results.\n *\n * Default: `false`\n */\n includePrivateReviews?: boolean;\n }\n type reviewsV1ReviewReviews_universal_d_Review = Review;\n type reviewsV1ReviewReviews_universal_d_ReviewContent = ReviewContent;\n type reviewsV1ReviewReviews_universal_d_Media = Media;\n type reviewsV1ReviewReviews_universal_d_MediaMediaOneOf = MediaMediaOneOf;\n type reviewsV1ReviewReviews_universal_d_VideoResolution = VideoResolution;\n type reviewsV1ReviewReviews_universal_d_Author = Author;\n type reviewsV1ReviewReviews_universal_d_AuthorType = AuthorType;\n const reviewsV1ReviewReviews_universal_d_AuthorType: typeof AuthorType;\n type reviewsV1ReviewReviews_universal_d_Reply = Reply;\n type reviewsV1ReviewReviews_universal_d_Moderation = Moderation;\n type reviewsV1ReviewReviews_universal_d_ModerationModerationStatus = ModerationModerationStatus;\n const reviewsV1ReviewReviews_universal_d_ModerationModerationStatus: typeof ModerationModerationStatus;\n type reviewsV1ReviewReviews_universal_d_Origin = Origin;\n type reviewsV1ReviewReviews_universal_d_OriginType = OriginType;\n const reviewsV1ReviewReviews_universal_d_OriginType: typeof OriginType;\n type reviewsV1ReviewReviews_universal_d_Source = Source;\n type reviewsV1ReviewReviews_universal_d_SourceSourceTypeOptionsOneOf = SourceSourceTypeOptionsOneOf;\n type reviewsV1ReviewReviews_universal_d_SourceType = SourceType;\n const reviewsV1ReviewReviews_universal_d_SourceType: typeof SourceType;\n type reviewsV1ReviewReviews_universal_d_ReviewRequestOptions = ReviewRequestOptions;\n type reviewsV1ReviewReviews_universal_d_RequestLinkOptions = RequestLinkOptions;\n type reviewsV1ReviewReviews_universal_d_DomainEvent = DomainEvent;\n type reviewsV1ReviewReviews_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type reviewsV1ReviewReviews_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type reviewsV1ReviewReviews_universal_d_RestoreInfo = RestoreInfo;\n type reviewsV1ReviewReviews_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type reviewsV1ReviewReviews_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type reviewsV1ReviewReviews_universal_d_ActionEvent = ActionEvent;\n type reviewsV1ReviewReviews_universal_d_Empty = Empty;\n type reviewsV1ReviewReviews_universal_d_MessageEnvelope = MessageEnvelope;\n type reviewsV1ReviewReviews_universal_d_IdentificationData = IdentificationData;\n type reviewsV1ReviewReviews_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type reviewsV1ReviewReviews_universal_d_WebhookIdentityType = WebhookIdentityType;\n const reviewsV1ReviewReviews_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type reviewsV1ReviewReviews_universal_d_GetReviewRequest = GetReviewRequest;\n type reviewsV1ReviewReviews_universal_d_GetReviewResponse = GetReviewResponse;\n type reviewsV1ReviewReviews_universal_d_GetDeletedReviewRequest = GetDeletedReviewRequest;\n type reviewsV1ReviewReviews_universal_d_GetDeletedReviewResponse = GetDeletedReviewResponse;\n type reviewsV1ReviewReviews_universal_d_CreateReviewAndContactRequest = CreateReviewAndContactRequest;\n type reviewsV1ReviewReviews_universal_d_CreateReviewResponse = CreateReviewResponse;\n type reviewsV1ReviewReviews_universal_d_CreateReviewRequest = CreateReviewRequest;\n type reviewsV1ReviewReviews_universal_d_ReviewPublished = ReviewPublished;\n type reviewsV1ReviewReviews_universal_d_BulkCreateReviewRequest = BulkCreateReviewRequest;\n type reviewsV1ReviewReviews_universal_d_BulkCreateReviewResponse = BulkCreateReviewResponse;\n type reviewsV1ReviewReviews_universal_d_BulkReviewResult = BulkReviewResult;\n type reviewsV1ReviewReviews_universal_d_ItemMetadata = ItemMetadata;\n type reviewsV1ReviewReviews_universal_d_ApplicationError = ApplicationError;\n type reviewsV1ReviewReviews_universal_d_BulkActionMetadata = BulkActionMetadata;\n type reviewsV1ReviewReviews_universal_d_UpdateReviewContentRequest = UpdateReviewContentRequest;\n type reviewsV1ReviewReviews_universal_d_UpdateReviewContentResponse = UpdateReviewContentResponse;\n type reviewsV1ReviewReviews_universal_d_ModerationStatusChanged = ModerationStatusChanged;\n type reviewsV1ReviewReviews_universal_d_UpdateReviewRequest = UpdateReviewRequest;\n type reviewsV1ReviewReviews_universal_d_UpdateReviewResponse = UpdateReviewResponse;\n type reviewsV1ReviewReviews_universal_d_DeleteReviewRequest = DeleteReviewRequest;\n type reviewsV1ReviewReviews_universal_d_DeleteReviewResponse = DeleteReviewResponse;\n type reviewsV1ReviewReviews_universal_d_BulkDeleteReviewsRequest = BulkDeleteReviewsRequest;\n type reviewsV1ReviewReviews_universal_d_BulkDeleteReviewsResponse = BulkDeleteReviewsResponse;\n type reviewsV1ReviewReviews_universal_d_QueryReviewsRequest = QueryReviewsRequest;\n type reviewsV1ReviewReviews_universal_d_QueryV2 = QueryV2;\n type reviewsV1ReviewReviews_universal_d_Sorting = Sorting;\n type reviewsV1ReviewReviews_universal_d_SortOrder = SortOrder;\n const reviewsV1ReviewReviews_universal_d_SortOrder: typeof SortOrder;\n type reviewsV1ReviewReviews_universal_d_CursorPaging = CursorPaging;\n type reviewsV1ReviewReviews_universal_d_QueryReviewsResponse = QueryReviewsResponse;\n type reviewsV1ReviewReviews_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type reviewsV1ReviewReviews_universal_d_Cursors = Cursors;\n type reviewsV1ReviewReviews_universal_d_SetReplyRequest = SetReplyRequest;\n type reviewsV1ReviewReviews_universal_d_SetReplyResponse = SetReplyResponse;\n type reviewsV1ReviewReviews_universal_d_RemoveReplyRequest = RemoveReplyRequest;\n type reviewsV1ReviewReviews_universal_d_RemoveReplyResponse = RemoveReplyResponse;\n type reviewsV1ReviewReviews_universal_d_UpdateModerationStatusRequest = UpdateModerationStatusRequest;\n type reviewsV1ReviewReviews_universal_d_UpdateModerationStatusRequestModerationStatus = UpdateModerationStatusRequestModerationStatus;\n const reviewsV1ReviewReviews_universal_d_UpdateModerationStatusRequestModerationStatus: typeof UpdateModerationStatusRequestModerationStatus;\n type reviewsV1ReviewReviews_universal_d_UpdateModerationStatusResponse = UpdateModerationStatusResponse;\n type reviewsV1ReviewReviews_universal_d_BulkUpdateModerationStatusRequest = BulkUpdateModerationStatusRequest;\n type reviewsV1ReviewReviews_universal_d_ModerationStatus = ModerationStatus;\n const reviewsV1ReviewReviews_universal_d_ModerationStatus: typeof ModerationStatus;\n type reviewsV1ReviewReviews_universal_d_BulkUpdateModerationStatusResponse = BulkUpdateModerationStatusResponse;\n type reviewsV1ReviewReviews_universal_d_CountReviewsRequest = CountReviewsRequest;\n type reviewsV1ReviewReviews_universal_d_CountReviewsResponse = CountReviewsResponse;\n const reviewsV1ReviewReviews_universal_d_getReview: typeof getReview;\n type reviewsV1ReviewReviews_universal_d_GetReviewOptions = GetReviewOptions;\n const reviewsV1ReviewReviews_universal_d_createReviewAndContact: typeof createReviewAndContact;\n type reviewsV1ReviewReviews_universal_d_CreateReviewAndContactOptions = CreateReviewAndContactOptions;\n const reviewsV1ReviewReviews_universal_d_createReview: typeof createReview;\n type reviewsV1ReviewReviews_universal_d_BulkCreateReviewOptions = BulkCreateReviewOptions;\n type reviewsV1ReviewReviews_universal_d_UpdateReviewContentOptions = UpdateReviewContentOptions;\n const reviewsV1ReviewReviews_universal_d_updateReview: typeof updateReview;\n type reviewsV1ReviewReviews_universal_d_UpdateReview = UpdateReview;\n type reviewsV1ReviewReviews_universal_d_UpdateReviewOptions = UpdateReviewOptions;\n const reviewsV1ReviewReviews_universal_d_deleteReview: typeof deleteReview;\n type reviewsV1ReviewReviews_universal_d_BulkDeleteReviewsOptions = BulkDeleteReviewsOptions;\n const reviewsV1ReviewReviews_universal_d_queryReviews: typeof queryReviews;\n type reviewsV1ReviewReviews_universal_d_QueryReviewsOptions = QueryReviewsOptions;\n type reviewsV1ReviewReviews_universal_d_ReviewsQueryResult = ReviewsQueryResult;\n type reviewsV1ReviewReviews_universal_d_ReviewsQueryBuilder = ReviewsQueryBuilder;\n const reviewsV1ReviewReviews_universal_d_setReply: typeof setReply;\n const reviewsV1ReviewReviews_universal_d_removeReply: typeof removeReply;\n type reviewsV1ReviewReviews_universal_d_UpdateModerationStatusOptions = UpdateModerationStatusOptions;\n type reviewsV1ReviewReviews_universal_d_BulkUpdateModerationStatusOptions = BulkUpdateModerationStatusOptions;\n const reviewsV1ReviewReviews_universal_d_countReviews: typeof countReviews;\n type reviewsV1ReviewReviews_universal_d_CountReviewsOptions = CountReviewsOptions;\n namespace reviewsV1ReviewReviews_universal_d {\n export { reviewsV1ReviewReviews_universal_d_Review as Review, reviewsV1ReviewReviews_universal_d_ReviewContent as ReviewContent, reviewsV1ReviewReviews_universal_d_Media as Media, reviewsV1ReviewReviews_universal_d_MediaMediaOneOf as MediaMediaOneOf, reviewsV1ReviewReviews_universal_d_VideoResolution as VideoResolution, reviewsV1ReviewReviews_universal_d_Author as Author, reviewsV1ReviewReviews_universal_d_AuthorType as AuthorType, reviewsV1ReviewReviews_universal_d_Reply as Reply, reviewsV1ReviewReviews_universal_d_Moderation as Moderation, reviewsV1ReviewReviews_universal_d_ModerationModerationStatus as ModerationModerationStatus, reviewsV1ReviewReviews_universal_d_Origin as Origin, reviewsV1ReviewReviews_universal_d_OriginType as OriginType, reviewsV1ReviewReviews_universal_d_Source as Source, reviewsV1ReviewReviews_universal_d_SourceSourceTypeOptionsOneOf as SourceSourceTypeOptionsOneOf, reviewsV1ReviewReviews_universal_d_SourceType as SourceType, reviewsV1ReviewReviews_universal_d_ReviewRequestOptions as ReviewRequestOptions, reviewsV1ReviewReviews_universal_d_RequestLinkOptions as RequestLinkOptions, reviewsV1ReviewReviews_universal_d_DomainEvent as DomainEvent, reviewsV1ReviewReviews_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, reviewsV1ReviewReviews_universal_d_EntityCreatedEvent as EntityCreatedEvent, reviewsV1ReviewReviews_universal_d_RestoreInfo as RestoreInfo, reviewsV1ReviewReviews_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, reviewsV1ReviewReviews_universal_d_EntityDeletedEvent as EntityDeletedEvent, reviewsV1ReviewReviews_universal_d_ActionEvent as ActionEvent, reviewsV1ReviewReviews_universal_d_Empty as Empty, reviewsV1ReviewReviews_universal_d_MessageEnvelope as MessageEnvelope, reviewsV1ReviewReviews_universal_d_IdentificationData as IdentificationData, reviewsV1ReviewReviews_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, reviewsV1ReviewReviews_universal_d_WebhookIdentityType as WebhookIdentityType, reviewsV1ReviewReviews_universal_d_GetReviewRequest as GetReviewRequest, reviewsV1ReviewReviews_universal_d_GetReviewResponse as GetReviewResponse, reviewsV1ReviewReviews_universal_d_GetDeletedReviewRequest as GetDeletedReviewRequest, reviewsV1ReviewReviews_universal_d_GetDeletedReviewResponse as GetDeletedReviewResponse, reviewsV1ReviewReviews_universal_d_CreateReviewAndContactRequest as CreateReviewAndContactRequest, reviewsV1ReviewReviews_universal_d_CreateReviewResponse as CreateReviewResponse, reviewsV1ReviewReviews_universal_d_CreateReviewRequest as CreateReviewRequest, reviewsV1ReviewReviews_universal_d_ReviewPublished as ReviewPublished, reviewsV1ReviewReviews_universal_d_BulkCreateReviewRequest as BulkCreateReviewRequest, reviewsV1ReviewReviews_universal_d_BulkCreateReviewResponse as BulkCreateReviewResponse, reviewsV1ReviewReviews_universal_d_BulkReviewResult as BulkReviewResult, reviewsV1ReviewReviews_universal_d_ItemMetadata as ItemMetadata, reviewsV1ReviewReviews_universal_d_ApplicationError as ApplicationError, reviewsV1ReviewReviews_universal_d_BulkActionMetadata as BulkActionMetadata, reviewsV1ReviewReviews_universal_d_UpdateReviewContentRequest as UpdateReviewContentRequest, reviewsV1ReviewReviews_universal_d_UpdateReviewContentResponse as UpdateReviewContentResponse, reviewsV1ReviewReviews_universal_d_ModerationStatusChanged as ModerationStatusChanged, reviewsV1ReviewReviews_universal_d_UpdateReviewRequest as UpdateReviewRequest, reviewsV1ReviewReviews_universal_d_UpdateReviewResponse as UpdateReviewResponse, reviewsV1ReviewReviews_universal_d_DeleteReviewRequest as DeleteReviewRequest, reviewsV1ReviewReviews_universal_d_DeleteReviewResponse as DeleteReviewResponse, reviewsV1ReviewReviews_universal_d_BulkDeleteReviewsRequest as BulkDeleteReviewsRequest, reviewsV1ReviewReviews_universal_d_BulkDeleteReviewsResponse as BulkDeleteReviewsResponse, reviewsV1ReviewReviews_universal_d_QueryReviewsRequest as QueryReviewsRequest, reviewsV1ReviewReviews_universal_d_QueryV2 as QueryV2, reviewsV1ReviewReviews_universal_d_Sorting as Sorting, reviewsV1ReviewReviews_universal_d_SortOrder as SortOrder, reviewsV1ReviewReviews_universal_d_CursorPaging as CursorPaging, reviewsV1ReviewReviews_universal_d_QueryReviewsResponse as QueryReviewsResponse, reviewsV1ReviewReviews_universal_d_PagingMetadataV2 as PagingMetadataV2, reviewsV1ReviewReviews_universal_d_Cursors as Cursors, reviewsV1ReviewReviews_universal_d_SetReplyRequest as SetReplyRequest, reviewsV1ReviewReviews_universal_d_SetReplyResponse as SetReplyResponse, reviewsV1ReviewReviews_universal_d_RemoveReplyRequest as RemoveReplyRequest, reviewsV1ReviewReviews_universal_d_RemoveReplyResponse as RemoveReplyResponse, reviewsV1ReviewReviews_universal_d_UpdateModerationStatusRequest as UpdateModerationStatusRequest, reviewsV1ReviewReviews_universal_d_UpdateModerationStatusRequestModerationStatus as UpdateModerationStatusRequestModerationStatus, reviewsV1ReviewReviews_universal_d_UpdateModerationStatusResponse as UpdateModerationStatusResponse, reviewsV1ReviewReviews_universal_d_BulkUpdateModerationStatusRequest as BulkUpdateModerationStatusRequest, reviewsV1ReviewReviews_universal_d_ModerationStatus as ModerationStatus, reviewsV1ReviewReviews_universal_d_BulkUpdateModerationStatusResponse as BulkUpdateModerationStatusResponse, reviewsV1ReviewReviews_universal_d_CountReviewsRequest as CountReviewsRequest, reviewsV1ReviewReviews_universal_d_CountReviewsResponse as CountReviewsResponse, reviewsV1ReviewReviews_universal_d_getReview as getReview, reviewsV1ReviewReviews_universal_d_GetReviewOptions as GetReviewOptions, reviewsV1ReviewReviews_universal_d_createReviewAndContact as createReviewAndContact, reviewsV1ReviewReviews_universal_d_CreateReviewAndContactOptions as CreateReviewAndContactOptions, reviewsV1ReviewReviews_universal_d_createReview as createReview, reviewsV1ReviewReviews_universal_d_BulkCreateReviewOptions as BulkCreateReviewOptions, reviewsV1ReviewReviews_universal_d_UpdateReviewContentOptions as UpdateReviewContentOptions, reviewsV1ReviewReviews_universal_d_updateReview as updateReview, reviewsV1ReviewReviews_universal_d_UpdateReview as UpdateReview, reviewsV1ReviewReviews_universal_d_UpdateReviewOptions as UpdateReviewOptions, reviewsV1ReviewReviews_universal_d_deleteReview as deleteReview, reviewsV1ReviewReviews_universal_d_BulkDeleteReviewsOptions as BulkDeleteReviewsOptions, reviewsV1ReviewReviews_universal_d_queryReviews as queryReviews, reviewsV1ReviewReviews_universal_d_QueryReviewsOptions as QueryReviewsOptions, reviewsV1ReviewReviews_universal_d_ReviewsQueryResult as ReviewsQueryResult, reviewsV1ReviewReviews_universal_d_ReviewsQueryBuilder as ReviewsQueryBuilder, reviewsV1ReviewReviews_universal_d_setReply as setReply, reviewsV1ReviewReviews_universal_d_removeReply as removeReply, reviewsV1ReviewReviews_universal_d_UpdateModerationStatusOptions as UpdateModerationStatusOptions, reviewsV1ReviewReviews_universal_d_BulkUpdateModerationStatusOptions as BulkUpdateModerationStatusOptions, reviewsV1ReviewReviews_universal_d_countReviews as countReviews, reviewsV1ReviewReviews_universal_d_CountReviewsOptions as CountReviewsOptions, };\n }\n export { reviewsV1ReviewReviews_universal_d as reviews };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-comments.v2.d.ts", "content": "declare module \"wix-comments.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * A comment is a user-generated message in response to a specific resource. It allows site visitors\n * to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,\n * or other site content. Comments are composed of text, images, videos, or other forms of media.\n */\n interface Comment {\n /**\n * Comment ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the comment is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the comment.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the comment was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the comment was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** ID of the app that the comment is added to. */\n appId?: string | null;\n /**\n * ID of the specific context the comment is in response to.\n *\n * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,\n * the `forumPostId` is used as both the `contextId` and the `resourceId`.\n */\n contextId?: string | null;\n /** Reserved for internal use. */\n contextType?: string | null;\n /**\n * ID of the specific resource that the comment is in response to.\n *\n * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,\n * the `forumPostId` is used as both the `resourceId` and the `contextId`.\n */\n resourceId?: string | null;\n /** Published comment content. */\n content?: CommentContent;\n /** Comment's author. */\n author?: CommentAuthor;\n /**\n * Parent comment information.\n *\n * See [Terminology](#introduction) for more information about parent comments.\n */\n parentComment?: ParentComment;\n /**\n * Amount of comments that reply to this comment.\n * @readonly\n */\n replyCount?: number;\n /**\n * Summary of votes.\n * @readonly\n */\n voteSummary?: VoteSummary;\n /**\n * Comment status.\n *\n * Supported values:\n * + `\"PUBLISHED\"`: This comment is published and publicly visible.\n * + `\"DELETED\"`: This comment is deleted.\n * + `\"PENDING\"`: This comment is pending moderation. Moderation is not currently supported.\n * + `\"HIDDEN\"`: This comment has been hidden by a site moderator.\n * @readonly\n */\n status?: Status;\n /**\n * Comment rating.\n * @readonly\n */\n rating?: number | null;\n /**\n * Summary of reactions.\n * @readonly\n */\n reactionSummary?: CommentReactionSummary;\n /** Whether the comment is marked. */\n marked?: boolean;\n }\n /** Comment content. */\n interface CommentContent {\n /** Comment rich content. */\n richContent?: RichContent;\n /**\n * Mentions to tag with this comment.\n *\n * Mentions can include users, members, visitors, or groups.\n */\n mentions?: Mention[];\n /** Content attachments. */\n attachments?: Attachment[];\n }\n interface RichContent {\n /** Node objects representing a rich content document. */\n nodes?: Node[];\n /** Object metadata. */\n metadata?: Metadata;\n /** Global styling for header, paragraph, block quote, and code block nodes in the object. */\n documentStyle?: DocumentStyle;\n }\n interface Node extends NodeDataOneOf {\n /** Data for a button node. */\n buttonData?: ButtonData;\n /** Data for a code block node. */\n codeBlockData?: CodeBlockData;\n /** Data for a divider node. */\n dividerData?: DividerData;\n /** Data for a file node. */\n fileData?: FileData;\n /** Data for a gallery node. */\n galleryData?: GalleryData;\n /** Data for a GIF node. */\n gifData?: GIFData;\n /** Data for a heading node. */\n headingData?: HeadingData;\n /** Data for an embedded HTML node. */\n htmlData?: HTMLData;\n /** Data for an image node. */\n imageData?: ImageData;\n /** Data for a link preview node. */\n linkPreviewData?: LinkPreviewData;\n /** Data for a map node. */\n mapData?: MapData;\n /** Data for a paragraph node. */\n paragraphData?: ParagraphData;\n /** Data for a poll node. */\n pollData?: PollData;\n /** Data for a text node. Used to apply decorations to text. */\n textData?: TextData;\n /** Data for an app embed node. */\n appEmbedData?: AppEmbedData;\n /** Data for a video node. */\n videoData?: VideoData;\n /** Data for an oEmbed node. */\n embedData?: EmbedData;\n /** Data for a collapsible list node. */\n collapsibleListData?: CollapsibleListData;\n /** Data for a table node. */\n tableData?: TableData;\n /** Data for a table cell node. */\n tableCellData?: TableCellData;\n /** Data for a custon external node. */\n externalData?: Record | null;\n /** Data for an audio node. */\n audioData?: AudioData;\n /** Data for an ordered list node. */\n orderedListData?: OrderedListData;\n /** Data for a bulleted list node. */\n bulletedListData?: BulletedListData;\n /** Data for a block quote node. */\n blockquoteData?: BlockquoteData;\n /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */\n type?: NodeType;\n /** Node ID. */\n _id?: string;\n /** A list of child nodes. */\n nodes?: Node[];\n /** Padding and background color styling for the node. */\n style?: NodeStyle;\n }\n /** @oneof */\n interface NodeDataOneOf {\n /** Data for a button node. */\n buttonData?: ButtonData;\n /** Data for a code block node. */\n codeBlockData?: CodeBlockData;\n /** Data for a divider node. */\n dividerData?: DividerData;\n /** Data for a file node. */\n fileData?: FileData;\n /** Data for a gallery node. */\n galleryData?: GalleryData;\n /** Data for a GIF node. */\n gifData?: GIFData;\n /** Data for a heading node. */\n headingData?: HeadingData;\n /** Data for an embedded HTML node. */\n htmlData?: HTMLData;\n /** Data for an image node. */\n imageData?: ImageData;\n /** Data for a link preview node. */\n linkPreviewData?: LinkPreviewData;\n /** Data for a map node. */\n mapData?: MapData;\n /** Data for a paragraph node. */\n paragraphData?: ParagraphData;\n /** Data for a poll node. */\n pollData?: PollData;\n /** Data for a text node. Used to apply decorations to text. */\n textData?: TextData;\n /** Data for an app embed node. */\n appEmbedData?: AppEmbedData;\n /** Data for a video node. */\n videoData?: VideoData;\n /** Data for an oEmbed node. */\n embedData?: EmbedData;\n /** Data for a collapsible list node. */\n collapsibleListData?: CollapsibleListData;\n /** Data for a table node. */\n tableData?: TableData;\n /** Data for a table cell node. */\n tableCellData?: TableCellData;\n /** Data for a custon external node. */\n externalData?: Record | null;\n /** Data for an audio node. */\n audioData?: AudioData;\n /** Data for an ordered list node. */\n orderedListData?: OrderedListData;\n /** Data for a bulleted list node. */\n bulletedListData?: BulletedListData;\n /** Data for a block quote node. */\n blockquoteData?: BlockquoteData;\n }\n enum NodeType {\n PARAGRAPH = \"PARAGRAPH\",\n TEXT = \"TEXT\",\n HEADING = \"HEADING\",\n BULLETED_LIST = \"BULLETED_LIST\",\n ORDERED_LIST = \"ORDERED_LIST\",\n LIST_ITEM = \"LIST_ITEM\",\n BLOCKQUOTE = \"BLOCKQUOTE\",\n CODE_BLOCK = \"CODE_BLOCK\",\n VIDEO = \"VIDEO\",\n DIVIDER = \"DIVIDER\",\n FILE = \"FILE\",\n GALLERY = \"GALLERY\",\n GIF = \"GIF\",\n HTML = \"HTML\",\n IMAGE = \"IMAGE\",\n LINK_PREVIEW = \"LINK_PREVIEW\",\n MAP = \"MAP\",\n POLL = \"POLL\",\n APP_EMBED = \"APP_EMBED\",\n BUTTON = \"BUTTON\",\n COLLAPSIBLE_LIST = \"COLLAPSIBLE_LIST\",\n TABLE = \"TABLE\",\n EMBED = \"EMBED\",\n COLLAPSIBLE_ITEM = \"COLLAPSIBLE_ITEM\",\n COLLAPSIBLE_ITEM_TITLE = \"COLLAPSIBLE_ITEM_TITLE\",\n COLLAPSIBLE_ITEM_BODY = \"COLLAPSIBLE_ITEM_BODY\",\n TABLE_CELL = \"TABLE_CELL\",\n TABLE_ROW = \"TABLE_ROW\",\n EXTERNAL = \"EXTERNAL\",\n AUDIO = \"AUDIO\"\n }\n interface NodeStyle {\n /** The top padding value in pixels. */\n paddingTop?: string | null;\n /** The bottom padding value in pixels. */\n paddingBottom?: string | null;\n /** The background color as a hexadecimal value. */\n backgroundColor?: string | null;\n }\n interface ButtonData {\n /** Styling for the button's container. */\n containerData?: PluginContainerData;\n /** The button type. */\n type?: Type;\n /** Styling for the button. */\n styles?: Styles;\n /** The text to display on the button. */\n text?: string | null;\n /** Button link details. */\n link?: Link;\n }\n interface Border {\n /** Border width in pixels. */\n width?: number | null;\n /** Border radius in pixels. */\n radius?: number | null;\n }\n interface Colors {\n /** The text color as a hexadecimal value. */\n text?: string | null;\n /** The border color as a hexadecimal value. */\n border?: string | null;\n /** The background color as a hexadecimal value. */\n background?: string | null;\n }\n interface PluginContainerData {\n /** The width of the node when it's displayed. */\n width?: PluginContainerDataWidth;\n /** The node's alignment within its container. */\n alignment?: PluginContainerDataAlignment;\n /** Spoiler cover settings for the node. */\n spoiler?: Spoiler;\n /** The height of the node when it's displayed. */\n height?: Height;\n /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. */\n textWrap?: boolean | null;\n }\n enum WidthType {\n /** Width matches the content width */\n CONTENT = \"CONTENT\",\n /** Small Width */\n SMALL = \"SMALL\",\n /** Width will match the original asset width */\n ORIGINAL = \"ORIGINAL\",\n /** coast-to-coast display */\n FULL_WIDTH = \"FULL_WIDTH\"\n }\n interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {\n /**\n * One of the following predefined width options:\n * `CONTENT`: The width of the container matches the content width.\n * `SMALL`: Small width.\n * `ORIGINAL`: The width of the container matches the original asset width.\n * `FULL_WIDTH`: Full width.\n */\n size?: WidthType;\n /** A custom width value in pixels. */\n custom?: string | null;\n }\n /** @oneof */\n interface PluginContainerDataWidthDataOneOf {\n /**\n * One of the following predefined width options:\n * `CONTENT`: The width of the container matches the content width.\n * `SMALL`: Small width.\n * `ORIGINAL`: The width of the container matches the original asset width.\n * `FULL_WIDTH`: Full width.\n */\n size?: WidthType;\n /** A custom width value in pixels. */\n custom?: string | null;\n }\n enum PluginContainerDataAlignment {\n /** Center Alignment */\n CENTER = \"CENTER\",\n /** Left Alignment */\n LEFT = \"LEFT\",\n /** Right Alignment */\n RIGHT = \"RIGHT\"\n }\n interface Spoiler {\n /** Sets whether the spoiler cover is enabled for this node. */\n enabled?: boolean | null;\n /** The description displayed on top of the spoiler cover. */\n description?: string | null;\n /** The text for the button used to remove the spoiler cover. */\n buttonText?: string | null;\n }\n interface Height {\n /** A custom height value in pixels. */\n custom?: string | null;\n }\n enum Type {\n /** Regular link button */\n LINK = \"LINK\",\n /** Triggers custom action that is defined in plugin configuration by the consumer */\n ACTION = \"ACTION\"\n }\n interface Styles {\n /** Border attributes. */\n border?: Border;\n /** Color attributes. */\n colors?: Colors;\n }\n interface Link extends LinkDataOneOf {\n /** The absolute URL for the linked document. */\n url?: string;\n /** The target node's ID. Used for linking to another node in this object. */\n anchor?: string;\n /**\n * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:\n * `SELF` - Default. Opens the linked document in the same frame as the link.\n * `BLANK` - Opens the linked document in a new browser tab or window.\n * `PARENT` - Opens the linked document in the link's parent frame.\n * `TOP` - Opens the linked document in the full body of the link's browser tab or window.\n */\n target?: Target;\n /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */\n rel?: Rel;\n /** A serialized object used for a custom or external link panel. */\n customData?: string | null;\n }\n /** @oneof */\n interface LinkDataOneOf {\n /** The absolute URL for the linked document. */\n url?: string;\n /** The target node's ID. Used for linking to another node in this object. */\n anchor?: string;\n }\n enum Target {\n /** Opens the linked document in the same frame as it was clicked (this is default) */\n SELF = \"SELF\",\n /** Opens the linked document in a new window or tab */\n BLANK = \"BLANK\",\n /** Opens the linked document in the parent frame */\n PARENT = \"PARENT\",\n /** Opens the linked document in the full body of the window */\n TOP = \"TOP\"\n }\n interface Rel {\n /** Indicates to search engine crawlers not to follow the link. */\n nofollow?: boolean | null;\n /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. */\n sponsored?: boolean | null;\n /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. */\n ugc?: boolean | null;\n /** Indicates that this link protect referral information from being passed to the target website. */\n noreferrer?: boolean | null;\n }\n interface CodeBlockData {\n /** Styling for the code block's text. */\n textStyle?: TextStyle;\n }\n interface TextStyle {\n /** Text alignment. Defaults to `AUTO`. */\n textAlignment?: TextAlignment;\n /** A CSS `line-height` value for the text as a unitless ratio. */\n lineHeight?: string | null;\n }\n enum TextAlignment {\n /** browser default, eqivalent to `initial` */\n AUTO = \"AUTO\",\n /** Left align */\n LEFT = \"LEFT\",\n /** Right align */\n RIGHT = \"RIGHT\",\n /** Center align */\n CENTER = \"CENTER\",\n /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line. */\n JUSTIFY = \"JUSTIFY\"\n }\n interface DividerData {\n /** Styling for the divider's container. */\n containerData?: PluginContainerData;\n /** Divider line style. */\n lineStyle?: LineStyle;\n /** Divider width. */\n width?: Width;\n /** Divider alignment. */\n alignment?: Alignment;\n }\n enum LineStyle {\n /** Single Line */\n SINGLE = \"SINGLE\",\n /** Double Line */\n DOUBLE = \"DOUBLE\",\n /** Dashed Line */\n DASHED = \"DASHED\",\n /** Dotted Line */\n DOTTED = \"DOTTED\"\n }\n enum Width {\n /** Large line */\n LARGE = \"LARGE\",\n /** Medium line */\n MEDIUM = \"MEDIUM\",\n /** Small line */\n SMALL = \"SMALL\"\n }\n enum Alignment {\n /** Center alignment */\n CENTER = \"CENTER\",\n /** Left alignment */\n LEFT = \"LEFT\",\n /** Right alignment */\n RIGHT = \"RIGHT\"\n }\n interface FileData {\n /** Styling for the file's container. */\n containerData?: PluginContainerData;\n /** The source for the file's data. */\n src?: FileSource;\n /** File name. */\n name?: string | null;\n /** File type. */\n type?: string | null;\n /** File size in KB. */\n size?: number | null;\n /** Settings for PDF files. */\n pdfSettings?: PDFSettings;\n /** File MIME type. */\n mimeType?: string | null;\n /** File path. */\n path?: string | null;\n }\n enum ViewMode {\n /** No PDF view */\n NONE = \"NONE\",\n /** Full PDF view */\n FULL = \"FULL\",\n /** Mini PDF view */\n MINI = \"MINI\"\n }\n interface FileSource extends FileSourceDataOneOf {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /** Custom ID. Use `id` instead. */\n custom?: string | null;\n /** An ID that's resolved to a URL by a resolver function. */\n _id?: string | null;\n /** Indicates whether the file's source is private. */\n private?: boolean | null;\n }\n /** @oneof */\n interface FileSourceDataOneOf {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /** Custom ID. Use `id` instead. */\n custom?: string | null;\n /** An ID that's resolved to a URL by a resolver function. */\n _id?: string | null;\n }\n interface PDFSettings {\n /**\n * PDF view mode. One of the following:\n * `NONE` : The PDF isn't displayed.\n * `FULL` : A full page view of the PDF is displayed.\n * `MINI` : A mini view of the PDF is displayed.\n */\n viewMode?: ViewMode;\n /** Sets whether the PDF download button is disabled. */\n disableDownload?: boolean | null;\n /** Sets whether the PDF print button is disabled. */\n disablePrint?: boolean | null;\n }\n interface GalleryData {\n /** Styling for the gallery's container. */\n containerData?: PluginContainerData;\n /** The items in the gallery. */\n items?: Item[];\n /** Options for defining the gallery's appearance. */\n options?: GalleryOptions;\n /** Sets whether the gallery's expand button is disabled. */\n disableExpand?: boolean | null;\n /** Sets whether the gallery's download button is disabled. */\n disableDownload?: boolean | null;\n }\n interface Media {\n /** The source for the media's data. */\n src?: FileSource;\n /** Media width in pixels. */\n width?: number | null;\n /** Media height in pixels. */\n height?: number | null;\n /** Media duration in seconds. Only relevant for audio and video files. */\n duration?: number | null;\n }\n interface Image {\n /** Image file details. */\n media?: Media;\n /** Link details for images that are links. */\n link?: Link;\n }\n interface Video {\n /** Video file details. */\n media?: Media;\n /** Video thumbnail file details. */\n thumbnail?: Media;\n }\n interface Item extends ItemDataOneOf {\n /** An image item. */\n image?: Image;\n /** A video item. */\n video?: Video;\n /** Item title. */\n title?: string | null;\n /** Item's alternative text. */\n altText?: string | null;\n }\n /** @oneof */\n interface ItemDataOneOf {\n /** An image item. */\n image?: Image;\n /** A video item. */\n video?: Video;\n }\n interface GalleryOptions {\n /** Gallery layout. */\n layout?: Layout;\n /** Styling for gallery items. */\n item?: ItemStyle;\n /** Styling for gallery thumbnail images. */\n thumbnails?: Thumbnails;\n }\n enum LayoutType {\n /** Collage type */\n COLLAGE = \"COLLAGE\",\n /** Masonry type */\n MASONRY = \"MASONRY\",\n /** Grid type */\n GRID = \"GRID\",\n /** Thumbnail type */\n THUMBNAIL = \"THUMBNAIL\",\n /** Slider type */\n SLIDER = \"SLIDER\",\n /** Slideshow type */\n SLIDESHOW = \"SLIDESHOW\",\n /** Panorama type */\n PANORAMA = \"PANORAMA\",\n /** Column type */\n COLUMN = \"COLUMN\",\n /** Magic type */\n MAGIC = \"MAGIC\",\n /** Fullsize images type */\n FULLSIZE = \"FULLSIZE\"\n }\n enum Orientation {\n /** Rows Orientation */\n ROWS = \"ROWS\",\n /** Columns Orientation */\n COLUMNS = \"COLUMNS\"\n }\n enum Crop {\n /** Crop to fill */\n FILL = \"FILL\",\n /** Crop to fit */\n FIT = \"FIT\"\n }\n enum ThumbnailsAlignment {\n /** Top alignment */\n TOP = \"TOP\",\n /** Right alignment */\n RIGHT = \"RIGHT\",\n /** Bottom alignment */\n BOTTOM = \"BOTTOM\",\n /** Left alignment */\n LEFT = \"LEFT\",\n /** No thumbnail */\n NONE = \"NONE\"\n }\n interface Layout {\n /** Gallery layout type. */\n type?: LayoutType;\n /** Sets whether horizontal scroll is enabled. */\n horizontalScroll?: boolean | null;\n /** Gallery orientation. */\n orientation?: Orientation;\n /** The number of columns to display on full size screens. */\n numberOfColumns?: number | null;\n /** The number of columns to display on mobile screens. */\n mobileNumberOfColumns?: number | null;\n }\n interface ItemStyle {\n /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */\n targetSize?: number | null;\n /** Item ratio */\n ratio?: number | null;\n /** Sets how item images are cropped. */\n crop?: Crop;\n /** The spacing between items in pixels. */\n spacing?: number | null;\n }\n interface Thumbnails {\n /** Thumbnail alignment. */\n placement?: ThumbnailsAlignment;\n /** Spacing between thumbnails in pixels. */\n spacing?: number | null;\n }\n interface GIFData {\n /** Styling for the GIF's container. */\n containerData?: PluginContainerData;\n /** The source of the full size GIF. */\n original?: GIF;\n /** The source of the downsized GIF. */\n downsized?: GIF;\n /** Height in pixels. */\n height?: number;\n /** Width in pixels. */\n width?: number;\n }\n interface GIF {\n /** GIF format URL. */\n gif?: string | null;\n /** MP4 format URL. */\n mp4?: string | null;\n /** Thumbnail URL. */\n still?: string | null;\n }\n interface HeadingData {\n /** Heading level from 1-6. */\n level?: number;\n /** Styling for the heading text. */\n textStyle?: TextStyle;\n /** Indentation level from 1-6. */\n indentation?: number | null;\n }\n interface HTMLData extends HTMLDataDataOneOf {\n /** The URL for the HTML code for the node. */\n url?: string;\n /** The HTML code for the node. */\n html?: string;\n /** Whether this is an AdSense element. Use `source` instead. */\n isAdsense?: boolean | null;\n /** Styling for the HTML node's container. */\n containerData?: PluginContainerData;\n /** The type of HTML code. */\n source?: Source;\n }\n /** @oneof */\n interface HTMLDataDataOneOf {\n /** The URL for the HTML code for the node. */\n url?: string;\n /** The HTML code for the node. */\n html?: string;\n /** Whether this is an AdSense element. Use `source` instead. */\n isAdsense?: boolean | null;\n }\n enum Source {\n HTML = \"HTML\",\n ADSENSE = \"ADSENSE\"\n }\n interface ImageData {\n /** Styling for the image's container. */\n containerData?: PluginContainerData;\n /** Image file details. */\n image?: Media;\n /** Link details for images that are links. */\n link?: Link;\n /** Sets whether the image expands to full screen when clicked. */\n disableExpand?: boolean | null;\n /** Image's alternative text. */\n altText?: string | null;\n /** Image caption. */\n caption?: string | null;\n /** Sets whether the image's download button is disabled. */\n disableDownload?: boolean | null;\n }\n interface LinkPreviewData {\n /** Styling for the link preview's container. */\n containerData?: PluginContainerData;\n /** Link details. */\n link?: Link;\n /** Preview title. */\n title?: string | null;\n /** Preview thumbnail URL. */\n thumbnailUrl?: string | null;\n /** Preview description. */\n description?: string | null;\n /** The preview content as HTML. */\n html?: string | null;\n }\n interface MapData {\n /** Styling for the map's container. */\n containerData?: PluginContainerData;\n /** Map settings. */\n mapSettings?: MapSettings;\n }\n interface MapSettings {\n /** The address to display on the map. */\n address?: string | null;\n /** Sets whether the map is draggable. */\n draggable?: boolean | null;\n /** Sets whether the location marker is visible. */\n marker?: boolean | null;\n /** Sets whether street view control is enabled. */\n streetViewControl?: boolean | null;\n /** Sets whether zoom control is enabled. */\n zoomControl?: boolean | null;\n /** Location latitude. */\n lat?: number | null;\n /** Location longitude. */\n lng?: number | null;\n /** Location name. */\n locationName?: string | null;\n /** Sets whether view mode control is enabled. */\n viewModeControl?: boolean | null;\n /** Initial zoom value. */\n initialZoom?: number | null;\n /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */\n mapType?: MapType;\n }\n enum MapType {\n /** Roadmap map type */\n ROADMAP = \"ROADMAP\",\n /** Satellite map type */\n SATELITE = \"SATELITE\",\n /** Hybrid map type */\n HYBRID = \"HYBRID\",\n /** Terrain map type */\n TERRAIN = \"TERRAIN\"\n }\n interface ParagraphData {\n /** Styling for the paragraph text. */\n textStyle?: TextStyle;\n /** Indentation level from 1-6. */\n indentation?: number | null;\n }\n interface PollData {\n /** Styling for the poll's container. */\n containerData?: PluginContainerData;\n /** Poll data. */\n poll?: Poll;\n /** Layout settings for the poll and voting options. */\n layout?: PollDataLayout;\n /** Styling for the poll and voting options. */\n design?: Design;\n }\n enum ViewRole {\n /** Only Poll creator can view the results */\n CREATOR = \"CREATOR\",\n /** Anyone who voted can see the results */\n VOTERS = \"VOTERS\",\n /** Anyone can see the results, even if one didn't vote */\n EVERYONE = \"EVERYONE\"\n }\n enum VoteRole {\n /** Logged in member */\n SITE_MEMBERS = \"SITE_MEMBERS\",\n /** Anyone */\n ALL = \"ALL\"\n }\n interface Permissions {\n /** Sets who can view the poll results. */\n view?: ViewRole;\n /** Sets who can vote. */\n vote?: VoteRole;\n /** Sets whether one voter can vote multiple times. */\n allowMultipleVotes?: boolean | null;\n }\n interface Option {\n /** Option ID. */\n _id?: string | null;\n /** Option title. */\n title?: string | null;\n /** The image displayed with the option. */\n image?: Media;\n }\n interface Settings {\n /** Permissions settings for voting. */\n permissions?: Permissions;\n /** Sets whether voters are displayed in the vote results. */\n showVoters?: boolean | null;\n /** Sets whether the vote count is displayed. */\n showVotesCount?: boolean | null;\n }\n enum PollLayoutType {\n /** List */\n LIST = \"LIST\",\n /** Grid */\n GRID = \"GRID\"\n }\n enum PollLayoutDirection {\n /** Left-to-right */\n LTR = \"LTR\",\n /** Right-to-left */\n RTL = \"RTL\"\n }\n interface PollLayout {\n /** The layout for displaying the voting options. */\n type?: PollLayoutType;\n /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */\n direction?: PollLayoutDirection;\n /** Sets whether to display the main poll image. */\n enableImage?: boolean | null;\n }\n interface OptionLayout {\n /** Sets whether to display option images. */\n enableImage?: boolean | null;\n }\n enum BackgroundType {\n /** Color background type */\n COLOR = \"COLOR\",\n /** Image background type */\n IMAGE = \"IMAGE\",\n /** Gradiant background type */\n GRADIENT = \"GRADIENT\"\n }\n interface Gradient {\n /** The gradient angle in degrees. */\n angle?: number | null;\n /** The start color as a hexademical value. */\n startColor?: string | null;\n /** The end color as a hexademical value. */\n lastColor?: string | null;\n }\n interface Background extends BackgroundBackgroundOneOf {\n /** The background color as a hexademical value. */\n color?: string | null;\n /** An image to use for the background. */\n image?: Media;\n /** Details for a gradient background. */\n gradient?: Gradient;\n /** Background type. For each option, include the relevant details. */\n type?: BackgroundType;\n }\n /** @oneof */\n interface BackgroundBackgroundOneOf {\n /** The background color as a hexademical value. */\n color?: string | null;\n /** An image to use for the background. */\n image?: Media;\n /** Details for a gradient background. */\n gradient?: Gradient;\n }\n interface PollDesign {\n /** Background styling. */\n background?: Background;\n /** Border radius in pixels. */\n borderRadius?: number | null;\n }\n interface OptionDesign {\n /** Border radius in pixels. */\n borderRadius?: number | null;\n }\n interface Poll {\n /** Poll ID. */\n _id?: string | null;\n /** Poll title. */\n title?: string | null;\n /** Poll creator ID. */\n creatorId?: string | null;\n /** Main poll image. */\n image?: Media;\n /** Voting options. */\n options?: Option[];\n /** The poll's permissions and display settings. */\n settings?: Settings;\n }\n interface PollDataLayout {\n /** Poll layout settings. */\n poll?: PollLayout;\n /** Voting otpions layout settings. */\n options?: OptionLayout;\n }\n interface Design {\n /** Styling for the poll. */\n poll?: PollDesign;\n /** Styling for voting options. */\n options?: OptionDesign;\n }\n interface TextData {\n /** The text to apply decorations to. */\n text?: string;\n /** The decorations to apply. */\n decorations?: Decoration[];\n }\n /** Adds appearence changes to text */\n interface Decoration extends DecorationDataOneOf {\n /** Data for an anchor link decoration. */\n anchorData?: AnchorData;\n /** Data for a color decoration. */\n colorData?: ColorData;\n /** Data for an external link decoration. */\n linkData?: LinkData;\n /** Data for a mention decoration. */\n mentionData?: MentionData;\n /** Data for a font size decoration. */\n fontSizeData?: FontSizeData;\n /** Font weight for a bold decoration. */\n fontWeightValue?: number | null;\n /** Data for an italic decoration. */\n italicData?: boolean | null;\n /** Data for an underline decoration. */\n underlineData?: boolean | null;\n /** The type of decoration to apply. */\n type?: DecorationType;\n }\n /** @oneof */\n interface DecorationDataOneOf {\n /** Data for an anchor link decoration. */\n anchorData?: AnchorData;\n /** Data for a color decoration. */\n colorData?: ColorData;\n /** Data for an external link decoration. */\n linkData?: LinkData;\n /** Data for a mention decoration. */\n mentionData?: MentionData;\n /** Data for a font size decoration. */\n fontSizeData?: FontSizeData;\n /** Font weight for a bold decoration. */\n fontWeightValue?: number | null;\n /** Data for an italic decoration. */\n italicData?: boolean | null;\n /** Data for an underline decoration. */\n underlineData?: boolean | null;\n }\n enum DecorationType {\n BOLD = \"BOLD\",\n ITALIC = \"ITALIC\",\n UNDERLINE = \"UNDERLINE\",\n SPOILER = \"SPOILER\",\n ANCHOR = \"ANCHOR\",\n MENTION = \"MENTION\",\n LINK = \"LINK\",\n COLOR = \"COLOR\",\n FONT_SIZE = \"FONT_SIZE\",\n EXTERNAL = \"EXTERNAL\"\n }\n interface AnchorData {\n /** The target node's ID. */\n anchor?: string;\n }\n interface ColorData {\n /** The text's background color as a hexadecimal value. */\n background?: string | null;\n /** The text's foreground color as a hexadecimal value. */\n foreground?: string | null;\n }\n interface LinkData {\n /** Link details. */\n link?: Link;\n }\n interface MentionData {\n /** The mentioned user's name. */\n name?: string;\n /** The version of the user's name that appears after the `@` character in the mention. */\n slug?: string;\n /** Mentioned user's ID. */\n _id?: string | null;\n }\n interface FontSizeData {\n /** The units used for the font size. */\n unit?: FontType;\n /** Font size value. */\n value?: number | null;\n }\n enum FontType {\n PX = \"PX\",\n EM = \"EM\"\n }\n interface AppEmbedData extends AppEmbedDataAppDataOneOf {\n /** Data for embedded Wix Bookings content. */\n bookingData?: BookingData;\n /** Data for embedded Wix Events content. */\n eventData?: EventData;\n /** The type of Wix App content being embedded. */\n type?: AppType;\n /** The ID of the embedded content. */\n itemId?: string | null;\n /** The name of the embedded content. */\n name?: string | null;\n /** Deprecated: Use `image` instead. */\n imageSrc?: string | null;\n /** The URL for the embedded content. */\n url?: string | null;\n /** An image for the embedded content. */\n image?: Media;\n }\n /** @oneof */\n interface AppEmbedDataAppDataOneOf {\n /** Data for embedded Wix Bookings content. */\n bookingData?: BookingData;\n /** Data for embedded Wix Events content. */\n eventData?: EventData;\n }\n enum AppType {\n PRODUCT = \"PRODUCT\",\n EVENT = \"EVENT\",\n BOOKING = \"BOOKING\"\n }\n interface BookingData {\n /** Booking duration in minutes. */\n durations?: string | null;\n }\n interface EventData {\n /** Event schedule. */\n scheduling?: string | null;\n /** Event location. */\n location?: string | null;\n }\n interface VideoData {\n /** Styling for the video's container. */\n containerData?: PluginContainerData;\n /** Video details. */\n video?: Media;\n /** Video thumbnail details. */\n thumbnail?: Media;\n /** Sets whether the video's download button is disabled. */\n disableDownload?: boolean | null;\n /** Video title. */\n title?: string | null;\n /** Video options. */\n options?: PlaybackOptions;\n }\n interface PlaybackOptions {\n /** Sets whether the media will automatically start playing. */\n autoPlay?: boolean | null;\n /** Sets whether media's will be looped. */\n playInLoop?: boolean | null;\n /** Sets whether media's controls will be shown. */\n showControls?: boolean | null;\n }\n interface EmbedData {\n /** Styling for the oEmbed node's container. */\n containerData?: PluginContainerData;\n /** An [oEmbed](https://www.oembed.com) object. */\n oembed?: Oembed;\n /** Origin asset source. */\n src?: string | null;\n }\n interface Oembed {\n /** The resource type. */\n type?: string | null;\n /** The width of the resource specified in the `url` property in pixels. */\n width?: number | null;\n /** The height of the resource specified in the `url` property in pixels. */\n height?: number | null;\n /** Resource title. */\n title?: string | null;\n /** The source URL for the resource. */\n url?: string | null;\n /** HTML for embedding a video player. The HTML should have no padding or margins. */\n html?: string | null;\n /** The name of the author or owner of the resource. */\n authorName?: string | null;\n /** The URL for the author or owner of the resource. */\n authorUrl?: string | null;\n /** The name of the resource provider. */\n providerName?: string | null;\n /** The URL for the resource provider. */\n providerUrl?: string | null;\n /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */\n thumbnailUrl?: string | null;\n /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */\n thumbnailWidth?: string | null;\n /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */\n thumbnailHeight?: string | null;\n /** The URL for an embedded viedo. */\n videoUrl?: string | null;\n /** The oEmbed version number. This value must be `1.0`. */\n version?: string | null;\n }\n interface CollapsibleListData {\n /** Styling for the collapsible list's container. */\n containerData?: PluginContainerData;\n /** If `true`, only one item can be expanded at a time. */\n expandOnlyOne?: boolean | null;\n /** Sets which items are expanded when the page loads. */\n initialExpandedItems?: InitialExpandedItems;\n /** The direction of the text in the list. Either left-to-right or right-to-left. */\n direction?: Direction;\n /** If `true`, The collapsible item will appear in search results as an FAQ. */\n isQapageData?: boolean | null;\n }\n enum InitialExpandedItems {\n /** First item will be expended initally */\n FIRST = \"FIRST\",\n /** All items will expended initally */\n ALL = \"ALL\",\n /** All items collapsed initally */\n NONE = \"NONE\"\n }\n enum Direction {\n /** Left-to-right */\n LTR = \"LTR\",\n /** Right-to-left */\n RTL = \"RTL\"\n }\n interface TableData {\n /** Styling for the table's container. */\n containerData?: PluginContainerData;\n /** The table's dimensions. */\n dimensions?: Dimensions;\n /** Deprecated: Use `rowHeader` and `columnHeader` instead. */\n header?: boolean | null;\n /** Sets whether the table's first row is a header. */\n rowHeader?: boolean | null;\n /** Sets whether the table's first column is a header. */\n columnHeader?: boolean | null;\n }\n interface Dimensions {\n /** An array representing relative width of each column in relation to the other columns. */\n colsWidthRatio?: number[];\n /** An array representing the height of each row in pixels. */\n rowsHeight?: number[];\n /** An array representing the minimum width of each column in pixels. */\n colsMinWidth?: number[];\n }\n interface TableCellData {\n /** Styling for the cell's background color and text alignment. */\n cellStyle?: CellStyle;\n /** The cell's border colors. */\n borderColors?: BorderColors;\n }\n enum VerticalAlignment {\n /** Top alignment */\n TOP = \"TOP\",\n /** Middle alignment */\n MIDDLE = \"MIDDLE\",\n /** Bottom alignment */\n BOTTOM = \"BOTTOM\"\n }\n interface CellStyle {\n /** Vertical alignment for the cell's text. */\n verticalAlignment?: VerticalAlignment;\n /** Cell background color as a hexadecimal value. */\n backgroundColor?: string | null;\n }\n interface BorderColors {\n /** Left border color as a hexadecimal value. */\n left?: string | null;\n /** Right border color as a hexadecimal value. */\n right?: string | null;\n /** Top border color as a hexadecimal value. */\n top?: string | null;\n /** Bottom border color as a hexadecimal value. */\n bottom?: string | null;\n }\n /**\n * `NullValue` is a singleton enumeration to represent the null value for the\n * `Value` type union.\n *\n * The JSON representation for `NullValue` is JSON `null`.\n */\n enum NullValue {\n /** Null value. */\n NULL_VALUE = \"NULL_VALUE\"\n }\n /**\n * `ListValue` is a wrapper around a repeated field of values.\n *\n * The JSON representation for `ListValue` is JSON array.\n */\n interface ListValue {\n /** Repeated field of dynamically typed values. */\n values?: any[];\n }\n interface AudioData {\n /** Styling for the audio node's container. */\n containerData?: PluginContainerData;\n /** Audio file details. */\n audio?: Media;\n /** Sets whether the audio node's download button is disabled. */\n disableDownload?: boolean | null;\n /** Cover image. */\n coverImage?: Media;\n /** Track name. */\n name?: string | null;\n /** Author name. */\n authorName?: string | null;\n /** An HTML version of the audio node. */\n html?: string | null;\n }\n interface OrderedListData {\n /** Indentation level. */\n indentation?: number;\n }\n interface BulletedListData {\n /** Indentation level. */\n indentation?: number;\n }\n interface BlockquoteData {\n /** Indentation level. */\n indentation?: number;\n }\n interface Metadata {\n /** Schema version. */\n version?: number;\n /**\n * When the object was created.\n * @readonly\n */\n createdTimestamp?: Date;\n /** When the object was most recently updated. */\n updatedTimestamp?: Date;\n /** Object ID. */\n _id?: string | null;\n }\n interface DocumentStyle {\n /** Styling for H1 nodes. */\n headerOne?: TextNodeStyle;\n /** Styling for H2 nodes. */\n headerTwo?: TextNodeStyle;\n /** Styling for H3 nodes. */\n headerThree?: TextNodeStyle;\n /** Styling for H4 nodes. */\n headerFour?: TextNodeStyle;\n /** Styling for H5 nodes. */\n headerFive?: TextNodeStyle;\n /** Styling for H6 nodes. */\n headerSix?: TextNodeStyle;\n /** Styling for paragraph nodes. */\n paragraph?: TextNodeStyle;\n /** Styling for block quote nodes. */\n blockquote?: TextNodeStyle;\n /** Styling for code block nodes. */\n codeBlock?: TextNodeStyle;\n }\n interface TextNodeStyle {\n /** The decorations to apply to the node. */\n decorations?: Decoration[];\n /** Padding and background color for the node. */\n nodeStyle?: NodeStyle;\n /** Line height for text in the node. */\n lineHeight?: string | null;\n }\n interface Mention extends MentionIdentityOneOf {\n /** Wix user ID. */\n userId?: string | null;\n /** Member ID. See the Members API for more details. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Group ID. See the Groups API for more details. */\n groupId?: string | null;\n }\n /** @oneof */\n interface MentionIdentityOneOf {\n /** Wix user ID. */\n userId?: string | null;\n /** Member ID. See the Members API for more details. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Group ID. See the Groups API for more details. */\n groupId?: string | null;\n }\n interface Attachment extends AttachmentMediaOneOf {\n /** Information about the image. */\n image?: string;\n /** Information about the video. */\n video?: string;\n /** Information about the audio. */\n audio?: string;\n /** Information about the document. */\n document?: string;\n /** Mime type of attachment. */\n mimeType?: string | null;\n }\n /** @oneof */\n interface AttachmentMediaOneOf {\n /** Information about the image. */\n image?: string;\n /** Information about the video. */\n video?: string;\n /** Information about the audio. */\n audio?: string;\n /** Information about the document. */\n document?: string;\n }\n interface VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Video quality. For example: 480p, 720p.\n * @readonly\n */\n quality?: string | null;\n /**\n * Video filename.\n * @readonly\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @readonly\n */\n durationInSeconds?: number | null;\n /**\n * When true, this is a protected asset, and calling the URL will return a 403 error.\n * In order to access private assets, make a request to:\n * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request\n * @readonly\n */\n private?: boolean | null;\n /**\n * Key to identify the video resolution's relationship to the original media in WixMedia.\n * Can be used to request a download for the specific video resolution.\n * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4\n * @readonly\n */\n assetKey?: string | null;\n }\n interface ContentAuthor extends ContentAuthorAuthorOneOf {\n /** Wix user ID. */\n userId?: string | null;\n /**\n * Member ID. See the [Members API](https://dev.wix.com/api/rest/members/members/member-object)\n * for more details.\n */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Application Id */\n appId?: string | null;\n }\n /** @oneof */\n interface ContentAuthorAuthorOneOf {\n /** Wix user ID. */\n userId?: string | null;\n /**\n * Member ID. See the [Members API](https://dev.wix.com/api/rest/members/members/member-object)\n * for more details.\n */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Application Id */\n appId?: string | null;\n }\n interface CommentAuthor extends CommentAuthorIdentityOneOf {\n /** Wix user ID. */\n userId?: string | null;\n /** Member ID. See the Members API for more details. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n }\n /** @oneof */\n interface CommentAuthorIdentityOneOf {\n /** Wix user ID. */\n userId?: string | null;\n /** Member ID. See the Members API for more details. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n }\n interface ParentComment {\n /** Comment ID of the parent comment. */\n _id?: string | null;\n /**\n * Author of the parent comment.\n * @readonly\n */\n author?: CommentAuthor;\n }\n interface VoteSummary {\n /** Amount of upvotes less downvotes on this comment. */\n netVoteCount?: number;\n /** Amount of upvotes on this comment. */\n upvoteCount?: number;\n /** Amount of downvotes on this comment. */\n downvoteCount?: number;\n }\n enum Status {\n UNKNOWN = \"UNKNOWN\",\n PUBLISHED = \"PUBLISHED\",\n DELETED = \"DELETED\",\n PENDING = \"PENDING\",\n HIDDEN = \"HIDDEN\"\n }\n interface CommentReactionSummary {\n /** Total amount of reactions. */\n total?: number;\n /**\n * Amounts of each type of reaction. `\"key\"` is the code for a reaction type and\n * `\"value\"` is the amount of that reaction type.\n */\n reactionCodeCount?: Record;\n }\n interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: InternalDocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update internal documents matching filter */\n updateByFilter?: InternalDocumentUpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: InternalUpdateExistingOperation;\n /** insert/update documents with versioning */\n versionedUpdate?: VersionedDocumentUpdateOperation;\n /** delete by document ids with versioning */\n versionedDeleteByIds?: VersionedDeleteByIdsOperation;\n /** type of the documents */\n documentType?: string;\n /** language of the documents (mandatory) */\n language?: string | null;\n /** one or more search documents */\n addDocuments?: InternalDocument[];\n /** one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided) */\n removeDocumentIds?: string[];\n /** id to pass to processing notification */\n correlationId?: string | null;\n }\n /** @oneof */\n interface UpdateInternalDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: InternalDocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update internal documents matching filter */\n updateByFilter?: InternalDocumentUpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: InternalUpdateExistingOperation;\n /** insert/update documents with versioning */\n versionedUpdate?: VersionedDocumentUpdateOperation;\n /** delete by document ids with versioning */\n versionedDeleteByIds?: VersionedDeleteByIdsOperation;\n }\n interface InternalDocument {\n /** document with mandatory fields (id) and with fields specific to the type of the document */\n document?: Record | null;\n }\n interface InternalDocumentUpdateOperation {\n /** documents to index or update */\n documents?: InternalDocument[];\n }\n interface DeleteByIdsOperation {\n /** ids of the documents to delete */\n documentIds?: string[];\n }\n interface DeleteByFilterOperation {\n /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */\n filter?: Record | null;\n }\n interface InternalDocumentUpdateByFilterOperation {\n /** documents matching this filter will be updated */\n filter?: Record | null;\n /** partial document to apply */\n document?: InternalDocument;\n }\n interface InternalUpdateExistingOperation {\n /** documents to update */\n documents?: InternalDocument[];\n }\n interface VersionedDocumentUpdateOperation {\n /** documents to create or overwrite */\n documents?: InternalDocument[];\n /** versioning mode to use instead of default */\n versioningMode?: VersioningMode;\n }\n enum VersioningMode {\n /** use default versioning mode agreed with search team */\n DEFAULT = \"DEFAULT\",\n /** execute only if version is greater than existing */\n GREATER_THAN = \"GREATER_THAN\",\n /** execute only if version is greater or equal to existing */\n GREATER_OR_EQUAL = \"GREATER_OR_EQUAL\"\n }\n interface VersionedDeleteByIdsOperation {\n /** ids with version of the documents to delete */\n documentIds?: VersionedDocumentId[];\n }\n interface VersionedDocumentId {\n /** document id */\n documentId?: string;\n /** document version */\n version?: string;\n /** versioning mode to use instead of default */\n versioningMode?: VersioningMode;\n }\n interface CreateCommentRequest {\n /** Comment to create. */\n comment?: Comment;\n }\n interface ContactDetails {\n }\n interface CreateCommentResponse {\n /** Created comment. */\n comment?: Comment;\n }\n interface ResourceCommentCountChanged {\n appId?: string;\n contextId?: string;\n resourceId?: string;\n publishedCommentCount?: number;\n }\n interface GetCommentRequest {\n /** ID of the comment to retrieve. */\n commentId: string;\n }\n interface GetCommentResponse {\n /** Retrieved comment. */\n comment?: Comment;\n }\n /** Comment info to update. */\n interface UpdateCommentRequest {\n /** Comment info to update. */\n comment?: Comment;\n }\n interface UpdateCommentResponse {\n /** Updated comment. */\n comment?: Comment;\n }\n interface CommentContentChanged {\n commentId?: string;\n previousContent?: CommentContent;\n currentContent?: CommentContent;\n }\n interface DeleteCommentRequest {\n /** ID of the Comment to delete. */\n commentId: string;\n }\n interface DeleteCommentResponse {\n }\n interface CommentDeleted {\n comment?: Comment;\n }\n interface ModerateDraftContentRequest {\n /** ID of the comment to moderate. */\n commentId: string;\n /**\n * Revision number, which increments by `1` each time the comment is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the comment.\n */\n revision: string | null;\n /** Draft content action. */\n draftContentAction?: Action;\n }\n enum Action {\n UNKNOWN = \"UNKNOWN\",\n /** Approve draft content. */\n APPROVE = \"APPROVE\",\n /** Reject draft content. */\n REJECT = \"REJECT\"\n }\n interface ModerateDraftContentResponse {\n /** Moderated comment. */\n comment?: Comment;\n }\n interface CommentPublished {\n comment?: Comment;\n firstPublish?: boolean;\n }\n interface CommentHidden {\n comment?: Comment;\n }\n interface QueryCommentsRequest {\n /** App ID to query comments for. */\n appId: string;\n /** Query options. */\n query: CursorQuery;\n }\n interface CursorQuery extends CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryCommentsResponse {\n /** Retrieved comments. */\n comments?: Comment[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata;\n }\n interface CursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface MarkCommentRequest {\n /** ID of the comment to mark. */\n commentId: string;\n }\n interface MarkCommentResponse {\n /** Marked comment. */\n comment?: Comment;\n }\n interface CommentMarked {\n comment?: Comment;\n }\n interface UnmarkCommentRequest {\n /** ID of the comment to unmark. */\n commentId: string;\n }\n interface UnmarkCommentResponse {\n /** Unmarked comment. */\n comment?: Comment;\n }\n interface CommentUnmarked {\n comment?: Comment;\n }\n interface HideCommentRequest {\n /** ID of the comment to hide. */\n commentId: string;\n }\n interface HideCommentResponse {\n /** Hidden comment. */\n comment?: Comment;\n }\n interface PublishCommentRequest {\n /** ID of the comment to publish. */\n commentId: string;\n }\n interface PublishCommentResponse {\n /** Published comment. */\n comment?: Comment;\n }\n /** Count comments options. */\n interface CountCommentsRequest {\n /** App ID to count the comments of. */\n appId?: string;\n /** Filter options. */\n filter?: Record | null;\n }\n interface CountCommentsResponse {\n /** Amount of comments. */\n count?: number;\n }\n interface ListCommentsByResourceRequest {\n /** App ID. */\n appId: string;\n /** Context ID. */\n contextId: string;\n /** Reserved for internal use. */\n contextType?: string;\n /** Resource ID. */\n resourceId: string;\n /** Comment sorting. Is ignored if cursorPaging.cursor is defined. */\n commentSort?: CommentSort;\n /** Reply sorting. Is ignored if cursorPaging.cursor is defined. */\n replySort?: ReplySort;\n /** Cursor paging. */\n cursorPaging?: ListCommentsByResourceCursorPaging;\n }\n interface CommentSort {\n /** Sorting. */\n order?: Order;\n /**\n * If set to `true`, marked comments are included in the comments list but maintain their original order rather\n * than being moved to the top.\n * Defaults to `false`, which means marked comments, will be prioritized and listed first.\n */\n keepMarkedInOriginalOrder?: boolean;\n }\n enum Order {\n UNKNOWN_ORDER = \"UNKNOWN_ORDER\",\n OLDEST_FIRST = \"OLDEST_FIRST\",\n NEWEST_FIRST = \"NEWEST_FIRST\",\n REACTION_COUNT = \"REACTION_COUNT\",\n NET_VOTE_COUNT = \"NET_VOTE_COUNT\",\n RATING = \"RATING\",\n NET_VOTE_COUNT_ASC = \"NET_VOTE_COUNT_ASC\",\n RATING_ASC = \"RATING_ASC\"\n }\n interface ReplySort {\n /** Sorting */\n order?: ReplySortOrder;\n /**\n * If set to `true`, marked replies are included in the comments list but maintain their original order rather\n * than being moved to the top.\n * Defaults to `false`, which means marked replies, will be prioritized and listed first.\n */\n keepMarkedInOriginalOrder?: boolean;\n }\n enum ReplySortOrder {\n UNKNOWN_ORDER = \"UNKNOWN_ORDER\",\n OLDEST_FIRST = \"OLDEST_FIRST\",\n NEWEST_FIRST = \"NEWEST_FIRST\",\n REACTION_COUNT = \"REACTION_COUNT\"\n }\n interface ListCommentsByResourceCursorPaging {\n /** Pointer to the next or previous page in the list of results. */\n cursor?: string | null;\n /**\n * Number of items to return.\n *\n * Min: `1`\\n\n * Max: `100`\n */\n limit?: number | null;\n /** Only taken into account if listing root comments. */\n repliesLimit?: number | null;\n }\n interface ListCommentsByResourceResponse {\n comments?: Comment[];\n pagingMetadata?: CursorPagingMetadata;\n commentReplies?: Record;\n }\n interface RepliesListResponse {\n replies?: Comment[];\n pagingMetadata?: CursorPagingMetadata;\n }\n interface GetCommentThreadRequest {\n /** App ID. */\n appId?: string;\n /** Comment ID. */\n commentId: string;\n /** Comment sorting. */\n commentSort?: CommentSort;\n /** Reply sorting. */\n replySort?: ReplySort;\n }\n interface GetCommentThreadResponse {\n comments?: Comment[];\n pagingMetadata?: CursorPagingMetadata;\n commentReplies?: Record;\n }\n interface BulkPublishCommentRequest {\n /** Owning vertical identifier */\n appId: string;\n /** Comments to publish */\n filter: Record | null;\n }\n interface BulkPublishCommentResponse {\n /** Reference to async job */\n jobId?: string;\n }\n interface BulkHideCommentRequest {\n /** Owning vertical identifier */\n appId: string;\n /** Comments to hide */\n filter: Record | null;\n }\n interface BulkHideCommentResponse {\n /** Reference to async job */\n jobId?: string;\n }\n interface BulkDeleteCommentRequest {\n /** Owning vertical identifier */\n appId: string;\n /** Comments to delete */\n filter: Record | null;\n }\n interface BulkDeleteCommentResponse {\n /** Reference to async job */\n jobId?: string;\n }\n interface BulkModerateDraftContentRequest {\n /** Owning vertical identifier */\n appId: string;\n /** Comments to moderate */\n filter: Record | null;\n /** Action to do regarding draft content */\n draftContentAction: Action;\n }\n interface BulkModerateDraftContentResponse {\n /** Reference to async job */\n jobId?: string;\n }\n /**\n * Creates a new comment.\n *\n * The `appId`, `contextId`, and `resourceId` are all required and associate the created comment with the specific\n * resource it responds to. See [Integrations](#introduction) for a list of integrated scopes for these fields.\n *\n * If the created comment is a direct response to another comment, the `commentId` of the parent comment should be passed\n * as `parentComment.id` in this comment's request. See [Terminology](#introduction) for additional information on parent comments and replies.\n *\n * This function is not a universal function and runs only on the backend.\n * @param comment - Comment to create.\n * @public\n * @documentationMaturity preview\n * @requiredField comment\n * @requiredField comment.appId\n * @requiredField comment.content\n * @requiredField comment.contextId\n * @requiredField comment.resourceId\n * @adminMethod\n * @returns Created comment.\n */\n function createComment(comment: Comment, options?: CreateCommentOptions): Promise;\n interface CreateCommentOptions {\n }\n /**\n * Retrieves a comment.\n *\n * This function is not a universal function and runs only on the backend.\n * @param commentId - ID of the comment to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField commentId\n * @adminMethod\n * @returns Retrieved comment.\n */\n function getComment(commentId: string): Promise;\n /**\n * Updates a comment.\n *\n * Each time the comment is updated, `revision` increments by 1. The current `revision` must be\n * passed when updating the comment. This ensures you're working with the latest comment and\n * prevents unintended overwrites.\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - Comment ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField comment\n * @requiredField comment.revision\n * @adminMethod\n * @returns Updated comment.\n */\n function updateComment(_id: string | null, comment: UpdateComment): Promise;\n interface UpdateComment {\n /**\n * Comment ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the comment is updated.\n *\n * To prevent conflicting changes, the current `revision` must be passed when updating the comment.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the comment was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the comment was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** ID of the app that the comment is added to. */\n appId?: string | null;\n /**\n * ID of the specific context the comment is in response to.\n *\n * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,\n * the `forumPostId` is used as both the `contextId` and the `resourceId`.\n */\n contextId?: string | null;\n /** Reserved for internal use. */\n contextType?: string | null;\n /**\n * ID of the specific resource that the comment is in response to.\n *\n * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,\n * the `forumPostId` is used as both the `resourceId` and the `contextId`.\n */\n resourceId?: string | null;\n /** Published comment content. */\n content?: CommentContent;\n /** Comment's author. */\n author?: CommentAuthor;\n /**\n * Parent comment information.\n *\n * See [Terminology](#introduction) for more information about parent comments.\n */\n parentComment?: ParentComment;\n /**\n * Amount of comments that reply to this comment.\n * @readonly\n */\n replyCount?: number;\n /**\n * Summary of votes.\n * @readonly\n */\n voteSummary?: VoteSummary;\n /**\n * Comment status.\n *\n * Supported values:\n * + `\"PUBLISHED\"`: This comment is published and publicly visible.\n * + `\"DELETED\"`: This comment is deleted.\n * + `\"PENDING\"`: This comment is pending moderation. Moderation is not currently supported.\n * + `\"HIDDEN\"`: This comment has been hidden by a site moderator.\n * @readonly\n */\n status?: Status;\n /**\n * Comment rating.\n * @readonly\n */\n rating?: number | null;\n /**\n * Summary of reactions.\n * @readonly\n */\n reactionSummary?: CommentReactionSummary;\n /** Whether the comment is marked. */\n marked?: boolean;\n }\n /**\n * Deletes a comment.\n *\n * This endpoint deletes the `content` of the comment and sets its `status` to `DELETED`.\n *\n * This function is not a universal function and runs only on the backend.\n * @param commentId - ID of the Comment to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField commentId\n * @adminMethod\n */\n function deleteComment(commentId: string, options?: DeleteCommentOptions): Promise;\n interface DeleteCommentOptions {\n }\n interface ModerateDraftContentOptions {\n /** Draft content action. */\n draftContentAction?: Action;\n }\n /**\n * Creates a query to retrieve a list of comments.\n *\n * The `queryComments()` function builds a query to retrieve a list of comments and returns a [`CommentsQueryBuilder`](#commentsquerybuilder) object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](#commentsquerybuilder/find) function.\n *\n * You can refine the query by chaining `CommentsQueryBuilder` functions onto the query. `CommentsQueryBuilder` functions enable you to sort, filter, and control the results that `queryComments()` returns.\n *\n * `queryComments()` runs with the following `CommentsQueryBuilder` default that you can override:\n * + `ascending(\"_id\")`\n *\n * The functions that are chained to `queryComments()` are applied in the order they are called. For example, if you apply `ascending(\"voteSummary.netVoteCount\")` and then `ascending(\"replyCount\")`, the results are sorted first by the `\"voteSummary.netVoteCount\"`, and then, if there are multiple results with the same `\"voteSummary.netVoteCount\"`, the items are sorted by `\"replyCount\"`.\n *\n * The following `CommentsQueryBuilder` functions are supported for the `queryComments()` function. For a full description of the comment object, see the object returned for the [`items`](#commentsqueryresult/items) property in [`CommentsQueryResult`](#commentsqueryresult).\n *\n * This function is not a universal function and runs only on the backend.\n * @public\n * @documentationMaturity preview\n * @requiredField appId\n * @param appId - App ID to query comments for.\n * @adminMethod\n */\n function queryComments(appId: string): CommentsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CommentsQueryResult extends QueryCursorResult {\n items: Comment[];\n query: CommentsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CommentsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"contextId\" | \"resourceId\" | \"author.userId\" | \"author.memberId\" | \"author.visitorId\" | \"parentComment.id\" | \"replyCount\" | \"voteSummary.netVoteCount\" | \"status\" | \"rating\" | \"reactionSummary.total\" | \"marked\", value: any) => CommentsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"contextId\" | \"resourceId\" | \"author.userId\" | \"author.memberId\" | \"author.visitorId\" | \"parentComment.id\" | \"replyCount\" | \"voteSummary.netVoteCount\" | \"status\" | \"rating\" | \"reactionSummary.total\" | \"marked\", value: any) => CommentsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"replyCount\" | \"voteSummary.netVoteCount\" | \"rating\" | \"reactionSummary.total\", value: any) => CommentsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"replyCount\" | \"voteSummary.netVoteCount\" | \"rating\" | \"reactionSummary.total\", value: any) => CommentsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"replyCount\" | \"voteSummary.netVoteCount\" | \"rating\" | \"reactionSummary.total\", value: any) => CommentsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"replyCount\" | \"voteSummary.netVoteCount\" | \"rating\" | \"reactionSummary.total\", value: any) => CommentsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"contextId\" | \"resourceId\" | \"author.userId\" | \"author.memberId\" | \"author.visitorId\" | \"parentComment.id\" | \"status\", value: any) => CommentsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"replyCount\" | \"voteSummary.netVoteCount\" | \"rating\" | \"reactionSummary.total\" | \"marked\">) => CommentsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"replyCount\" | \"voteSummary.netVoteCount\" | \"rating\" | \"reactionSummary.total\" | \"marked\">) => CommentsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => CommentsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => CommentsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Sets `marked` to `\"TRUE\"` to mark a comment.\n *\n * You can then filter for marked comments with the [`queryComments()`](#querycomments) function to apply customizations.\n *\n * This function is not a universal function and runs only on the backend.\n * @param commentId - ID of the comment to mark.\n * @public\n * @documentationMaturity preview\n * @requiredField commentId\n * @adminMethod\n */\n function markComment(commentId: string, options?: MarkCommentOptions): Promise;\n interface MarkCommentOptions {\n }\n /**\n * Sets `marked` to `\"FALSE\"` to unmark a comment.\n *\n * This function is not a universal function and runs only on the backend.\n * @param commentId - ID of the comment to unmark.\n * @public\n * @documentationMaturity preview\n * @requiredField commentId\n * @adminMethod\n */\n function unmarkComment(commentId: string, options?: UnmarkCommentOptions): Promise;\n interface UnmarkCommentOptions {\n }\n /**\n * Counts comments, given the provided filtering.\n *\n * For field support for filters and sorting, see the **Supported Filters & Sorting** table in the [`queryComments()`](/querycomments) function.\n *\n * This function is not a universal function and runs only on the backend.\n * @param appId - App ID to count the comments of.\n * @public\n * @documentationMaturity preview\n * @requiredField appId\n * @adminMethod\n */\n function countComments(appId: string, options?: CountCommentsOptions): Promise;\n interface CountCommentsOptions {\n /** Filter options. */\n filter?: Record | null;\n }\n interface ListCommentsByResourceOptions {\n /** Context ID. */\n contextId: string;\n /** Reserved for internal use. */\n contextType?: string;\n /** Resource ID. */\n resourceId: string;\n /** Comment sorting. Is ignored if cursorPaging.cursor is defined. */\n commentSort?: CommentSort;\n /** Reply sorting. Is ignored if cursorPaging.cursor is defined. */\n replySort?: ReplySort;\n /** Cursor paging. */\n cursorPaging?: ListCommentsByResourceCursorPaging;\n }\n interface GetCommentThreadOptions {\n /** App ID. */\n appId?: string;\n /** Comment sorting. */\n commentSort?: CommentSort;\n /** Reply sorting. */\n replySort?: ReplySort;\n }\n interface BulkPublishCommentOptions {\n /** Comments to publish */\n filter: Record | null;\n }\n interface BulkHideCommentOptions {\n /** Comments to hide */\n filter: Record | null;\n }\n interface BulkDeleteCommentOptions {\n /** Comments to delete */\n filter: Record | null;\n }\n interface BulkModerateDraftContentOptions {\n /** Comments to moderate */\n filter: Record | null;\n /** Action to do regarding draft content */\n draftContentAction: Action;\n }\n const commentsV2Comment_universal_d___debug: typeof __debug;\n type commentsV2Comment_universal_d_Comment = Comment;\n type commentsV2Comment_universal_d_CommentContent = CommentContent;\n type commentsV2Comment_universal_d_RichContent = RichContent;\n type commentsV2Comment_universal_d_Node = Node;\n type commentsV2Comment_universal_d_NodeDataOneOf = NodeDataOneOf;\n type commentsV2Comment_universal_d_NodeType = NodeType;\n const commentsV2Comment_universal_d_NodeType: typeof NodeType;\n type commentsV2Comment_universal_d_NodeStyle = NodeStyle;\n type commentsV2Comment_universal_d_ButtonData = ButtonData;\n type commentsV2Comment_universal_d_Border = Border;\n type commentsV2Comment_universal_d_Colors = Colors;\n type commentsV2Comment_universal_d_PluginContainerData = PluginContainerData;\n type commentsV2Comment_universal_d_WidthType = WidthType;\n const commentsV2Comment_universal_d_WidthType: typeof WidthType;\n type commentsV2Comment_universal_d_PluginContainerDataWidth = PluginContainerDataWidth;\n type commentsV2Comment_universal_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;\n type commentsV2Comment_universal_d_PluginContainerDataAlignment = PluginContainerDataAlignment;\n const commentsV2Comment_universal_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;\n type commentsV2Comment_universal_d_Spoiler = Spoiler;\n type commentsV2Comment_universal_d_Height = Height;\n type commentsV2Comment_universal_d_Type = Type;\n const commentsV2Comment_universal_d_Type: typeof Type;\n type commentsV2Comment_universal_d_Styles = Styles;\n type commentsV2Comment_universal_d_Link = Link;\n type commentsV2Comment_universal_d_LinkDataOneOf = LinkDataOneOf;\n type commentsV2Comment_universal_d_Target = Target;\n const commentsV2Comment_universal_d_Target: typeof Target;\n type commentsV2Comment_universal_d_Rel = Rel;\n type commentsV2Comment_universal_d_CodeBlockData = CodeBlockData;\n type commentsV2Comment_universal_d_TextStyle = TextStyle;\n type commentsV2Comment_universal_d_TextAlignment = TextAlignment;\n const commentsV2Comment_universal_d_TextAlignment: typeof TextAlignment;\n type commentsV2Comment_universal_d_DividerData = DividerData;\n type commentsV2Comment_universal_d_LineStyle = LineStyle;\n const commentsV2Comment_universal_d_LineStyle: typeof LineStyle;\n type commentsV2Comment_universal_d_Width = Width;\n const commentsV2Comment_universal_d_Width: typeof Width;\n type commentsV2Comment_universal_d_Alignment = Alignment;\n const commentsV2Comment_universal_d_Alignment: typeof Alignment;\n type commentsV2Comment_universal_d_FileData = FileData;\n type commentsV2Comment_universal_d_ViewMode = ViewMode;\n const commentsV2Comment_universal_d_ViewMode: typeof ViewMode;\n type commentsV2Comment_universal_d_FileSource = FileSource;\n type commentsV2Comment_universal_d_FileSourceDataOneOf = FileSourceDataOneOf;\n type commentsV2Comment_universal_d_PDFSettings = PDFSettings;\n type commentsV2Comment_universal_d_GalleryData = GalleryData;\n type commentsV2Comment_universal_d_Media = Media;\n type commentsV2Comment_universal_d_Image = Image;\n type commentsV2Comment_universal_d_Video = Video;\n type commentsV2Comment_universal_d_Item = Item;\n type commentsV2Comment_universal_d_ItemDataOneOf = ItemDataOneOf;\n type commentsV2Comment_universal_d_GalleryOptions = GalleryOptions;\n type commentsV2Comment_universal_d_LayoutType = LayoutType;\n const commentsV2Comment_universal_d_LayoutType: typeof LayoutType;\n type commentsV2Comment_universal_d_Orientation = Orientation;\n const commentsV2Comment_universal_d_Orientation: typeof Orientation;\n type commentsV2Comment_universal_d_Crop = Crop;\n const commentsV2Comment_universal_d_Crop: typeof Crop;\n type commentsV2Comment_universal_d_ThumbnailsAlignment = ThumbnailsAlignment;\n const commentsV2Comment_universal_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;\n type commentsV2Comment_universal_d_Layout = Layout;\n type commentsV2Comment_universal_d_ItemStyle = ItemStyle;\n type commentsV2Comment_universal_d_Thumbnails = Thumbnails;\n type commentsV2Comment_universal_d_GIFData = GIFData;\n type commentsV2Comment_universal_d_GIF = GIF;\n type commentsV2Comment_universal_d_HeadingData = HeadingData;\n type commentsV2Comment_universal_d_HTMLData = HTMLData;\n type commentsV2Comment_universal_d_HTMLDataDataOneOf = HTMLDataDataOneOf;\n type commentsV2Comment_universal_d_Source = Source;\n const commentsV2Comment_universal_d_Source: typeof Source;\n type commentsV2Comment_universal_d_ImageData = ImageData;\n type commentsV2Comment_universal_d_LinkPreviewData = LinkPreviewData;\n type commentsV2Comment_universal_d_MapData = MapData;\n type commentsV2Comment_universal_d_MapSettings = MapSettings;\n type commentsV2Comment_universal_d_MapType = MapType;\n const commentsV2Comment_universal_d_MapType: typeof MapType;\n type commentsV2Comment_universal_d_ParagraphData = ParagraphData;\n type commentsV2Comment_universal_d_PollData = PollData;\n type commentsV2Comment_universal_d_ViewRole = ViewRole;\n const commentsV2Comment_universal_d_ViewRole: typeof ViewRole;\n type commentsV2Comment_universal_d_VoteRole = VoteRole;\n const commentsV2Comment_universal_d_VoteRole: typeof VoteRole;\n type commentsV2Comment_universal_d_Permissions = Permissions;\n type commentsV2Comment_universal_d_Option = Option;\n type commentsV2Comment_universal_d_Settings = Settings;\n type commentsV2Comment_universal_d_PollLayoutType = PollLayoutType;\n const commentsV2Comment_universal_d_PollLayoutType: typeof PollLayoutType;\n type commentsV2Comment_universal_d_PollLayoutDirection = PollLayoutDirection;\n const commentsV2Comment_universal_d_PollLayoutDirection: typeof PollLayoutDirection;\n type commentsV2Comment_universal_d_PollLayout = PollLayout;\n type commentsV2Comment_universal_d_OptionLayout = OptionLayout;\n type commentsV2Comment_universal_d_BackgroundType = BackgroundType;\n const commentsV2Comment_universal_d_BackgroundType: typeof BackgroundType;\n type commentsV2Comment_universal_d_Gradient = Gradient;\n type commentsV2Comment_universal_d_Background = Background;\n type commentsV2Comment_universal_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;\n type commentsV2Comment_universal_d_PollDesign = PollDesign;\n type commentsV2Comment_universal_d_OptionDesign = OptionDesign;\n type commentsV2Comment_universal_d_Poll = Poll;\n type commentsV2Comment_universal_d_PollDataLayout = PollDataLayout;\n type commentsV2Comment_universal_d_Design = Design;\n type commentsV2Comment_universal_d_TextData = TextData;\n type commentsV2Comment_universal_d_Decoration = Decoration;\n type commentsV2Comment_universal_d_DecorationDataOneOf = DecorationDataOneOf;\n type commentsV2Comment_universal_d_DecorationType = DecorationType;\n const commentsV2Comment_universal_d_DecorationType: typeof DecorationType;\n type commentsV2Comment_universal_d_AnchorData = AnchorData;\n type commentsV2Comment_universal_d_ColorData = ColorData;\n type commentsV2Comment_universal_d_LinkData = LinkData;\n type commentsV2Comment_universal_d_MentionData = MentionData;\n type commentsV2Comment_universal_d_FontSizeData = FontSizeData;\n type commentsV2Comment_universal_d_FontType = FontType;\n const commentsV2Comment_universal_d_FontType: typeof FontType;\n type commentsV2Comment_universal_d_AppEmbedData = AppEmbedData;\n type commentsV2Comment_universal_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;\n type commentsV2Comment_universal_d_AppType = AppType;\n const commentsV2Comment_universal_d_AppType: typeof AppType;\n type commentsV2Comment_universal_d_BookingData = BookingData;\n type commentsV2Comment_universal_d_EventData = EventData;\n type commentsV2Comment_universal_d_VideoData = VideoData;\n type commentsV2Comment_universal_d_PlaybackOptions = PlaybackOptions;\n type commentsV2Comment_universal_d_EmbedData = EmbedData;\n type commentsV2Comment_universal_d_Oembed = Oembed;\n type commentsV2Comment_universal_d_CollapsibleListData = CollapsibleListData;\n type commentsV2Comment_universal_d_InitialExpandedItems = InitialExpandedItems;\n const commentsV2Comment_universal_d_InitialExpandedItems: typeof InitialExpandedItems;\n type commentsV2Comment_universal_d_Direction = Direction;\n const commentsV2Comment_universal_d_Direction: typeof Direction;\n type commentsV2Comment_universal_d_TableData = TableData;\n type commentsV2Comment_universal_d_Dimensions = Dimensions;\n type commentsV2Comment_universal_d_TableCellData = TableCellData;\n type commentsV2Comment_universal_d_VerticalAlignment = VerticalAlignment;\n const commentsV2Comment_universal_d_VerticalAlignment: typeof VerticalAlignment;\n type commentsV2Comment_universal_d_CellStyle = CellStyle;\n type commentsV2Comment_universal_d_BorderColors = BorderColors;\n type commentsV2Comment_universal_d_NullValue = NullValue;\n const commentsV2Comment_universal_d_NullValue: typeof NullValue;\n type commentsV2Comment_universal_d_ListValue = ListValue;\n type commentsV2Comment_universal_d_AudioData = AudioData;\n type commentsV2Comment_universal_d_OrderedListData = OrderedListData;\n type commentsV2Comment_universal_d_BulletedListData = BulletedListData;\n type commentsV2Comment_universal_d_BlockquoteData = BlockquoteData;\n type commentsV2Comment_universal_d_Metadata = Metadata;\n type commentsV2Comment_universal_d_DocumentStyle = DocumentStyle;\n type commentsV2Comment_universal_d_TextNodeStyle = TextNodeStyle;\n type commentsV2Comment_universal_d_Mention = Mention;\n type commentsV2Comment_universal_d_MentionIdentityOneOf = MentionIdentityOneOf;\n type commentsV2Comment_universal_d_Attachment = Attachment;\n type commentsV2Comment_universal_d_AttachmentMediaOneOf = AttachmentMediaOneOf;\n type commentsV2Comment_universal_d_VideoResolution = VideoResolution;\n type commentsV2Comment_universal_d_ContentAuthor = ContentAuthor;\n type commentsV2Comment_universal_d_ContentAuthorAuthorOneOf = ContentAuthorAuthorOneOf;\n type commentsV2Comment_universal_d_CommentAuthor = CommentAuthor;\n type commentsV2Comment_universal_d_CommentAuthorIdentityOneOf = CommentAuthorIdentityOneOf;\n type commentsV2Comment_universal_d_ParentComment = ParentComment;\n type commentsV2Comment_universal_d_VoteSummary = VoteSummary;\n type commentsV2Comment_universal_d_Status = Status;\n const commentsV2Comment_universal_d_Status: typeof Status;\n type commentsV2Comment_universal_d_CommentReactionSummary = CommentReactionSummary;\n type commentsV2Comment_universal_d_UpdateInternalDocumentsEvent = UpdateInternalDocumentsEvent;\n type commentsV2Comment_universal_d_UpdateInternalDocumentsEventOperationOneOf = UpdateInternalDocumentsEventOperationOneOf;\n type commentsV2Comment_universal_d_InternalDocument = InternalDocument;\n type commentsV2Comment_universal_d_InternalDocumentUpdateOperation = InternalDocumentUpdateOperation;\n type commentsV2Comment_universal_d_DeleteByIdsOperation = DeleteByIdsOperation;\n type commentsV2Comment_universal_d_DeleteByFilterOperation = DeleteByFilterOperation;\n type commentsV2Comment_universal_d_InternalDocumentUpdateByFilterOperation = InternalDocumentUpdateByFilterOperation;\n type commentsV2Comment_universal_d_InternalUpdateExistingOperation = InternalUpdateExistingOperation;\n type commentsV2Comment_universal_d_VersionedDocumentUpdateOperation = VersionedDocumentUpdateOperation;\n type commentsV2Comment_universal_d_VersioningMode = VersioningMode;\n const commentsV2Comment_universal_d_VersioningMode: typeof VersioningMode;\n type commentsV2Comment_universal_d_VersionedDeleteByIdsOperation = VersionedDeleteByIdsOperation;\n type commentsV2Comment_universal_d_VersionedDocumentId = VersionedDocumentId;\n type commentsV2Comment_universal_d_CreateCommentRequest = CreateCommentRequest;\n type commentsV2Comment_universal_d_ContactDetails = ContactDetails;\n type commentsV2Comment_universal_d_CreateCommentResponse = CreateCommentResponse;\n type commentsV2Comment_universal_d_ResourceCommentCountChanged = ResourceCommentCountChanged;\n type commentsV2Comment_universal_d_GetCommentRequest = GetCommentRequest;\n type commentsV2Comment_universal_d_GetCommentResponse = GetCommentResponse;\n type commentsV2Comment_universal_d_UpdateCommentRequest = UpdateCommentRequest;\n type commentsV2Comment_universal_d_UpdateCommentResponse = UpdateCommentResponse;\n type commentsV2Comment_universal_d_CommentContentChanged = CommentContentChanged;\n type commentsV2Comment_universal_d_DeleteCommentRequest = DeleteCommentRequest;\n type commentsV2Comment_universal_d_DeleteCommentResponse = DeleteCommentResponse;\n type commentsV2Comment_universal_d_CommentDeleted = CommentDeleted;\n type commentsV2Comment_universal_d_ModerateDraftContentRequest = ModerateDraftContentRequest;\n type commentsV2Comment_universal_d_Action = Action;\n const commentsV2Comment_universal_d_Action: typeof Action;\n type commentsV2Comment_universal_d_ModerateDraftContentResponse = ModerateDraftContentResponse;\n type commentsV2Comment_universal_d_CommentPublished = CommentPublished;\n type commentsV2Comment_universal_d_CommentHidden = CommentHidden;\n type commentsV2Comment_universal_d_QueryCommentsRequest = QueryCommentsRequest;\n type commentsV2Comment_universal_d_CursorQuery = CursorQuery;\n type commentsV2Comment_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type commentsV2Comment_universal_d_Sorting = Sorting;\n type commentsV2Comment_universal_d_SortOrder = SortOrder;\n const commentsV2Comment_universal_d_SortOrder: typeof SortOrder;\n type commentsV2Comment_universal_d_CursorPaging = CursorPaging;\n type commentsV2Comment_universal_d_QueryCommentsResponse = QueryCommentsResponse;\n type commentsV2Comment_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type commentsV2Comment_universal_d_Cursors = Cursors;\n type commentsV2Comment_universal_d_MarkCommentRequest = MarkCommentRequest;\n type commentsV2Comment_universal_d_MarkCommentResponse = MarkCommentResponse;\n type commentsV2Comment_universal_d_CommentMarked = CommentMarked;\n type commentsV2Comment_universal_d_UnmarkCommentRequest = UnmarkCommentRequest;\n type commentsV2Comment_universal_d_UnmarkCommentResponse = UnmarkCommentResponse;\n type commentsV2Comment_universal_d_CommentUnmarked = CommentUnmarked;\n type commentsV2Comment_universal_d_HideCommentRequest = HideCommentRequest;\n type commentsV2Comment_universal_d_HideCommentResponse = HideCommentResponse;\n type commentsV2Comment_universal_d_PublishCommentRequest = PublishCommentRequest;\n type commentsV2Comment_universal_d_PublishCommentResponse = PublishCommentResponse;\n type commentsV2Comment_universal_d_CountCommentsRequest = CountCommentsRequest;\n type commentsV2Comment_universal_d_CountCommentsResponse = CountCommentsResponse;\n type commentsV2Comment_universal_d_ListCommentsByResourceRequest = ListCommentsByResourceRequest;\n type commentsV2Comment_universal_d_CommentSort = CommentSort;\n type commentsV2Comment_universal_d_Order = Order;\n const commentsV2Comment_universal_d_Order: typeof Order;\n type commentsV2Comment_universal_d_ReplySort = ReplySort;\n type commentsV2Comment_universal_d_ReplySortOrder = ReplySortOrder;\n const commentsV2Comment_universal_d_ReplySortOrder: typeof ReplySortOrder;\n type commentsV2Comment_universal_d_ListCommentsByResourceCursorPaging = ListCommentsByResourceCursorPaging;\n type commentsV2Comment_universal_d_ListCommentsByResourceResponse = ListCommentsByResourceResponse;\n type commentsV2Comment_universal_d_RepliesListResponse = RepliesListResponse;\n type commentsV2Comment_universal_d_GetCommentThreadRequest = GetCommentThreadRequest;\n type commentsV2Comment_universal_d_GetCommentThreadResponse = GetCommentThreadResponse;\n type commentsV2Comment_universal_d_BulkPublishCommentRequest = BulkPublishCommentRequest;\n type commentsV2Comment_universal_d_BulkPublishCommentResponse = BulkPublishCommentResponse;\n type commentsV2Comment_universal_d_BulkHideCommentRequest = BulkHideCommentRequest;\n type commentsV2Comment_universal_d_BulkHideCommentResponse = BulkHideCommentResponse;\n type commentsV2Comment_universal_d_BulkDeleteCommentRequest = BulkDeleteCommentRequest;\n type commentsV2Comment_universal_d_BulkDeleteCommentResponse = BulkDeleteCommentResponse;\n type commentsV2Comment_universal_d_BulkModerateDraftContentRequest = BulkModerateDraftContentRequest;\n type commentsV2Comment_universal_d_BulkModerateDraftContentResponse = BulkModerateDraftContentResponse;\n const commentsV2Comment_universal_d_createComment: typeof createComment;\n type commentsV2Comment_universal_d_CreateCommentOptions = CreateCommentOptions;\n const commentsV2Comment_universal_d_getComment: typeof getComment;\n const commentsV2Comment_universal_d_updateComment: typeof updateComment;\n type commentsV2Comment_universal_d_UpdateComment = UpdateComment;\n const commentsV2Comment_universal_d_deleteComment: typeof deleteComment;\n type commentsV2Comment_universal_d_DeleteCommentOptions = DeleteCommentOptions;\n type commentsV2Comment_universal_d_ModerateDraftContentOptions = ModerateDraftContentOptions;\n const commentsV2Comment_universal_d_queryComments: typeof queryComments;\n type commentsV2Comment_universal_d_CommentsQueryResult = CommentsQueryResult;\n type commentsV2Comment_universal_d_CommentsQueryBuilder = CommentsQueryBuilder;\n const commentsV2Comment_universal_d_markComment: typeof markComment;\n type commentsV2Comment_universal_d_MarkCommentOptions = MarkCommentOptions;\n const commentsV2Comment_universal_d_unmarkComment: typeof unmarkComment;\n type commentsV2Comment_universal_d_UnmarkCommentOptions = UnmarkCommentOptions;\n const commentsV2Comment_universal_d_countComments: typeof countComments;\n type commentsV2Comment_universal_d_CountCommentsOptions = CountCommentsOptions;\n type commentsV2Comment_universal_d_ListCommentsByResourceOptions = ListCommentsByResourceOptions;\n type commentsV2Comment_universal_d_GetCommentThreadOptions = GetCommentThreadOptions;\n type commentsV2Comment_universal_d_BulkPublishCommentOptions = BulkPublishCommentOptions;\n type commentsV2Comment_universal_d_BulkHideCommentOptions = BulkHideCommentOptions;\n type commentsV2Comment_universal_d_BulkDeleteCommentOptions = BulkDeleteCommentOptions;\n type commentsV2Comment_universal_d_BulkModerateDraftContentOptions = BulkModerateDraftContentOptions;\n namespace commentsV2Comment_universal_d {\n export { commentsV2Comment_universal_d___debug as __debug, commentsV2Comment_universal_d_Comment as Comment, commentsV2Comment_universal_d_CommentContent as CommentContent, commentsV2Comment_universal_d_RichContent as RichContent, commentsV2Comment_universal_d_Node as Node, commentsV2Comment_universal_d_NodeDataOneOf as NodeDataOneOf, commentsV2Comment_universal_d_NodeType as NodeType, commentsV2Comment_universal_d_NodeStyle as NodeStyle, commentsV2Comment_universal_d_ButtonData as ButtonData, commentsV2Comment_universal_d_Border as Border, commentsV2Comment_universal_d_Colors as Colors, commentsV2Comment_universal_d_PluginContainerData as PluginContainerData, commentsV2Comment_universal_d_WidthType as WidthType, commentsV2Comment_universal_d_PluginContainerDataWidth as PluginContainerDataWidth, commentsV2Comment_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf, commentsV2Comment_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment, commentsV2Comment_universal_d_Spoiler as Spoiler, commentsV2Comment_universal_d_Height as Height, commentsV2Comment_universal_d_Type as Type, commentsV2Comment_universal_d_Styles as Styles, commentsV2Comment_universal_d_Link as Link, commentsV2Comment_universal_d_LinkDataOneOf as LinkDataOneOf, commentsV2Comment_universal_d_Target as Target, commentsV2Comment_universal_d_Rel as Rel, commentsV2Comment_universal_d_CodeBlockData as CodeBlockData, commentsV2Comment_universal_d_TextStyle as TextStyle, commentsV2Comment_universal_d_TextAlignment as TextAlignment, commentsV2Comment_universal_d_DividerData as DividerData, commentsV2Comment_universal_d_LineStyle as LineStyle, commentsV2Comment_universal_d_Width as Width, commentsV2Comment_universal_d_Alignment as Alignment, commentsV2Comment_universal_d_FileData as FileData, commentsV2Comment_universal_d_ViewMode as ViewMode, commentsV2Comment_universal_d_FileSource as FileSource, commentsV2Comment_universal_d_FileSourceDataOneOf as FileSourceDataOneOf, commentsV2Comment_universal_d_PDFSettings as PDFSettings, commentsV2Comment_universal_d_GalleryData as GalleryData, commentsV2Comment_universal_d_Media as Media, commentsV2Comment_universal_d_Image as Image, commentsV2Comment_universal_d_Video as Video, commentsV2Comment_universal_d_Item as Item, commentsV2Comment_universal_d_ItemDataOneOf as ItemDataOneOf, commentsV2Comment_universal_d_GalleryOptions as GalleryOptions, commentsV2Comment_universal_d_LayoutType as LayoutType, commentsV2Comment_universal_d_Orientation as Orientation, commentsV2Comment_universal_d_Crop as Crop, commentsV2Comment_universal_d_ThumbnailsAlignment as ThumbnailsAlignment, commentsV2Comment_universal_d_Layout as Layout, commentsV2Comment_universal_d_ItemStyle as ItemStyle, commentsV2Comment_universal_d_Thumbnails as Thumbnails, commentsV2Comment_universal_d_GIFData as GIFData, commentsV2Comment_universal_d_GIF as GIF, commentsV2Comment_universal_d_HeadingData as HeadingData, commentsV2Comment_universal_d_HTMLData as HTMLData, commentsV2Comment_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf, commentsV2Comment_universal_d_Source as Source, commentsV2Comment_universal_d_ImageData as ImageData, commentsV2Comment_universal_d_LinkPreviewData as LinkPreviewData, commentsV2Comment_universal_d_MapData as MapData, commentsV2Comment_universal_d_MapSettings as MapSettings, commentsV2Comment_universal_d_MapType as MapType, commentsV2Comment_universal_d_ParagraphData as ParagraphData, commentsV2Comment_universal_d_PollData as PollData, commentsV2Comment_universal_d_ViewRole as ViewRole, commentsV2Comment_universal_d_VoteRole as VoteRole, commentsV2Comment_universal_d_Permissions as Permissions, commentsV2Comment_universal_d_Option as Option, commentsV2Comment_universal_d_Settings as Settings, commentsV2Comment_universal_d_PollLayoutType as PollLayoutType, commentsV2Comment_universal_d_PollLayoutDirection as PollLayoutDirection, commentsV2Comment_universal_d_PollLayout as PollLayout, commentsV2Comment_universal_d_OptionLayout as OptionLayout, commentsV2Comment_universal_d_BackgroundType as BackgroundType, commentsV2Comment_universal_d_Gradient as Gradient, commentsV2Comment_universal_d_Background as Background, commentsV2Comment_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf, commentsV2Comment_universal_d_PollDesign as PollDesign, commentsV2Comment_universal_d_OptionDesign as OptionDesign, commentsV2Comment_universal_d_Poll as Poll, commentsV2Comment_universal_d_PollDataLayout as PollDataLayout, commentsV2Comment_universal_d_Design as Design, commentsV2Comment_universal_d_TextData as TextData, commentsV2Comment_universal_d_Decoration as Decoration, commentsV2Comment_universal_d_DecorationDataOneOf as DecorationDataOneOf, commentsV2Comment_universal_d_DecorationType as DecorationType, commentsV2Comment_universal_d_AnchorData as AnchorData, commentsV2Comment_universal_d_ColorData as ColorData, commentsV2Comment_universal_d_LinkData as LinkData, commentsV2Comment_universal_d_MentionData as MentionData, commentsV2Comment_universal_d_FontSizeData as FontSizeData, commentsV2Comment_universal_d_FontType as FontType, commentsV2Comment_universal_d_AppEmbedData as AppEmbedData, commentsV2Comment_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf, commentsV2Comment_universal_d_AppType as AppType, commentsV2Comment_universal_d_BookingData as BookingData, commentsV2Comment_universal_d_EventData as EventData, commentsV2Comment_universal_d_VideoData as VideoData, commentsV2Comment_universal_d_PlaybackOptions as PlaybackOptions, commentsV2Comment_universal_d_EmbedData as EmbedData, commentsV2Comment_universal_d_Oembed as Oembed, commentsV2Comment_universal_d_CollapsibleListData as CollapsibleListData, commentsV2Comment_universal_d_InitialExpandedItems as InitialExpandedItems, commentsV2Comment_universal_d_Direction as Direction, commentsV2Comment_universal_d_TableData as TableData, commentsV2Comment_universal_d_Dimensions as Dimensions, commentsV2Comment_universal_d_TableCellData as TableCellData, commentsV2Comment_universal_d_VerticalAlignment as VerticalAlignment, commentsV2Comment_universal_d_CellStyle as CellStyle, commentsV2Comment_universal_d_BorderColors as BorderColors, commentsV2Comment_universal_d_NullValue as NullValue, commentsV2Comment_universal_d_ListValue as ListValue, commentsV2Comment_universal_d_AudioData as AudioData, commentsV2Comment_universal_d_OrderedListData as OrderedListData, commentsV2Comment_universal_d_BulletedListData as BulletedListData, commentsV2Comment_universal_d_BlockquoteData as BlockquoteData, commentsV2Comment_universal_d_Metadata as Metadata, commentsV2Comment_universal_d_DocumentStyle as DocumentStyle, commentsV2Comment_universal_d_TextNodeStyle as TextNodeStyle, commentsV2Comment_universal_d_Mention as Mention, commentsV2Comment_universal_d_MentionIdentityOneOf as MentionIdentityOneOf, commentsV2Comment_universal_d_Attachment as Attachment, commentsV2Comment_universal_d_AttachmentMediaOneOf as AttachmentMediaOneOf, commentsV2Comment_universal_d_VideoResolution as VideoResolution, commentsV2Comment_universal_d_ContentAuthor as ContentAuthor, commentsV2Comment_universal_d_ContentAuthorAuthorOneOf as ContentAuthorAuthorOneOf, commentsV2Comment_universal_d_CommentAuthor as CommentAuthor, commentsV2Comment_universal_d_CommentAuthorIdentityOneOf as CommentAuthorIdentityOneOf, commentsV2Comment_universal_d_ParentComment as ParentComment, commentsV2Comment_universal_d_VoteSummary as VoteSummary, commentsV2Comment_universal_d_Status as Status, commentsV2Comment_universal_d_CommentReactionSummary as CommentReactionSummary, commentsV2Comment_universal_d_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent, commentsV2Comment_universal_d_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf, commentsV2Comment_universal_d_InternalDocument as InternalDocument, commentsV2Comment_universal_d_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation, commentsV2Comment_universal_d_DeleteByIdsOperation as DeleteByIdsOperation, commentsV2Comment_universal_d_DeleteByFilterOperation as DeleteByFilterOperation, commentsV2Comment_universal_d_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation, commentsV2Comment_universal_d_InternalUpdateExistingOperation as InternalUpdateExistingOperation, commentsV2Comment_universal_d_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation, commentsV2Comment_universal_d_VersioningMode as VersioningMode, commentsV2Comment_universal_d_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation, commentsV2Comment_universal_d_VersionedDocumentId as VersionedDocumentId, commentsV2Comment_universal_d_CreateCommentRequest as CreateCommentRequest, commentsV2Comment_universal_d_ContactDetails as ContactDetails, commentsV2Comment_universal_d_CreateCommentResponse as CreateCommentResponse, commentsV2Comment_universal_d_ResourceCommentCountChanged as ResourceCommentCountChanged, commentsV2Comment_universal_d_GetCommentRequest as GetCommentRequest, commentsV2Comment_universal_d_GetCommentResponse as GetCommentResponse, commentsV2Comment_universal_d_UpdateCommentRequest as UpdateCommentRequest, commentsV2Comment_universal_d_UpdateCommentResponse as UpdateCommentResponse, commentsV2Comment_universal_d_CommentContentChanged as CommentContentChanged, commentsV2Comment_universal_d_DeleteCommentRequest as DeleteCommentRequest, commentsV2Comment_universal_d_DeleteCommentResponse as DeleteCommentResponse, commentsV2Comment_universal_d_CommentDeleted as CommentDeleted, commentsV2Comment_universal_d_ModerateDraftContentRequest as ModerateDraftContentRequest, commentsV2Comment_universal_d_Action as Action, commentsV2Comment_universal_d_ModerateDraftContentResponse as ModerateDraftContentResponse, commentsV2Comment_universal_d_CommentPublished as CommentPublished, commentsV2Comment_universal_d_CommentHidden as CommentHidden, commentsV2Comment_universal_d_QueryCommentsRequest as QueryCommentsRequest, commentsV2Comment_universal_d_CursorQuery as CursorQuery, commentsV2Comment_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, commentsV2Comment_universal_d_Sorting as Sorting, commentsV2Comment_universal_d_SortOrder as SortOrder, commentsV2Comment_universal_d_CursorPaging as CursorPaging, commentsV2Comment_universal_d_QueryCommentsResponse as QueryCommentsResponse, commentsV2Comment_universal_d_CursorPagingMetadata as CursorPagingMetadata, commentsV2Comment_universal_d_Cursors as Cursors, commentsV2Comment_universal_d_MarkCommentRequest as MarkCommentRequest, commentsV2Comment_universal_d_MarkCommentResponse as MarkCommentResponse, commentsV2Comment_universal_d_CommentMarked as CommentMarked, commentsV2Comment_universal_d_UnmarkCommentRequest as UnmarkCommentRequest, commentsV2Comment_universal_d_UnmarkCommentResponse as UnmarkCommentResponse, commentsV2Comment_universal_d_CommentUnmarked as CommentUnmarked, commentsV2Comment_universal_d_HideCommentRequest as HideCommentRequest, commentsV2Comment_universal_d_HideCommentResponse as HideCommentResponse, commentsV2Comment_universal_d_PublishCommentRequest as PublishCommentRequest, commentsV2Comment_universal_d_PublishCommentResponse as PublishCommentResponse, commentsV2Comment_universal_d_CountCommentsRequest as CountCommentsRequest, commentsV2Comment_universal_d_CountCommentsResponse as CountCommentsResponse, commentsV2Comment_universal_d_ListCommentsByResourceRequest as ListCommentsByResourceRequest, commentsV2Comment_universal_d_CommentSort as CommentSort, commentsV2Comment_universal_d_Order as Order, commentsV2Comment_universal_d_ReplySort as ReplySort, commentsV2Comment_universal_d_ReplySortOrder as ReplySortOrder, commentsV2Comment_universal_d_ListCommentsByResourceCursorPaging as ListCommentsByResourceCursorPaging, commentsV2Comment_universal_d_ListCommentsByResourceResponse as ListCommentsByResourceResponse, commentsV2Comment_universal_d_RepliesListResponse as RepliesListResponse, commentsV2Comment_universal_d_GetCommentThreadRequest as GetCommentThreadRequest, commentsV2Comment_universal_d_GetCommentThreadResponse as GetCommentThreadResponse, commentsV2Comment_universal_d_BulkPublishCommentRequest as BulkPublishCommentRequest, commentsV2Comment_universal_d_BulkPublishCommentResponse as BulkPublishCommentResponse, commentsV2Comment_universal_d_BulkHideCommentRequest as BulkHideCommentRequest, commentsV2Comment_universal_d_BulkHideCommentResponse as BulkHideCommentResponse, commentsV2Comment_universal_d_BulkDeleteCommentRequest as BulkDeleteCommentRequest, commentsV2Comment_universal_d_BulkDeleteCommentResponse as BulkDeleteCommentResponse, commentsV2Comment_universal_d_BulkModerateDraftContentRequest as BulkModerateDraftContentRequest, commentsV2Comment_universal_d_BulkModerateDraftContentResponse as BulkModerateDraftContentResponse, commentsV2Comment_universal_d_createComment as createComment, commentsV2Comment_universal_d_CreateCommentOptions as CreateCommentOptions, commentsV2Comment_universal_d_getComment as getComment, commentsV2Comment_universal_d_updateComment as updateComment, commentsV2Comment_universal_d_UpdateComment as UpdateComment, commentsV2Comment_universal_d_deleteComment as deleteComment, commentsV2Comment_universal_d_DeleteCommentOptions as DeleteCommentOptions, commentsV2Comment_universal_d_ModerateDraftContentOptions as ModerateDraftContentOptions, commentsV2Comment_universal_d_queryComments as queryComments, commentsV2Comment_universal_d_CommentsQueryResult as CommentsQueryResult, commentsV2Comment_universal_d_CommentsQueryBuilder as CommentsQueryBuilder, commentsV2Comment_universal_d_markComment as markComment, commentsV2Comment_universal_d_MarkCommentOptions as MarkCommentOptions, commentsV2Comment_universal_d_unmarkComment as unmarkComment, commentsV2Comment_universal_d_UnmarkCommentOptions as UnmarkCommentOptions, commentsV2Comment_universal_d_countComments as countComments, commentsV2Comment_universal_d_CountCommentsOptions as CountCommentsOptions, commentsV2Comment_universal_d_ListCommentsByResourceOptions as ListCommentsByResourceOptions, commentsV2Comment_universal_d_GetCommentThreadOptions as GetCommentThreadOptions, commentsV2Comment_universal_d_BulkPublishCommentOptions as BulkPublishCommentOptions, commentsV2Comment_universal_d_BulkHideCommentOptions as BulkHideCommentOptions, commentsV2Comment_universal_d_BulkDeleteCommentOptions as BulkDeleteCommentOptions, commentsV2Comment_universal_d_BulkModerateDraftContentOptions as BulkModerateDraftContentOptions, };\n }\n export { commentsV2Comment_universal_d as comments };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-web-module.d.ts", "content": "declare module \"wix-web-module\" {\n /* eslint-disable import/group-exports */\n interface CacheOptions {\n tags: string[];\n ttl?: number;\n }\n interface WebMethodOptions {\n cache?: CacheOptions;\n }\n /**\n * Permissions needed to call the function in frontend code.\n * - Anyone Any site visitor can call the function.\n * - Admin Only site admins can call the function.\n * - SiteMember Only site members can call the function.\n */\n export const Permissions: {\n Admin: {\n allowedRoles: any[];\n };\n SiteMember: {\n allowedRoles: any[];\n };\n Anyone: {\n allowedRoles: any[];\n };\n };\n /**\n * The `webMethod()` function is a wrapper used to export functions from backend code that can be called from the frontend.\n * Use the function's first parameter to define the permissions needed to call the function in frontend code. You can import\n * the `Permissions` enum from the `wix-web-module` module to define the permissions.\n * The permission options are:\n * - `Permissions.Anyone`: Any site visitor can call the function.\n * - `Permissions.Admin`: Only site admins can call the function.\n * - `Permissions.SiteMember`: Only site members can call the function.\n *\n * Web methods must be defined in files with a `.web.js` extension.\n */\n export function webMethod any>(permission: {\n allowedRoles: any[];\n }, method: T, options?: WebMethodOptions): T & {\n permission: {\n allowedRoles: any[];\n };\n };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-forms.v2.d.ts", "content": "declare module \"wix-forms.v2\" {\n /** Form submission that was created or retrieved. */\n interface FormSubmission {\n /**\n * Submission ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the form which the submission belongs to. */\n formId?: string;\n /**\n * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.\n * @readonly\n */\n namespace?: string;\n /**\n * Status of the submission.\n * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.\n * - `PAYMENT_WAITING`: A form submission requiring payment is created.\n * - `PAYMENT_CANCELED`: An order of a form submission is canceled.\n * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.\n */\n status?: SubmissionStatus;\n /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */\n submissions?: Record;\n /**\n * Date and time the form submission was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the form submission was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.\n * @readonly\n */\n revision?: string | null;\n /**\n * ID of the visitor that submitted the form.\n * @readonly\n */\n submitter?: Submitter;\n /** Whether a site owner marked a submission as \"seen\". */\n seen?: boolean;\n /** Data extension object that holds users' and apps' fields. */\n extendedFields?: ExtendedFields;\n /**\n * Order details.
      \n * Note: This object is only applicable when submittng a form in the Wix Payments app.\n */\n orderDetails?: OrderDetails;\n /**\n * Contact ID. Member who created the submission, or a mapped contact.\n * @readonly\n */\n contactId?: string | null;\n }\n enum SubmissionStatus {\n UNDEFINED = \"UNDEFINED\",\n PENDING = \"PENDING\",\n CONFIRMED = \"CONFIRMED\",\n PAYMENT_WAITING = \"PAYMENT_WAITING\",\n PAYMENT_CANCELED = \"PAYMENT_CANCELED\"\n }\n interface Submitter extends SubmitterSubmitterOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Application ID. */\n applicationId?: string | null;\n /** User ID. */\n userId?: string | null;\n }\n /** @oneof */\n interface SubmitterSubmitterOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Application ID. */\n applicationId?: string | null;\n /** User ID. */\n userId?: string | null;\n }\n interface ExtendedFields {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface OrderDetails {\n /**\n * ID of the order related to submission (only applicable if a form has payments).\n * @readonly\n */\n orderId?: string | null;\n /**\n * Order number.\n * @readonly\n */\n number?: string | null;\n /**\n * Currency.\n * @readonly\n */\n currency?: string | null;\n /**\n * Item subtotal.\n * @readonly\n */\n itemSubtotal?: string;\n /**\n * ID of the checkout related to submission (only applicable if a form has payments).\n * @readonly\n */\n checkoutId?: string;\n }\n interface CreateSubmissionRequest {\n /** Submission to create. */\n submission: FormSubmission;\n /** Captcha token. */\n captchaToken?: string | null;\n }\n interface CreateSubmissionResponse {\n /** The created submission. */\n submission?: FormSubmission;\n }\n interface CreateSubmissionBySubmitterRequest {\n /** Submission to create. */\n submission: FormSubmission;\n /** A flag indicating whether this operation is a repeated creation, such as restoring a previously manually reported as spam entity. */\n repeatedCreation?: boolean;\n /** Validation will be mode is more forgiving, for example \"required\" won't be validated. */\n lenientValidation?: boolean;\n }\n interface CreateSubmissionBySubmitterResponse {\n /** The created submission. */\n submission?: FormSubmission;\n }\n interface BulkCreateSubmissionBySubmitterRequest {\n /** Form id. Restricts submissions creation for a single form. */\n formId: string;\n /**\n * Submissions to create.\n * Deprecated\n */\n submissions?: FormSubmission[];\n /** When set, items will be returned on successful create. */\n returnEntity?: boolean;\n /** Submissions data to create. */\n submissionsV2?: BulkCreateSubmissionBySubmitterData[];\n /** Validation will be mode is more forgiving, for example \"required\" won't be validated. */\n lenientValidation?: boolean;\n }\n interface BulkCreateSubmissionBySubmitterData {\n /** Submissions to create. */\n submission?: FormSubmission;\n /** A flag indicating whether this operation is a repeated creation, such as restoring a previously manually reported as spam entity. */\n repeatedCreation?: boolean;\n }\n interface BulkCreateSubmissionBySubmitterResponse {\n /** Created submissions with metadata */\n results?: BulkSubmissionResult[];\n /** Metadata of request */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkSubmissionResult {\n /** Created submission metadata */\n itemMetadata?: ItemMetadata;\n /** The created submission. */\n item?: FormSubmission;\n }\n interface ItemMetadata {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetSubmissionRequest {\n /** ID of the submission to retrieve. */\n submissionId: string;\n }\n interface GetSubmissionResponse {\n /** The retrieved submission. */\n submission?: FormSubmission;\n }\n interface GetSubmissionByCheckoutIdRequest {\n /** Checkout ID of the submission to retrieve. */\n checkoutId: string;\n }\n interface GetSubmissionByCheckoutIdResponse {\n /** The retrieved submission. */\n submission?: FormSubmission;\n }\n interface UpdateSubmissionRequest {\n /** Submission to update. */\n submission: FormSubmission;\n }\n interface UpdateSubmissionResponse {\n /** The updated submission. */\n submission?: FormSubmission;\n }\n interface ConfirmSubmissionRequest {\n /** Submission ID to confirm. */\n submissionId: string;\n }\n interface ConfirmSubmissionResponse {\n /** The confirmed submission. */\n submission?: FormSubmission;\n }\n interface FormSubmissionStatusUpdatedEvent {\n /** Updated submission. */\n submission?: FormSubmission;\n /** Previous status of the submission. */\n previousStatus?: SubmissionStatus;\n }\n interface DeleteSubmissionRequest {\n /** ID of the submission to delete. */\n submissionId: string;\n /**\n * Delete the submission, bypassing the trash bin. This means that the submission is permanently deleted and cannot be restored.\n *\n *\n * Default: `false`\n */\n permanent?: boolean;\n /** Whether to preserve files, associated with the submission. If the value is `false`, then the files are deleted after 210 days. */\n preserveFiles?: boolean;\n }\n interface DeleteSubmissionResponse {\n }\n interface BulkDeleteSubmissionRequest {\n /** Form ID. */\n formId: string;\n /** Submission ids. */\n submissionIds?: string[];\n /**\n * Delete submission bypassing trash-bin\n * Default: false\n */\n permanent?: boolean;\n /** Preserve files. */\n preserveFiles?: boolean;\n }\n interface BulkDeleteSubmissionResponse {\n /** Results of bulk submission delete */\n results?: BulkDeleteSubmissionResult[];\n /** Metadata of request */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkDeleteSubmissionResult {\n /** Deleted item metadata */\n itemMetadata?: ItemMetadata;\n }\n interface RestoreSubmissionFromTrashBinRequest {\n /** ID of the submission to restore. */\n submissionId: string;\n }\n interface RestoreSubmissionFromTrashBinResponse {\n /** The restored submission. */\n submission?: FormSubmission;\n }\n interface RemoveSubmissionFromTrashBinRequest {\n /** ID of the submission to restore. */\n submissionId: string;\n }\n interface RemoveSubmissionFromTrashBinResponse {\n }\n interface RemovedSubmissionFromTrash {\n /** Removed submission. */\n submission?: FormSubmission;\n }\n interface BulkRemoveSubmissionFromTrashBinRequest {\n /** Form ID. */\n formId: string;\n /** Submission ids. */\n submissionIds?: string[];\n }\n interface BulkRemoveSubmissionFromTrashBinResponse {\n /** Results of bulk submission removal from trash */\n results?: BulkRemoveSubmissionFromTrashBinResult[];\n /** Metadata of request */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkRemoveSubmissionFromTrashBinResult {\n /** Deleted item metadata */\n itemMetadata?: ItemMetadata;\n }\n interface ListDeletedSubmissionsRequest {\n /** Form ID. */\n formId: string;\n /** Submission ids. */\n submissionIds?: string[];\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */\n paging?: CursorPaging;\n /**\n * List of statuses of submissions which should be returned\n * Default: CONFIRMED\n */\n statuses?: SubmissionStatus[];\n }\n interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListDeletedSubmissionsResponse {\n /** The retrieved Submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata;\n }\n interface CursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface GetDeletedSubmissionRequest {\n /** Submission id. */\n submissionId: string;\n }\n interface GetDeletedSubmissionResponse {\n /** The retrieved Submission. */\n submission?: FormSubmission;\n }\n interface QuerySubmissionRequest {\n /** Query options. */\n query: CursorQuery;\n /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */\n onlyYourOwn?: boolean;\n }\n interface CursorQuery extends CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QuerySubmissionResponse {\n /** The retrieved submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n metadata?: CursorPagingMetadata;\n }\n interface SearchSubmissionsByNamespaceRequest {\n /** Query options. */\n search: CursorSearch;\n }\n interface CursorSearch extends CursorSearchPagingMethodOneOf {\n /**\n * Cursor pointing to page of results.\n * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.\n */\n cursorPaging?: CursorPaging;\n /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */\n filter?: Record | null;\n /** Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}] */\n sort?: Sorting[];\n /** Free text to match in searchable fields */\n search?: SearchDetails;\n }\n /** @oneof */\n interface CursorSearchPagingMethodOneOf {\n /**\n * Cursor pointing to page of results.\n * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.\n */\n cursorPaging?: CursorPaging;\n }\n interface SearchDetails {\n /** Defines how separate search terms in `expression` are combined */\n mode?: Mode;\n /** Search term or expression */\n expression?: string | null;\n /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */\n fuzzy?: boolean;\n }\n enum Mode {\n /** Any of the search terms must be present */\n OR = \"OR\",\n /** All search terms must be present */\n AND = \"AND\"\n }\n interface SearchSubmissionsByNamespaceResponse {\n /** The retrieved Submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n metadata?: CursorPagingMetadata;\n }\n interface SearchSubmissionsByNamespaceForExportRequest {\n /** Query options. */\n query: CursorQuery;\n }\n interface SearchSubmissionsByNamespaceForExportResponse {\n /** The retrieved Submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n metadata?: CursorPagingMetadata;\n }\n interface QuerySubmissionsByNamespaceRequest {\n /** Query options. */\n query: CursorQuery;\n /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */\n onlyYourOwn?: boolean;\n }\n interface QuerySubmissionsByNamespaceResponse {\n /** The retrieved Submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n metadata?: CursorPagingMetadata;\n }\n interface QuerySubmissionsByNamespaceForExportRequest {\n /** Query options. */\n query: CursorQuery;\n }\n interface QuerySubmissionsByNamespaceForExportResponse {\n /** The retrieved Submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n metadata?: CursorPagingMetadata;\n }\n interface CountSubmissionsByFilterRequest {\n /** A filter object. Must filter by namespace. */\n filter: Record | null;\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n }\n interface CountSubmissionsByFilterResponse {\n /** Forms submission count. */\n formsSubmissionsCount?: FormSubmissionsCount[];\n }\n interface FormSubmissionsCount {\n /** Form ID. */\n formId?: string;\n /** Total number of submissions. */\n totalCount?: number;\n /** Number of submissions that the site owner hasn't seen yet. */\n unseenCount?: number;\n }\n interface CountSubmissionsRequest {\n /** Form IDs which submissions should be counted. */\n formIds: string[];\n /** The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `getSubmission()` to retrieve the namespace. */\n namespace: string;\n /**\n * Status of the submission.\n * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.\n * - `PAYMENT_WAITING`: A form submission requiring payment is created.\n * - `PAYMENT_CANCELED`: An order of a form submission is canceled.\n * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.\n */\n statuses?: SubmissionStatus[];\n }\n interface CountSubmissionsResponse {\n /** Forms submission count. */\n formsSubmissionsCount?: FormSubmissionsCount[];\n }\n interface CountDeletedSubmissionsRequest {\n /** Form IDs. */\n formIds: string[];\n /** Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `\"wix.form_app.form\"`. The namespace of a submission can be retrieved using the Get Submission endpoint. */\n namespace: string;\n /**\n * List of statuses of submissions which should be taken into count\n * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED\n */\n statuses?: SubmissionStatus[];\n }\n interface CountDeletedSubmissionsResponse {\n /** Forms submission count. */\n formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];\n }\n interface FormDeletedSubmissionsCount {\n /** Form ID. */\n formId?: string;\n /** Total number of submissions. */\n totalCount?: number;\n }\n interface GetMediaUploadURLRequest {\n /** Form ID. */\n formId: string;\n /** Name of file to upload. */\n filename: string;\n /**\n * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.\n *\n * For example, `'image/png'`\n */\n mimeType: string;\n }\n interface GetMediaUploadURLResponse {\n /** Url to upload file. */\n uploadUrl?: string;\n }\n interface BulkMarkSubmissionsAsSeenRequest {\n /** Submission IDs to mark as seen. */\n ids: string[];\n /** ID of the form which the submissions belong to. */\n formId: string;\n }\n interface BulkMarkSubmissionsAsSeenResponse {\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n }\n interface RestoreInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface MessageEnvelope {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData extends IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface UpsertContactFromSubmissionRequest {\n /** Submission from which contact needs to be upserted. */\n submissionId: string;\n /** Optional contact id to which submission should be mapped. */\n contactId?: string | null;\n /** Indicates contact has verified primary email. */\n emailVerified?: boolean;\n }\n interface UpsertContactFromSubmissionResponse {\n /** Submit contact response. */\n submitContactResponse?: SubmitContactResponse;\n }\n interface SubmitContactResponse {\n /** ID of the contact that was found or created. */\n contactId?: string;\n /**\n * Identity type of the returned contact.\n *\n * - `CONTACT`: The returned contact ID belongs to a new or existing contact.\n * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.\n * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.\n */\n identityType?: IdentityType;\n /**\n * Indicates whether the contact was just created or already existed.\n *\n * If the contact was just created, returns `true`.\n * If it already existed, returns `false`.\n */\n newContact?: boolean;\n }\n enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n /** Existing or new contact */\n CONTACT = \"CONTACT\",\n /** Member is logged in, matching logic skipped */\n MEMBER = \"MEMBER\",\n /** Matching contact is a member, Merge logic won't be applied */\n NOT_AUTHENTICATED_MEMBER = \"NOT_AUTHENTICATED_MEMBER\"\n }\n interface SubmissionContactMapped {\n /**\n * Mapped upserted contact ID.\n * @readonly\n */\n contactId?: string;\n /** Identifies the namespace that the submission's form belongs to. */\n namespace?: string;\n /** Marketing subscription details */\n marketingSubscriptionDetails?: MarketingSubscriptionDetails;\n }\n interface MarketingSubscriptionDetails {\n /** Form id which was submitted */\n formId?: string;\n /** Mapped contact emails. */\n emails?: string[];\n /**\n * Date and time the form submission was created.\n * @readonly\n */\n submittedDate?: Date;\n /**\n * Subscription consent opt in level, either single or double confirmation.\n * Default: SINGLE_CONFIRMATION\n */\n optInLevel?: OptInLevel;\n }\n enum OptInLevel {\n SINGLE_CONFIRMATION = \"SINGLE_CONFIRMATION\",\n DOUBLE_CONFIRMATION = \"DOUBLE_CONFIRMATION\"\n }\n interface SubmissionContactMappingSkipped {\n /** Form Id. */\n formId?: string;\n /** Identifies the namespace that the submission's form belongs to. */\n namespace?: string;\n }\n /**\n * Creates a submission.\n *\n *\n * The `createSubmission()` function is an alternative way to the [`WixFormsV2`](https://www.wix.com/velo/reference/$w/wixformsv2/submit) element for submitting a form. In this case, clicking the submit button is unnecessary, the submission is automatically created when calling this function.\n * @param submission - Submission to create.\n * @public\n * @requiredField submission\n * @requiredField submission.formId\n * @param options - Optional fields.\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function createSubmission(submission: FormSubmission, options?: CreateSubmissionOptions): Promise;\n interface CreateSubmissionOptions {\n /** Captcha token. */\n captchaToken?: string | null;\n }\n interface CreateSubmissionBySubmitterOptions {\n /** A flag indicating whether this operation is a repeated creation, such as restoring a previously manually reported as spam entity. */\n repeatedCreation?: boolean;\n /** Validation will be mode is more forgiving, for example \"required\" won't be validated. */\n lenientValidation?: boolean;\n }\n /**\n * Creates multiple submissions with specified submitters.\n * Internal, migration only.\n * @param formId - Form id. Restricts submissions creation for a single form.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @requiredField options.submissions.submissions\n * @requiredField options.submissions.submitter\n * @adminMethod\n */\n function bulkCreateSubmissionBySubmitter(formId: string, options?: BulkCreateSubmissionBySubmitterOptions): Promise;\n interface BulkCreateSubmissionBySubmitterOptions {\n /**\n * Submissions to create.\n * Deprecated\n */\n submissions?: FormSubmission[];\n /** When set, items will be returned on successful create. */\n returnEntity?: boolean;\n /** Submissions data to create. */\n submissionsV2?: BulkCreateSubmissionBySubmitterData[];\n /** Validation will be mode is more forgiving, for example \"required\" won't be validated. */\n lenientValidation?: boolean;\n }\n /**\n * Retrieves a submission by ID.\n * @param submissionId - ID of the submission to retrieve.\n * @public\n * @requiredField submissionId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function getSubmission(submissionId: string): Promise;\n /**\n * Updates a submission.\n *\n *\n * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.\n * @param _id - Submission ID.\n * @public\n * @requiredField _id\n * @requiredField submission\n * @requiredField submission.formId\n * @requiredField submission.revision\n * @param submission - Submission to update.\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n * @returns The updated submission.\n */\n function updateSubmission(_id: string | null, submission: UpdateSubmission, options?: UpdateSubmissionOptions): Promise;\n interface UpdateSubmission {\n /**\n * Submission ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the form which the submission belongs to. */\n formId?: string;\n /**\n * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.\n * @readonly\n */\n namespace?: string;\n /**\n * Status of the submission.\n * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.\n * - `PAYMENT_WAITING`: A form submission requiring payment is created.\n * - `PAYMENT_CANCELED`: An order of a form submission is canceled.\n * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.\n */\n status?: SubmissionStatus;\n /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */\n submissions?: Record;\n /**\n * Date and time the form submission was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the form submission was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.\n * @readonly\n */\n revision?: string | null;\n /**\n * ID of the visitor that submitted the form.\n * @readonly\n */\n submitter?: Submitter;\n /** Whether a site owner marked a submission as \"seen\". */\n seen?: boolean;\n /** Data extension object that holds users' and apps' fields. */\n extendedFields?: ExtendedFields;\n /**\n * Order details.
      \n * Note: This object is only applicable when submittng a form in the Wix Payments app.\n */\n orderDetails?: OrderDetails;\n /**\n * Contact ID. Member who created the submission, or a mapped contact.\n * @readonly\n */\n contactId?: string | null;\n }\n interface UpdateSubmissionOptions {\n }\n /**\n * Confirms a submission.\n *\n *\n * You can only confirm a submission that has a `PENDING` status.\n * When using forms from the [Wix Pricing Plans](https://www.wix.com/app-market/paid-plans?referral=collection&appIndex=42&referralTag=made-by-wix&referralSectionName=made-by-wix) app, the default submission status is `PENDING`.\n * When using forms from the [Wix Forms]() app, the default form submission status is `CONFIRMED`. You can change the default status for individual submissions using the `updateSubmission()` method.\n * @param submissionId - Submission ID to confirm.\n * @public\n * @requiredField submissionId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function confirmSubmission(submissionId: string): Promise;\n /**\n * Deletes a submission.\n *\n *\n * This function moves the form submission into the trash bin. To delete the submission permanently, change the default `permanent` field value to `true.`\n * @param submissionId - ID of the submission to delete.\n * @public\n * @requiredField submissionId\n * @param options - Optional fields.\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteSubmission(submissionId: string, options?: DeleteSubmissionOptions): Promise;\n interface DeleteSubmissionOptions {\n /**\n * Delete the submission, bypassing the trash bin. This means that the submission is permanently delete and cannot be restored.\n *\n *\n * Default: `false`\n */\n permanent?: boolean;\n /** Whether to preserve files, associated with the submission. If the value is `false`, then the files are deleted after 210 days. */\n preserveFiles?: boolean;\n }\n /**\n * Deletes submissions by IDS for specific form.\n * @param formId - Form ID.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteSubmission(formId: string, options?: BulkDeleteSubmissionOptions): Promise;\n interface BulkDeleteSubmissionOptions {\n /** Submission ids. */\n submissionIds?: string[];\n /**\n * Delete submission bypassing trash-bin\n * Default: false\n */\n permanent?: boolean;\n /** Preserve files. */\n preserveFiles?: boolean;\n }\n /**\n * Restores deleted submission\n * @param submissionId - ID of the submission to restore.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function restoreSubmissionFromTrashBin(submissionId: string): Promise;\n /**\n * Remove deleted submission\n * @param submissionId - ID of the submission to restore.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function removeSubmissionFromTrashBin(submissionId: string): Promise;\n /**\n * Remove multiple deleted submissions\n * @param formId - Form ID.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkRemoveSubmissionFromTrashBin(formId: string, options?: BulkRemoveSubmissionFromTrashBinOptions): Promise;\n interface BulkRemoveSubmissionFromTrashBinOptions {\n /** Submission ids. */\n submissionIds?: string[];\n }\n /**\n * List deleted submissions\n * @param formId - Form ID.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function listDeletedSubmissions(formId: string, options?: ListDeletedSubmissionsOptions): Promise;\n interface ListDeletedSubmissionsOptions {\n /** Submission ids. */\n submissionIds?: string[];\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */\n paging?: CursorPaging;\n /**\n * List of statuses of submissions which should be returned\n * Default: CONFIRMED\n */\n statuses?: SubmissionStatus[];\n }\n /**\n * Get deleted submission\n * @param submissionId - Submission id.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function getDeletedSubmission(submissionId: string): Promise;\n /**\n * Deprecated on '2023-08-08'. Use QuerySubmissionsByNamespace.\n * @param query - Query options.\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace\n * @targetRemovalDate 2025-01-11\n */\n function querySubmission(query: CursorQuery, options?: QuerySubmissionOptions): Promise;\n interface QuerySubmissionOptions {\n /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */\n onlyYourOwn?: boolean;\n }\n /**\n * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site.\n *
      \n *\n * Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.\n *\n * You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.\n *\n * For field support for filters and sorting, see [Form Submissions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/sort-and-filter).option\n *\n * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n * @param search - Query options.\n * @public\n * @documentationMaturity preview\n * @requiredField search\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function searchSubmissionsByNamespace(search: CursorSearch): Promise;\n /**\n * Creates a query to retrieve a list of submissions.\n *\n *\n * The `querySubmissionsByNamespace()` method builds a query to retrieve a list of submissions from the specified namespace and returns a [`SubmissionsQueryBuilder`](#submissionsquerybuilder) object.\n * >**Note:** You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [`find()`](#submissionsquerybuilder/find) method.\n *\n * You can refine the query by chaining `SubmissionsQueryBuilder` methods onto the query. `SubmissionsQueryBuilder` methods enable you to sort, filter, and control the results that `querySubmissionsByNamespace()` returns.\n *\n * The following `SubmissionsQueryBuilder` methods are supported for `querySubmissionsByNamespace()`. For a full description of the Submissions object, see the object returned for the [`items`](#submissionsqueryresult/items) property in [`SubmissionsQueryResult`](#submissionsqueryresult).\n * @public\n * @param options - Query options.\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function querySubmissionsByNamespace(options?: QuerySubmissionsByNamespaceOptions): SubmissionsQueryBuilder;\n interface QuerySubmissionsByNamespaceOptions {\n /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */\n onlyYourOwn?: boolean | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface SubmissionsQueryResult extends QueryCursorResult {\n items: FormSubmission[];\n query: SubmissionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface SubmissionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: \"_id\" | \"formId\" | \"namespace\" | \"status\" | \"_createdDate\" | \"_updatedDate\" | \"seen\", value: any) => SubmissionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: \"_id\" | \"formId\" | \"status\" | \"_createdDate\" | \"_updatedDate\" | \"seen\", value: any) => SubmissionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => SubmissionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => SubmissionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => SubmissionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => SubmissionsQueryBuilder;\n in: (propertyName: \"_id\" | \"formId\" | \"status\" | \"_createdDate\" | \"_updatedDate\", value: any) => SubmissionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<\"_id\" | \"formId\" | \"status\" | \"_createdDate\" | \"_updatedDate\" | \"seen\">) => SubmissionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<\"_id\" | \"formId\" | \"status\" | \"_createdDate\" | \"_updatedDate\" | \"seen\">) => SubmissionsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => SubmissionsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => SubmissionsQueryBuilder;\n find: () => Promise;\n }\n /**\n * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site.\n *
      \n * Counts the number of submissions belonging to forms that were filtered and contain a provided expression.\n * @param filter - A filter object. Must filter by namespace.\n * @public\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function countSubmissionsByFilter(filter: Record | null, options?: CountSubmissionsByFilterOptions): Promise;\n interface CountSubmissionsByFilterOptions {\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n }\n /**\n * Counts the number of submissions belonging to the specified forms.\n *\n *\n * The `countSubmissions()` function is useful for analytics and tracking purposes. For example, if you have a contact form on your website, you can use this function to track how many submissions it receives daily, weekly, or monthly.\n * @public\n * @requiredField formIds\n * @requiredField namespace\n * @param namespace - The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `getSubmission()` to retrieve the namespace.\n * @param formIds - Form IDs which submissions should be counted.\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise;\n interface CountSubmissionsOptions {\n /**\n * Status of the submission.\n * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.\n * - `PAYMENT_WAITING`: A form submission requiring payment is created.\n * - `PAYMENT_CANCELED`: An order of a form submission is canceled.\n * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.\n */\n statuses?: SubmissionStatus[];\n }\n /**\n * > **Note:**\n * > The Submissions API is only available in the Wix Studio editor.\n *\n * Counts the number of submissions belonging to the specified forms.\n * @param formIds - Form IDs.\n * @param namespace - Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `\"wix.form_app.form\"`. The namespace of a submission can be retrieved using the Get Submission endpoint.\n * @public\n * @documentationMaturity preview\n * @requiredField formIds\n * @requiredField namespace\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise;\n interface CountDeletedSubmissionsOptions {\n /**\n * List of statuses of submissions which should be taken into count\n * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED\n */\n statuses?: SubmissionStatus[];\n }\n /**\n * Retrieves a URL generated by the [Media Manager](https://www.wix.com/velo/reference/wix-media-v2/files/generatefileuploadurl) to use when creating a submission that includes a field for uploading files.\n * > **Note:** You need at least a [Standard Premium](https://support.wix.com/en/article/choosing-a-premium-plan) plan for your site to upload files.\n *\n *\n * To learn how external clients can use the generated upload URL to upload a file to the Media Manager, see [Upload API](https://www.wix.com/velo/reference/wix-media-v2/files/upload-api).\n * @param formId - Form ID.\n * @param filename - Name of file to upload.\n * @param mimeType - [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.\n *\n * For example, `'image/png'`\n * @public\n * @requiredField filename\n * @requiredField formId\n * @requiredField mimeType\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise;\n /**\n * Marks form submissions as \"seen\".\n *\n *\n * This function marks the submissions as if they were seen by the site owner. Only site collaborators with the **[Manage Submission](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions)** permissions can mark submissions.\n * @public\n * @requiredField formId\n * @requiredField ids\n * @param ids - IDs of submissions to mark as seen.\n * @param formId - ID of the form which the submissions belong to.\n * @permissionScope Manage Submissions\n * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS\n * @permissionScope Manage Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS\n * @permissionScope Read Orders\n * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS\n * @permissionScope Read Submissions\n * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise;\n /**\n * Upserts contact from submission.\n * @param submissionId - Submission from which contact needs to be upserted.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n * @adminMethod\n */\n function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise;\n interface UpsertContactFromSubmissionOptions {\n /** Optional contact id to which submission should be mapped. */\n contactId?: string | null;\n /** Indicates contact has verified primary email. */\n emailVerified?: boolean;\n }\n type formsV4SubmissionSubmissions_universal_d_FormSubmission = FormSubmission;\n type formsV4SubmissionSubmissions_universal_d_SubmissionStatus = SubmissionStatus;\n const formsV4SubmissionSubmissions_universal_d_SubmissionStatus: typeof SubmissionStatus;\n type formsV4SubmissionSubmissions_universal_d_Submitter = Submitter;\n type formsV4SubmissionSubmissions_universal_d_SubmitterSubmitterOneOf = SubmitterSubmitterOneOf;\n type formsV4SubmissionSubmissions_universal_d_ExtendedFields = ExtendedFields;\n type formsV4SubmissionSubmissions_universal_d_OrderDetails = OrderDetails;\n type formsV4SubmissionSubmissions_universal_d_CreateSubmissionRequest = CreateSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_CreateSubmissionResponse = CreateSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_CreateSubmissionBySubmitterRequest = CreateSubmissionBySubmitterRequest;\n type formsV4SubmissionSubmissions_universal_d_CreateSubmissionBySubmitterResponse = CreateSubmissionBySubmitterResponse;\n type formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterRequest = BulkCreateSubmissionBySubmitterRequest;\n type formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterData = BulkCreateSubmissionBySubmitterData;\n type formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterResponse = BulkCreateSubmissionBySubmitterResponse;\n type formsV4SubmissionSubmissions_universal_d_BulkSubmissionResult = BulkSubmissionResult;\n type formsV4SubmissionSubmissions_universal_d_ItemMetadata = ItemMetadata;\n type formsV4SubmissionSubmissions_universal_d_ApplicationError = ApplicationError;\n type formsV4SubmissionSubmissions_universal_d_BulkActionMetadata = BulkActionMetadata;\n type formsV4SubmissionSubmissions_universal_d_GetSubmissionRequest = GetSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_GetSubmissionResponse = GetSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_GetSubmissionByCheckoutIdRequest = GetSubmissionByCheckoutIdRequest;\n type formsV4SubmissionSubmissions_universal_d_GetSubmissionByCheckoutIdResponse = GetSubmissionByCheckoutIdResponse;\n type formsV4SubmissionSubmissions_universal_d_UpdateSubmissionRequest = UpdateSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_UpdateSubmissionResponse = UpdateSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_ConfirmSubmissionRequest = ConfirmSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_ConfirmSubmissionResponse = ConfirmSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_FormSubmissionStatusUpdatedEvent = FormSubmissionStatusUpdatedEvent;\n type formsV4SubmissionSubmissions_universal_d_DeleteSubmissionRequest = DeleteSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_DeleteSubmissionResponse = DeleteSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionRequest = BulkDeleteSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionResponse = BulkDeleteSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionResult = BulkDeleteSubmissionResult;\n type formsV4SubmissionSubmissions_universal_d_RestoreSubmissionFromTrashBinRequest = RestoreSubmissionFromTrashBinRequest;\n type formsV4SubmissionSubmissions_universal_d_RestoreSubmissionFromTrashBinResponse = RestoreSubmissionFromTrashBinResponse;\n type formsV4SubmissionSubmissions_universal_d_RemoveSubmissionFromTrashBinRequest = RemoveSubmissionFromTrashBinRequest;\n type formsV4SubmissionSubmissions_universal_d_RemoveSubmissionFromTrashBinResponse = RemoveSubmissionFromTrashBinResponse;\n type formsV4SubmissionSubmissions_universal_d_RemovedSubmissionFromTrash = RemovedSubmissionFromTrash;\n type formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinRequest = BulkRemoveSubmissionFromTrashBinRequest;\n type formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinResponse = BulkRemoveSubmissionFromTrashBinResponse;\n type formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinResult = BulkRemoveSubmissionFromTrashBinResult;\n type formsV4SubmissionSubmissions_universal_d_ListDeletedSubmissionsRequest = ListDeletedSubmissionsRequest;\n type formsV4SubmissionSubmissions_universal_d_CursorPaging = CursorPaging;\n type formsV4SubmissionSubmissions_universal_d_ListDeletedSubmissionsResponse = ListDeletedSubmissionsResponse;\n type formsV4SubmissionSubmissions_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type formsV4SubmissionSubmissions_universal_d_Cursors = Cursors;\n type formsV4SubmissionSubmissions_universal_d_GetDeletedSubmissionRequest = GetDeletedSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_GetDeletedSubmissionResponse = GetDeletedSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionRequest = QuerySubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_CursorQuery = CursorQuery;\n type formsV4SubmissionSubmissions_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type formsV4SubmissionSubmissions_universal_d_Sorting = Sorting;\n type formsV4SubmissionSubmissions_universal_d_SortOrder = SortOrder;\n const formsV4SubmissionSubmissions_universal_d_SortOrder: typeof SortOrder;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionResponse = QuerySubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceRequest = SearchSubmissionsByNamespaceRequest;\n type formsV4SubmissionSubmissions_universal_d_CursorSearch = CursorSearch;\n type formsV4SubmissionSubmissions_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type formsV4SubmissionSubmissions_universal_d_SearchDetails = SearchDetails;\n type formsV4SubmissionSubmissions_universal_d_Mode = Mode;\n const formsV4SubmissionSubmissions_universal_d_Mode: typeof Mode;\n type formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceResponse = SearchSubmissionsByNamespaceResponse;\n type formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceForExportRequest = SearchSubmissionsByNamespaceForExportRequest;\n type formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceForExportResponse = SearchSubmissionsByNamespaceForExportResponse;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceRequest = QuerySubmissionsByNamespaceRequest;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceResponse = QuerySubmissionsByNamespaceResponse;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceForExportRequest = QuerySubmissionsByNamespaceForExportRequest;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceForExportResponse = QuerySubmissionsByNamespaceForExportResponse;\n type formsV4SubmissionSubmissions_universal_d_CountSubmissionsByFilterRequest = CountSubmissionsByFilterRequest;\n type formsV4SubmissionSubmissions_universal_d_CountSubmissionsByFilterResponse = CountSubmissionsByFilterResponse;\n type formsV4SubmissionSubmissions_universal_d_FormSubmissionsCount = FormSubmissionsCount;\n type formsV4SubmissionSubmissions_universal_d_CountSubmissionsRequest = CountSubmissionsRequest;\n type formsV4SubmissionSubmissions_universal_d_CountSubmissionsResponse = CountSubmissionsResponse;\n type formsV4SubmissionSubmissions_universal_d_CountDeletedSubmissionsRequest = CountDeletedSubmissionsRequest;\n type formsV4SubmissionSubmissions_universal_d_CountDeletedSubmissionsResponse = CountDeletedSubmissionsResponse;\n type formsV4SubmissionSubmissions_universal_d_FormDeletedSubmissionsCount = FormDeletedSubmissionsCount;\n type formsV4SubmissionSubmissions_universal_d_GetMediaUploadURLRequest = GetMediaUploadURLRequest;\n type formsV4SubmissionSubmissions_universal_d_GetMediaUploadURLResponse = GetMediaUploadURLResponse;\n type formsV4SubmissionSubmissions_universal_d_BulkMarkSubmissionsAsSeenRequest = BulkMarkSubmissionsAsSeenRequest;\n type formsV4SubmissionSubmissions_universal_d_BulkMarkSubmissionsAsSeenResponse = BulkMarkSubmissionsAsSeenResponse;\n type formsV4SubmissionSubmissions_universal_d_DomainEvent = DomainEvent;\n type formsV4SubmissionSubmissions_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type formsV4SubmissionSubmissions_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type formsV4SubmissionSubmissions_universal_d_RestoreInfo = RestoreInfo;\n type formsV4SubmissionSubmissions_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type formsV4SubmissionSubmissions_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type formsV4SubmissionSubmissions_universal_d_ActionEvent = ActionEvent;\n type formsV4SubmissionSubmissions_universal_d_Empty = Empty;\n type formsV4SubmissionSubmissions_universal_d_MessageEnvelope = MessageEnvelope;\n type formsV4SubmissionSubmissions_universal_d_IdentificationData = IdentificationData;\n type formsV4SubmissionSubmissions_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type formsV4SubmissionSubmissions_universal_d_WebhookIdentityType = WebhookIdentityType;\n const formsV4SubmissionSubmissions_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type formsV4SubmissionSubmissions_universal_d_UpsertContactFromSubmissionRequest = UpsertContactFromSubmissionRequest;\n type formsV4SubmissionSubmissions_universal_d_UpsertContactFromSubmissionResponse = UpsertContactFromSubmissionResponse;\n type formsV4SubmissionSubmissions_universal_d_SubmitContactResponse = SubmitContactResponse;\n type formsV4SubmissionSubmissions_universal_d_IdentityType = IdentityType;\n const formsV4SubmissionSubmissions_universal_d_IdentityType: typeof IdentityType;\n type formsV4SubmissionSubmissions_universal_d_SubmissionContactMapped = SubmissionContactMapped;\n type formsV4SubmissionSubmissions_universal_d_MarketingSubscriptionDetails = MarketingSubscriptionDetails;\n type formsV4SubmissionSubmissions_universal_d_OptInLevel = OptInLevel;\n const formsV4SubmissionSubmissions_universal_d_OptInLevel: typeof OptInLevel;\n type formsV4SubmissionSubmissions_universal_d_SubmissionContactMappingSkipped = SubmissionContactMappingSkipped;\n const formsV4SubmissionSubmissions_universal_d_createSubmission: typeof createSubmission;\n type formsV4SubmissionSubmissions_universal_d_CreateSubmissionOptions = CreateSubmissionOptions;\n type formsV4SubmissionSubmissions_universal_d_CreateSubmissionBySubmitterOptions = CreateSubmissionBySubmitterOptions;\n const formsV4SubmissionSubmissions_universal_d_bulkCreateSubmissionBySubmitter: typeof bulkCreateSubmissionBySubmitter;\n type formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterOptions = BulkCreateSubmissionBySubmitterOptions;\n const formsV4SubmissionSubmissions_universal_d_getSubmission: typeof getSubmission;\n const formsV4SubmissionSubmissions_universal_d_updateSubmission: typeof updateSubmission;\n type formsV4SubmissionSubmissions_universal_d_UpdateSubmission = UpdateSubmission;\n type formsV4SubmissionSubmissions_universal_d_UpdateSubmissionOptions = UpdateSubmissionOptions;\n const formsV4SubmissionSubmissions_universal_d_confirmSubmission: typeof confirmSubmission;\n const formsV4SubmissionSubmissions_universal_d_deleteSubmission: typeof deleteSubmission;\n type formsV4SubmissionSubmissions_universal_d_DeleteSubmissionOptions = DeleteSubmissionOptions;\n const formsV4SubmissionSubmissions_universal_d_bulkDeleteSubmission: typeof bulkDeleteSubmission;\n type formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionOptions = BulkDeleteSubmissionOptions;\n const formsV4SubmissionSubmissions_universal_d_restoreSubmissionFromTrashBin: typeof restoreSubmissionFromTrashBin;\n const formsV4SubmissionSubmissions_universal_d_removeSubmissionFromTrashBin: typeof removeSubmissionFromTrashBin;\n const formsV4SubmissionSubmissions_universal_d_bulkRemoveSubmissionFromTrashBin: typeof bulkRemoveSubmissionFromTrashBin;\n type formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinOptions = BulkRemoveSubmissionFromTrashBinOptions;\n const formsV4SubmissionSubmissions_universal_d_listDeletedSubmissions: typeof listDeletedSubmissions;\n type formsV4SubmissionSubmissions_universal_d_ListDeletedSubmissionsOptions = ListDeletedSubmissionsOptions;\n const formsV4SubmissionSubmissions_universal_d_getDeletedSubmission: typeof getDeletedSubmission;\n const formsV4SubmissionSubmissions_universal_d_querySubmission: typeof querySubmission;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionOptions = QuerySubmissionOptions;\n const formsV4SubmissionSubmissions_universal_d_searchSubmissionsByNamespace: typeof searchSubmissionsByNamespace;\n const formsV4SubmissionSubmissions_universal_d_querySubmissionsByNamespace: typeof querySubmissionsByNamespace;\n type formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceOptions = QuerySubmissionsByNamespaceOptions;\n type formsV4SubmissionSubmissions_universal_d_SubmissionsQueryResult = SubmissionsQueryResult;\n type formsV4SubmissionSubmissions_universal_d_SubmissionsQueryBuilder = SubmissionsQueryBuilder;\n const formsV4SubmissionSubmissions_universal_d_countSubmissionsByFilter: typeof countSubmissionsByFilter;\n type formsV4SubmissionSubmissions_universal_d_CountSubmissionsByFilterOptions = CountSubmissionsByFilterOptions;\n const formsV4SubmissionSubmissions_universal_d_countSubmissions: typeof countSubmissions;\n type formsV4SubmissionSubmissions_universal_d_CountSubmissionsOptions = CountSubmissionsOptions;\n const formsV4SubmissionSubmissions_universal_d_countDeletedSubmissions: typeof countDeletedSubmissions;\n type formsV4SubmissionSubmissions_universal_d_CountDeletedSubmissionsOptions = CountDeletedSubmissionsOptions;\n const formsV4SubmissionSubmissions_universal_d_getMediaUploadUrl: typeof getMediaUploadUrl;\n const formsV4SubmissionSubmissions_universal_d_bulkMarkSubmissionsAsSeen: typeof bulkMarkSubmissionsAsSeen;\n const formsV4SubmissionSubmissions_universal_d_upsertContactFromSubmission: typeof upsertContactFromSubmission;\n type formsV4SubmissionSubmissions_universal_d_UpsertContactFromSubmissionOptions = UpsertContactFromSubmissionOptions;\n namespace formsV4SubmissionSubmissions_universal_d {\n export { formsV4SubmissionSubmissions_universal_d_FormSubmission as FormSubmission, formsV4SubmissionSubmissions_universal_d_SubmissionStatus as SubmissionStatus, formsV4SubmissionSubmissions_universal_d_Submitter as Submitter, formsV4SubmissionSubmissions_universal_d_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf, formsV4SubmissionSubmissions_universal_d_ExtendedFields as ExtendedFields, formsV4SubmissionSubmissions_universal_d_OrderDetails as OrderDetails, formsV4SubmissionSubmissions_universal_d_CreateSubmissionRequest as CreateSubmissionRequest, formsV4SubmissionSubmissions_universal_d_CreateSubmissionResponse as CreateSubmissionResponse, formsV4SubmissionSubmissions_universal_d_CreateSubmissionBySubmitterRequest as CreateSubmissionBySubmitterRequest, formsV4SubmissionSubmissions_universal_d_CreateSubmissionBySubmitterResponse as CreateSubmissionBySubmitterResponse, formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterRequest as BulkCreateSubmissionBySubmitterRequest, formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterData as BulkCreateSubmissionBySubmitterData, formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterResponse as BulkCreateSubmissionBySubmitterResponse, formsV4SubmissionSubmissions_universal_d_BulkSubmissionResult as BulkSubmissionResult, formsV4SubmissionSubmissions_universal_d_ItemMetadata as ItemMetadata, formsV4SubmissionSubmissions_universal_d_ApplicationError as ApplicationError, formsV4SubmissionSubmissions_universal_d_BulkActionMetadata as BulkActionMetadata, formsV4SubmissionSubmissions_universal_d_GetSubmissionRequest as GetSubmissionRequest, formsV4SubmissionSubmissions_universal_d_GetSubmissionResponse as GetSubmissionResponse, formsV4SubmissionSubmissions_universal_d_GetSubmissionByCheckoutIdRequest as GetSubmissionByCheckoutIdRequest, formsV4SubmissionSubmissions_universal_d_GetSubmissionByCheckoutIdResponse as GetSubmissionByCheckoutIdResponse, formsV4SubmissionSubmissions_universal_d_UpdateSubmissionRequest as UpdateSubmissionRequest, formsV4SubmissionSubmissions_universal_d_UpdateSubmissionResponse as UpdateSubmissionResponse, formsV4SubmissionSubmissions_universal_d_ConfirmSubmissionRequest as ConfirmSubmissionRequest, formsV4SubmissionSubmissions_universal_d_ConfirmSubmissionResponse as ConfirmSubmissionResponse, formsV4SubmissionSubmissions_universal_d_FormSubmissionStatusUpdatedEvent as FormSubmissionStatusUpdatedEvent, formsV4SubmissionSubmissions_universal_d_DeleteSubmissionRequest as DeleteSubmissionRequest, formsV4SubmissionSubmissions_universal_d_DeleteSubmissionResponse as DeleteSubmissionResponse, formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionRequest as BulkDeleteSubmissionRequest, formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionResponse as BulkDeleteSubmissionResponse, formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionResult as BulkDeleteSubmissionResult, formsV4SubmissionSubmissions_universal_d_RestoreSubmissionFromTrashBinRequest as RestoreSubmissionFromTrashBinRequest, formsV4SubmissionSubmissions_universal_d_RestoreSubmissionFromTrashBinResponse as RestoreSubmissionFromTrashBinResponse, formsV4SubmissionSubmissions_universal_d_RemoveSubmissionFromTrashBinRequest as RemoveSubmissionFromTrashBinRequest, formsV4SubmissionSubmissions_universal_d_RemoveSubmissionFromTrashBinResponse as RemoveSubmissionFromTrashBinResponse, formsV4SubmissionSubmissions_universal_d_RemovedSubmissionFromTrash as RemovedSubmissionFromTrash, formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinRequest as BulkRemoveSubmissionFromTrashBinRequest, formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinResponse as BulkRemoveSubmissionFromTrashBinResponse, formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinResult as BulkRemoveSubmissionFromTrashBinResult, formsV4SubmissionSubmissions_universal_d_ListDeletedSubmissionsRequest as ListDeletedSubmissionsRequest, formsV4SubmissionSubmissions_universal_d_CursorPaging as CursorPaging, formsV4SubmissionSubmissions_universal_d_ListDeletedSubmissionsResponse as ListDeletedSubmissionsResponse, formsV4SubmissionSubmissions_universal_d_CursorPagingMetadata as CursorPagingMetadata, formsV4SubmissionSubmissions_universal_d_Cursors as Cursors, formsV4SubmissionSubmissions_universal_d_GetDeletedSubmissionRequest as GetDeletedSubmissionRequest, formsV4SubmissionSubmissions_universal_d_GetDeletedSubmissionResponse as GetDeletedSubmissionResponse, formsV4SubmissionSubmissions_universal_d_QuerySubmissionRequest as QuerySubmissionRequest, formsV4SubmissionSubmissions_universal_d_CursorQuery as CursorQuery, formsV4SubmissionSubmissions_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, formsV4SubmissionSubmissions_universal_d_Sorting as Sorting, formsV4SubmissionSubmissions_universal_d_SortOrder as SortOrder, formsV4SubmissionSubmissions_universal_d_QuerySubmissionResponse as QuerySubmissionResponse, formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceRequest as SearchSubmissionsByNamespaceRequest, formsV4SubmissionSubmissions_universal_d_CursorSearch as CursorSearch, formsV4SubmissionSubmissions_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, formsV4SubmissionSubmissions_universal_d_SearchDetails as SearchDetails, formsV4SubmissionSubmissions_universal_d_Mode as Mode, formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceResponse as SearchSubmissionsByNamespaceResponse, formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceForExportRequest as SearchSubmissionsByNamespaceForExportRequest, formsV4SubmissionSubmissions_universal_d_SearchSubmissionsByNamespaceForExportResponse as SearchSubmissionsByNamespaceForExportResponse, formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceRequest as QuerySubmissionsByNamespaceRequest, formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceResponse as QuerySubmissionsByNamespaceResponse, formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceForExportRequest as QuerySubmissionsByNamespaceForExportRequest, formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceForExportResponse as QuerySubmissionsByNamespaceForExportResponse, formsV4SubmissionSubmissions_universal_d_CountSubmissionsByFilterRequest as CountSubmissionsByFilterRequest, formsV4SubmissionSubmissions_universal_d_CountSubmissionsByFilterResponse as CountSubmissionsByFilterResponse, formsV4SubmissionSubmissions_universal_d_FormSubmissionsCount as FormSubmissionsCount, formsV4SubmissionSubmissions_universal_d_CountSubmissionsRequest as CountSubmissionsRequest, formsV4SubmissionSubmissions_universal_d_CountSubmissionsResponse as CountSubmissionsResponse, formsV4SubmissionSubmissions_universal_d_CountDeletedSubmissionsRequest as CountDeletedSubmissionsRequest, formsV4SubmissionSubmissions_universal_d_CountDeletedSubmissionsResponse as CountDeletedSubmissionsResponse, formsV4SubmissionSubmissions_universal_d_FormDeletedSubmissionsCount as FormDeletedSubmissionsCount, formsV4SubmissionSubmissions_universal_d_GetMediaUploadURLRequest as GetMediaUploadURLRequest, formsV4SubmissionSubmissions_universal_d_GetMediaUploadURLResponse as GetMediaUploadURLResponse, formsV4SubmissionSubmissions_universal_d_BulkMarkSubmissionsAsSeenRequest as BulkMarkSubmissionsAsSeenRequest, formsV4SubmissionSubmissions_universal_d_BulkMarkSubmissionsAsSeenResponse as BulkMarkSubmissionsAsSeenResponse, formsV4SubmissionSubmissions_universal_d_DomainEvent as DomainEvent, formsV4SubmissionSubmissions_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, formsV4SubmissionSubmissions_universal_d_EntityCreatedEvent as EntityCreatedEvent, formsV4SubmissionSubmissions_universal_d_RestoreInfo as RestoreInfo, formsV4SubmissionSubmissions_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, formsV4SubmissionSubmissions_universal_d_EntityDeletedEvent as EntityDeletedEvent, formsV4SubmissionSubmissions_universal_d_ActionEvent as ActionEvent, formsV4SubmissionSubmissions_universal_d_Empty as Empty, formsV4SubmissionSubmissions_universal_d_MessageEnvelope as MessageEnvelope, formsV4SubmissionSubmissions_universal_d_IdentificationData as IdentificationData, formsV4SubmissionSubmissions_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, formsV4SubmissionSubmissions_universal_d_WebhookIdentityType as WebhookIdentityType, formsV4SubmissionSubmissions_universal_d_UpsertContactFromSubmissionRequest as UpsertContactFromSubmissionRequest, formsV4SubmissionSubmissions_universal_d_UpsertContactFromSubmissionResponse as UpsertContactFromSubmissionResponse, formsV4SubmissionSubmissions_universal_d_SubmitContactResponse as SubmitContactResponse, formsV4SubmissionSubmissions_universal_d_IdentityType as IdentityType, formsV4SubmissionSubmissions_universal_d_SubmissionContactMapped as SubmissionContactMapped, formsV4SubmissionSubmissions_universal_d_MarketingSubscriptionDetails as MarketingSubscriptionDetails, formsV4SubmissionSubmissions_universal_d_OptInLevel as OptInLevel, formsV4SubmissionSubmissions_universal_d_SubmissionContactMappingSkipped as SubmissionContactMappingSkipped, formsV4SubmissionSubmissions_universal_d_createSubmission as createSubmission, formsV4SubmissionSubmissions_universal_d_CreateSubmissionOptions as CreateSubmissionOptions, formsV4SubmissionSubmissions_universal_d_CreateSubmissionBySubmitterOptions as CreateSubmissionBySubmitterOptions, formsV4SubmissionSubmissions_universal_d_bulkCreateSubmissionBySubmitter as bulkCreateSubmissionBySubmitter, formsV4SubmissionSubmissions_universal_d_BulkCreateSubmissionBySubmitterOptions as BulkCreateSubmissionBySubmitterOptions, formsV4SubmissionSubmissions_universal_d_getSubmission as getSubmission, formsV4SubmissionSubmissions_universal_d_updateSubmission as updateSubmission, formsV4SubmissionSubmissions_universal_d_UpdateSubmission as UpdateSubmission, formsV4SubmissionSubmissions_universal_d_UpdateSubmissionOptions as UpdateSubmissionOptions, formsV4SubmissionSubmissions_universal_d_confirmSubmission as confirmSubmission, formsV4SubmissionSubmissions_universal_d_deleteSubmission as deleteSubmission, formsV4SubmissionSubmissions_universal_d_DeleteSubmissionOptions as DeleteSubmissionOptions, formsV4SubmissionSubmissions_universal_d_bulkDeleteSubmission as bulkDeleteSubmission, formsV4SubmissionSubmissions_universal_d_BulkDeleteSubmissionOptions as BulkDeleteSubmissionOptions, formsV4SubmissionSubmissions_universal_d_restoreSubmissionFromTrashBin as restoreSubmissionFromTrashBin, formsV4SubmissionSubmissions_universal_d_removeSubmissionFromTrashBin as removeSubmissionFromTrashBin, formsV4SubmissionSubmissions_universal_d_bulkRemoveSubmissionFromTrashBin as bulkRemoveSubmissionFromTrashBin, formsV4SubmissionSubmissions_universal_d_BulkRemoveSubmissionFromTrashBinOptions as BulkRemoveSubmissionFromTrashBinOptions, formsV4SubmissionSubmissions_universal_d_listDeletedSubmissions as listDeletedSubmissions, formsV4SubmissionSubmissions_universal_d_ListDeletedSubmissionsOptions as ListDeletedSubmissionsOptions, formsV4SubmissionSubmissions_universal_d_getDeletedSubmission as getDeletedSubmission, formsV4SubmissionSubmissions_universal_d_querySubmission as querySubmission, formsV4SubmissionSubmissions_universal_d_QuerySubmissionOptions as QuerySubmissionOptions, formsV4SubmissionSubmissions_universal_d_searchSubmissionsByNamespace as searchSubmissionsByNamespace, formsV4SubmissionSubmissions_universal_d_querySubmissionsByNamespace as querySubmissionsByNamespace, formsV4SubmissionSubmissions_universal_d_QuerySubmissionsByNamespaceOptions as QuerySubmissionsByNamespaceOptions, formsV4SubmissionSubmissions_universal_d_SubmissionsQueryResult as SubmissionsQueryResult, formsV4SubmissionSubmissions_universal_d_SubmissionsQueryBuilder as SubmissionsQueryBuilder, formsV4SubmissionSubmissions_universal_d_countSubmissionsByFilter as countSubmissionsByFilter, formsV4SubmissionSubmissions_universal_d_CountSubmissionsByFilterOptions as CountSubmissionsByFilterOptions, formsV4SubmissionSubmissions_universal_d_countSubmissions as countSubmissions, formsV4SubmissionSubmissions_universal_d_CountSubmissionsOptions as CountSubmissionsOptions, formsV4SubmissionSubmissions_universal_d_countDeletedSubmissions as countDeletedSubmissions, formsV4SubmissionSubmissions_universal_d_CountDeletedSubmissionsOptions as CountDeletedSubmissionsOptions, formsV4SubmissionSubmissions_universal_d_getMediaUploadUrl as getMediaUploadUrl, formsV4SubmissionSubmissions_universal_d_bulkMarkSubmissionsAsSeen as bulkMarkSubmissionsAsSeen, formsV4SubmissionSubmissions_universal_d_upsertContactFromSubmission as upsertContactFromSubmission, formsV4SubmissionSubmissions_universal_d_UpsertContactFromSubmissionOptions as UpsertContactFromSubmissionOptions, };\n }\n export { formsV4SubmissionSubmissions_universal_d as submissions };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/common/wix-restaurants.v2.d.ts", "content": "declare module \"wix-restaurants.v2\" {\n interface Variant {\n /**\n * Item variant ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item variant is updated. To prevent conflicting changes, the current revision must be passed when updating the item variant. Ignored when creating an item variant.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item variant was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item variant was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item variant name. */\n name?: string | null;\n /** Extended fields. */\n extendedFields?: ExtendedFields$7;\n }\n interface ExtendedFields$7 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface InvalidateCache$9 extends InvalidateCacheGetByOneOf$9 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$9;\n /** Invalidate by page id */\n page?: Page$9;\n /** Invalidate by URI path */\n uri?: URI$9;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$9;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$9 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$9;\n /** Invalidate by page id */\n page?: Page$9;\n /** Invalidate by URI path */\n uri?: URI$9;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$9;\n }\n interface App$9 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$9 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$9 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$9 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface CreateVariantRequest {\n /** Item variant info. */\n variant: Variant;\n }\n interface CreateVariantResponse {\n /** Item variant. */\n variant?: Variant;\n }\n interface GetVariantRequest {\n /** ID of the item variant to retrieve. */\n variantId: string;\n }\n interface GetVariantResponse {\n /** Item variant. */\n variant?: Variant;\n }\n interface ListVariantsRequest {\n /** Item variant IDs. */\n variantIds?: string[];\n /** The metadata of the paginated results. */\n paging?: CursorPaging$a;\n }\n interface CursorPaging$a {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListVariantsResponse {\n /** The retrieved item variants. */\n variants?: Variant[];\n /** The metadata of the paginated results. */\n metadata?: CursorPagingMetadata$a;\n }\n interface CursorPagingMetadata$a {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$a;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$a {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface UpdateVariantRequest {\n /** Item variant to update. */\n variant: Variant;\n }\n interface UpdateVariantResponse {\n /** Updated item variant. */\n variant?: Variant;\n }\n interface BulkCreateVariantsRequest {\n /** Item variants details. */\n variants: Variant[];\n /** Whether to receive the created item variants in the response. */\n returnEntity?: boolean;\n }\n interface BulkCreateVariantsResponse {\n /** Information about the created item variants. */\n results?: BulkVariantResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$8;\n }\n interface BulkVariantResult {\n /** Metadata for creation of item variants. */\n itemMetadata?: ItemMetadata$8;\n /** Created item variants. Only returned if the `returnEntity` value is `true`. */\n variant?: Variant;\n }\n interface ItemMetadata$8 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$8;\n }\n interface ApplicationError$8 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$8 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkUpdateVariantsRequest {\n /** Item variants to be updated. */\n variants: MaskedVariant[];\n /** Whether to receive the updated item variants in the response. */\n returnEntity?: boolean;\n }\n interface MaskedVariant {\n /** Item variant to update. */\n variant?: Variant;\n }\n interface BulkUpdateVariantsResponse {\n /** Information about the updated item variants. */\n results?: BulkVariantResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$8;\n }\n interface DeleteVariantRequest {\n /** Item variant ID. */\n variantId: string;\n }\n interface DeleteVariantResponse {\n }\n interface QueryVariantsRequest {\n /** Query options. */\n query?: CursorQuery$a;\n }\n interface CursorQuery$a extends CursorQueryPagingMethodOneOf$a {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$a;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$a[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$a {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$a;\n }\n interface Sorting$a {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$a;\n }\n enum SortOrder$a {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryVariantsResponse {\n /** Retrieved item variants. */\n variants?: Variant[];\n /** Metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$a;\n }\n interface CountVariantsRequest {\n /** Filter for counting variants. */\n filter?: Record | null;\n }\n interface CountVariantsResponse {\n /** Counted variants. */\n count?: number;\n }\n interface CloneVariantsRequest {\n /** The MetaSiteId to clone from */\n metaSiteId: string;\n }\n interface CloneVariantsResponse {\n }\n interface BulkDeleteVariantsRequest {\n /** Item variant IDs. */\n ids: string[];\n }\n interface BulkDeleteVariantsResponse {\n /** Information about the deleted variants. */\n results?: BulkDeleteVariantsResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$8;\n }\n interface BulkDeleteVariantsResult {\n /** Metadata for variants deletion. */\n itemMetadata?: ItemMetadata$8;\n }\n interface DomainEvent$a extends DomainEventBodyOneOf$a {\n createdEvent?: EntityCreatedEvent$a;\n updatedEvent?: EntityUpdatedEvent$a;\n deletedEvent?: EntityDeletedEvent$a;\n actionEvent?: ActionEvent$a;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$a {\n createdEvent?: EntityCreatedEvent$a;\n updatedEvent?: EntityUpdatedEvent$a;\n deletedEvent?: EntityDeletedEvent$a;\n actionEvent?: ActionEvent$a;\n }\n interface EntityCreatedEvent$a {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$9;\n }\n interface RestoreInfo$9 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$a {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$a {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$a {\n bodyAsJson?: string;\n }\n interface Empty$9 {\n }\n interface MessageEnvelope$a {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$a;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$a extends IdentificationDataIdOneOf$a {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$a;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$a {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$a {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates an item variant.\n *\n * To create multiple item variants at once, use [Bulk Create Variants](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/bulk-create-variants).\n * @param variant - Item variant info.\n * @public\n * @documentationMaturity preview\n * @requiredField variant\n * @requiredField variant.name\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Item variant.\n */\n function createVariant(variant: Variant): Promise;\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves an item variant by ID.\n * @param variantId - ID of the item variant to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField variantId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Item variant.\n */\n function getVariant(variantId: string): Promise;\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves a list of up to 100 item variants.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listVariants(options?: ListVariantsOptions): Promise;\n interface ListVariantsOptions {\n /** Item variant IDs. */\n variantIds?: string[];\n /** The metadata of the paginated results. */\n paging?: CursorPaging$a;\n }\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates an item variant.\n *\n * To update multiple item variants at once, use [Bulk Update Variants](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-variant/bulk-update-variants).\n *\n * Each time an item variant is updated, its revision increments by 1. The existing revision must be included when updating the variant. This ensures you're working with the latest variant information, and it prevents unintended overwrites.\n * @param _id - Item variant ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField variant\n * @requiredField variant.revision\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated item variant.\n */\n function updateVariant(_id: string | null, variant: UpdateVariant, options?: UpdateVariantOptions): Promise;\n interface UpdateVariant {\n /**\n * Item variant ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item variant is updated. To prevent conflicting changes, the current revision must be passed when updating the item variant. Ignored when creating an item variant.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item variant was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item variant was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item variant name. */\n name?: string | null;\n /** Extended fields. */\n extendedFields?: ExtendedFields$7;\n }\n interface UpdateVariantOptions {\n }\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates multiple item variants.\n * @param variants - Item variants details.\n * @public\n * @documentationMaturity preview\n * @requiredField variants\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateVariants(variants: Variant[], options?: BulkCreateVariantsOptions): Promise;\n interface BulkCreateVariantsOptions {\n /** Whether to receive the created item variants in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates multiple item variants.\n *\n * Each time an item variant is updated, its revision increments by 1. The existing revision must be included when updating variant. This ensures you're working with the latest item information, and it prevents unintended overwrites.\n *\n * Up to 100 item variants can be returned per request.\n * @param variants - Item variants to be updated.\n * @public\n * @documentationMaturity preview\n * @requiredField variants\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateVariants(variants: MaskedVariant[], options?: BulkUpdateVariantsOptions): Promise;\n interface BulkUpdateVariantsOptions {\n /** Whether to receive the updated item variants in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Permanently deletes an item variant.\n * @param variantId - Item variant ID.\n * @public\n * @documentationMaturity preview\n * @requiredField variantId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteVariant(variantId: string): Promise;\n /**\n * Creates a query to retrieve a list of item variants.\n *\n * The `queryVariants()` function builds a query to retrieve a list of item variants and returns a `VariantsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the [`find()`](/item-variants/variants-query-builder/find) function.\n *\n * You can refine the query by chaining `VariantsQueryBuilder` functions onto the query. `VariantsQueryBuilder` functions enable you to filter, sort, and control the results that `queryVariants()` returns.\n *\n * `queryVariants()` runs with the following `VariantsQueryBuilder` defaults, which you can override:\n *\n * * [`limit(200)`](/item-variants/variants-query-builder/limit)\n * * [`ascending('entityId')`](/item-variants/variants-query-builder/ascending)\n *\n * The following `VariantsQueryBuilder` functions are supported for `queryVariants()`. For a full description of the item variant object, see the object returned for the [`items`](/item-variants/variants-query-builder/items) property in `VariantsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId RESTAURANTS.VARIANT_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryVariants(): VariantsQueryBuilder;\n interface QueryCursorResult$a {\n cursors: Cursors$a;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface VariantsQueryResult extends QueryCursorResult$a {\n items: Variant[];\n query: VariantsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface VariantsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\", value: any) => VariantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\", value: any) => VariantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => VariantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => VariantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => VariantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => VariantsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"name\", value: any) => VariantsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => VariantsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => VariantsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves the number of item variants that match a specified filter.\n *\n * If a filter isn't passed in the request, the endpoint returns the count of all item variants.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function countVariants(options?: CountVariantsOptions): Promise;\n interface CountVariantsOptions {\n /** Filter for counting variants. */\n filter?: Record | null;\n }\n /**\n * > **Note:** The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Deletes multiple item variants at once.\n * @param ids - Item variant IDs.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteVariants(ids: string[]): Promise;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_Variant = Variant;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CreateVariantRequest = CreateVariantRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CreateVariantResponse = CreateVariantResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_GetVariantRequest = GetVariantRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_GetVariantResponse = GetVariantResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_ListVariantsRequest = ListVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_ListVariantsResponse = ListVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariantRequest = UpdateVariantRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariantResponse = UpdateVariantResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkCreateVariantsRequest = BulkCreateVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkCreateVariantsResponse = BulkCreateVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkVariantResult = BulkVariantResult;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkUpdateVariantsRequest = BulkUpdateVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_MaskedVariant = MaskedVariant;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkUpdateVariantsResponse = BulkUpdateVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_DeleteVariantRequest = DeleteVariantRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_DeleteVariantResponse = DeleteVariantResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_QueryVariantsRequest = QueryVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_QueryVariantsResponse = QueryVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CountVariantsRequest = CountVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CountVariantsResponse = CountVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CloneVariantsRequest = CloneVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CloneVariantsResponse = CloneVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkDeleteVariantsRequest = BulkDeleteVariantsRequest;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkDeleteVariantsResponse = BulkDeleteVariantsResponse;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkDeleteVariantsResult = BulkDeleteVariantsResult;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_createVariant: typeof createVariant;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_getVariant: typeof getVariant;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_listVariants: typeof listVariants;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_ListVariantsOptions = ListVariantsOptions;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_updateVariant: typeof updateVariant;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariant = UpdateVariant;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariantOptions = UpdateVariantOptions;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_bulkCreateVariants: typeof bulkCreateVariants;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkCreateVariantsOptions = BulkCreateVariantsOptions;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_bulkUpdateVariants: typeof bulkUpdateVariants;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkUpdateVariantsOptions = BulkUpdateVariantsOptions;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_deleteVariant: typeof deleteVariant;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_queryVariants: typeof queryVariants;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_VariantsQueryResult = VariantsQueryResult;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_VariantsQueryBuilder = VariantsQueryBuilder;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_countVariants: typeof countVariants;\n type restaurantsMenusV1ItemVariantItemVariants_universal_d_CountVariantsOptions = CountVariantsOptions;\n const restaurantsMenusV1ItemVariantItemVariants_universal_d_bulkDeleteVariants: typeof bulkDeleteVariants;\n namespace restaurantsMenusV1ItemVariantItemVariants_universal_d {\n export { restaurantsMenusV1ItemVariantItemVariants_universal_d_Variant as Variant, ExtendedFields$7 as ExtendedFields, InvalidateCache$9 as InvalidateCache, InvalidateCacheGetByOneOf$9 as InvalidateCacheGetByOneOf, App$9 as App, Page$9 as Page, URI$9 as URI, File$9 as File, restaurantsMenusV1ItemVariantItemVariants_universal_d_CreateVariantRequest as CreateVariantRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_CreateVariantResponse as CreateVariantResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_GetVariantRequest as GetVariantRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_GetVariantResponse as GetVariantResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_ListVariantsRequest as ListVariantsRequest, CursorPaging$a as CursorPaging, restaurantsMenusV1ItemVariantItemVariants_universal_d_ListVariantsResponse as ListVariantsResponse, CursorPagingMetadata$a as CursorPagingMetadata, Cursors$a as Cursors, restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariantRequest as UpdateVariantRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariantResponse as UpdateVariantResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkCreateVariantsRequest as BulkCreateVariantsRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkCreateVariantsResponse as BulkCreateVariantsResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkVariantResult as BulkVariantResult, ItemMetadata$8 as ItemMetadata, ApplicationError$8 as ApplicationError, BulkActionMetadata$8 as BulkActionMetadata, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkUpdateVariantsRequest as BulkUpdateVariantsRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_MaskedVariant as MaskedVariant, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkUpdateVariantsResponse as BulkUpdateVariantsResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_DeleteVariantRequest as DeleteVariantRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_DeleteVariantResponse as DeleteVariantResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_QueryVariantsRequest as QueryVariantsRequest, CursorQuery$a as CursorQuery, CursorQueryPagingMethodOneOf$a as CursorQueryPagingMethodOneOf, Sorting$a as Sorting, SortOrder$a as SortOrder, restaurantsMenusV1ItemVariantItemVariants_universal_d_QueryVariantsResponse as QueryVariantsResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_CountVariantsRequest as CountVariantsRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_CountVariantsResponse as CountVariantsResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_CloneVariantsRequest as CloneVariantsRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_CloneVariantsResponse as CloneVariantsResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkDeleteVariantsRequest as BulkDeleteVariantsRequest, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkDeleteVariantsResponse as BulkDeleteVariantsResponse, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkDeleteVariantsResult as BulkDeleteVariantsResult, DomainEvent$a as DomainEvent, DomainEventBodyOneOf$a as DomainEventBodyOneOf, EntityCreatedEvent$a as EntityCreatedEvent, RestoreInfo$9 as RestoreInfo, EntityUpdatedEvent$a as EntityUpdatedEvent, EntityDeletedEvent$a as EntityDeletedEvent, ActionEvent$a as ActionEvent, Empty$9 as Empty, MessageEnvelope$a as MessageEnvelope, IdentificationData$a as IdentificationData, IdentificationDataIdOneOf$a as IdentificationDataIdOneOf, WebhookIdentityType$a as WebhookIdentityType, restaurantsMenusV1ItemVariantItemVariants_universal_d_createVariant as createVariant, restaurantsMenusV1ItemVariantItemVariants_universal_d_getVariant as getVariant, restaurantsMenusV1ItemVariantItemVariants_universal_d_listVariants as listVariants, restaurantsMenusV1ItemVariantItemVariants_universal_d_ListVariantsOptions as ListVariantsOptions, restaurantsMenusV1ItemVariantItemVariants_universal_d_updateVariant as updateVariant, restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariant as UpdateVariant, restaurantsMenusV1ItemVariantItemVariants_universal_d_UpdateVariantOptions as UpdateVariantOptions, restaurantsMenusV1ItemVariantItemVariants_universal_d_bulkCreateVariants as bulkCreateVariants, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkCreateVariantsOptions as BulkCreateVariantsOptions, restaurantsMenusV1ItemVariantItemVariants_universal_d_bulkUpdateVariants as bulkUpdateVariants, restaurantsMenusV1ItemVariantItemVariants_universal_d_BulkUpdateVariantsOptions as BulkUpdateVariantsOptions, restaurantsMenusV1ItemVariantItemVariants_universal_d_deleteVariant as deleteVariant, restaurantsMenusV1ItemVariantItemVariants_universal_d_queryVariants as queryVariants, restaurantsMenusV1ItemVariantItemVariants_universal_d_VariantsQueryResult as VariantsQueryResult, restaurantsMenusV1ItemVariantItemVariants_universal_d_VariantsQueryBuilder as VariantsQueryBuilder, restaurantsMenusV1ItemVariantItemVariants_universal_d_countVariants as countVariants, restaurantsMenusV1ItemVariantItemVariants_universal_d_CountVariantsOptions as CountVariantsOptions, restaurantsMenusV1ItemVariantItemVariants_universal_d_bulkDeleteVariants as bulkDeleteVariants, };\n }\n /**\n * An item modifier is a type of menu item that serves as an addition to a menu item.\n * Read more about [item modifiers](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifiers/introduction).\n */\n interface Modifier$1 {\n /**\n * Item modifier ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item modifier is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the item modifier.
      \n *\n * Ignored when creating an item modifier.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item modifier was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item modifier was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item modifier display name. */\n name?: string | null;\n /** Extended fields. */\n extendedFields?: ExtendedFields$6;\n }\n interface ExtendedFields$6 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface InvalidateCache$8 extends InvalidateCacheGetByOneOf$8 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$8;\n /** Invalidate by page id */\n page?: Page$8;\n /** Invalidate by URI path */\n uri?: URI$8;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$8;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$8 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$8;\n /** Invalidate by page id */\n page?: Page$8;\n /** Invalidate by URI path */\n uri?: URI$8;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$8;\n }\n interface App$8 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$8 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$8 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$8 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface CreateModifierRequest {\n /** Item modifier to create. */\n modifier: Modifier$1;\n }\n interface CreateModifierResponse {\n /** Created item modifier. */\n modifier?: Modifier$1;\n }\n interface GetModifierRequest {\n /** ID of the item modifier to retrieve. */\n modifierId: string;\n }\n interface GetModifierResponse {\n /** Retrieved item modifier. */\n modifier?: Modifier$1;\n }\n interface ListModifiersRequest {\n /** IDs of the item modifiers to retrieve. */\n modifierIds?: string[];\n /** Metadata of the paginated results. */\n paging?: CursorPaging$9;\n }\n interface CursorPaging$9 {\n /** Maximum number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListModifiersResponse {\n /** Retrieved item modifiers. */\n modifiers?: Modifier$1[];\n /** Metadata of the paginated results. */\n metadata?: CursorPagingMetadata$9;\n }\n interface CursorPagingMetadata$9 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor pointing to the next page and the previous page in the list of results. */\n cursors?: Cursors$9;\n /**\n * Whether there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$9 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface UpdateModifierRequest {\n /** Item Modifier with updated properties. */\n modifier: Modifier$1;\n }\n interface UpdateModifierResponse {\n /** Updated item modifier. */\n modifier?: Modifier$1;\n }\n interface BulkCreateModifiersRequest {\n /** List of item modifiers to create. */\n modifiers: Modifier$1[];\n /**\n * Whether the created item modifiers are included in the response.
      \n * Default: `false`.\n */\n returnEntity?: boolean;\n }\n interface BulkCreateModifiersResponse {\n /** Information about the created item modifiers. */\n results?: BulkCreateModifierResult[];\n /** Metadata for Bulk Create Modifiers API call. */\n bulkActionMetadata?: BulkActionMetadata$7;\n }\n interface BulkCreateModifierResult {\n /** Metadata for creation of the item modifer. */\n itemMetadata?: ItemMetadata$7;\n /** Created item modifier. */\n modifier?: Modifier$1;\n }\n interface ItemMetadata$7 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$7;\n }\n interface ApplicationError$7 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$7 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkUpdateModifiersRequest {\n /** List of item modifiers to update. */\n modifiers: MaskedModifier[];\n /** Whether the updated item modifiers are included in the response. */\n returnEntity?: boolean;\n }\n interface MaskedModifier {\n /** Item modifier to update. */\n modifier?: Modifier$1;\n }\n interface BulkUpdateModifiersResponse {\n /** Information about the updated item modifiers. */\n results?: BulkUpdateModifierResult[];\n /** Metadata for Bulk Update Modifiers API call. */\n bulkActionMetadata?: BulkActionMetadata$7;\n }\n interface BulkUpdateModifierResult {\n /** Metadata for the update of the item modifer. */\n itemMetadata?: ItemMetadata$7;\n /** Updated item modifier. */\n modifier?: Modifier$1;\n }\n interface DeleteModifierRequest {\n /** ID of the item modifier to delete. */\n modifierId: string;\n }\n interface DeleteModifierResponse {\n }\n interface QueryModifiersRequest {\n /** Query options. */\n query?: CursorQuery$9;\n }\n interface CursorQuery$9 extends CursorQueryPagingMethodOneOf$9 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$9;\n /**\n * Filter object.\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * for more information.\n *\n * For a detailed list of supported filters, see\n * [Supported Filters](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifiers/supported-filters-and-sorting).\n */\n filter?: Record | null;\n /** Sort object. */\n sort?: Sorting$9[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$9 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$9;\n }\n interface Sorting$9 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$9;\n }\n enum SortOrder$9 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryModifiersResponse {\n /** Retrieved item modifiers. */\n modifiers?: Modifier$1[];\n /** Metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$9;\n }\n interface CountModifiersRequest {\n /** Filter for counting modifiers. */\n filter?: Record | null;\n }\n interface CountModifiersResponse {\n /** Counted modifiers. */\n count?: number;\n }\n interface BulkDeleteModifiersRequest {\n /** Item Modifier IDs. */\n ids: string[];\n }\n interface BulkDeleteModifiersResponse {\n /** Information about the deleted modifiers. */\n results?: BulkDeleteModifiersResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$7;\n }\n interface BulkDeleteModifiersResult {\n /** Metadata for modifiers deletion. */\n itemMetadata?: ItemMetadata$7;\n }\n interface CloneModifiersRequest {\n /** The MetaSiteId to clone from */\n metaSiteId: string;\n }\n interface CloneModifiersResponse {\n }\n interface DomainEvent$9 extends DomainEventBodyOneOf$9 {\n createdEvent?: EntityCreatedEvent$9;\n updatedEvent?: EntityUpdatedEvent$9;\n deletedEvent?: EntityDeletedEvent$9;\n actionEvent?: ActionEvent$9;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$9 {\n createdEvent?: EntityCreatedEvent$9;\n updatedEvent?: EntityUpdatedEvent$9;\n deletedEvent?: EntityDeletedEvent$9;\n actionEvent?: ActionEvent$9;\n }\n interface EntityCreatedEvent$9 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$8;\n }\n interface RestoreInfo$8 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$9 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$9 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$9 {\n bodyAsJson?: string;\n }\n interface Empty$8 {\n }\n interface MessageEnvelope$9 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$9;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$9 extends IdentificationDataIdOneOf$9 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$9;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$9 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$9 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * > **Note:** The Item Modifiers API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates an item modifier.\n *\n * To create multiple item modifiers at once, use [Bulk Create Modifiers](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifiers/bulk-create-modifiers).\n * @param modifier - Item modifier to create.\n * @public\n * @documentationMaturity preview\n * @requiredField modifier\n * @requiredField modifier.name\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created item modifier.\n */\n function createModifier(modifier: Modifier$1): Promise;\n /**\n * > **Note:** The Item Modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves an item modifier by ID.\n * @param modifierId - ID of the item modifier to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField modifierId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Retrieved item modifier.\n */\n function getModifier(modifierId: string): Promise;\n /**\n * > **Note:** The Item Modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves a list of up to 100 item modifiers.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listModifiers(options?: ListModifiersOptions): Promise;\n interface ListModifiersOptions {\n /** IDs of the item modifiers to retrieve. */\n modifierIds?: string[];\n /** Metadata of the paginated results. */\n paging?: CursorPaging$9;\n }\n /**\n * > **Note:** The Item Modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates an item modifier.\n *\n * To update multiple item modifiers at once, use [Bulk Update Item Modifiers](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifiers/bulk-update-modifiers).\n *\n * Each time an item modifier is updated, its revision increments by 1. The existing revision must be included when updating an item modifier. This ensures you're working with the latest item modifier information, and it prevents unintended overwrites.\n * @param _id - Item modifier ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField modifier\n * @requiredField modifier.revision\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated item modifier.\n */\n function updateModifier(_id: string | null, modifier: UpdateModifier, options?: UpdateModifierOptions): Promise;\n interface UpdateModifier {\n /**\n * Item modifier ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item modifier is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the item modifier.
      \n *\n * Ignored when creating an item modifier.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item modifier was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item modifier was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item modifier display name. */\n name?: string | null;\n /** Extended fields. */\n extendedFields?: ExtendedFields$6;\n }\n interface UpdateModifierOptions {\n }\n /**\n * > **Note:** The Item Modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates multiple item modifiers.\n * @param modifiers - List of item modifiers to create.\n * @public\n * @documentationMaturity preview\n * @requiredField modifiers\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateModifiers(modifiers: Modifier$1[], options?: BulkCreateModifiersOptions): Promise;\n interface BulkCreateModifiersOptions {\n /**\n * Whether the created item modifiers are included in the response.
      \n * Default: `false`.\n */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Item modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates multiple item modifiers at once.\n * Each time an item modifier is updated, its revision increments by 1. The existing revision must be included when updating the item modifier. This ensures you're working with the latest item modifier information, and prevents unintended overwrites.\n * @param modifiers - List of item modifiers to update.\n * @public\n * @documentationMaturity preview\n * @requiredField modifiers\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateModifiers(modifiers: MaskedModifier[], options?: BulkUpdateModifiersOptions): Promise;\n interface BulkUpdateModifiersOptions {\n /** Whether the updated item modifiers are included in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Item modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n * Deletes an item modifier.\n * @param modifierId - ID of the item modifier to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField modifierId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteModifier(modifierId: string): Promise;\n /**\n * Creates a query to retrieve a list of item modifiers.\n *\n * The `queryModifiers()` function builds a query to retrieve a list of item modifiers and returns a `ModifiersQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the [`find()`](/item-modifiers/modifiers-query-builder/find) function.\n *\n * You can refine the query by chaining `ModifiersQueryBuilder` functions onto the query. `ModifiersQueryBuilder` functions enable you to filter, sort, and control the results that `queryModifiers()` returns.\n *\n * `queryModifiers()` runs with the following `ModifiersQueryBuilder` defaults, which you can override:\n *\n * * [`limit(200)`](/item-modifiers/modifiers-query-builder/limit)\n * * [`ascending('entityId')`](/item-modifiers/modifiers-query-builder/ascending)\n *\n * The following `ModifiersQueryBuilder` functions are supported for `queryModifiers()`. For a full description of the item modifier object, see the object returned for the [`items`](/item-modifiers/modifiers-query-builder/items) property in `ModifiersQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId RESTAURANTS.MODIFIER_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryModifiers(): ModifiersQueryBuilder;\n interface QueryCursorResult$9 {\n cursors: Cursors$9;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ModifiersQueryResult extends QueryCursorResult$9 {\n items: Modifier$1[];\n query: ModifiersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ModifiersQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\", value: any) => ModifiersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\", value: any) => ModifiersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ModifiersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ModifiersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ModifiersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ModifiersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"name\", value: any) => ModifiersQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => ModifiersQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ModifiersQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves the number of modifiers that match a specified filter.\n *\n * If a filter isn't passed in the request, the endpoint returns the count of all modifiers.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function countModifiers(options?: CountModifiersOptions): Promise;\n interface CountModifiersOptions {\n /** Filter for counting modifiers. */\n filter?: Record | null;\n }\n /**\n * > **Note:** The Item Modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Deletes multiple item Modifiers at once.\n * @param ids - Item Modifier IDs.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteModifiers(ids: string[]): Promise;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CreateModifierRequest = CreateModifierRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CreateModifierResponse = CreateModifierResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_GetModifierRequest = GetModifierRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_GetModifierResponse = GetModifierResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_ListModifiersRequest = ListModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_ListModifiersResponse = ListModifiersResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifierRequest = UpdateModifierRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifierResponse = UpdateModifierResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifiersRequest = BulkCreateModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifiersResponse = BulkCreateModifiersResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifierResult = BulkCreateModifierResult;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifiersRequest = BulkUpdateModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_MaskedModifier = MaskedModifier;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifiersResponse = BulkUpdateModifiersResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifierResult = BulkUpdateModifierResult;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_DeleteModifierRequest = DeleteModifierRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_DeleteModifierResponse = DeleteModifierResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_QueryModifiersRequest = QueryModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_QueryModifiersResponse = QueryModifiersResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CountModifiersRequest = CountModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CountModifiersResponse = CountModifiersResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkDeleteModifiersRequest = BulkDeleteModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkDeleteModifiersResponse = BulkDeleteModifiersResponse;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkDeleteModifiersResult = BulkDeleteModifiersResult;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CloneModifiersRequest = CloneModifiersRequest;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CloneModifiersResponse = CloneModifiersResponse;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_createModifier: typeof createModifier;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_getModifier: typeof getModifier;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_listModifiers: typeof listModifiers;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_ListModifiersOptions = ListModifiersOptions;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_updateModifier: typeof updateModifier;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifier = UpdateModifier;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifierOptions = UpdateModifierOptions;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_bulkCreateModifiers: typeof bulkCreateModifiers;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifiersOptions = BulkCreateModifiersOptions;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_bulkUpdateModifiers: typeof bulkUpdateModifiers;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifiersOptions = BulkUpdateModifiersOptions;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_deleteModifier: typeof deleteModifier;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_queryModifiers: typeof queryModifiers;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_ModifiersQueryResult = ModifiersQueryResult;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_ModifiersQueryBuilder = ModifiersQueryBuilder;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_countModifiers: typeof countModifiers;\n type restaurantsMenusV1ItemModifierItemModifiers_universal_d_CountModifiersOptions = CountModifiersOptions;\n const restaurantsMenusV1ItemModifierItemModifiers_universal_d_bulkDeleteModifiers: typeof bulkDeleteModifiers;\n namespace restaurantsMenusV1ItemModifierItemModifiers_universal_d {\n export { Modifier$1 as Modifier, ExtendedFields$6 as ExtendedFields, InvalidateCache$8 as InvalidateCache, InvalidateCacheGetByOneOf$8 as InvalidateCacheGetByOneOf, App$8 as App, Page$8 as Page, URI$8 as URI, File$8 as File, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CreateModifierRequest as CreateModifierRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CreateModifierResponse as CreateModifierResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_GetModifierRequest as GetModifierRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_GetModifierResponse as GetModifierResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_ListModifiersRequest as ListModifiersRequest, CursorPaging$9 as CursorPaging, restaurantsMenusV1ItemModifierItemModifiers_universal_d_ListModifiersResponse as ListModifiersResponse, CursorPagingMetadata$9 as CursorPagingMetadata, Cursors$9 as Cursors, restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifierRequest as UpdateModifierRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifierResponse as UpdateModifierResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifiersRequest as BulkCreateModifiersRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifiersResponse as BulkCreateModifiersResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifierResult as BulkCreateModifierResult, ItemMetadata$7 as ItemMetadata, ApplicationError$7 as ApplicationError, BulkActionMetadata$7 as BulkActionMetadata, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifiersRequest as BulkUpdateModifiersRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_MaskedModifier as MaskedModifier, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifiersResponse as BulkUpdateModifiersResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifierResult as BulkUpdateModifierResult, restaurantsMenusV1ItemModifierItemModifiers_universal_d_DeleteModifierRequest as DeleteModifierRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_DeleteModifierResponse as DeleteModifierResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_QueryModifiersRequest as QueryModifiersRequest, CursorQuery$9 as CursorQuery, CursorQueryPagingMethodOneOf$9 as CursorQueryPagingMethodOneOf, Sorting$9 as Sorting, SortOrder$9 as SortOrder, restaurantsMenusV1ItemModifierItemModifiers_universal_d_QueryModifiersResponse as QueryModifiersResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CountModifiersRequest as CountModifiersRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CountModifiersResponse as CountModifiersResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkDeleteModifiersRequest as BulkDeleteModifiersRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkDeleteModifiersResponse as BulkDeleteModifiersResponse, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkDeleteModifiersResult as BulkDeleteModifiersResult, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CloneModifiersRequest as CloneModifiersRequest, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CloneModifiersResponse as CloneModifiersResponse, DomainEvent$9 as DomainEvent, DomainEventBodyOneOf$9 as DomainEventBodyOneOf, EntityCreatedEvent$9 as EntityCreatedEvent, RestoreInfo$8 as RestoreInfo, EntityUpdatedEvent$9 as EntityUpdatedEvent, EntityDeletedEvent$9 as EntityDeletedEvent, ActionEvent$9 as ActionEvent, Empty$8 as Empty, MessageEnvelope$9 as MessageEnvelope, IdentificationData$9 as IdentificationData, IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, WebhookIdentityType$9 as WebhookIdentityType, restaurantsMenusV1ItemModifierItemModifiers_universal_d_createModifier as createModifier, restaurantsMenusV1ItemModifierItemModifiers_universal_d_getModifier as getModifier, restaurantsMenusV1ItemModifierItemModifiers_universal_d_listModifiers as listModifiers, restaurantsMenusV1ItemModifierItemModifiers_universal_d_ListModifiersOptions as ListModifiersOptions, restaurantsMenusV1ItemModifierItemModifiers_universal_d_updateModifier as updateModifier, restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifier as UpdateModifier, restaurantsMenusV1ItemModifierItemModifiers_universal_d_UpdateModifierOptions as UpdateModifierOptions, restaurantsMenusV1ItemModifierItemModifiers_universal_d_bulkCreateModifiers as bulkCreateModifiers, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkCreateModifiersOptions as BulkCreateModifiersOptions, restaurantsMenusV1ItemModifierItemModifiers_universal_d_bulkUpdateModifiers as bulkUpdateModifiers, restaurantsMenusV1ItemModifierItemModifiers_universal_d_BulkUpdateModifiersOptions as BulkUpdateModifiersOptions, restaurantsMenusV1ItemModifierItemModifiers_universal_d_deleteModifier as deleteModifier, restaurantsMenusV1ItemModifierItemModifiers_universal_d_queryModifiers as queryModifiers, restaurantsMenusV1ItemModifierItemModifiers_universal_d_ModifiersQueryResult as ModifiersQueryResult, restaurantsMenusV1ItemModifierItemModifiers_universal_d_ModifiersQueryBuilder as ModifiersQueryBuilder, restaurantsMenusV1ItemModifierItemModifiers_universal_d_countModifiers as countModifiers, restaurantsMenusV1ItemModifierItemModifiers_universal_d_CountModifiersOptions as CountModifiersOptions, restaurantsMenusV1ItemModifierItemModifiers_universal_d_bulkDeleteModifiers as bulkDeleteModifiers, };\n }\n interface Menu {\n /**\n * Menu ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the menu is updated. To prevent conflicting changes, the current revision must be passed when updating the menu. Ignored when creating a menu.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the menu was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the menu was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Menu name. */\n name?: string;\n /** Menu description. */\n description?: string | null;\n /** Is the menu visible to site visitors. */\n visible?: boolean | null;\n /** Menu section IDs. */\n sectionIds?: string[];\n /** Extended fields. */\n extendedFields?: ExtendedFields$5;\n /** Part of the site URL, that redirects to the menu. For example, in the URL `www.mywebsite.com/our-menus/dinner-menu`, `dinner-menu` is the field value. */\n urlQueryParam?: string | null;\n }\n interface ExtendedFields$5 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface GetMenuSiteUrlRequest {\n /**\n * Menu ID.\n * @readonly\n */\n _id: string | null;\n }\n interface GetMenuSiteUrlResponse {\n /** Retrieved menuInfo with path url. */\n menuSiteUrl?: MenuSiteUrl;\n }\n interface MenuSiteUrl {\n /** Path URL. */\n path?: string;\n }\n interface QueryMenusSiteUrlRequest {\n /** Query options */\n query: CursorQuery$8;\n }\n interface CursorQuery$8 extends CursorQueryPagingMethodOneOf$8 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$8;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$8[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$8 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$8;\n }\n interface Sorting$8 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$8;\n }\n enum SortOrder$8 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$8 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryMenusSiteUrlResponse {\n /** Retrieved menuInfos with path urls. */\n menuSiteUrls?: MenuSiteUrl[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$8;\n }\n interface CursorPagingMetadata$8 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$8;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$8 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface InvalidateCache$7 extends InvalidateCacheGetByOneOf$7 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$7;\n /** Invalidate by page id */\n page?: Page$7;\n /** Invalidate by URI path */\n uri?: URI$7;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$7;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$7 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$7;\n /** Invalidate by page id */\n page?: Page$7;\n /** Invalidate by URI path */\n uri?: URI$7;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$7;\n }\n interface App$7 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$7 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$7 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$7 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface DeleteOrphanSections {\n /** Menu id */\n menuId?: string;\n }\n interface MenusDataCloningCompleted$1 {\n }\n interface CreateMenuRequest {\n /** Menu details. */\n menu: Menu;\n }\n interface CreateMenuResponse {\n /** Menu. */\n menu?: Menu;\n }\n interface BulkCreateMenusRequest {\n /** Menu details. */\n menus: Menu[];\n /** Whether to receive the created menus in the response. */\n returnEntity?: boolean;\n }\n interface BulkCreateMenusResponse {\n /** Information about the created menus. */\n results?: BulkCreateMenuResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$6;\n }\n interface BulkCreateMenuResult {\n /** Whether to receive the created menus in the response. */\n menuMetadata?: ItemMetadata$6;\n /** Created menu. */\n menu?: Menu;\n }\n interface ItemMetadata$6 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$6;\n }\n interface ApplicationError$6 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$6 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetMenuRequest {\n /** Menu ID. */\n menuId: string;\n }\n interface GetMenuResponse {\n /** Menu. */\n menu?: Menu;\n }\n interface ListMenusRequest {\n /** Menu IDs. */\n menuIds?: string[];\n /** The metadata of the paginated results. */\n paging?: CursorPaging$8;\n }\n interface ListMenusResponse {\n /** Retrieved menus. */\n menus?: Menu[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$8;\n }\n interface QueryMenusRequest {\n /** Query options. */\n query?: CursorQuery$8;\n }\n interface QueryMenusResponse {\n /** Retrieved menus. */\n menus?: Menu[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$8;\n }\n interface UpdateMenuRequest {\n /** Menu to update. */\n menu: Menu;\n }\n interface UpdateMenuResponse {\n /** Updated menu. */\n menu?: Menu;\n }\n interface BulkUpdateMenuRequest {\n /** Menus to update. */\n menus: MaskedMenu[];\n /** Whether to receive the entity in the response. */\n returnEntity?: boolean;\n }\n interface MaskedMenu {\n /** Menu to updated. */\n menu?: Menu;\n }\n interface BulkUpdateMenuResponse {\n /** Results of bulk menu update. */\n results?: BulkMenuResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$6;\n }\n interface BulkMenuResult {\n /** Metadata for menu update. */\n menuMetadata?: ItemMetadata$6;\n /** Updated menu. Only returned if `returnEntity` is set to `true`. */\n menu?: Menu;\n }\n interface UpdateExtendedFieldsRequest$1 {\n /** ID of the entity to update. */\n _id: string;\n /** Identifier for the app whose extended fields are being updated. */\n namespace: string;\n /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */\n namespaceData: Record | null;\n }\n interface UpdateExtendedFieldsResponse$1 {\n /** Namespace of the app. */\n namespace?: string;\n /** Updated extended fields data. */\n namespaceData?: Record | null;\n }\n interface DeleteMenuRequest {\n /** Menu ID. */\n menuId: string;\n }\n interface DeleteMenuResponse {\n }\n interface CloneMenusRequest {\n /** The MetaSiteId to clone from. */\n metaSiteId: string;\n }\n interface CloneMenusResponse {\n }\n interface DomainEvent$8 extends DomainEventBodyOneOf$8 {\n createdEvent?: EntityCreatedEvent$8;\n updatedEvent?: EntityUpdatedEvent$8;\n deletedEvent?: EntityDeletedEvent$8;\n actionEvent?: ActionEvent$8;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp. */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$8 {\n createdEvent?: EntityCreatedEvent$8;\n updatedEvent?: EntityUpdatedEvent$8;\n deletedEvent?: EntityDeletedEvent$8;\n actionEvent?: ActionEvent$8;\n }\n interface EntityCreatedEvent$8 {\n entityAsJson?: string;\n }\n interface UndeleteInfo {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$8 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$8 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$8 {\n bodyAsJson?: string;\n }\n interface Empty$7 {\n }\n interface MessageEnvelope$8 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$8;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$8 extends IdentificationDataIdOneOf$8 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$8;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$8 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$8 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * > **Note:** The Menus API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates a menu.\n *\n * To create multiple menus at once, use [Bulk Create Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/bulk-create-menus).\n * @param menu - Menu details.\n * @public\n * @documentationMaturity preview\n * @requiredField menu\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Menu.\n */\n function createMenu(menu: Menu): Promise;\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates multiple menus at once.\n * @param menus - Menu details.\n * @public\n * @documentationMaturity preview\n * @requiredField menus\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateMenus(menus: Menu[], options?: BulkCreateMenusOptions): Promise;\n interface BulkCreateMenusOptions {\n /** Whether to receive the created menus in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieve a menu by ID.\n * @param menuId - Menu ID.\n * @public\n * @documentationMaturity preview\n * @requiredField menuId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n * @returns Menu.\n */\n function getMenu(menuId: string): Promise;\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves a list of up to 500 menus.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function listMenus(options?: ListMenusOptions): Promise;\n interface ListMenusOptions {\n /** Menu IDs. */\n menuIds?: string[];\n /** The metadata of the paginated results. */\n paging?: CursorPaging$8;\n }\n /**\n * Creates a query to retrieve a list of menus.\n *\n * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.\n *\n * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.\n *\n * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:\n *\n * * [`limit(100)`](/menus/menus-query-builder/limit)\n * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)\n *\n * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId RESTAURANTS.MENU_READ\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @applicableIdentity VISITOR\n */\n function queryMenus(): MenusQueryBuilder;\n interface QueryCursorResult$8 {\n cursors: Cursors$8;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface MenusQueryResult extends QueryCursorResult$8 {\n items: Menu[];\n query: MenusQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface MenusQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"urlQueryParam\", value: any) => MenusQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"urlQueryParam\", value: any) => MenusQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenusQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenusQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenusQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenusQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"name\" | \"description\" | \"urlQueryParam\", value: string) => MenusQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"name\" | \"description\" | \"urlQueryParam\", value: any) => MenusQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => MenusQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => MenusQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates a menu.\n *\n * To update multiple menus at once, use [Bulk Update Menu](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/bulk-update-menu).\n *\n * Each time a menu is updated, revision increments by 1. The existing revision must be included when updating a menu. This ensures you're working with the latest menu information, and it prevents unintended overwrites.\n * @param _id - Menu ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField menu\n * @requiredField menu.revision\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated menu.\n */\n function updateMenu(_id: string | null, menu: UpdateMenu, options?: UpdateMenuOptions): Promise;\n interface UpdateMenu {\n /**\n * Menu ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the menu is updated. To prevent conflicting changes, the current revision must be passed when updating the menu. Ignored when creating a menu.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the menu was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the menu was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Menu name. */\n name?: string;\n /** Menu description. */\n description?: string | null;\n /** Is the menu visible to site visitors. */\n visible?: boolean | null;\n /** Menu section IDs. */\n sectionIds?: string[];\n /** Extended fields. */\n extendedFields?: ExtendedFields$5;\n /** Part of the site URL, that redirects to the menu. For example, in the URL `www.mywebsite.com/our-menus/dinner-menu`, `dinner-menu` is the field value. */\n urlQueryParam?: string | null;\n }\n interface UpdateMenuOptions {\n }\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates multiple menus at once.\n *\n * Each time a menu is updated, revision increments by 1. The existing revision must be included when updating the menu. This ensures you're working with the latest menu information, and it prevents unintended overwrites.\n * @param menus - Menus to update.\n * @public\n * @documentationMaturity preview\n * @requiredField menus\n * @requiredField menus.menu._id\n * @requiredField menus.menu.revision\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateMenu(menus: MaskedMenu[], options?: BulkUpdateMenuOptions): Promise;\n interface BulkUpdateMenuOptions {\n /** Whether to receive the entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates only the `extendedFields` field.\n *\n * Updates only the `extendedFields` field.\n * @param _id - ID of the entity to update.\n * @param namespace - Identifier for the app whose extended fields are being updated.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField namespace\n * @requiredField options\n * @requiredField options.namespaceData\n * @adminMethod\n */\n function updateExtendedFields$1(_id: string, namespace: string, options: UpdateExtendedFieldsOptions$1): Promise;\n interface UpdateExtendedFieldsOptions$1 {\n /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */\n namespaceData: Record | null;\n }\n /**\n * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Deletes a menu.\n * @param menuId - Menu ID.\n * @public\n * @documentationMaturity preview\n * @requiredField menuId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteMenu(menuId: string): Promise;\n type restaurantsMenusV1MenuMenus_universal_d_Menu = Menu;\n type restaurantsMenusV1MenuMenus_universal_d_GetMenuSiteUrlRequest = GetMenuSiteUrlRequest;\n type restaurantsMenusV1MenuMenus_universal_d_GetMenuSiteUrlResponse = GetMenuSiteUrlResponse;\n type restaurantsMenusV1MenuMenus_universal_d_MenuSiteUrl = MenuSiteUrl;\n type restaurantsMenusV1MenuMenus_universal_d_QueryMenusSiteUrlRequest = QueryMenusSiteUrlRequest;\n type restaurantsMenusV1MenuMenus_universal_d_QueryMenusSiteUrlResponse = QueryMenusSiteUrlResponse;\n type restaurantsMenusV1MenuMenus_universal_d_DeleteOrphanSections = DeleteOrphanSections;\n type restaurantsMenusV1MenuMenus_universal_d_CreateMenuRequest = CreateMenuRequest;\n type restaurantsMenusV1MenuMenus_universal_d_CreateMenuResponse = CreateMenuResponse;\n type restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenusRequest = BulkCreateMenusRequest;\n type restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenusResponse = BulkCreateMenusResponse;\n type restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenuResult = BulkCreateMenuResult;\n type restaurantsMenusV1MenuMenus_universal_d_GetMenuRequest = GetMenuRequest;\n type restaurantsMenusV1MenuMenus_universal_d_GetMenuResponse = GetMenuResponse;\n type restaurantsMenusV1MenuMenus_universal_d_ListMenusRequest = ListMenusRequest;\n type restaurantsMenusV1MenuMenus_universal_d_ListMenusResponse = ListMenusResponse;\n type restaurantsMenusV1MenuMenus_universal_d_QueryMenusRequest = QueryMenusRequest;\n type restaurantsMenusV1MenuMenus_universal_d_QueryMenusResponse = QueryMenusResponse;\n type restaurantsMenusV1MenuMenus_universal_d_UpdateMenuRequest = UpdateMenuRequest;\n type restaurantsMenusV1MenuMenus_universal_d_UpdateMenuResponse = UpdateMenuResponse;\n type restaurantsMenusV1MenuMenus_universal_d_BulkUpdateMenuRequest = BulkUpdateMenuRequest;\n type restaurantsMenusV1MenuMenus_universal_d_MaskedMenu = MaskedMenu;\n type restaurantsMenusV1MenuMenus_universal_d_BulkUpdateMenuResponse = BulkUpdateMenuResponse;\n type restaurantsMenusV1MenuMenus_universal_d_BulkMenuResult = BulkMenuResult;\n type restaurantsMenusV1MenuMenus_universal_d_DeleteMenuRequest = DeleteMenuRequest;\n type restaurantsMenusV1MenuMenus_universal_d_DeleteMenuResponse = DeleteMenuResponse;\n type restaurantsMenusV1MenuMenus_universal_d_CloneMenusRequest = CloneMenusRequest;\n type restaurantsMenusV1MenuMenus_universal_d_CloneMenusResponse = CloneMenusResponse;\n type restaurantsMenusV1MenuMenus_universal_d_UndeleteInfo = UndeleteInfo;\n const restaurantsMenusV1MenuMenus_universal_d_createMenu: typeof createMenu;\n const restaurantsMenusV1MenuMenus_universal_d_bulkCreateMenus: typeof bulkCreateMenus;\n type restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenusOptions = BulkCreateMenusOptions;\n const restaurantsMenusV1MenuMenus_universal_d_getMenu: typeof getMenu;\n const restaurantsMenusV1MenuMenus_universal_d_listMenus: typeof listMenus;\n type restaurantsMenusV1MenuMenus_universal_d_ListMenusOptions = ListMenusOptions;\n const restaurantsMenusV1MenuMenus_universal_d_queryMenus: typeof queryMenus;\n type restaurantsMenusV1MenuMenus_universal_d_MenusQueryResult = MenusQueryResult;\n type restaurantsMenusV1MenuMenus_universal_d_MenusQueryBuilder = MenusQueryBuilder;\n const restaurantsMenusV1MenuMenus_universal_d_updateMenu: typeof updateMenu;\n type restaurantsMenusV1MenuMenus_universal_d_UpdateMenu = UpdateMenu;\n type restaurantsMenusV1MenuMenus_universal_d_UpdateMenuOptions = UpdateMenuOptions;\n const restaurantsMenusV1MenuMenus_universal_d_bulkUpdateMenu: typeof bulkUpdateMenu;\n type restaurantsMenusV1MenuMenus_universal_d_BulkUpdateMenuOptions = BulkUpdateMenuOptions;\n const restaurantsMenusV1MenuMenus_universal_d_deleteMenu: typeof deleteMenu;\n namespace restaurantsMenusV1MenuMenus_universal_d {\n export { restaurantsMenusV1MenuMenus_universal_d_Menu as Menu, ExtendedFields$5 as ExtendedFields, restaurantsMenusV1MenuMenus_universal_d_GetMenuSiteUrlRequest as GetMenuSiteUrlRequest, restaurantsMenusV1MenuMenus_universal_d_GetMenuSiteUrlResponse as GetMenuSiteUrlResponse, restaurantsMenusV1MenuMenus_universal_d_MenuSiteUrl as MenuSiteUrl, restaurantsMenusV1MenuMenus_universal_d_QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest, CursorQuery$8 as CursorQuery, CursorQueryPagingMethodOneOf$8 as CursorQueryPagingMethodOneOf, Sorting$8 as Sorting, SortOrder$8 as SortOrder, CursorPaging$8 as CursorPaging, restaurantsMenusV1MenuMenus_universal_d_QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse, CursorPagingMetadata$8 as CursorPagingMetadata, Cursors$8 as Cursors, InvalidateCache$7 as InvalidateCache, InvalidateCacheGetByOneOf$7 as InvalidateCacheGetByOneOf, App$7 as App, Page$7 as Page, URI$7 as URI, File$7 as File, restaurantsMenusV1MenuMenus_universal_d_DeleteOrphanSections as DeleteOrphanSections, MenusDataCloningCompleted$1 as MenusDataCloningCompleted, restaurantsMenusV1MenuMenus_universal_d_CreateMenuRequest as CreateMenuRequest, restaurantsMenusV1MenuMenus_universal_d_CreateMenuResponse as CreateMenuResponse, restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenusRequest as BulkCreateMenusRequest, restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenusResponse as BulkCreateMenusResponse, restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenuResult as BulkCreateMenuResult, ItemMetadata$6 as ItemMetadata, ApplicationError$6 as ApplicationError, BulkActionMetadata$6 as BulkActionMetadata, restaurantsMenusV1MenuMenus_universal_d_GetMenuRequest as GetMenuRequest, restaurantsMenusV1MenuMenus_universal_d_GetMenuResponse as GetMenuResponse, restaurantsMenusV1MenuMenus_universal_d_ListMenusRequest as ListMenusRequest, restaurantsMenusV1MenuMenus_universal_d_ListMenusResponse as ListMenusResponse, restaurantsMenusV1MenuMenus_universal_d_QueryMenusRequest as QueryMenusRequest, restaurantsMenusV1MenuMenus_universal_d_QueryMenusResponse as QueryMenusResponse, restaurantsMenusV1MenuMenus_universal_d_UpdateMenuRequest as UpdateMenuRequest, restaurantsMenusV1MenuMenus_universal_d_UpdateMenuResponse as UpdateMenuResponse, restaurantsMenusV1MenuMenus_universal_d_BulkUpdateMenuRequest as BulkUpdateMenuRequest, restaurantsMenusV1MenuMenus_universal_d_MaskedMenu as MaskedMenu, restaurantsMenusV1MenuMenus_universal_d_BulkUpdateMenuResponse as BulkUpdateMenuResponse, restaurantsMenusV1MenuMenus_universal_d_BulkMenuResult as BulkMenuResult, UpdateExtendedFieldsRequest$1 as UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1 as UpdateExtendedFieldsResponse, restaurantsMenusV1MenuMenus_universal_d_DeleteMenuRequest as DeleteMenuRequest, restaurantsMenusV1MenuMenus_universal_d_DeleteMenuResponse as DeleteMenuResponse, restaurantsMenusV1MenuMenus_universal_d_CloneMenusRequest as CloneMenusRequest, restaurantsMenusV1MenuMenus_universal_d_CloneMenusResponse as CloneMenusResponse, DomainEvent$8 as DomainEvent, DomainEventBodyOneOf$8 as DomainEventBodyOneOf, EntityCreatedEvent$8 as EntityCreatedEvent, restaurantsMenusV1MenuMenus_universal_d_UndeleteInfo as UndeleteInfo, EntityUpdatedEvent$8 as EntityUpdatedEvent, EntityDeletedEvent$8 as EntityDeletedEvent, ActionEvent$8 as ActionEvent, Empty$7 as Empty, MessageEnvelope$8 as MessageEnvelope, IdentificationData$8 as IdentificationData, IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf, WebhookIdentityType$8 as WebhookIdentityType, restaurantsMenusV1MenuMenus_universal_d_createMenu as createMenu, restaurantsMenusV1MenuMenus_universal_d_bulkCreateMenus as bulkCreateMenus, restaurantsMenusV1MenuMenus_universal_d_BulkCreateMenusOptions as BulkCreateMenusOptions, restaurantsMenusV1MenuMenus_universal_d_getMenu as getMenu, restaurantsMenusV1MenuMenus_universal_d_listMenus as listMenus, restaurantsMenusV1MenuMenus_universal_d_ListMenusOptions as ListMenusOptions, restaurantsMenusV1MenuMenus_universal_d_queryMenus as queryMenus, restaurantsMenusV1MenuMenus_universal_d_MenusQueryResult as MenusQueryResult, restaurantsMenusV1MenuMenus_universal_d_MenusQueryBuilder as MenusQueryBuilder, restaurantsMenusV1MenuMenus_universal_d_updateMenu as updateMenu, restaurantsMenusV1MenuMenus_universal_d_UpdateMenu as UpdateMenu, restaurantsMenusV1MenuMenus_universal_d_UpdateMenuOptions as UpdateMenuOptions, restaurantsMenusV1MenuMenus_universal_d_bulkUpdateMenu as bulkUpdateMenu, restaurantsMenusV1MenuMenus_universal_d_BulkUpdateMenuOptions as BulkUpdateMenuOptions, updateExtendedFields$1 as updateExtendedFields, UpdateExtendedFieldsOptions$1 as UpdateExtendedFieldsOptions, restaurantsMenusV1MenuMenus_universal_d_deleteMenu as deleteMenu, };\n }\n interface Rule$1 extends RuleValueOneOf, RuleRequirementsOneOf, RuleConditionsOneOf, RuleConditionTypeOptionsOneOf, RuleTaxesOneOf {\n /**\n * Fixed fee. Must hold a positive value.\n * @deprecated Fixed fee. Must hold a positive value.\n * @replacedBy fixed_fee\n * @targetRemovalDate 2024-02-15\n */\n amount?: CommonMoney;\n /**\n * Percentage fee. For example, `5` represents a 5% fee applied to the order's total.\n * @deprecated\n * @replacedBy percentage_fee\n * @targetRemovalDate 2024-02-15\n */\n percentage?: string | null;\n /** Fixed fee. Must hold a positive value. */\n fixedFee?: Money;\n /**\n * Percentage fee. For example, 5 represents a 5% fee applied to the order's total.\n *\n * Min: `0`.\n *\n * Max: `100`.\n */\n percentageFee?: string | null;\n /**\n * Single condition that must be met for the rule to be applied to an order.\n * @deprecated Single condition that must be met for the rule to be applied to an order.\n * @replacedBy condition_options\n * @targetRemovalDate 2024-02-15\n */\n condition?: Condition;\n /**\n * Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.\n * @deprecated Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.\n * @replacedBy condition_tree_options\n * @targetRemovalDate 2024-02-15\n */\n conditionTree?: ConditionTree;\n /** Single condition that must be met for the rule to be applied to an order. */\n conditionOptions?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n conditionTreeOptions?: ConditionTree;\n /** Percentage value to apply as a custom tax rate. Range: [0-100]. */\n customTaxRate?: string | null;\n /** Tax group ID. Internal only. */\n taxGroupId?: string | null;\n /**\n * Rule ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the restaurant’s [location](/locations/introduction). */\n locationId?: string | null;\n /** Rule name. */\n name?: string | null;\n /**\n * Date and time the rule was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the rule was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Percentage value to apply as a custom tax rate. For example, `5` respresents a 5% fee applied to the order's total.
      \n * Min: '0'.
      \n * Max: `100`.\n * @deprecated\n * @replacedBy taxes\n * @targetRemovalDate 2023-09-16\n */\n taxRate?: string | null;\n /**\n * Specifies the type of condition.\n * @deprecated Specifies the type of condition.\n * @replacedBy condition_type\n * @targetRemovalDate 2024-02-15\n */\n conditionsType?: ConditionsType;\n /** Specifies the type of condition. */\n conditionType?: ConditionType;\n /** Whether the rule is enabled. If `true`, the rule is evaluated when service fees are calculated. If `false`, the rule will not be evaluated when service fees are calculated. */\n enabled?: boolean | null;\n /**\n * Revision number. Increments by 1 each time the rule is updated.\n * To prevent conflicting changes, the existing `revision` must be used when updating a rule.\n * @readonly\n */\n revision?: string | null;\n /**\n * DEPRECATED. Defines the app that the rule is connected to.\n * @deprecated DEPRECATED. Defines the app that the rule is connected to.\n * @replacedBy app_id\n * @targetRemovalDate 2023-02-19\n */\n label?: string | null;\n /** Defines the app that the rule is connected to. */\n appId?: string | null;\n /**\n * Rounding strategy to apply to fee and tax calculation.\n *\n * Supported values:\n *\n * - `\"HALF_UP\"`: Rounds up any number exactly halfway between two integers. For example, `2.5` rounds to `3`, and `3.5` and rounds to `4`.\n * - `\"HALF_EVEN\"`: Rounds such numbers to the nearest even integer. For example, `2.5` rounds to `2`, but `3.5` rounds to `4`.\n * - `\"UNKNOWN_ROUNDING_STRATEGY\"`\n */\n roundingStrategy?: RoundingStrategy;\n }\n /** @oneof */\n interface RuleValueOneOf {\n /**\n * Fixed fee. Must hold a positive value.\n * @deprecated Fixed fee. Must hold a positive value.\n * @replacedBy fixed_fee\n * @targetRemovalDate 2024-02-15\n */\n amount?: CommonMoney;\n /**\n * Percentage fee. For example, `5` represents a 5% fee applied to the order's total.\n * @deprecated\n * @replacedBy percentage_fee\n * @targetRemovalDate 2024-02-15\n */\n percentage?: string | null;\n }\n /** @oneof */\n interface RuleRequirementsOneOf {\n /** Fixed fee. Must hold a positive value. */\n fixedFee?: Money;\n /**\n * Percentage fee. For example, 5 represents a 5% fee applied to the order's total.\n *\n * Min: `0`.\n *\n * Max: `100`.\n */\n percentageFee?: string | null;\n }\n /** @oneof */\n interface RuleConditionsOneOf {\n /**\n * Single condition that must be met for the rule to be applied to an order.\n * @deprecated Single condition that must be met for the rule to be applied to an order.\n * @replacedBy condition_options\n * @targetRemovalDate 2024-02-15\n */\n condition?: Condition;\n /**\n * Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.\n * @deprecated Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.\n * @replacedBy condition_tree_options\n * @targetRemovalDate 2024-02-15\n */\n conditionTree?: ConditionTree;\n }\n /** @oneof */\n interface RuleConditionTypeOptionsOneOf {\n /** Single condition that must be met for the rule to be applied to an order. */\n conditionOptions?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n conditionTreeOptions?: ConditionTree;\n }\n /** @oneof */\n interface RuleTaxesOneOf {\n /** Percentage value to apply as a custom tax rate. Range: [0-100]. */\n customTaxRate?: string | null;\n /** Tax group ID. Internal only. */\n taxGroupId?: string | null;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface CommonMoney {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n formattedValue?: string | null;\n }\n /**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\n interface Money {\n /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n formattedValue?: string | null;\n }\n interface Condition extends ConditionValueOneOf {\n /**\n * Contains a numeric value and an operation.\n *\n * Required if `expectedFieldType` is `NUMBER`.\n */\n number?: _Number;\n /**\n * Contains an array of strings to compare with the value of the specified field. If the value of the field matches a string in the array, the condition is considered met.\n *\n * Required if `expectedFieldType` is `LIST`.\n */\n list?: List;\n /**\n * Path of the field in the order entity that this condition will evaluate. For example, `priceSummary.subtotal`.\n * @deprecated\n * @replacedBy order_field_path\n * @targetRemovalDate 2024-02-15\n */\n path?: string;\n /** Path of the field in the order entity that this condition will evaluate. For example, `priceSummary.subtotal`. */\n orderFieldPath?: string;\n /**\n * Type of the field specified in `orderFieldPath`. For example, the type of `priceSummary.subtotal` is `\"NUMBER\"`).\n * @deprecated Type of the field specified in `orderFieldPath`. For example, the type of `priceSummary.subtotal` is `\"NUMBER\"`).\n * @replacedBy expected_field_type\n * @targetRemovalDate 2024-02-15\n */\n expectedType?: ExpectedType;\n /** Type of the field specified in `orderFieldPath`. For example, the type of `priceSummary.subtotal` is `\"NUMBER\"`). */\n expectedFieldType?: ExpectedFieldType;\n }\n /** @oneof */\n interface ConditionValueOneOf {\n /**\n * Contains a numeric value and an operation.\n *\n * Required if `expectedFieldType` is `NUMBER`.\n */\n number?: _Number;\n /**\n * Contains an array of strings to compare with the value of the specified field. If the value of the field matches a string in the array, the condition is considered met.\n *\n * Required if `expectedFieldType` is `LIST`.\n */\n list?: List;\n }\n interface ExpectedType {\n /** Type of the field specified in `orderFieldPath`. */\n value?: Value;\n }\n enum Value {\n /** Represents a number value. */\n NUMBER = \"NUMBER\",\n /** Represents a list of strings values - Not supported yet. */\n LIST = \"LIST\",\n /** Represents a string value. */\n STRING = \"STRING\"\n }\n enum ExpectedFieldType {\n /** Unknown expected field type */\n UNKNOWN_EXPECTED_FIELD_TYPE = \"UNKNOWN_EXPECTED_FIELD_TYPE\",\n /** Represents a number value. */\n NUMBER = \"NUMBER\",\n /** Represents a list of strings values - Not supported yet. */\n LIST = \"LIST\",\n /** Represents a string value. */\n STRING = \"STRING\"\n }\n interface _Number {\n /** Numeric value to compare with the value of the specified field. */\n value?: number;\n /**\n * Operation to use.\n *\n * Supported values:\n *\n * - `\"EQ\"`: Equal to.\n * - `\"LT\"`: Strictly less than.\n * - `\"LE\"`: Less than or equal to.\n * - `\"GT\"`: Strictly greater than.\n * - `\"GE\"`: Greater than or equal to.\n */\n operation?: Operation$1;\n }\n enum Operation$1 {\n /** == */\n EQ = \"EQ\",\n /** < */\n LT = \"LT\",\n /** <= */\n LE = \"LE\",\n /** > */\n GT = \"GT\",\n /** >= */\n GE = \"GE\"\n }\n interface List {\n /** Array of string values to compare with the value of the field. If the value of the fields matches a string in the array, the condition is considered met. */\n values?: string[];\n }\n /** Used to represent a logical condition in the form of a tree structure. */\n interface ConditionTree extends ConditionTreeLeftConditionNodeOneOf, ConditionTreeRightConditionNodeOneOf {\n /** Single condition that must be met for the rule to be applied to an order. */\n leftCondition?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n leftConditionsTree?: ConditionTree;\n /** Single condition that must be met for the rule to be applied to an order. */\n rightCondition?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n rightConditionsTree?: ConditionTree;\n /** Specifies the logical operator to use when combining the evaluation of the left and right conditions. */\n operator?: Operator;\n }\n /** @oneof */\n interface ConditionTreeLeftConditionNodeOneOf {\n /** Single condition that must be met for the rule to be applied to an order. */\n leftCondition?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n leftConditionsTree?: ConditionTree;\n }\n /** @oneof */\n interface ConditionTreeRightConditionNodeOneOf {\n /** Single condition that must be met for the rule to be applied to an order. */\n rightCondition?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n rightConditionsTree?: ConditionTree;\n }\n enum Operator {\n /** The condition is true if both the left and right sides are true. */\n AND = \"AND\",\n /** The condition is true if either the left or right side is true. */\n OR = \"OR\"\n }\n enum ConditionsType {\n /** Indicates that the Rule has no conditions specified. */\n NO_CONDITIONS = \"NO_CONDITIONS\",\n /** Indicates that the Rule has a single Condition. */\n CONDITION = \"CONDITION\",\n /** Indicates that the Rule has a complex condition specified as a ConditionTree. */\n CONDITION_TREE = \"CONDITION_TREE\"\n }\n enum ConditionType {\n /** Indicates that the Rule has no conditions specified. */\n UNDEFINED_CONDITION_TYPE = \"UNDEFINED_CONDITION_TYPE\",\n /** Indicates that the Rule has a single Condition. */\n CONDITION = \"CONDITION\",\n /** Indicates that the Rule has a complex condition specified as a ConditionTree. */\n CONDITION_TREE = \"CONDITION_TREE\"\n }\n enum RoundingStrategy {\n /** Unknown rounding strategy */\n UNKNOWN_ROUNDING_STRATEGY = \"UNKNOWN_ROUNDING_STRATEGY\",\n /** Half-up rounding strategy - relevant for fee and percentage fee calculation. */\n HALF_UP = \"HALF_UP\",\n /** Half-even rounding strategy - relevant for fee and percentage fee calculation. */\n HALF_EVEN = \"HALF_EVEN\"\n }\n interface CalculateServiceFeesRequest {\n /** Order information needed to evaluate the rules and calculate the relevant fees. */\n order: Order;\n /**\n * DEPRECATED. Defines the app that the rule is connected to.\n * @deprecated DEPRECATED. Defines the app that the rule is connected to.\n * @replacedBy app_id\n * @targetRemovalDate 2023-02-19\n */\n label?: string | null;\n /** Defines the app that the rule is connected to. */\n appId?: string | null;\n }\n interface Order {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string;\n /** ID of the site's location. */\n locationId?: string | null;\n /** Currency used for pricing on the site. */\n currency?: string | null;\n /** Information about the price of the order. */\n priceSummary?: PriceSummary;\n /** Order's shipping information. */\n shippingInfo?: ShippingInformation;\n /** Platform on which the order was placed. */\n platform?: Platform;\n /** Order's locale. */\n locale?: Locale$3;\n }\n interface PriceSummary {\n /** Subtotal of the order. */\n subtotal?: string;\n }\n interface ShippingInformation {\n /** Information about the type of delivery. For example, pick-up. */\n logistics?: DeliveryLogistics;\n }\n interface DeliveryLogistics {\n /**\n * Type of delivery.\n *\n * Supported values:\n * - `\"UNSPECIFIED_FULFILLMENT_TYPE\"`\n * - `\"PICKUP\"`\n * - `\"DELIVERY\"`\n * - `\"DINE_IN\"`\n * - `\"CURBSIDE_PICKUP\"`\n */\n type?: Type$1;\n }\n enum Type$1 {\n /** Missing type due to an error */\n UNSPECIFIED_FULFILLMENT_TYPE = \"UNSPECIFIED_FULFILLMENT_TYPE\",\n /** Pickup */\n PICKUP = \"PICKUP\",\n /** Delivery */\n DELIVERY = \"DELIVERY\",\n /** Dine-in */\n DINE_IN = \"DINE_IN\",\n /** Curbside-pickup */\n CURBSIDE_PICKUP = \"CURBSIDE_PICKUP\"\n }\n interface Platform {\n /**\n * Platform on which the order was placed.\n *\n * Supported values:\n * - `\"SITE\"`\n * - `\"MOBILE_SITE\"`\n * - `\"MOBILE_APP\"`\n */\n value?: PlatformValue;\n }\n enum PlatformValue {\n /** Site */\n SITE = \"SITE\",\n /** Mobile site */\n MOBILE_SITE = \"MOBILE_SITE\",\n /** Mobile app */\n MOBILE_APP = \"MOBILE_APP\"\n }\n interface Locale$3 {\n /**\n * Locale in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Typically, this is a lowercase 2-letter language code,\n * followed by a hyphen, followed by an uppercase 2-letter country code.\n * For example, `en-US` for U.S. English, and `de-DE` for Germany German.\n */\n languageCode?: string | null;\n /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string | null;\n }\n interface CalculateServiceFeesResponse {\n /** A list of calculated fees based on rules evaluation. */\n calculatedFees?: CalculatedFee[];\n }\n interface CalculatedFee {\n /** The ID of the rule that was used to calculate the fee. */\n ruleId?: string;\n /**\n * The name of the rule that was used to calculate the fee.\n * @readonly\n */\n name?: string;\n /** Fee amount. */\n fee?: Money;\n /** Tax amount. */\n tax?: Money;\n /** Tax group ID. This is an alternative to calculating the tax amount manually. */\n taxGroupId?: string | null;\n }\n interface CreateRuleRequest {\n /** Rule to create. */\n rule: Rule$1;\n }\n interface CreateRuleResponse {\n /** Created rule */\n rule?: Rule$1;\n }\n interface GetRuleRequest {\n /** ID of the rule to retrieve. */\n ruleId: string;\n }\n interface GetRuleResponse {\n /** The retrieved rule. */\n rule?: Rule$1;\n }\n interface UpdateRuleRequest {\n /** Rule to update. */\n rule: Rule$1;\n }\n interface UpdateRuleResponse {\n /** Updated rule. */\n rule?: Rule$1;\n }\n interface DeleteRuleRequest {\n /** ID of the rule to delete. */\n ruleId: string;\n }\n interface DeleteRuleResponse {\n }\n interface ListRulesRequest {\n /** Retrieve only rule that apply at the [location](https://dev.wix.com/docs/rest/api-reference/business-tools/locations/location-object) with this ID. If this field is `null`, the rules will not be filtered by location. */\n locationId?: string | null;\n /**\n * DEPRECATED. Defines the app that the rule is connected to.\n * @deprecated DEPRECATED. Defines the app that the rule is connected to.\n * @replacedBy app_id\n * @targetRemovalDate 2023-02-19\n */\n label?: string | null;\n /** Defines the app that the rule is connected to. */\n appId?: string | null;\n }\n interface ListRulesResponse {\n /** Array containing the retrieved rules. */\n rules?: Rule$1[];\n }\n interface QueryRulesRequest {\n /** Query options. */\n query: CursorQuery$7;\n }\n interface CursorQuery$7 extends CursorQueryPagingMethodOneOf$7 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$7;\n /**\n * Filter object.\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * for more information.\n *\n * For a detailed list of supported filters, see\n * [Supported Filters](/supported-filters-and-sorting).\n */\n filter?: Record | null;\n /** Sort object. */\n sort?: Sorting$7[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$7 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$7;\n }\n interface Sorting$7 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Supported values:\n * - `\"ASC\"`\n * - `\"DESC\"`\n */\n order?: SortOrder$7;\n }\n enum SortOrder$7 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$7 {\n /**\n * Number of items to load.
      \n * Default: `50`\n */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryRulesResponse {\n /** The retrieved rules. */\n rules?: Rule$1[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$7;\n }\n interface CursorPagingMetadata$7 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$7;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$7 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface BulkCreateRulesRequest {\n /** Rules to create. */\n rules: Rule$1[];\n /**\n * Whether the full rule entity is returned.
      \n * Default: `false`.\n */\n returnFullEntity?: boolean;\n }\n interface BulkCreateRulesResponse {\n /** The created rules. Omitted if `returnFullEntity` is set to false. */\n results?: BulkRuleResult[];\n /** Bulk Create Rule metadata. */\n bulkActionMetadata?: BulkActionMetadata$5;\n }\n interface BulkRuleResult {\n /** Metadata of the rule. */\n itemMetadata?: ItemMetadata$5;\n /** The created rule. */\n rule?: Rule$1;\n }\n interface ItemMetadata$5 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$5;\n }\n interface ApplicationError$5 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$5 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface BulkUpdateRulesRequest {\n /** Masked rules to update. */\n rules: MaskedRule[];\n /**\n * Whether the full rule entity is returned.
      \n * Default: `false`.\n */\n returnFullEntity?: boolean;\n }\n interface MaskedRule {\n /** Rule to update. */\n rule?: Rule$1;\n }\n interface BulkUpdateRulesResponse {\n /** The updated rules. Omitted if `returnFullEntity` is set to false. */\n results?: BulkRuleResult[];\n /** Bulk Update Rule metadata. */\n bulkActionMetadata?: BulkActionMetadata$5;\n }\n interface BulkDeleteRulesRequest {\n /** IDs of the rules to delete. */\n ruleIds: string[];\n }\n interface BulkDeleteRulesResponse {\n /** Information about the deleted rules. */\n results?: BulkRuleResult[];\n /** Bulk Delete Rule metadata. */\n bulkActionMetadata?: BulkActionMetadata$5;\n }\n interface DomainEvent$7 extends DomainEventBodyOneOf$7 {\n createdEvent?: EntityCreatedEvent$7;\n updatedEvent?: EntityUpdatedEvent$7;\n deletedEvent?: EntityDeletedEvent$7;\n actionEvent?: ActionEvent$7;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$7 {\n createdEvent?: EntityCreatedEvent$7;\n updatedEvent?: EntityUpdatedEvent$7;\n deletedEvent?: EntityDeletedEvent$7;\n actionEvent?: ActionEvent$7;\n }\n interface EntityCreatedEvent$7 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$7;\n }\n interface RestoreInfo$7 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$7 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$7 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$7 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$7 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$7;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$7;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$7 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$7 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * The `calculateServiceFees()` function returns a Promise that resolves to an array containing the calculated fees.\n *\n *\n * The specified order information is evaluated against all rules created for the site. If the rule conditions are met, the service fee set in the rule is applied. Otherwise, no service fee is added.\n * @param order - Order information needed to evaluate the rules and calculate the relevant fees.\n * @public\n * @documentationMaturity preview\n * @requiredField order\n * @requiredField order.currency\n * @requiredField order.priceSummary\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function calculateServiceFees(order: Order, options?: CalculateServiceFeesOptions): Promise;\n interface CalculateServiceFeesOptions {\n /**\n * DEPRECATED. Defines the app that the rule is connected to.\n * @deprecated DEPRECATED. Defines the app that the rule is connected to.\n * @replacedBy app_id\n * @targetRemovalDate 2023-02-19\n */\n label?: string | null;\n /** Defines the app that the rule is connected to. */\n appId?: string | null;\n }\n /**\n * The `createRule()` function returns a Promise that resolves to the created rule.\n *\n *\n * To create multiple rules at once, use the `bulkCreateRules()` function.\n * @param rule - Rule to create.\n * @public\n * @documentationMaturity preview\n * @requiredField rule\n * @requiredField rule.enabled\n * @requiredField rule.name\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created rule\n */\n function createRule(rule: Rule$1): Promise;\n /**\n * The `createRule()` function returns a Promise that resolves to the retrieved rule.\n * @param ruleId - ID of the rule to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField ruleId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns The retrieved rule.\n */\n function getRule(ruleId: string): Promise;\n /**\n * The `updateRule()` function returns a Promise that resolves to the updated rule.\n *\n *\n * Each time the task is updated, `revision` increments by 1. The existing `revision` must be included when updating the task. This ensures you're working with the latest task and prevents unintended overwrites.\n *\n * To update multiple rules at once, use the `bulkUpdateRules()` function.\n * @param _id - Rule ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField rule\n * @requiredField rule.revision\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated rule.\n */\n function updateRule(_id: string | null, rule: UpdateRule, options?: UpdateRuleOptions): Promise;\n interface UpdateRule {\n /**\n * Fixed fee. Must hold a positive value.\n * @deprecated Fixed fee. Must hold a positive value.\n * @replacedBy fixed_fee\n * @targetRemovalDate 2024-02-15\n */\n amount?: CommonMoney;\n /**\n * Percentage fee. For example, `5` represents a 5% fee applied to the order's total.\n * @deprecated\n * @replacedBy percentage_fee\n * @targetRemovalDate 2024-02-15\n */\n percentage?: string | null;\n /** Fixed fee. Must hold a positive value. */\n fixedFee?: Money;\n /**\n * Percentage fee. For example, 5 represents a 5% fee applied to the order's total.\n *\n * Min: `0`.\n *\n * Max: `100`.\n */\n percentageFee?: string | null;\n /**\n * Single condition that must be met for the rule to be applied to an order.\n * @deprecated Single condition that must be met for the rule to be applied to an order.\n * @replacedBy condition_options\n * @targetRemovalDate 2024-02-15\n */\n condition?: Condition;\n /**\n * Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.\n * @deprecated Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.\n * @replacedBy condition_tree_options\n * @targetRemovalDate 2024-02-15\n */\n conditionTree?: ConditionTree;\n /** Single condition that must be met for the rule to be applied to an order. */\n conditionOptions?: Condition;\n /** Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order. */\n conditionTreeOptions?: ConditionTree;\n /** Percentage value to apply as a custom tax rate. Range: [0-100]. */\n customTaxRate?: string | null;\n /** Tax group ID. Internal only. */\n taxGroupId?: string | null;\n /**\n * Rule ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the restaurant’s [location](/locations/introduction). */\n locationId?: string | null;\n /** Rule name. */\n name?: string | null;\n /**\n * Date and time the rule was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the rule was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Percentage value to apply as a custom tax rate. For example, `5` respresents a 5% fee applied to the order's total.
      \n * Min: '0'.
      \n * Max: `100`.\n * @deprecated\n * @replacedBy taxes\n * @targetRemovalDate 2023-09-16\n */\n taxRate?: string | null;\n /**\n * Specifies the type of condition.\n * @deprecated Specifies the type of condition.\n * @replacedBy condition_type\n * @targetRemovalDate 2024-02-15\n */\n conditionsType?: ConditionsType;\n /** Specifies the type of condition. */\n conditionType?: ConditionType;\n /** Whether the rule is enabled. If `true`, the rule is evaluated when service fees are calculated. If `false`, the rule will not be evaluated when service fees are calculated. */\n enabled?: boolean | null;\n /**\n * Revision number. Increments by 1 each time the rule is updated.\n * To prevent conflicting changes, the existing `revision` must be used when updating a rule.\n * @readonly\n */\n revision?: string | null;\n /**\n * DEPRECATED. Defines the app that the rule is connected to.\n * @deprecated DEPRECATED. Defines the app that the rule is connected to.\n * @replacedBy app_id\n * @targetRemovalDate 2023-02-19\n */\n label?: string | null;\n /** Defines the app that the rule is connected to. */\n appId?: string | null;\n /**\n * Rounding strategy to apply to fee and tax calculation.\n *\n * Supported values:\n *\n * - `\"HALF_UP\"`: Rounds up any number exactly halfway between two integers. For example, `2.5` rounds to `3`, and `3.5` and rounds to `4`.\n * - `\"HALF_EVEN\"`: Rounds such numbers to the nearest even integer. For example, `2.5` rounds to `2`, but `3.5` rounds to `4`.\n * - `\"UNKNOWN_ROUNDING_STRATEGY\"`\n */\n roundingStrategy?: RoundingStrategy;\n }\n interface UpdateRuleOptions {\n }\n /**\n * The `deleteRule()` function returns a Promise that resolves to void.\n *\n *\n * To delete multiple rules at once, use the `bulkDeleteRules()` function.\n * @param ruleId - ID of the rule to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField ruleId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteRule(ruleId: string): Promise;\n /**\n * The `listRules()` function returns a Promise that resolves to an array of the retrieved rules.\n *\n *\n * You can filter by location or app that the rules are associated with.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listRules(options?: ListRulesOptions): Promise;\n interface ListRulesOptions {\n /** Retrieve only rule that apply at the [location](https://dev.wix.com/docs/rest/api-reference/business-tools/locations/location-object) with this ID. If this field is `null`, the rules will not be filtered by location. */\n locationId?: string | null;\n /**\n * DEPRECATED. Defines the app that the rule is connected to.\n * @deprecated DEPRECATED. Defines the app that the rule is connected to.\n * @replacedBy app_id\n * @targetRemovalDate 2023-02-19\n */\n label?: string | null;\n /** Defines the app that the rule is connected to. */\n appId?: string | null;\n }\n /**\n * Creates a query to retrieve a list of rules.\n *\n *\n * The `queryRules()` function builds a query to retrieve a list of up to 1,000 rules and returns a `RulesQueryBuilder` object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](/service-fees/rules-query-builder/find) function.\n *\n * You can refine the query by chaining `RulesQueryBuilder` functions onto the query. `RulesQueryBuilder` functions enable you to sort, filter, and control the results that `queryRules()` returns. The functions that are chained to `queryRules()` are applied in the order they are called.\n *\n * `queryRules()` runs with the following `RulesQueryBuilder` defaults that you can override:\n *\n * * [`limit(50)`](/service-fees/rules-query-builder/limit)\n * * [`ascending('entityId')`](/service-fees/rules-query-builder/ascending)\n *\n * The following `QueryRulesBuilder` functions are supported for the `queryRules()` function. For a full description of the Rules object, see the object returned for the [`items`](/service-fees/rules-query-builder/items) property in `RulesQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId WIX_RESTAURANTS.SERVICE_FEES_RULES_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryRules(): RulesQueryBuilder;\n interface QueryCursorResult$7 {\n cursors: Cursors$7;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface RulesQueryResult extends QueryCursorResult$7 {\n items: Rule$1[];\n query: RulesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface RulesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\", value: any) => RulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\", value: any) => RulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\", value: string) => RulesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\", value: any[]) => RulesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\", value: any) => RulesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\", value: boolean) => RulesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\">) => RulesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\">) => RulesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => RulesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => RulesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * The `bulkCreateRules()` function returns a Promise that resolves to the created rules.\n *\n *\n * To create only one rule, use the `createRule()` function.\n * @param rules - Rules to create.\n * @public\n * @documentationMaturity preview\n * @requiredField rules\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateRules(rules: Rule$1[], options?: BulkCreateRulesOptions): Promise;\n interface BulkCreateRulesOptions {\n /**\n * Whether the full rule entity is returned.
      \n * Default: `false`.\n */\n returnFullEntity?: boolean;\n }\n /**\n * The `bulkUpdateRules()` function returns a Promise that resolves to the updated rules.\n *\n *\n * Each time the task is updated, `revision` increments by 1. The existing `revision` must be included when updating the task. This ensures you're working with the latest task and prevents unintended overwrites.\n *\n * To update only one rule, use the `updateRule()` function.\n * @param rules - Masked rules to update.\n * @public\n * @documentationMaturity preview\n * @requiredField rules\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateRules(rules: MaskedRule[], options?: BulkUpdateRulesOptions): Promise;\n interface BulkUpdateRulesOptions {\n /**\n * Whether the full rule entity is returned.
      \n * Default: `false`.\n */\n returnFullEntity?: boolean;\n }\n /**\n * The `bulkDeleteRules()` function returns a Promise that resolves to the deleted rules.\n *\n *\n * To delete only one rule, use the `deleteRule()` function.\n * @param ruleIds - IDs of the rules to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField ruleIds\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteRules(ruleIds: string[]): Promise;\n type serviceFeesV1RuleServiceFees_universal_d_RuleValueOneOf = RuleValueOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_RuleRequirementsOneOf = RuleRequirementsOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_RuleConditionsOneOf = RuleConditionsOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_RuleConditionTypeOptionsOneOf = RuleConditionTypeOptionsOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_RuleTaxesOneOf = RuleTaxesOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_CommonMoney = CommonMoney;\n type serviceFeesV1RuleServiceFees_universal_d_Money = Money;\n type serviceFeesV1RuleServiceFees_universal_d_Condition = Condition;\n type serviceFeesV1RuleServiceFees_universal_d_ConditionValueOneOf = ConditionValueOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_ExpectedType = ExpectedType;\n type serviceFeesV1RuleServiceFees_universal_d_Value = Value;\n const serviceFeesV1RuleServiceFees_universal_d_Value: typeof Value;\n type serviceFeesV1RuleServiceFees_universal_d_ExpectedFieldType = ExpectedFieldType;\n const serviceFeesV1RuleServiceFees_universal_d_ExpectedFieldType: typeof ExpectedFieldType;\n type serviceFeesV1RuleServiceFees_universal_d__Number = _Number;\n type serviceFeesV1RuleServiceFees_universal_d_List = List;\n type serviceFeesV1RuleServiceFees_universal_d_ConditionTree = ConditionTree;\n type serviceFeesV1RuleServiceFees_universal_d_ConditionTreeLeftConditionNodeOneOf = ConditionTreeLeftConditionNodeOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_ConditionTreeRightConditionNodeOneOf = ConditionTreeRightConditionNodeOneOf;\n type serviceFeesV1RuleServiceFees_universal_d_Operator = Operator;\n const serviceFeesV1RuleServiceFees_universal_d_Operator: typeof Operator;\n type serviceFeesV1RuleServiceFees_universal_d_ConditionsType = ConditionsType;\n const serviceFeesV1RuleServiceFees_universal_d_ConditionsType: typeof ConditionsType;\n type serviceFeesV1RuleServiceFees_universal_d_ConditionType = ConditionType;\n const serviceFeesV1RuleServiceFees_universal_d_ConditionType: typeof ConditionType;\n type serviceFeesV1RuleServiceFees_universal_d_RoundingStrategy = RoundingStrategy;\n const serviceFeesV1RuleServiceFees_universal_d_RoundingStrategy: typeof RoundingStrategy;\n type serviceFeesV1RuleServiceFees_universal_d_CalculateServiceFeesRequest = CalculateServiceFeesRequest;\n type serviceFeesV1RuleServiceFees_universal_d_Order = Order;\n type serviceFeesV1RuleServiceFees_universal_d_PriceSummary = PriceSummary;\n type serviceFeesV1RuleServiceFees_universal_d_ShippingInformation = ShippingInformation;\n type serviceFeesV1RuleServiceFees_universal_d_DeliveryLogistics = DeliveryLogistics;\n type serviceFeesV1RuleServiceFees_universal_d_Platform = Platform;\n type serviceFeesV1RuleServiceFees_universal_d_PlatformValue = PlatformValue;\n const serviceFeesV1RuleServiceFees_universal_d_PlatformValue: typeof PlatformValue;\n type serviceFeesV1RuleServiceFees_universal_d_CalculateServiceFeesResponse = CalculateServiceFeesResponse;\n type serviceFeesV1RuleServiceFees_universal_d_CalculatedFee = CalculatedFee;\n type serviceFeesV1RuleServiceFees_universal_d_CreateRuleRequest = CreateRuleRequest;\n type serviceFeesV1RuleServiceFees_universal_d_CreateRuleResponse = CreateRuleResponse;\n type serviceFeesV1RuleServiceFees_universal_d_GetRuleRequest = GetRuleRequest;\n type serviceFeesV1RuleServiceFees_universal_d_GetRuleResponse = GetRuleResponse;\n type serviceFeesV1RuleServiceFees_universal_d_UpdateRuleRequest = UpdateRuleRequest;\n type serviceFeesV1RuleServiceFees_universal_d_UpdateRuleResponse = UpdateRuleResponse;\n type serviceFeesV1RuleServiceFees_universal_d_DeleteRuleRequest = DeleteRuleRequest;\n type serviceFeesV1RuleServiceFees_universal_d_DeleteRuleResponse = DeleteRuleResponse;\n type serviceFeesV1RuleServiceFees_universal_d_ListRulesRequest = ListRulesRequest;\n type serviceFeesV1RuleServiceFees_universal_d_ListRulesResponse = ListRulesResponse;\n type serviceFeesV1RuleServiceFees_universal_d_QueryRulesRequest = QueryRulesRequest;\n type serviceFeesV1RuleServiceFees_universal_d_QueryRulesResponse = QueryRulesResponse;\n type serviceFeesV1RuleServiceFees_universal_d_BulkCreateRulesRequest = BulkCreateRulesRequest;\n type serviceFeesV1RuleServiceFees_universal_d_BulkCreateRulesResponse = BulkCreateRulesResponse;\n type serviceFeesV1RuleServiceFees_universal_d_BulkRuleResult = BulkRuleResult;\n type serviceFeesV1RuleServiceFees_universal_d_BulkUpdateRulesRequest = BulkUpdateRulesRequest;\n type serviceFeesV1RuleServiceFees_universal_d_MaskedRule = MaskedRule;\n type serviceFeesV1RuleServiceFees_universal_d_BulkUpdateRulesResponse = BulkUpdateRulesResponse;\n type serviceFeesV1RuleServiceFees_universal_d_BulkDeleteRulesRequest = BulkDeleteRulesRequest;\n type serviceFeesV1RuleServiceFees_universal_d_BulkDeleteRulesResponse = BulkDeleteRulesResponse;\n const serviceFeesV1RuleServiceFees_universal_d_calculateServiceFees: typeof calculateServiceFees;\n type serviceFeesV1RuleServiceFees_universal_d_CalculateServiceFeesOptions = CalculateServiceFeesOptions;\n const serviceFeesV1RuleServiceFees_universal_d_createRule: typeof createRule;\n const serviceFeesV1RuleServiceFees_universal_d_getRule: typeof getRule;\n const serviceFeesV1RuleServiceFees_universal_d_updateRule: typeof updateRule;\n type serviceFeesV1RuleServiceFees_universal_d_UpdateRule = UpdateRule;\n type serviceFeesV1RuleServiceFees_universal_d_UpdateRuleOptions = UpdateRuleOptions;\n const serviceFeesV1RuleServiceFees_universal_d_deleteRule: typeof deleteRule;\n const serviceFeesV1RuleServiceFees_universal_d_listRules: typeof listRules;\n type serviceFeesV1RuleServiceFees_universal_d_ListRulesOptions = ListRulesOptions;\n const serviceFeesV1RuleServiceFees_universal_d_queryRules: typeof queryRules;\n type serviceFeesV1RuleServiceFees_universal_d_RulesQueryResult = RulesQueryResult;\n type serviceFeesV1RuleServiceFees_universal_d_RulesQueryBuilder = RulesQueryBuilder;\n const serviceFeesV1RuleServiceFees_universal_d_bulkCreateRules: typeof bulkCreateRules;\n type serviceFeesV1RuleServiceFees_universal_d_BulkCreateRulesOptions = BulkCreateRulesOptions;\n const serviceFeesV1RuleServiceFees_universal_d_bulkUpdateRules: typeof bulkUpdateRules;\n type serviceFeesV1RuleServiceFees_universal_d_BulkUpdateRulesOptions = BulkUpdateRulesOptions;\n const serviceFeesV1RuleServiceFees_universal_d_bulkDeleteRules: typeof bulkDeleteRules;\n namespace serviceFeesV1RuleServiceFees_universal_d {\n export { Rule$1 as Rule, serviceFeesV1RuleServiceFees_universal_d_RuleValueOneOf as RuleValueOneOf, serviceFeesV1RuleServiceFees_universal_d_RuleRequirementsOneOf as RuleRequirementsOneOf, serviceFeesV1RuleServiceFees_universal_d_RuleConditionsOneOf as RuleConditionsOneOf, serviceFeesV1RuleServiceFees_universal_d_RuleConditionTypeOptionsOneOf as RuleConditionTypeOptionsOneOf, serviceFeesV1RuleServiceFees_universal_d_RuleTaxesOneOf as RuleTaxesOneOf, serviceFeesV1RuleServiceFees_universal_d_CommonMoney as CommonMoney, serviceFeesV1RuleServiceFees_universal_d_Money as Money, serviceFeesV1RuleServiceFees_universal_d_Condition as Condition, serviceFeesV1RuleServiceFees_universal_d_ConditionValueOneOf as ConditionValueOneOf, serviceFeesV1RuleServiceFees_universal_d_ExpectedType as ExpectedType, serviceFeesV1RuleServiceFees_universal_d_Value as Value, serviceFeesV1RuleServiceFees_universal_d_ExpectedFieldType as ExpectedFieldType, serviceFeesV1RuleServiceFees_universal_d__Number as _Number, Operation$1 as Operation, serviceFeesV1RuleServiceFees_universal_d_List as List, serviceFeesV1RuleServiceFees_universal_d_ConditionTree as ConditionTree, serviceFeesV1RuleServiceFees_universal_d_ConditionTreeLeftConditionNodeOneOf as ConditionTreeLeftConditionNodeOneOf, serviceFeesV1RuleServiceFees_universal_d_ConditionTreeRightConditionNodeOneOf as ConditionTreeRightConditionNodeOneOf, serviceFeesV1RuleServiceFees_universal_d_Operator as Operator, serviceFeesV1RuleServiceFees_universal_d_ConditionsType as ConditionsType, serviceFeesV1RuleServiceFees_universal_d_ConditionType as ConditionType, serviceFeesV1RuleServiceFees_universal_d_RoundingStrategy as RoundingStrategy, serviceFeesV1RuleServiceFees_universal_d_CalculateServiceFeesRequest as CalculateServiceFeesRequest, serviceFeesV1RuleServiceFees_universal_d_Order as Order, serviceFeesV1RuleServiceFees_universal_d_PriceSummary as PriceSummary, serviceFeesV1RuleServiceFees_universal_d_ShippingInformation as ShippingInformation, serviceFeesV1RuleServiceFees_universal_d_DeliveryLogistics as DeliveryLogistics, Type$1 as Type, serviceFeesV1RuleServiceFees_universal_d_Platform as Platform, serviceFeesV1RuleServiceFees_universal_d_PlatformValue as PlatformValue, Locale$3 as Locale, serviceFeesV1RuleServiceFees_universal_d_CalculateServiceFeesResponse as CalculateServiceFeesResponse, serviceFeesV1RuleServiceFees_universal_d_CalculatedFee as CalculatedFee, serviceFeesV1RuleServiceFees_universal_d_CreateRuleRequest as CreateRuleRequest, serviceFeesV1RuleServiceFees_universal_d_CreateRuleResponse as CreateRuleResponse, serviceFeesV1RuleServiceFees_universal_d_GetRuleRequest as GetRuleRequest, serviceFeesV1RuleServiceFees_universal_d_GetRuleResponse as GetRuleResponse, serviceFeesV1RuleServiceFees_universal_d_UpdateRuleRequest as UpdateRuleRequest, serviceFeesV1RuleServiceFees_universal_d_UpdateRuleResponse as UpdateRuleResponse, serviceFeesV1RuleServiceFees_universal_d_DeleteRuleRequest as DeleteRuleRequest, serviceFeesV1RuleServiceFees_universal_d_DeleteRuleResponse as DeleteRuleResponse, serviceFeesV1RuleServiceFees_universal_d_ListRulesRequest as ListRulesRequest, serviceFeesV1RuleServiceFees_universal_d_ListRulesResponse as ListRulesResponse, serviceFeesV1RuleServiceFees_universal_d_QueryRulesRequest as QueryRulesRequest, CursorQuery$7 as CursorQuery, CursorQueryPagingMethodOneOf$7 as CursorQueryPagingMethodOneOf, Sorting$7 as Sorting, SortOrder$7 as SortOrder, CursorPaging$7 as CursorPaging, serviceFeesV1RuleServiceFees_universal_d_QueryRulesResponse as QueryRulesResponse, CursorPagingMetadata$7 as CursorPagingMetadata, Cursors$7 as Cursors, serviceFeesV1RuleServiceFees_universal_d_BulkCreateRulesRequest as BulkCreateRulesRequest, serviceFeesV1RuleServiceFees_universal_d_BulkCreateRulesResponse as BulkCreateRulesResponse, serviceFeesV1RuleServiceFees_universal_d_BulkRuleResult as BulkRuleResult, ItemMetadata$5 as ItemMetadata, ApplicationError$5 as ApplicationError, BulkActionMetadata$5 as BulkActionMetadata, serviceFeesV1RuleServiceFees_universal_d_BulkUpdateRulesRequest as BulkUpdateRulesRequest, serviceFeesV1RuleServiceFees_universal_d_MaskedRule as MaskedRule, serviceFeesV1RuleServiceFees_universal_d_BulkUpdateRulesResponse as BulkUpdateRulesResponse, serviceFeesV1RuleServiceFees_universal_d_BulkDeleteRulesRequest as BulkDeleteRulesRequest, serviceFeesV1RuleServiceFees_universal_d_BulkDeleteRulesResponse as BulkDeleteRulesResponse, DomainEvent$7 as DomainEvent, DomainEventBodyOneOf$7 as DomainEventBodyOneOf, EntityCreatedEvent$7 as EntityCreatedEvent, RestoreInfo$7 as RestoreInfo, EntityUpdatedEvent$7 as EntityUpdatedEvent, EntityDeletedEvent$7 as EntityDeletedEvent, ActionEvent$7 as ActionEvent, MessageEnvelope$7 as MessageEnvelope, IdentificationData$7 as IdentificationData, IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf, WebhookIdentityType$7 as WebhookIdentityType, serviceFeesV1RuleServiceFees_universal_d_calculateServiceFees as calculateServiceFees, serviceFeesV1RuleServiceFees_universal_d_CalculateServiceFeesOptions as CalculateServiceFeesOptions, serviceFeesV1RuleServiceFees_universal_d_createRule as createRule, serviceFeesV1RuleServiceFees_universal_d_getRule as getRule, serviceFeesV1RuleServiceFees_universal_d_updateRule as updateRule, serviceFeesV1RuleServiceFees_universal_d_UpdateRule as UpdateRule, serviceFeesV1RuleServiceFees_universal_d_UpdateRuleOptions as UpdateRuleOptions, serviceFeesV1RuleServiceFees_universal_d_deleteRule as deleteRule, serviceFeesV1RuleServiceFees_universal_d_listRules as listRules, serviceFeesV1RuleServiceFees_universal_d_ListRulesOptions as ListRulesOptions, serviceFeesV1RuleServiceFees_universal_d_queryRules as queryRules, serviceFeesV1RuleServiceFees_universal_d_RulesQueryResult as RulesQueryResult, serviceFeesV1RuleServiceFees_universal_d_RulesQueryBuilder as RulesQueryBuilder, serviceFeesV1RuleServiceFees_universal_d_bulkCreateRules as bulkCreateRules, serviceFeesV1RuleServiceFees_universal_d_BulkCreateRulesOptions as BulkCreateRulesOptions, serviceFeesV1RuleServiceFees_universal_d_bulkUpdateRules as bulkUpdateRules, serviceFeesV1RuleServiceFees_universal_d_BulkUpdateRulesOptions as BulkUpdateRulesOptions, serviceFeesV1RuleServiceFees_universal_d_bulkDeleteRules as bulkDeleteRules, };\n }\n /**\n * An operation is a service a restaurant offers that includes various aspects of its online ordering.\n * You can define default fulfillments, service fees, and scheduling requirements for each operation.\n */\n interface Operation extends OperationOnlineOrderingStatusOptionsOneOf {\n /** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */\n pausedUntilOptions?: OnlineOrderingPausedUntilOptions;\n /**\n * Operation ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number. Increments by 1 each time the operation is updated.\n * To prevent conflicting changes,\n * the existing `revision` must be passed when updating an operation.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the operation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the operation was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Operation name. */\n name?: string | null;\n /**\n * Whether the operation is the default operation.
      \n * Default: `false`.\n */\n default?: boolean | null;\n /** IDs of the [fulfillment methods](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/fulfillment-methods/introduction) associated with the operation. */\n fulfillmentIds?: string[] | null;\n /**\n * Online ordering status of the operation.
      \n * - `ENABLED`: Operation currently accepts online orders.
      \n * - `DISABLED`: Operation currently does not accept online orders.
      \n * - `PAUSED_UNTIL`: Operation currently does not accept online orders, but will accept online orders from a specifed time and date. When applied, `pausedUntilOptions` is a required field.
      \n * - `UNDEFINED_ONLINE_ORDERING_STATUS`: Online ordering status is not defined.\n */\n onlineOrderingStatus?: OnlineOrderingStatusType;\n /** IDs of the [service fee](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/introduction) rules associated with the operation. */\n serviceFeeRuleIds?: string[] | null;\n /** Default fulfillment type of the operation. */\n defaultFulfillmentType?: FulfillmentType;\n /** Information about when an order can be placed for. */\n orderScheduling?: OrderScheduling;\n }\n /** @oneof */\n interface OperationOnlineOrderingStatusOptionsOneOf {\n /** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */\n pausedUntilOptions?: OnlineOrderingPausedUntilOptions;\n }\n /** Information about when an order can be placed for. */\n interface Scheduling extends SchedulingSchedulingOptionsOneOf {\n /** Options for scheduling. Required when `type` is `ASAP`. */\n asapOptions?: AsapScheduling;\n /** Options for scheduling. Required when `type` is `REQUIRED`. */\n preorderOptions?: PreorderScheduling;\n /**\n * Scheduling type.
      \n * - When `ASAP`, `asapOptions` is a required field.\n * - When `PREORDER`, `preorderOptions` is a required field.\n */\n type?: SchedulingType;\n }\n /** @oneof */\n interface SchedulingSchedulingOptionsOneOf {\n /** Options for scheduling. Required when `type` is `ASAP`. */\n asapOptions?: AsapScheduling;\n /** Options for scheduling. Required when `type` is `REQUIRED`. */\n preorderOptions?: PreorderScheduling;\n }\n /** Scheduling type enum. */\n enum SchedulingType {\n /** Unknown scheduling type. */\n UNKNOWN_SCHEDULING = \"UNKNOWN_SCHEDULING\",\n /** Orders can be scheduled for the future and to be handled immediately. */\n ASAP = \"ASAP\",\n /** Orders can be scheduled only for the future. */\n PREORDER = \"PREORDER\"\n }\n /** Options for scheduling. Required if `type` is `ASAP`. */\n interface AsapScheduling extends AsapSchedulingPreparationTimeOneOf, AsapSchedulingAsapPreorderOneOf {\n /** Options for preparation time. Required when `type` is `MAX_TIME`. */\n maxOptions?: TimeDuration;\n /** Options for preparation time. Required when `type` is `TIME_RANGE`. */\n rangeOptions?: TimeDurationRange;\n /** Information for when orders must be made a set number of business days in advance. */\n businessDaysPreorderOptions?: BusinessDaysPreorder;\n /** How to define the time needed to prepare an order. */\n type?: PreparationTimeType;\n /**\n * Indication of whether it is possible to place an order for a later time on the same day.\n * @deprecated Indication of whether it is possible to place an order for a later time on the same day.\n * @replacedBy asap_preorder_type\n * @targetRemovalDate 2023-12-28\n */\n allowSameDayPreorder?: boolean | null;\n /** The type of preorder allowed for the ASAP scheduling. */\n asapPreorderType?: AsapPreorderType;\n }\n /** @oneof */\n interface AsapSchedulingPreparationTimeOneOf {\n /** Options for preparation time. Required when `type` is `MAX_TIME`. */\n maxOptions?: TimeDuration;\n /** Options for preparation time. Required when `type` is `TIME_RANGE`. */\n rangeOptions?: TimeDurationRange;\n }\n /** @oneof */\n interface AsapSchedulingAsapPreorderOneOf {\n /** Information for when orders must be made a set number of business days in advance. */\n businessDaysPreorderOptions?: BusinessDaysPreorder;\n }\n /** Preparation time type enum. */\n enum PreparationTimeType {\n /** Unknown preparation time type. */\n UNKNOWN_PREPARATION_TIME = \"UNKNOWN_PREPARATION_TIME\",\n /** Preparation time that is bounded by a maximum time. */\n MAX = \"MAX\",\n /** Preparation time that is bounded by a range of times. */\n RANGE = \"RANGE\"\n }\n /** Time duration. */\n interface TimeDuration {\n /** Unit of time for the duration. */\n timeUnit?: TimeUnit;\n /** Duration value. Unit of time specified in `timeUnit`. */\n duration?: number | null;\n }\n /** Time unit enum. */\n enum TimeUnit {\n /** Unknown time unit. */\n UNKNOWN_TIME_UNIT = \"UNKNOWN_TIME_UNIT\",\n /** Minutes time unit. */\n MINUTES = \"MINUTES\",\n /** Hours time unit. */\n HOURS = \"HOURS\",\n /** Days time unit. */\n DAYS = \"DAYS\"\n }\n /** Time range for preparation. */\n interface TimeDurationRange {\n /** Time unit for the time range. */\n timeUnit?: TimeUnit;\n /** Minimum duration value. Unit of time specified in `timeUnit`. */\n minDuration?: number | null;\n /** Maximum duration value. Unit of time specified in `timeUnit`. */\n maxDuration?: number | null;\n }\n /** Asap preorder type enum. */\n enum AsapPreorderType {\n /** Unknown ASAP preorder type. */\n UNKNOWN_ASAP_PREORDER = \"UNKNOWN_ASAP_PREORDER\",\n /** Doesn't allow preorder. */\n NO_PREORDER = \"NO_PREORDER\",\n /** Allows preorder for a maximum specified number of business days in advance. */\n BUSINESS_DAYS_PREORDER = \"BUSINESS_DAYS_PREORDER\"\n }\n /** Information for when orders must be made a set number of business days in advance. */\n interface BusinessDaysPreorder {\n /**\n * Maximum number of business days an order can be scheduled in advance.\n *\n * When `0`, an order can be scheduled only until the end of the current business day.\n * For any other value, the order can be scheduled for the end of the business day in that many days.\n * For example, `5` means the order can be scheduled for any time before the end of the 5th business day from today (where today is \"day 0\").\n */\n businessDays?: number | null;\n }\n /** Information about preorders. */\n interface PreorderScheduling {\n method?: PreorderMethod;\n /**\n * Configuration of the fulfillment times.
      \n * Currenly, only `TIME_WINDOWS` is supported.\n */\n fulfillmentTimesDisplay?: FulfillmentTimesDisplayConfig;\n }\n /** Method for `PREORDER` scheduling type. */\n interface PreorderMethod extends PreorderMethodMethodOptionsOneOf {\n /** Options for method. Required when `type` is `TIME_BOUNDED`. */\n timeBoundedOptions?: TimeBounded;\n /** Options for method. Required when `type` is `WEEKLY_SCHEDULE`. */\n weeklyScheduleOptions?: WeeklySchedule;\n /**\n * Type of time frame for how long in advance preorders can be made.
      \n * - When `TIME_BOUNDED`, `timeBoundedOptions` is a required field.\n * - When `WEEKLY_SCHEDULE`, `weeklyScheduleOptions` is a required field.\n */\n type?: MethodType;\n }\n /** @oneof */\n interface PreorderMethodMethodOptionsOneOf {\n /** Options for method. Required when `type` is `TIME_BOUNDED`. */\n timeBoundedOptions?: TimeBounded;\n /** Options for method. Required when `type` is `WEEKLY_SCHEDULE`. */\n weeklyScheduleOptions?: WeeklySchedule;\n }\n /** Day of the week and time of the day. */\n interface DayAndTime {\n /** Day of the week. */\n dayOfWeek?: EntitiesDayOfWeek$2;\n /** Time of the day. */\n timeOfDay?: TimeOfDay$2;\n }\n enum EntitiesDayOfWeek$2 {\n /** Monday. */\n MON = \"MON\",\n /** Tuesday. */\n TUE = \"TUE\",\n /** Wednesday. */\n WED = \"WED\",\n /** Thursday. */\n THU = \"THU\",\n /** Friday. */\n FRI = \"FRI\",\n /** Saturday. */\n SAT = \"SAT\",\n /** Sunday. */\n SUN = \"SUN\"\n }\n interface TimeOfDay$2 {\n /**\n * Hours.
      \n * Min: `0`.
      \n * Max: `23`.\n */\n hours?: number;\n /**\n * Minutes.
      \n * Min: `0`.
      \n * Max: `23`.\n */\n minutes?: number;\n }\n /** Preorder method type enum. */\n enum MethodType {\n /** Unknown preorder method type. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /** Preorder time has a minimum and a maximum. */\n TIME_BOUNDED = \"TIME_BOUNDED\",\n /** Preorder have a weekly schedule with a weekly a cutoff time. */\n WEEKLY_SCHEDULE = \"WEEKLY_SCHEDULE\"\n }\n /** Information about the time range when preorders are time bounded. */\n interface TimeBounded {\n /** Minimum time required to schedule the order. */\n minTimeInAdvance?: TimeDuration;\n /** Maximum time allowed to schedule the order. */\n maxTimeInAdvance?: TimeDuration;\n }\n /** Options for method. Required when `type` is `WEEKLY_SCHEDULE`. */\n interface WeeklySchedule {\n /**\n * The weekly schedule cutoff time.
      \n * Orders placed before the cutoff time are scheduled for the current week.
      \n * Orders placed after the cutoff time are scheduled for the next week.\n */\n cutOffTime?: DayAndTime;\n }\n /** Way by which fulfillment times should be displayed. */\n interface FulfillmentTimesDisplayConfig extends FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {\n /** Options for fulfillment time. Required when `fulfillmentTimesType` is `TIME_WINDOWS`. */\n timeWindowsOptions?: TimeDuration;\n /**\n * Type of the fulfillment times.
      \n * When `TIME_WINDOWS`, `timeWindowsOptions` is a required field.\n */\n type?: FulfillmentTimesType;\n }\n /** @oneof */\n interface FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {\n /** Options for fulfillment time. Required when `fulfillmentTimesType` is `TIME_WINDOWS`. */\n timeWindowsOptions?: TimeDuration;\n }\n /** The fulfillment times type enum. */\n enum FulfillmentTimesType {\n /** Unknown fulfillment times type. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /** Display fulfillment times as time windows. */\n TIME_WINDOWS = \"TIME_WINDOWS\"\n }\n /** Online ordering status enum. */\n enum OnlineOrderingStatusType {\n /** Undefined online ordering status. */\n UNDEFINED_ONLINE_ORDERING_STATUS = \"UNDEFINED_ONLINE_ORDERING_STATUS\",\n /** Online ordering is enabled. */\n ENABLED = \"ENABLED\",\n /** Online ordering is disabled. */\n DISABLED = \"DISABLED\",\n /** Online ordering is paused until a specific date and time. */\n PAUSED_UNTIL = \"PAUSED_UNTIL\"\n }\n /** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */\n interface OnlineOrderingPausedUntilOptions {\n /**\n * Date and time until which online ordering is paused.
      \n *\n * Before the specified time, behavior is the same as when `onlineOrderingStatus` is `DISABLED`.
      \n *\n * After the specified time, behavior is the same as when `onlineOrderingStatus` is `ENABLED`.
      \n *\n * Passing the time does not trigger any changes to value of any properties.\n */\n time?: Date;\n }\n /** Fulfillment type enum. */\n enum FulfillmentType {\n /** Undefined fulfillment type. */\n UNDEFINED_FULFILLMENT_TYPE = \"UNDEFINED_FULFILLMENT_TYPE\",\n /** Pickup fulfillment. */\n PICKUP = \"PICKUP\",\n /** Delivery fulfillment. */\n DELIVERY = \"DELIVERY\"\n }\n /** Information about when an order can be placed for. */\n interface OrderScheduling extends OrderSchedulingOrderSchedulingOptionsOneOf {\n /** Options for scheduling. Required if `type` is `ASAP`. */\n asapOptions?: AsapOrderScheduling;\n /** Options for scheduling. Required if `type` is `PREORDER`. */\n preorderOptions?: PreorderScheduling;\n /**\n * Scheduling type.
      \n * - When `ASAP`, `asapOptions` is a required field.\n * - When `PREORDER`, `preorderOptions` is a required field.\n */\n type?: SchedulingType;\n }\n /** @oneof */\n interface OrderSchedulingOrderSchedulingOptionsOneOf {\n /** Options for scheduling. Required if `type` is `ASAP`. */\n asapOptions?: AsapOrderScheduling;\n /** Options for scheduling. Required if `type` is `PREORDER`. */\n preorderOptions?: PreorderScheduling;\n }\n interface AsapOrderScheduling extends AsapOrderSchedulingAsapFutureHandlingOptionsOneOf {\n /** Options for future handling. Required when `asapFutureHandlingType` is `BUSINESS_DAYS_AHEAD_HANDLING`. */\n businessDaysAheadHandlingOptions?: BusinessDaysAheadHandling;\n /**\n * Amount of time needed to prepare the order.
      \n * - When `MAX_TIME`, `maxTimeOptions` is a required field.\n * - When `MAX_RANGE`, `timeRangeOptions` is a required field.\n */\n preparationTime?: PreparationTime;\n /**\n * Defines if and how non-immediate orders should be handled.
      \n * When `BUSINESS_DAYS_AHEAD_HANDLING`, `businessDaysAheadHandlingOptions` is a required field.\n */\n asapFutureHandlingType?: AsapFutureHandlingType;\n }\n /** @oneof */\n interface AsapOrderSchedulingAsapFutureHandlingOptionsOneOf {\n /** Options for future handling. Required when `asapFutureHandlingType` is `BUSINESS_DAYS_AHEAD_HANDLING`. */\n businessDaysAheadHandlingOptions?: BusinessDaysAheadHandling;\n }\n interface PreparationTime extends PreparationTimeTimeSpecificationOneOf {\n /** Options for preparation time. Required when `type` is `MAX_TIME`. */\n maxTimeOptions?: TimeDuration;\n /** Options for preparation time. Required when `type` is `TIME_RANGE`. */\n timeRangeOptions?: TimeDurationRange;\n /** Preparation time type. */\n type?: PreparationTimePreparationTimeType;\n }\n /** @oneof */\n interface PreparationTimeTimeSpecificationOneOf {\n /** Options for preparation time. Required when `type` is `MAX_TIME`. */\n maxTimeOptions?: TimeDuration;\n /** Options for preparation time. Required when `type` is `TIME_RANGE`. */\n timeRangeOptions?: TimeDurationRange;\n }\n /** Preparation time type enum. */\n enum PreparationTimePreparationTimeType {\n /** Unknown preparation time type. */\n UNKNOWN_PREPARATION_TIME = \"UNKNOWN_PREPARATION_TIME\",\n /** Options for preparation time. Required when `type` is `MAX_TIME`. */\n MAX_TIME = \"MAX_TIME\",\n /** Options for preparation time. Required when `type` is `TIME_RANGE`. */\n TIME_RANGE = \"TIME_RANGE\"\n }\n enum AsapFutureHandlingType {\n /** Unknown asap future handling type. */\n UNKNOWN_ASAP_FUTURE_HANDLING = \"UNKNOWN_ASAP_FUTURE_HANDLING\",\n /** No future handling. */\n NO_FUTURE_HANDLING = \"NO_FUTURE_HANDLING\",\n /** Allows future orders for up to a specified number of business days ahead. */\n BUSINESS_DAYS_AHEAD_HANDLING = \"BUSINESS_DAYS_AHEAD_HANDLING\"\n }\n interface BusinessDaysAheadHandling {\n /**\n * Number of business days ahead for which orders can be scheduled.
      \n * Setting the `daysCount` to 0 means that orders can be scheduled until the end of the current business day.\n */\n daysCount?: number | null;\n }\n interface DomainEvent$6 extends DomainEventBodyOneOf$6 {\n createdEvent?: EntityCreatedEvent$6;\n updatedEvent?: EntityUpdatedEvent$6;\n deletedEvent?: EntityDeletedEvent$6;\n actionEvent?: ActionEvent$6;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$6 {\n createdEvent?: EntityCreatedEvent$6;\n updatedEvent?: EntityUpdatedEvent$6;\n deletedEvent?: EntityDeletedEvent$6;\n actionEvent?: ActionEvent$6;\n }\n interface EntityCreatedEvent$6 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$6;\n }\n interface RestoreInfo$6 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$6 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$6 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$6 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$6 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$6;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$6 extends IdentificationDataIdOneOf$6 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$6;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$6 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$6 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface InvalidateCache$6 extends InvalidateCacheGetByOneOf$6 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$6;\n /** Invalidate by page id */\n page?: Page$6;\n /** Invalidate by URI path */\n uri?: URI$6;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$6;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$6 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$6;\n /** Invalidate by page id */\n page?: Page$6;\n /** Invalidate by URI path */\n uri?: URI$6;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$6;\n }\n interface App$6 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$6 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$6 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$6 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface DeliveryProfileConfiguredForOperation {\n /** Operation */\n operation?: Operation;\n }\n interface OperationsDataCloningCompleted$1 {\n }\n interface CreateOperationRequest {\n /** Operation to create. */\n operation: Operation;\n }\n interface CreateOperationResponse {\n /** Created operation. */\n operation?: Operation;\n }\n interface GetOperationRequest {\n /** ID of the operation to retrieve. */\n operationId: string;\n }\n interface GetOperationResponse {\n /** Retrieved operation. */\n operation?: Operation;\n }\n interface UpdateOperationRequest {\n /** Operation to update. */\n operation: Operation;\n }\n interface UpdateOperationResponse {\n /** Updated operation. */\n operation?: Operation;\n }\n interface DeleteOperationRequest {\n /** ID of the operation to delete. */\n operationId: string;\n }\n interface DeleteOperationResponse {\n }\n interface QueryOperationRequest {\n /** Query options. */\n query: CursorQuery$6;\n }\n interface CursorQuery$6 extends CursorQueryPagingMethodOneOf$6 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$6;\n /**\n * Filter object.\n * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * for more information.\n *\n * For a detailed list of supported filters, see\n * [Supported Filters](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/operations/operations/supported-filters-and-sorting).\n */\n filter?: Record | null;\n /** Sort object. */\n sort?: Sorting$6[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$6 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$6;\n }\n interface Sorting$6 {\n /**\n * Supported properties:\n * - `id`\n * - `createdDate`\n * - `updatedDate`\n * - `name`\n */\n fieldName?: string;\n /**\n * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
      \n *\n * Default: `ASC`\n */\n order?: SortOrder$6;\n }\n enum SortOrder$6 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$6 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryOperationResponse {\n /** Retrieved operations. */\n operations?: Operation[];\n /** Metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$6;\n }\n interface CursorPagingMetadata$6 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors$6;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$6 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface ListOperationsRequest {\n }\n interface ListOperationsResponse {\n /** Retrieved operations. */\n operations?: Operation[];\n }\n interface ListOperationIdsRequest {\n /** metasite id */\n metasiteId: string;\n }\n interface ListOperationIdsResponse {\n /** List of operation ids */\n operationIds?: string[];\n }\n interface ListAvailableFulfillmentOptionsRequest {\n /** Operation ID. Returned fulfillment options will belong to this operation. */\n operationId: string;\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n }\n /** Physical address */\n interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {\n /** Street name and number. */\n streetAddress?: StreetAddress$1;\n /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Country code. */\n country?: string | null;\n /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */\n subdivision?: string | null;\n /** City name. */\n city?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** @oneof */\n interface CommonAddressStreetOneOf$1 {\n /** Street name and number. */\n streetAddress?: StreetAddress$1;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n }\n interface AddressLocation$1 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$1 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n }\n enum SubdivisionType$1 {\n UNKNOWN_SUBDIVISION_TYPE = \"UNKNOWN_SUBDIVISION_TYPE\",\n /** State */\n ADMINISTRATIVE_AREA_LEVEL_1 = \"ADMINISTRATIVE_AREA_LEVEL_1\",\n /** County */\n ADMINISTRATIVE_AREA_LEVEL_2 = \"ADMINISTRATIVE_AREA_LEVEL_2\",\n /** City/town */\n ADMINISTRATIVE_AREA_LEVEL_3 = \"ADMINISTRATIVE_AREA_LEVEL_3\",\n /** Neighborhood/quarter */\n ADMINISTRATIVE_AREA_LEVEL_4 = \"ADMINISTRATIVE_AREA_LEVEL_4\",\n /** Street/block */\n ADMINISTRATIVE_AREA_LEVEL_5 = \"ADMINISTRATIVE_AREA_LEVEL_5\",\n /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */\n COUNTRY = \"COUNTRY\"\n }\n interface ListAvailableFulfillmentOptionsResponse {\n /** Whether pickup fulfillment method is configured for the requested operation. */\n pickupConfigured?: boolean;\n /** Whether delivery fulfillment method is configured for the requested operation. */\n deliveryConfigured?: boolean;\n /** List of the available fulfillment options. */\n fulfillmentOptions?: FulfillmentOption[];\n /** Whether availability exceptions block the fulfillment options. */\n blockedByAvailabilityExceptions?: boolean | null;\n }\n /** Fulfillment method that is currently available to fulfil orders, given its availability and the operation's scheduling configurations. */\n interface FulfillmentOption extends FulfillmentOptionFulfillmentTimeOptionsOneOf, FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf, FulfillmentOptionFulfillmentTypeOptionsOneOf {\n /** Fulfillment time has a maximum time. */\n maxTimeOptions?: number;\n /** Fulfillment time is limitted by a range. */\n durationRangeOptions?: DurationRange;\n /** Options for fulfillment time. Required when `type` is `TIME_WINDOWS`. */\n timeWindowsOptions?: TimeWindowDisplayConfig;\n /** Information about pickup fulfillment types. */\n pickupOptions?: PickupDetails;\n /** Information about delivery fulfillment types. */\n deliveryOptions?: DeliveryDetails;\n /** Fulfillment method ID. */\n _id?: string | null;\n /** Fulfillment option type. */\n type?: FulfillmentType;\n /** Minimum order price to qualify for the fulfillment option. */\n minOrderPrice?: string | null;\n /** Fee for using the fulfillment option. */\n fee?: string | null;\n /** Availability of the fulfillment option. */\n availability?: FulfillmentOptionAvailability;\n /**\n * Fulfillment time type.\n * Relevant only to ASAP operations.\n */\n fulfillmentTimeType?: FulfillmentTimeType;\n /** Fulfillment times display type. Relevant to preorder operations. */\n fulfillmentTimesDisplayType?: FulfillmentTimesDisplayType;\n /**\n * Minimum order price for free fulfillment.\n * If order price exceeds this amount, the given `fee` is waived.\n */\n freeFulfillmentPriceThreshold?: string | null;\n /** Instructions for the fulfillment. */\n instructions?: string | null;\n }\n /** @oneof */\n interface FulfillmentOptionFulfillmentTimeOptionsOneOf {\n /** Fulfillment time has a maximum time. */\n maxTimeOptions?: number;\n /** Fulfillment time is limitted by a range. */\n durationRangeOptions?: DurationRange;\n }\n /** @oneof */\n interface FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf {\n /** Options for fulfillment time. Required when `type` is `TIME_WINDOWS`. */\n timeWindowsOptions?: TimeWindowDisplayConfig;\n }\n /** @oneof */\n interface FulfillmentOptionFulfillmentTypeOptionsOneOf {\n /** Information about pickup fulfillment types. */\n pickupOptions?: PickupDetails;\n /** Information about delivery fulfillment types. */\n deliveryOptions?: DeliveryDetails;\n }\n /** Availability of the fulfillment option. */\n interface FulfillmentOptionAvailability {\n /**\n * Whether it is possible to submit an order for as soon as possible handling.\n * @deprecated Whether it is possible to submit an order for as soon as possible handling.\n * @replacedBy asap_handling_available\n * @targetRemovalDate 2023-11-11\n */\n canSubmitOrderForNow?: boolean;\n /** Date and time at which the fulfillment option's availability starts. */\n startTime?: Date;\n /** Date and time at which the fulfillment option's availability ends. */\n endTime?: Date;\n /**\n * List of availabile times for the days of the week.\n * All the given times must be within the range between `startTime` and `endTime`.\n */\n availableTimes?: DayOfWeekAvailability$2[];\n /** List of availability exceptions that override the availability defined in `availableTimes`. */\n exceptions?: AvailabilityException[];\n /** Timezone for which the available times are given. */\n timeZone?: string | null;\n /** Whether it is possible to submit an order for as soon as possible handling. */\n asapHandlingAvailable?: boolean;\n /** Whether it is possible to submit an order for future handling. */\n futureHandlingAvailable?: boolean | null;\n }\n interface DayOfWeekAvailability$2 {\n /** The day of week this availability relates to. */\n dayOfWeek?: EntitiesDayOfWeek$2;\n /** A list of time ranges during which the fulfillment should be available. */\n timeRanges?: TimeOfDayRange$2[];\n }\n interface TimeOfDayRange$2 {\n /** The start time in time of day representation. */\n startTime?: TimeOfDay$2;\n /** The end time in time of day representation. */\n endTime?: TimeOfDay$2;\n }\n interface AvailabilityException {\n /** The start time of the availability exception. */\n startTime?: Date;\n /** The end time of the availability exception. */\n endTime?: Date;\n /** An indication whether the exception makes the [`start_time`, `end_time`] range available. */\n available?: boolean;\n /** The reason for the exception. */\n reason?: string | null;\n }\n /** Fulfillment time type enum. */\n enum FulfillmentTimeType {\n /** Undefined fulfillment time type. */\n UNDEFINED_FULFILLMENT_TIME = \"UNDEFINED_FULFILLMENT_TIME\",\n /** Fulfillment time has a maximum. */\n MAX_TIME = \"MAX_TIME\",\n /** Fulfillment time has a minimum and a maximum. */\n DURATION_RANGE = \"DURATION_RANGE\"\n }\n /** Duration range. */\n interface DurationRange {\n /** Minimum duration in minutes. */\n minDuration?: number;\n /** Maximum duration in minutes. */\n maxDuration?: number;\n }\n /** Fulfillment times display type enum. */\n enum FulfillmentTimesDisplayType {\n /** Undefined fulfillment times display type. */\n UNDEFINED_FULFILLMENT_TIMES_DISPLAY = \"UNDEFINED_FULFILLMENT_TIMES_DISPLAY\",\n /** Fulfillment times are displayed as a list of time windows. */\n TIME_WINDOWS = \"TIME_WINDOWS\"\n }\n /** Time window. */\n interface TimeWindowDisplayConfig {\n /** Time window duration in minutes. */\n durationInMinutes?: number;\n }\n /** Information about pickup fulfillment types. */\n interface PickupDetails {\n /** Pickup address. This is the restaurant's address. */\n address?: CommonAddress$1;\n }\n /** Information about delivery fulfillment types. */\n interface DeliveryDetails {\n /** Delivery provider app id. */\n deliveryProviderAppId?: string | null;\n }\n interface ListFirstAvailableTimeSlotForFulfillmentTypesRequest {\n /**\n * Operation ID.\n * Returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n }\n interface ListFirstAvailableTimeSlotForFulfillmentTypesResponse {\n /**\n * List of available time slots for each fulfillment type.\n *\n * Each time slot will be the first available time slot for the given fulfillment type.\n * A delivery fulfillment type will only be returned if the delivery address is provided.\n */\n timeSlots?: FulfillmentTimeSlot[];\n }\n interface FulfillmentTimeSlot {\n /** Start time and date of the time slot. */\n startTime?: Date;\n /** End time and date of the time slot. */\n endTime?: Date;\n /** Type of the fulfillment. */\n fulfilmentType?: FulfillmentType;\n /** Whether the time slot starts now. */\n startsNow?: boolean;\n /** Details for each fulfillment option of the time slot. */\n fulfillmentDetails?: FulfillmentDetails[];\n /** Address of the fulfillment. */\n fulfillmentAddress?: FulfillmentAddress;\n }\n /** Details about the fulfillment option. */\n interface FulfillmentDetails extends FulfillmentDetailsFulfillmentTimeOptionsOneOf {\n /** Fulfillment time has a maximum. */\n maxTimeOptions?: number;\n /** Fulfillment time has a minimum and a maximum. */\n durationRangeOptions?: DurationRange;\n /** Fee for using this fulfillment. */\n fee?: string | null;\n /** Minimum order price to qualify for using this fulfillment. */\n minOrderPrice?: string | null;\n /** Fulfillment time type. Only be relevant to ASAP operations. */\n fulfillmentTimeType?: FulfillmentTimeType;\n /**\n * Minimum order price for free fulfillment.\n * If order price exceeds this amount, the given `fee` is waived.\n */\n freeFulfillmentPriceThreshold?: string | null;\n }\n /** @oneof */\n interface FulfillmentDetailsFulfillmentTimeOptionsOneOf {\n /** Fulfillment time has a maximum. */\n maxTimeOptions?: number;\n /** Fulfillment time has a minimum and a maximum. */\n durationRangeOptions?: DurationRange;\n }\n /**\n * Details on the address of the fulfillment.\n * For pickup it will the address to take the order from.\n * For delivery it will be the address to deliver the order to.\n */\n interface FulfillmentAddress {\n /** Pickup address. This is the address of the restaurant. */\n address?: CommonAddress$1;\n }\n interface ListFirstAvailableTimeSlotsForMenusRequest {\n /**\n * Operation ID.\n * Returned timeslots that are belong to this operation.\n */\n operationId: string | null;\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Menu IDs to get the first available time slots for. */\n menuIds?: string[];\n }\n interface ListFirstAvailableTimeSlotsForMenusResponse {\n /**\n * List of available time slots for each menu.\n * For each menu will be returned the first available time slot for each fulfillment type.\n */\n timeSlotsPerMenu?: FirstFulfillmentTimeSlotsPerMenu[];\n }\n interface FirstFulfillmentTimeSlotsPerMenu {\n /** Menu ID. */\n menuId?: string | null;\n /** List of available time slots for each fulfillment type. */\n timeslotsPerFulfillmentType?: FulfillmentTimeSlot[];\n }\n interface ListAvailableTimeSlotsForDateRequest {\n /**\n * Operation ID.\n * The returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Date and time to get the available time slots for. */\n date: _Date;\n }\n interface _Date {\n /** The day of the month. */\n day?: number;\n /** The month of the year. */\n month?: number;\n /** The year of the date. */\n year?: number;\n }\n interface ListAvailableTimeSlotsForDateResponse {\n /** Lst of the available time slots in the requested date. */\n timeSlots?: FulfillmentTimeSlot[];\n }\n interface ListAvailableDatesInRangeRequest {\n /**\n * Operation ID.\n * The returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Start date and time of the range. */\n from: _Date;\n /** End date and time of the range. */\n until: _Date;\n }\n interface ListAvailableDatesInRangeResponse {\n /** List of the available dates in descending order for each fulfillment type. */\n availableDates?: FulfillmentTypeAvailableDates[];\n }\n /** Available dates for a given fulfillment type. */\n interface FulfillmentTypeAvailableDates {\n /** Type of the fulfillment. */\n fulfilmentType?: FulfillmentType;\n /** List of the available dates in descending order. */\n dates?: _Date[];\n }\n interface GetExpectedFulfillmentSelectionRequest {\n /** Operation ID. The returned fulfillment will belong to this operation. */\n operationId: string;\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Start time and date of the time slot. */\n timeslotStartTime?: Date;\n /** End time and date of the time slot. */\n timeslotEndTime?: Date;\n /** Type of fulfillment. */\n fulfilmentType: FulfillmentType;\n /** Whether it is possible to submit an order to be prepared asap. */\n canSubmitOrderForNow?: boolean | null;\n }\n interface GetExpectedFulfillmentSelectionResponse {\n /** Expected fulfillment option. */\n expectedFulfillmentSelections?: FulfillmentOption[];\n }\n interface Empty$6 {\n }\n /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */\n interface SitePropertiesNotification$2 {\n /** The site ID for which this update notification applies. */\n metasiteId?: string;\n /** The actual update event. */\n event?: SitePropertiesEvent$2;\n /** A convenience set of mappings from the MetaSite ID to its constituent services. */\n translations?: Translation$2[];\n /** Context of the notification */\n changeContext?: ChangeContext$2;\n }\n /** The actual update event for a particular notification. */\n interface SitePropertiesEvent$2 {\n /** Version of the site's properties represented by this update. */\n version?: number;\n /** Updated properties. */\n properties?: Properties$2;\n }\n interface Properties$2 {\n /** Site categories. */\n categories?: Categories$2;\n /** Site locale. */\n locale?: Locale$2;\n /**\n * Site language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Site currency format used to bill customers.\n *\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n paymentCurrency?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Fax number. */\n fax?: string | null;\n /** Address. */\n address?: Address$2;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n /**\n * Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$2;\n /** Supported languages of a site and the primary language. */\n multilingual?: Multilingual$2;\n /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */\n consentPolicy?: ConsentPolicy$2;\n /**\n * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n *\n * Site business type.\n */\n businessConfig?: string | null;\n /** External site url that uses Wix as its headless business solution */\n externalSiteUrl?: string | null;\n /** Track clicks analytics */\n trackClicksAnalytics?: boolean;\n }\n interface Categories$2 {\n /** Primary site category. */\n primary?: string;\n /** Secondary site category. */\n secondary?: string[];\n /** Business Term Id */\n businessTermId?: string | null;\n }\n interface Locale$2 {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string;\n }\n interface Address$2 {\n /** Street name. */\n street?: string;\n /** City name. */\n city?: string;\n /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string;\n /** State. */\n state?: string;\n /** Zip or postal code. */\n zip?: string;\n /** Extra information to be displayed in the address. */\n hint?: AddressHint$2;\n /** Whether this address represents a physical location. */\n isPhysical?: boolean;\n /** Google-formatted version of this address. */\n googleFormattedAddress?: string;\n /** Street number. */\n streetNumber?: string;\n /** Apartment number. */\n apartmentNumber?: string;\n /** Geographic coordinates of location. */\n coordinates?: GeoCoordinates$2;\n }\n /**\n * Extra information on displayed addresses.\n * This is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\n * Free text. In addition the user can state where he wants that additional description - before, after, or instead\n * the address string.\n */\n interface AddressHint$2 {\n /** Extra text displayed next to, or instead of, the actual address. */\n text?: string;\n /** Where the extra text should be displayed. */\n placement?: PlacementType$2;\n }\n /** Where the extra text should be displayed: before, after or instead of the actual address. */\n enum PlacementType$2 {\n BEFORE = \"BEFORE\",\n AFTER = \"AFTER\",\n REPLACE = \"REPLACE\"\n }\n /** Geocoordinates for a particular address. */\n interface GeoCoordinates$2 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$2 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$2[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$2[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$2 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$2;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$2;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$2 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$2 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Multilingual$2 {\n /** Supported languages list. */\n supportedLanguages?: SupportedLanguage$2[];\n /** Whether to redirect to user language. */\n autoRedirect?: boolean;\n }\n interface SupportedLanguage$2 {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Locale. */\n locale?: Locale$2;\n /** Whether the supported language is the primary language for the site. */\n isPrimary?: boolean;\n /** Language icon. */\n countryCode?: string;\n /** How the language will be resolved. For internal use. */\n resolutionMethod?: ResolutionMethod$2;\n }\n enum ResolutionMethod$2 {\n QUERY_PARAM = \"QUERY_PARAM\",\n SUBDOMAIN = \"SUBDOMAIN\",\n SUBDIRECTORY = \"SUBDIRECTORY\"\n }\n interface ConsentPolicy$2 {\n /** Whether the site uses cookies that are essential to site operation. */\n essential?: boolean | null;\n /** Whether the site uses cookies that affect site performance and other functional measurements. */\n functional?: boolean | null;\n /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */\n analytics?: boolean | null;\n /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */\n advertising?: boolean | null;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean | null;\n }\n /** A single mapping from the MetaSite ID to a particular service. */\n interface Translation$2 {\n /** The service type. */\n serviceType?: string;\n /** The application definition ID; this only applies to services of type ThirdPartyApps. */\n appDefId?: string;\n /** The instance ID of the service. */\n instanceId?: string;\n }\n interface ChangeContext$2 extends ChangeContextPayloadOneOf$2 {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange$2;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated$2;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$2;\n }\n /** @oneof */\n interface ChangeContextPayloadOneOf$2 {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange$2;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated$2;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$2;\n }\n interface PropertiesChange$2 {\n }\n interface SiteCreated$2 {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned$2 {\n /** Origin site id. */\n originMetaSiteId?: string;\n }\n /**\n * Creates a new operation.\n * @param operation - Operation to create.\n * @public\n * @documentationMaturity preview\n * @requiredField operation\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Created operation.\n */\n function createOperation(operation: Operation): Promise;\n /**\n * Retrieves an operation.\n * @param operationId - ID of the operation to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField operationId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Retrieved operation.\n */\n function getOperation(operationId: string): Promise;\n /**\n * Updates an operation.\n *\n * If you update part of the `orderScheduling` property, the whole object is overwritten,\n * so you must include the entire object unless you are not updating `orderScheduling` at all.
      \n *\n * Each time the operation is updated,\n * `revision` increments by 1.\n * The current `revision` must be passed when updating the operation.\n * This ensures you're working with the latest operation\n * and prevents unintended overwrites.\n * @param _id - Operation ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField operation\n * @requiredField operation.revision\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated operation.\n */\n function updateOperation(_id: string | null, operation: UpdateOperation, options?: UpdateOperationOptions): Promise;\n interface UpdateOperation {\n /** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */\n pausedUntilOptions?: OnlineOrderingPausedUntilOptions;\n /**\n * Operation ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number. Increments by 1 each time the operation is updated.\n * To prevent conflicting changes,\n * the existing `revision` must be passed when updating an operation.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the operation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the operation was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Operation name. */\n name?: string | null;\n /**\n * Whether the operation is the default operation.
      \n * Default: `false`.\n */\n default?: boolean | null;\n /** IDs of the [fulfillment methods](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/fulfillment-methods/introduction) associated with the operation. */\n fulfillmentIds?: string[] | null;\n /**\n * Online ordering status of the operation.
      \n * - `ENABLED`: Operation currently accepts online orders.
      \n * - `DISABLED`: Operation currently does not accept online orders.
      \n * - `PAUSED_UNTIL`: Operation currently does not accept online orders, but will accept online orders from a specifed time and date. When applied, `pausedUntilOptions` is a required field.
      \n * - `UNDEFINED_ONLINE_ORDERING_STATUS`: Online ordering status is not defined.\n */\n onlineOrderingStatus?: OnlineOrderingStatusType;\n /** IDs of the [service fee](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/introduction) rules associated with the operation. */\n serviceFeeRuleIds?: string[] | null;\n /** Default fulfillment type of the operation. */\n defaultFulfillmentType?: FulfillmentType;\n /** Information about when an order can be placed for. */\n orderScheduling?: OrderScheduling;\n }\n interface UpdateOperationOptions {\n }\n /**\n * Deletes an operation.\n * @param operationId - ID of the operation to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField operationId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteOperation(operationId: string): Promise;\n /**\n * Creates a query to retrieve a list of operations.\n *\n * The `queryOperations()` function builds a query to retrieve a list of operations and returns an `OperationsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the [`find()`](/operations/operations-query-builder/find) function.\n *\n * You can refine the query by chaining `OperationsQueryBuilder` functions onto the query. `OperationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryOperations()` returns.\n *\n * `queryOperations()` runs with the following `OperationsQueryBuilder` defaults, which you can override:\n *\n * * [`limit(50)`](/operations/operations-query-builder/limit)\n * * [`ascending('entityId')`](/operations/operations-methods-query-builder/ascending)\n *\n * The following `OperationsQueryBuilder` functions are supported for `queryOperations()`. For a full description of the operations object, see the object returned for the [`items`](/operations/operations-query-result/items) property in `OperationsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId RESTAURANTS.OPERATION_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryOperation(): OperationsQueryBuilder;\n interface QueryCursorResult$6 {\n cursors: Cursors$6;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OperationsQueryResult extends QueryCursorResult$6 {\n items: Operation[];\n query: OperationsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface OperationsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\", value: any) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\", value: any) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"name\", value: string) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\", value: any[]) => OperationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasAll: (propertyName: \"fulfillmentIds\" | \"serviceFeeRuleIds\", value: any[]) => OperationsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\", value: any) => OperationsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\", value: boolean) => OperationsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"profileId\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\">) => OperationsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"profileId\" | \"default\" | \"fulfillmentIds\" | \"onlineOrderingStatus\" | \"serviceFeeRuleIds\" | \"defaultFulfillmentType\">) => OperationsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => OperationsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => OperationsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves a list of operations.\n * The result will be sorted by created date in ascending order.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listOperations(): Promise;\n /**\n * Retrieves a list of available fulfillment options.\n *\n * What makes a fulfillment option available is whether it's possible to submit an order given the scheduling configurations and the fulfillment method's availability.\n * When a delivery address is not provided in the input, our system retrieves a list encompassing all types of fulfillment methods.\n * Conversely, if a delivery address` is given, the response may includes non-delivery fulfillment options along with delivery fulfillment methods that are applicable to the given address, ensuring the address falls within the defined delivery area of these methods.\n * @param operationId - Operation ID. Returned fulfillment options will belong to this operation.\n * @public\n * @documentationMaturity preview\n * @requiredField operationId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listAvailableFulfillmentOptions(operationId: string, options?: ListAvailableFulfillmentOptions): Promise;\n interface ListAvailableFulfillmentOptions {\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n }\n /**\n * Retrieves a list of available time slots for each fulfillment type.\n *\n * Each time slot will be the first available time slot for the given fulfillment type.\n * @param operationId - Operation ID.\n * Returned fulfillment options will belong to this operation.\n * @public\n * @documentationMaturity preview\n * @requiredField operationId\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listFirstAvailableTimeSlotForFulfillmentTypes(operationId: string, options?: ListFirstAvailableTimeSlotForFulfillmentTypesOptions): Promise;\n interface ListFirstAvailableTimeSlotForFulfillmentTypesOptions {\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n }\n interface ListFirstAvailableTimeSlotsForMenusOptions {\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Menu IDs to get the first available time slots for. */\n menuIds?: string[];\n }\n /**\n * Retrieves a list of the available time slots for a given date.\n * @param operationId - Operation ID.\n * The returned fulfillment options will belong to this operation.\n * @public\n * @documentationMaturity preview\n * @requiredField operationId\n * @requiredField options.date\n * @requiredField options.date.day\n * @requiredField options.date.month\n * @requiredField options.date.year\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listAvailableTimeSlotsForDate(operationId: string, options?: ListAvailableTimeSlotsForDateOptions): Promise;\n interface ListAvailableTimeSlotsForDateOptions {\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Date and time to get the available time slots for. */\n date: _Date;\n }\n /**\n * Retrieves a list of the available dates in a given time range.\n *\n * A date is considered available if it has at least one available time slot.\n * @param operationId - Operation ID.\n * The returned fulfillment options will belong to this operation.\n * @public\n * @documentationMaturity preview\n * @requiredField operationId\n * @requiredField options.from\n * @requiredField options.until\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listAvailableDatesInRange(operationId: string, options?: ListAvailableDatesInRangeOptions): Promise;\n interface ListAvailableDatesInRangeOptions {\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Start date and time of the range. */\n from: _Date;\n /** End date and time of the range. */\n until: _Date;\n }\n interface GetExpectedFulfillmentSelectionOptions {\n /**\n * Delivery address. Optional.\n *\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: CommonAddress$1;\n /** Start time and date of the time slot. */\n timeslotStartTime?: Date;\n /** End time and date of the time slot. */\n timeslotEndTime?: Date;\n /** Type of fulfillment. */\n fulfilmentType: FulfillmentType;\n /** Whether it is possible to submit an order to be prepared asap. */\n canSubmitOrderForNow?: boolean | null;\n }\n type restaurantsOperationsV1OperationOperations_universal_d_Operation = Operation;\n type restaurantsOperationsV1OperationOperations_universal_d_OperationOnlineOrderingStatusOptionsOneOf = OperationOnlineOrderingStatusOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_Scheduling = Scheduling;\n type restaurantsOperationsV1OperationOperations_universal_d_SchedulingSchedulingOptionsOneOf = SchedulingSchedulingOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_SchedulingType = SchedulingType;\n const restaurantsOperationsV1OperationOperations_universal_d_SchedulingType: typeof SchedulingType;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapScheduling = AsapScheduling;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapSchedulingPreparationTimeOneOf = AsapSchedulingPreparationTimeOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapSchedulingAsapPreorderOneOf = AsapSchedulingAsapPreorderOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_PreparationTimeType = PreparationTimeType;\n const restaurantsOperationsV1OperationOperations_universal_d_PreparationTimeType: typeof PreparationTimeType;\n type restaurantsOperationsV1OperationOperations_universal_d_TimeDuration = TimeDuration;\n type restaurantsOperationsV1OperationOperations_universal_d_TimeUnit = TimeUnit;\n const restaurantsOperationsV1OperationOperations_universal_d_TimeUnit: typeof TimeUnit;\n type restaurantsOperationsV1OperationOperations_universal_d_TimeDurationRange = TimeDurationRange;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapPreorderType = AsapPreorderType;\n const restaurantsOperationsV1OperationOperations_universal_d_AsapPreorderType: typeof AsapPreorderType;\n type restaurantsOperationsV1OperationOperations_universal_d_BusinessDaysPreorder = BusinessDaysPreorder;\n type restaurantsOperationsV1OperationOperations_universal_d_PreorderScheduling = PreorderScheduling;\n type restaurantsOperationsV1OperationOperations_universal_d_PreorderMethod = PreorderMethod;\n type restaurantsOperationsV1OperationOperations_universal_d_PreorderMethodMethodOptionsOneOf = PreorderMethodMethodOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_DayAndTime = DayAndTime;\n type restaurantsOperationsV1OperationOperations_universal_d_MethodType = MethodType;\n const restaurantsOperationsV1OperationOperations_universal_d_MethodType: typeof MethodType;\n type restaurantsOperationsV1OperationOperations_universal_d_TimeBounded = TimeBounded;\n type restaurantsOperationsV1OperationOperations_universal_d_WeeklySchedule = WeeklySchedule;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayConfig = FulfillmentTimesDisplayConfig;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf = FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesType = FulfillmentTimesType;\n const restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesType: typeof FulfillmentTimesType;\n type restaurantsOperationsV1OperationOperations_universal_d_OnlineOrderingStatusType = OnlineOrderingStatusType;\n const restaurantsOperationsV1OperationOperations_universal_d_OnlineOrderingStatusType: typeof OnlineOrderingStatusType;\n type restaurantsOperationsV1OperationOperations_universal_d_OnlineOrderingPausedUntilOptions = OnlineOrderingPausedUntilOptions;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentType = FulfillmentType;\n const restaurantsOperationsV1OperationOperations_universal_d_FulfillmentType: typeof FulfillmentType;\n type restaurantsOperationsV1OperationOperations_universal_d_OrderScheduling = OrderScheduling;\n type restaurantsOperationsV1OperationOperations_universal_d_OrderSchedulingOrderSchedulingOptionsOneOf = OrderSchedulingOrderSchedulingOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapOrderScheduling = AsapOrderScheduling;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapOrderSchedulingAsapFutureHandlingOptionsOneOf = AsapOrderSchedulingAsapFutureHandlingOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_PreparationTime = PreparationTime;\n type restaurantsOperationsV1OperationOperations_universal_d_PreparationTimeTimeSpecificationOneOf = PreparationTimeTimeSpecificationOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_PreparationTimePreparationTimeType = PreparationTimePreparationTimeType;\n const restaurantsOperationsV1OperationOperations_universal_d_PreparationTimePreparationTimeType: typeof PreparationTimePreparationTimeType;\n type restaurantsOperationsV1OperationOperations_universal_d_AsapFutureHandlingType = AsapFutureHandlingType;\n const restaurantsOperationsV1OperationOperations_universal_d_AsapFutureHandlingType: typeof AsapFutureHandlingType;\n type restaurantsOperationsV1OperationOperations_universal_d_BusinessDaysAheadHandling = BusinessDaysAheadHandling;\n type restaurantsOperationsV1OperationOperations_universal_d_DeliveryProfileConfiguredForOperation = DeliveryProfileConfiguredForOperation;\n type restaurantsOperationsV1OperationOperations_universal_d_CreateOperationRequest = CreateOperationRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_CreateOperationResponse = CreateOperationResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_GetOperationRequest = GetOperationRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_GetOperationResponse = GetOperationResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_UpdateOperationRequest = UpdateOperationRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_UpdateOperationResponse = UpdateOperationResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_DeleteOperationRequest = DeleteOperationRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_DeleteOperationResponse = DeleteOperationResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_QueryOperationRequest = QueryOperationRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_QueryOperationResponse = QueryOperationResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_ListOperationsRequest = ListOperationsRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_ListOperationsResponse = ListOperationsResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_ListOperationIdsRequest = ListOperationIdsRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_ListOperationIdsResponse = ListOperationIdsResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableFulfillmentOptionsRequest = ListAvailableFulfillmentOptionsRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableFulfillmentOptionsResponse = ListAvailableFulfillmentOptionsResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOption = FulfillmentOption;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionFulfillmentTimeOptionsOneOf = FulfillmentOptionFulfillmentTimeOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf = FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionFulfillmentTypeOptionsOneOf = FulfillmentOptionFulfillmentTypeOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionAvailability = FulfillmentOptionAvailability;\n type restaurantsOperationsV1OperationOperations_universal_d_AvailabilityException = AvailabilityException;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimeType = FulfillmentTimeType;\n const restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimeType: typeof FulfillmentTimeType;\n type restaurantsOperationsV1OperationOperations_universal_d_DurationRange = DurationRange;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayType = FulfillmentTimesDisplayType;\n const restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayType: typeof FulfillmentTimesDisplayType;\n type restaurantsOperationsV1OperationOperations_universal_d_TimeWindowDisplayConfig = TimeWindowDisplayConfig;\n type restaurantsOperationsV1OperationOperations_universal_d_PickupDetails = PickupDetails;\n type restaurantsOperationsV1OperationOperations_universal_d_DeliveryDetails = DeliveryDetails;\n type restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesRequest = ListFirstAvailableTimeSlotForFulfillmentTypesRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesResponse = ListFirstAvailableTimeSlotForFulfillmentTypesResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimeSlot = FulfillmentTimeSlot;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentDetails = FulfillmentDetails;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentDetailsFulfillmentTimeOptionsOneOf = FulfillmentDetailsFulfillmentTimeOptionsOneOf;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentAddress = FulfillmentAddress;\n type restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotsForMenusRequest = ListFirstAvailableTimeSlotsForMenusRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotsForMenusResponse = ListFirstAvailableTimeSlotsForMenusResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_FirstFulfillmentTimeSlotsPerMenu = FirstFulfillmentTimeSlotsPerMenu;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableTimeSlotsForDateRequest = ListAvailableTimeSlotsForDateRequest;\n type restaurantsOperationsV1OperationOperations_universal_d__Date = _Date;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableTimeSlotsForDateResponse = ListAvailableTimeSlotsForDateResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableDatesInRangeRequest = ListAvailableDatesInRangeRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableDatesInRangeResponse = ListAvailableDatesInRangeResponse;\n type restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTypeAvailableDates = FulfillmentTypeAvailableDates;\n type restaurantsOperationsV1OperationOperations_universal_d_GetExpectedFulfillmentSelectionRequest = GetExpectedFulfillmentSelectionRequest;\n type restaurantsOperationsV1OperationOperations_universal_d_GetExpectedFulfillmentSelectionResponse = GetExpectedFulfillmentSelectionResponse;\n const restaurantsOperationsV1OperationOperations_universal_d_createOperation: typeof createOperation;\n const restaurantsOperationsV1OperationOperations_universal_d_getOperation: typeof getOperation;\n const restaurantsOperationsV1OperationOperations_universal_d_updateOperation: typeof updateOperation;\n type restaurantsOperationsV1OperationOperations_universal_d_UpdateOperation = UpdateOperation;\n type restaurantsOperationsV1OperationOperations_universal_d_UpdateOperationOptions = UpdateOperationOptions;\n const restaurantsOperationsV1OperationOperations_universal_d_deleteOperation: typeof deleteOperation;\n const restaurantsOperationsV1OperationOperations_universal_d_queryOperation: typeof queryOperation;\n type restaurantsOperationsV1OperationOperations_universal_d_OperationsQueryResult = OperationsQueryResult;\n type restaurantsOperationsV1OperationOperations_universal_d_OperationsQueryBuilder = OperationsQueryBuilder;\n const restaurantsOperationsV1OperationOperations_universal_d_listOperations: typeof listOperations;\n const restaurantsOperationsV1OperationOperations_universal_d_listAvailableFulfillmentOptions: typeof listAvailableFulfillmentOptions;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableFulfillmentOptions = ListAvailableFulfillmentOptions;\n const restaurantsOperationsV1OperationOperations_universal_d_listFirstAvailableTimeSlotForFulfillmentTypes: typeof listFirstAvailableTimeSlotForFulfillmentTypes;\n type restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesOptions = ListFirstAvailableTimeSlotForFulfillmentTypesOptions;\n type restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotsForMenusOptions = ListFirstAvailableTimeSlotsForMenusOptions;\n const restaurantsOperationsV1OperationOperations_universal_d_listAvailableTimeSlotsForDate: typeof listAvailableTimeSlotsForDate;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableTimeSlotsForDateOptions = ListAvailableTimeSlotsForDateOptions;\n const restaurantsOperationsV1OperationOperations_universal_d_listAvailableDatesInRange: typeof listAvailableDatesInRange;\n type restaurantsOperationsV1OperationOperations_universal_d_ListAvailableDatesInRangeOptions = ListAvailableDatesInRangeOptions;\n type restaurantsOperationsV1OperationOperations_universal_d_GetExpectedFulfillmentSelectionOptions = GetExpectedFulfillmentSelectionOptions;\n namespace restaurantsOperationsV1OperationOperations_universal_d {\n export { restaurantsOperationsV1OperationOperations_universal_d_Operation as Operation, restaurantsOperationsV1OperationOperations_universal_d_OperationOnlineOrderingStatusOptionsOneOf as OperationOnlineOrderingStatusOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_Scheduling as Scheduling, restaurantsOperationsV1OperationOperations_universal_d_SchedulingSchedulingOptionsOneOf as SchedulingSchedulingOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_SchedulingType as SchedulingType, restaurantsOperationsV1OperationOperations_universal_d_AsapScheduling as AsapScheduling, restaurantsOperationsV1OperationOperations_universal_d_AsapSchedulingPreparationTimeOneOf as AsapSchedulingPreparationTimeOneOf, restaurantsOperationsV1OperationOperations_universal_d_AsapSchedulingAsapPreorderOneOf as AsapSchedulingAsapPreorderOneOf, restaurantsOperationsV1OperationOperations_universal_d_PreparationTimeType as PreparationTimeType, restaurantsOperationsV1OperationOperations_universal_d_TimeDuration as TimeDuration, restaurantsOperationsV1OperationOperations_universal_d_TimeUnit as TimeUnit, restaurantsOperationsV1OperationOperations_universal_d_TimeDurationRange as TimeDurationRange, restaurantsOperationsV1OperationOperations_universal_d_AsapPreorderType as AsapPreorderType, restaurantsOperationsV1OperationOperations_universal_d_BusinessDaysPreorder as BusinessDaysPreorder, restaurantsOperationsV1OperationOperations_universal_d_PreorderScheduling as PreorderScheduling, restaurantsOperationsV1OperationOperations_universal_d_PreorderMethod as PreorderMethod, restaurantsOperationsV1OperationOperations_universal_d_PreorderMethodMethodOptionsOneOf as PreorderMethodMethodOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_DayAndTime as DayAndTime, EntitiesDayOfWeek$2 as EntitiesDayOfWeek, TimeOfDay$2 as TimeOfDay, restaurantsOperationsV1OperationOperations_universal_d_MethodType as MethodType, restaurantsOperationsV1OperationOperations_universal_d_TimeBounded as TimeBounded, restaurantsOperationsV1OperationOperations_universal_d_WeeklySchedule as WeeklySchedule, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayConfig as FulfillmentTimesDisplayConfig, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf as FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesType as FulfillmentTimesType, restaurantsOperationsV1OperationOperations_universal_d_OnlineOrderingStatusType as OnlineOrderingStatusType, restaurantsOperationsV1OperationOperations_universal_d_OnlineOrderingPausedUntilOptions as OnlineOrderingPausedUntilOptions, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentType as FulfillmentType, restaurantsOperationsV1OperationOperations_universal_d_OrderScheduling as OrderScheduling, restaurantsOperationsV1OperationOperations_universal_d_OrderSchedulingOrderSchedulingOptionsOneOf as OrderSchedulingOrderSchedulingOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_AsapOrderScheduling as AsapOrderScheduling, restaurantsOperationsV1OperationOperations_universal_d_AsapOrderSchedulingAsapFutureHandlingOptionsOneOf as AsapOrderSchedulingAsapFutureHandlingOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_PreparationTime as PreparationTime, restaurantsOperationsV1OperationOperations_universal_d_PreparationTimeTimeSpecificationOneOf as PreparationTimeTimeSpecificationOneOf, restaurantsOperationsV1OperationOperations_universal_d_PreparationTimePreparationTimeType as PreparationTimePreparationTimeType, restaurantsOperationsV1OperationOperations_universal_d_AsapFutureHandlingType as AsapFutureHandlingType, restaurantsOperationsV1OperationOperations_universal_d_BusinessDaysAheadHandling as BusinessDaysAheadHandling, DomainEvent$6 as DomainEvent, DomainEventBodyOneOf$6 as DomainEventBodyOneOf, EntityCreatedEvent$6 as EntityCreatedEvent, RestoreInfo$6 as RestoreInfo, EntityUpdatedEvent$6 as EntityUpdatedEvent, EntityDeletedEvent$6 as EntityDeletedEvent, ActionEvent$6 as ActionEvent, MessageEnvelope$6 as MessageEnvelope, IdentificationData$6 as IdentificationData, IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf, WebhookIdentityType$6 as WebhookIdentityType, InvalidateCache$6 as InvalidateCache, InvalidateCacheGetByOneOf$6 as InvalidateCacheGetByOneOf, App$6 as App, Page$6 as Page, URI$6 as URI, File$6 as File, restaurantsOperationsV1OperationOperations_universal_d_DeliveryProfileConfiguredForOperation as DeliveryProfileConfiguredForOperation, OperationsDataCloningCompleted$1 as OperationsDataCloningCompleted, restaurantsOperationsV1OperationOperations_universal_d_CreateOperationRequest as CreateOperationRequest, restaurantsOperationsV1OperationOperations_universal_d_CreateOperationResponse as CreateOperationResponse, restaurantsOperationsV1OperationOperations_universal_d_GetOperationRequest as GetOperationRequest, restaurantsOperationsV1OperationOperations_universal_d_GetOperationResponse as GetOperationResponse, restaurantsOperationsV1OperationOperations_universal_d_UpdateOperationRequest as UpdateOperationRequest, restaurantsOperationsV1OperationOperations_universal_d_UpdateOperationResponse as UpdateOperationResponse, restaurantsOperationsV1OperationOperations_universal_d_DeleteOperationRequest as DeleteOperationRequest, restaurantsOperationsV1OperationOperations_universal_d_DeleteOperationResponse as DeleteOperationResponse, restaurantsOperationsV1OperationOperations_universal_d_QueryOperationRequest as QueryOperationRequest, CursorQuery$6 as CursorQuery, CursorQueryPagingMethodOneOf$6 as CursorQueryPagingMethodOneOf, Sorting$6 as Sorting, SortOrder$6 as SortOrder, CursorPaging$6 as CursorPaging, restaurantsOperationsV1OperationOperations_universal_d_QueryOperationResponse as QueryOperationResponse, CursorPagingMetadata$6 as CursorPagingMetadata, Cursors$6 as Cursors, restaurantsOperationsV1OperationOperations_universal_d_ListOperationsRequest as ListOperationsRequest, restaurantsOperationsV1OperationOperations_universal_d_ListOperationsResponse as ListOperationsResponse, restaurantsOperationsV1OperationOperations_universal_d_ListOperationIdsRequest as ListOperationIdsRequest, restaurantsOperationsV1OperationOperations_universal_d_ListOperationIdsResponse as ListOperationIdsResponse, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableFulfillmentOptionsRequest as ListAvailableFulfillmentOptionsRequest, CommonAddress$1 as CommonAddress, CommonAddressStreetOneOf$1 as CommonAddressStreetOneOf, StreetAddress$1 as StreetAddress, AddressLocation$1 as AddressLocation, Subdivision$1 as Subdivision, SubdivisionType$1 as SubdivisionType, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableFulfillmentOptionsResponse as ListAvailableFulfillmentOptionsResponse, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOption as FulfillmentOption, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionFulfillmentTimeOptionsOneOf as FulfillmentOptionFulfillmentTimeOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf as FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionFulfillmentTypeOptionsOneOf as FulfillmentOptionFulfillmentTypeOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentOptionAvailability as FulfillmentOptionAvailability, DayOfWeekAvailability$2 as DayOfWeekAvailability, TimeOfDayRange$2 as TimeOfDayRange, restaurantsOperationsV1OperationOperations_universal_d_AvailabilityException as AvailabilityException, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimeType as FulfillmentTimeType, restaurantsOperationsV1OperationOperations_universal_d_DurationRange as DurationRange, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimesDisplayType as FulfillmentTimesDisplayType, restaurantsOperationsV1OperationOperations_universal_d_TimeWindowDisplayConfig as TimeWindowDisplayConfig, restaurantsOperationsV1OperationOperations_universal_d_PickupDetails as PickupDetails, restaurantsOperationsV1OperationOperations_universal_d_DeliveryDetails as DeliveryDetails, restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesRequest as ListFirstAvailableTimeSlotForFulfillmentTypesRequest, restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesResponse as ListFirstAvailableTimeSlotForFulfillmentTypesResponse, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTimeSlot as FulfillmentTimeSlot, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentDetails as FulfillmentDetails, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentDetailsFulfillmentTimeOptionsOneOf as FulfillmentDetailsFulfillmentTimeOptionsOneOf, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentAddress as FulfillmentAddress, restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotsForMenusRequest as ListFirstAvailableTimeSlotsForMenusRequest, restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotsForMenusResponse as ListFirstAvailableTimeSlotsForMenusResponse, restaurantsOperationsV1OperationOperations_universal_d_FirstFulfillmentTimeSlotsPerMenu as FirstFulfillmentTimeSlotsPerMenu, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableTimeSlotsForDateRequest as ListAvailableTimeSlotsForDateRequest, restaurantsOperationsV1OperationOperations_universal_d__Date as _Date, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableTimeSlotsForDateResponse as ListAvailableTimeSlotsForDateResponse, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableDatesInRangeRequest as ListAvailableDatesInRangeRequest, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableDatesInRangeResponse as ListAvailableDatesInRangeResponse, restaurantsOperationsV1OperationOperations_universal_d_FulfillmentTypeAvailableDates as FulfillmentTypeAvailableDates, restaurantsOperationsV1OperationOperations_universal_d_GetExpectedFulfillmentSelectionRequest as GetExpectedFulfillmentSelectionRequest, restaurantsOperationsV1OperationOperations_universal_d_GetExpectedFulfillmentSelectionResponse as GetExpectedFulfillmentSelectionResponse, Empty$6 as Empty, SitePropertiesNotification$2 as SitePropertiesNotification, SitePropertiesEvent$2 as SitePropertiesEvent, Properties$2 as Properties, Categories$2 as Categories, Locale$2 as Locale, Address$2 as Address, AddressHint$2 as AddressHint, PlacementType$2 as PlacementType, GeoCoordinates$2 as GeoCoordinates, BusinessSchedule$2 as BusinessSchedule, TimePeriod$2 as TimePeriod, DayOfWeek$2 as DayOfWeek, SpecialHourPeriod$2 as SpecialHourPeriod, Multilingual$2 as Multilingual, SupportedLanguage$2 as SupportedLanguage, ResolutionMethod$2 as ResolutionMethod, ConsentPolicy$2 as ConsentPolicy, Translation$2 as Translation, ChangeContext$2 as ChangeContext, ChangeContextPayloadOneOf$2 as ChangeContextPayloadOneOf, PropertiesChange$2 as PropertiesChange, SiteCreated$2 as SiteCreated, SiteCloned$2 as SiteCloned, restaurantsOperationsV1OperationOperations_universal_d_createOperation as createOperation, restaurantsOperationsV1OperationOperations_universal_d_getOperation as getOperation, restaurantsOperationsV1OperationOperations_universal_d_updateOperation as updateOperation, restaurantsOperationsV1OperationOperations_universal_d_UpdateOperation as UpdateOperation, restaurantsOperationsV1OperationOperations_universal_d_UpdateOperationOptions as UpdateOperationOptions, restaurantsOperationsV1OperationOperations_universal_d_deleteOperation as deleteOperation, restaurantsOperationsV1OperationOperations_universal_d_queryOperation as queryOperation, restaurantsOperationsV1OperationOperations_universal_d_OperationsQueryResult as OperationsQueryResult, restaurantsOperationsV1OperationOperations_universal_d_OperationsQueryBuilder as OperationsQueryBuilder, restaurantsOperationsV1OperationOperations_universal_d_listOperations as listOperations, restaurantsOperationsV1OperationOperations_universal_d_listAvailableFulfillmentOptions as listAvailableFulfillmentOptions, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableFulfillmentOptions as ListAvailableFulfillmentOptions, restaurantsOperationsV1OperationOperations_universal_d_listFirstAvailableTimeSlotForFulfillmentTypes as listFirstAvailableTimeSlotForFulfillmentTypes, restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesOptions as ListFirstAvailableTimeSlotForFulfillmentTypesOptions, restaurantsOperationsV1OperationOperations_universal_d_ListFirstAvailableTimeSlotsForMenusOptions as ListFirstAvailableTimeSlotsForMenusOptions, restaurantsOperationsV1OperationOperations_universal_d_listAvailableTimeSlotsForDate as listAvailableTimeSlotsForDate, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableTimeSlotsForDateOptions as ListAvailableTimeSlotsForDateOptions, restaurantsOperationsV1OperationOperations_universal_d_listAvailableDatesInRange as listAvailableDatesInRange, restaurantsOperationsV1OperationOperations_universal_d_ListAvailableDatesInRangeOptions as ListAvailableDatesInRangeOptions, restaurantsOperationsV1OperationOperations_universal_d_GetExpectedFulfillmentSelectionOptions as GetExpectedFulfillmentSelectionOptions, };\n }\n interface MenuOrderingSettings {\n /**\n * Menu ordering settings object ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating a menu ordering settings object.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** ID of the [restaurant operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/operations/introduction) the menu belongs to. */\n operationId?: string | null;\n /**\n * ID of the menu these settings apply to.\n * @readonly\n */\n menuId?: string | null;\n /** Whether online ordering is enabled for the menu. */\n onlineOrderingEnabled?: boolean | null;\n /** Menu availability settings. */\n availability?: Availability$1;\n /** Extended fields. */\n extendedFields?: ExtendedFields$4;\n }\n interface Availability$1 extends AvailabilityAvailabilityTypeOptionsOneOf {\n /** Settings for availability on a weekly schedule. */\n weeklyScheduleOptions?: WeeklyScheduleOptions;\n /** Settings for availability within a time range. */\n timestampRangesOptions?: TimestampRangesOptions;\n /**\n * Availability type.\n *\n * - `UNSPECIFIED_AVAILABILITY_OPTION`: Missing type due to an error\n * - `ALWAYS_AVAILABLE`: Available all the time.\n * - `WEEKLY_SCHEDULE`: Available on specific days and times throughout the week.\n * - `TIMESTAMP_RANGES`: Available during a specfic time range.\n */\n type?: AvailabilityType;\n /**\n * Time zone in [Time Zone Database](https://www.iana.org/time-zones) format.\n * @readonly\n */\n timeZone?: string | null;\n }\n /** @oneof */\n interface AvailabilityAvailabilityTypeOptionsOneOf {\n /** Settings for availability on a weekly schedule. */\n weeklyScheduleOptions?: WeeklyScheduleOptions;\n /** Settings for availability within a time range. */\n timestampRangesOptions?: TimestampRangesOptions;\n }\n enum AvailabilityType {\n /** Missing type due to an error */\n UNSPECIFIED_AVAILABILITY_OPTION = \"UNSPECIFIED_AVAILABILITY_OPTION\",\n /** Available all the time. */\n ALWAYS_AVAILABLE = \"ALWAYS_AVAILABLE\",\n /** Available on specific days and times throughout the week. */\n WEEKLY_SCHEDULE = \"WEEKLY_SCHEDULE\",\n /** Available during a specfic time range. */\n TIMESTAMP_RANGES = \"TIMESTAMP_RANGES\"\n }\n interface WeeklyScheduleOptions {\n /** List of available time ranges for specific days of the week. */\n availableTimes?: DayOfWeekAvailability$1[];\n }\n interface DayOfWeekAvailability$1 {\n /** The day of week this availability relates to. */\n dayOfWeek?: EntitiesDayOfWeek$1;\n /** A list of time ranges during which the fulfillment should be available. */\n timeRanges?: TimeOfDayRange$1[];\n }\n enum EntitiesDayOfWeek$1 {\n /** Monday. */\n MON = \"MON\",\n /** Tuesday. */\n TUE = \"TUE\",\n /** Wednesday. */\n WED = \"WED\",\n /** Thursday. */\n THU = \"THU\",\n /** Friday. */\n FRI = \"FRI\",\n /** Saturday. */\n SAT = \"SAT\",\n /** Sunday. */\n SUN = \"SUN\"\n }\n interface TimeOfDayRange$1 {\n /** The start time in time of day representation. */\n startTime?: TimeOfDay$1;\n /** The end time in time of day representation. */\n endTime?: TimeOfDay$1;\n }\n interface TimeOfDay$1 {\n /**\n * Hours.
      \n * Min: `0`.
      \n * Max: `23`.\n */\n hours?: number;\n /**\n * Minutes.
      \n * Min: `0`.
      \n * Max: `23`.\n */\n minutes?: number;\n }\n interface TimestampRangesOptions {\n /** List of available time ranges. */\n ranges?: AvailableRange[];\n }\n interface AvailableRange {\n /** The start time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */\n startTime?: Date | null;\n /** The end time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */\n endTime?: Date | null;\n }\n interface ExtendedFields$4 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface InvalidateCache$5 extends InvalidateCacheGetByOneOf$5 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$5;\n /** Invalidate by page id */\n page?: Page$5;\n /** Invalidate by URI path */\n uri?: URI$5;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$5;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n hardPurge?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$5 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$5;\n /** Invalidate by page id */\n page?: Page$5;\n /** Invalidate by URI path */\n uri?: URI$5;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$5;\n }\n interface App$5 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$5 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$5 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$5 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface CreateMenuOrderingSettingsRequest {\n /** Menu ordering settings entity details. */\n menuOrderingSettings: MenuOrderingSettings;\n }\n interface CreateMenuOrderingSettingsResponse {\n /** The created menu ordering settings entity. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface GetMenuOrderingSettingsRequest {\n /** ID of the menu ordering settings entity to retrieve. */\n menuOrderingSettingsId: string;\n }\n interface GetMenuOrderingSettingsResponse {\n /** The requested menu ordering settings entity. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface UpsertMenuOrderingSettingsByMenuIdRequest {\n /** Details of the menu ordering settings entity to be created or updated. */\n menuOrderingSettings: MenuOrderingSettings;\n }\n interface UpsertMenuOrderingSettingsByMenuIdResponse {\n /** The created or updated menu ordering settings entity. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface UpdateMenuOrderingSettingsRequest {\n /** Details of the menu ordering settings entity to update. */\n menuOrderingSettings: MenuOrderingSettings;\n }\n interface UpdateMenuOrderingSettingsResponse {\n /** Updated menu ordering settings entity. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface DeleteMenuOrderingSettingsRequest {\n /** ID of the menu ordering settings entity to delete. */\n menuOrderingSettingsId: string;\n }\n interface DeleteMenuOrderingSettingsResponse {\n }\n interface QueryMenuOrderingSettingsRequest {\n /** WQL expression. */\n query?: CursorQuery$5;\n }\n interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$5;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$5[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$5 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$5;\n }\n interface Sorting$5 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$5;\n }\n enum SortOrder$5 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$5 {\n /** Maximum number of items to return in the results. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryMenuOrderingSettingsResponse {\n /** List of menu ordering settings entities. */\n menuOrderingSettings?: MenuOrderingSettings[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$5;\n }\n interface CursorPagingMetadata$5 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors$5;\n /**\n * Whether there are more pages to retrieve following the current page.\n *\n * + `true`: Another page of results can be retrieved.\n * + `false`: This is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$5 {\n /** Cursor string pointing to the next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to the previous page in the list of results. */\n prev?: string | null;\n }\n interface BulkUpdateMenuOrderingSettingsRequest {\n /** Menu ordering settings entities to update. */\n menusOrderingSettings: MaskedMenuOrderingSettings[];\n /** Whether to receive the entity in the response. */\n returnEntity?: boolean;\n }\n interface MaskedMenuOrderingSettings {\n /** Menu ordering settings entities to update. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface BulkUpdateMenuOrderingSettingsResponse {\n /** Results of bulk menu ordering settings entities update. */\n results?: BulkMenuOrderingSettingsResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$4;\n }\n interface ItemMetadata$4 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$4;\n }\n interface ApplicationError$4 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkMenuOrderingSettingsResult {\n /** Metadata for menu update. */\n menuOrderingSettingsMetadata?: ItemMetadata$4;\n /** Updated menu ordering settings. Only returned if `returnEntity` is set to `true`. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface BulkActionMetadata$4 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface ListMenusAvailabilityStatusRequest {\n /** The time slot for which to check the availability of menus. */\n timeSlot: TimeSlot;\n /** The ID of the [restaurant operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/operations/introduction) whose menus will be checked. */\n operationId?: string | null;\n /** Cursor paging */\n cursorPaging?: CursorPaging$5;\n }\n interface TimeSlot {\n /** The start time of the time slot in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */\n startTime?: Date | null;\n /** The end time of the time slot in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */\n endTime?: Date | null;\n }\n interface ListMenusAvailabilityStatusResponse {\n /** The retrieved menus' availability statuses. */\n menusAvailabilityStatus?: MenuAvailabilityStatus[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$5;\n }\n interface MenuAvailabilityStatus {\n /** Menu ID. */\n menuId?: string;\n /** The menu's availability status. */\n availabilityStatus?: AvailabilityStatus;\n }\n enum AvailabilityStatus {\n /** Unknown availability status. */\n UNKNOWN_AVAILABILITY_STATUS = \"UNKNOWN_AVAILABILITY_STATUS\",\n /** Available. */\n AVAILABLE = \"AVAILABLE\",\n /** Unavailable. */\n UNAVAILABLE = \"UNAVAILABLE\"\n }\n interface UpdateExtendedFieldsRequest {\n /** ID of the entity to update. */\n _id: string;\n /** Identifier for the app whose extended fields are being updated. */\n namespace: string;\n /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */\n namespaceData: Record | null;\n }\n interface UpdateExtendedFieldsResponse {\n /** The updated menu ordering settings entity. */\n menuOrderingSettings?: MenuOrderingSettings;\n }\n interface DomainEvent$5 extends DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$5 {\n createdEvent?: EntityCreatedEvent$5;\n updatedEvent?: EntityUpdatedEvent$5;\n deletedEvent?: EntityDeletedEvent$5;\n actionEvent?: ActionEvent$5;\n }\n interface EntityCreatedEvent$5 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n }\n interface RestoreInfo$5 {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$5 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$5 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\n }\n interface Empty$5 {\n }\n interface GetRestaurantsAppClonesStatusRequest {\n }\n interface GetRestaurantsAppClonesStatusResponse {\n /** The requested menu ordering settings entity. */\n retaurantsAppCloneStatus?: RestaurantsAppCloneStatus;\n }\n /** The status of the data cloning process of the Restaurants Apps. */\n interface RestaurantsAppCloneStatus {\n /**\n * Whether the cloning of the orders was completed.\n * @readonly\n */\n ordersCloningCompleted?: boolean;\n /**\n * Whether the cloning of the menus was completed.\n * @readonly\n */\n menusCloningCompleted?: boolean;\n }\n /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */\n interface SitePropertiesNotification$1 {\n /** The site ID for which this update notification applies. */\n metasiteId?: string;\n /** The actual update event. */\n event?: SitePropertiesEvent$1;\n /** A convenience set of mappings from the MetaSite ID to its constituent services. */\n translations?: Translation$1[];\n /** Context of the notification */\n changeContext?: ChangeContext$1;\n }\n /** The actual update event for a particular notification. */\n interface SitePropertiesEvent$1 {\n /** Version of the site's properties represented by this update. */\n version?: number;\n /** Updated properties. */\n properties?: Properties$1;\n }\n interface Properties$1 {\n /** Site categories. */\n categories?: Categories$1;\n /** Site locale. */\n locale?: Locale$1;\n /**\n * Site language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Site currency format used to bill customers.\n *\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n paymentCurrency?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Fax number. */\n fax?: string | null;\n /** Address. */\n address?: Address$1;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n /**\n * Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule$1;\n /** Supported languages of a site and the primary language. */\n multilingual?: Multilingual$1;\n /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */\n consentPolicy?: ConsentPolicy$1;\n /**\n * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n *\n * Site business type.\n */\n businessConfig?: string | null;\n /** External site url that uses Wix as its headless business solution */\n externalSiteUrl?: string | null;\n /** Track clicks analytics */\n trackClicksAnalytics?: boolean;\n }\n interface Categories$1 {\n /** Primary site category. */\n primary?: string;\n /** Secondary site category. */\n secondary?: string[];\n /** Business Term Id */\n businessTermId?: string | null;\n }\n interface Locale$1 {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string;\n }\n interface Address$1 {\n /** Street name. */\n street?: string;\n /** City name. */\n city?: string;\n /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string;\n /** State. */\n state?: string;\n /** Zip or postal code. */\n zip?: string;\n /** Extra information to be displayed in the address. */\n hint?: AddressHint$1;\n /** Whether this address represents a physical location. */\n isPhysical?: boolean;\n /** Google-formatted version of this address. */\n googleFormattedAddress?: string;\n /** Street number. */\n streetNumber?: string;\n /** Apartment number. */\n apartmentNumber?: string;\n /** Geographic coordinates of location. */\n coordinates?: GeoCoordinates$1;\n }\n /**\n * Extra information on displayed addresses.\n * This is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\n * Free text. In addition the user can state where he wants that additional description - before, after, or instead\n * the address string.\n */\n interface AddressHint$1 {\n /** Extra text displayed next to, or instead of, the actual address. */\n text?: string;\n /** Where the extra text should be displayed. */\n placement?: PlacementType$1;\n }\n /** Where the extra text should be displayed: before, after or instead of the actual address. */\n enum PlacementType$1 {\n BEFORE = \"BEFORE\",\n AFTER = \"AFTER\",\n REPLACE = \"REPLACE\"\n }\n /** Geocoordinates for a particular address. */\n interface GeoCoordinates$1 {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number;\n }\n /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\n interface BusinessSchedule$1 {\n /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */\n periods?: TimePeriod$1[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$1[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$1 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$1;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeek$1;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n }\n /** Enumerates the days of the week. */\n enum DayOfWeek$1 {\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n /** Exception to the business's regular hours. The business can be open or closed during the exception. */\n interface SpecialHourPeriod$1 {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n }\n interface Multilingual$1 {\n /** Supported languages list. */\n supportedLanguages?: SupportedLanguage$1[];\n /** Whether to redirect to user language. */\n autoRedirect?: boolean;\n }\n interface SupportedLanguage$1 {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Locale. */\n locale?: Locale$1;\n /** Whether the supported language is the primary language for the site. */\n isPrimary?: boolean;\n /** Language icon. */\n countryCode?: string;\n /** How the language will be resolved. For internal use. */\n resolutionMethod?: ResolutionMethod$1;\n }\n enum ResolutionMethod$1 {\n QUERY_PARAM = \"QUERY_PARAM\",\n SUBDOMAIN = \"SUBDOMAIN\",\n SUBDIRECTORY = \"SUBDIRECTORY\"\n }\n interface ConsentPolicy$1 {\n /** Whether the site uses cookies that are essential to site operation. */\n essential?: boolean | null;\n /** Whether the site uses cookies that affect site performance and other functional measurements. */\n functional?: boolean | null;\n /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */\n analytics?: boolean | null;\n /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */\n advertising?: boolean | null;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean | null;\n }\n /** A single mapping from the MetaSite ID to a particular service. */\n interface Translation$1 {\n /** The service type. */\n serviceType?: string;\n /** The application definition ID; this only applies to services of type ThirdPartyApps. */\n appDefId?: string;\n /** The instance ID of the service. */\n instanceId?: string;\n }\n interface ChangeContext$1 extends ChangeContextPayloadOneOf$1 {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange$1;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated$1;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$1;\n }\n /** @oneof */\n interface ChangeContextPayloadOneOf$1 {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange$1;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated$1;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$1;\n }\n interface PropertiesChange$1 {\n }\n interface SiteCreated$1 {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned$1 {\n /** Origin site id. */\n originMetaSiteId?: string;\n }\n interface OperationsDataCloningCompleted {\n }\n interface MenusDataCloningCompleted {\n }\n interface MessageEnvelope$5 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$5;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$5;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$5 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$5 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves a menu ordering settings entity.\n * @param menuOrderingSettingsId - ID of the menu ordering settings entity to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField menuOrderingSettingsId\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_READ\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns The requested menu ordering settings entity.\n */\n function getMenuOrderingSettings(menuOrderingSettingsId: string): Promise;\n /**\n * Upserts a menu ordering settings entity for a given `menuId`.\n * Try to create a menu ordering settings, in case it already exists - update the menu ordering settings\n * @param menuId - ID of the menu these settings apply to.\n * @public\n * @documentationMaturity preview\n * @requiredField menuId\n * @requiredField menuOrderingSettings\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_UPSERT\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function upsertMenuOrderingSettingsByMenuId(menuId: string | null, menuOrderingSettings: UpsertMenuOrderingSettingsByMenuIdMenuOrderingSettings, options?: UpsertMenuOrderingSettingsByMenuIdOptions): Promise;\n interface UpsertMenuOrderingSettingsByMenuIdMenuOrderingSettings {\n /**\n * Menu ordering settings object ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating a menu ordering settings object.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** ID of the [restaurant operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/operations/introduction) the menu belongs to. */\n operationId?: string | null;\n /** Whether online ordering is enabled for the menu. */\n onlineOrderingEnabled?: boolean | null;\n /** Menu availability settings. */\n availability?: Availability$1;\n /** Extended fields. */\n extendedFields?: ExtendedFields$4;\n }\n interface UpsertMenuOrderingSettingsByMenuIdOptions {\n }\n /**\n * Updates a menu ordering settings entity.\n *\n * Each time the menu ordering settings entity is updated, `revision` increments by 1. The current `revision` must be passed when updating the menu ordering settings entity.\n * This ensures you're working with the latest entity and prevents unintended overwrites.\n * @param _id - Menu ordering settings object ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField menuOrderingSettings\n * @requiredField menuOrderingSettings.revision\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_UPDATE\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated menu ordering settings entity.\n */\n function updateMenuOrderingSettings(_id: string | null, menuOrderingSettings: UpdateMenuOrderingSettings, options?: UpdateMenuOrderingSettingsOptions): Promise;\n interface UpdateMenuOrderingSettings {\n /**\n * Menu ordering settings object ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating a menu ordering settings object.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** ID of the [restaurant operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/operations/introduction) the menu belongs to. */\n operationId?: string | null;\n /**\n * ID of the menu these settings apply to.\n * @readonly\n */\n menuId?: string | null;\n /** Whether online ordering is enabled for the menu. */\n onlineOrderingEnabled?: boolean | null;\n /** Menu availability settings. */\n availability?: Availability$1;\n /** Extended fields. */\n extendedFields?: ExtendedFields$4;\n }\n interface UpdateMenuOrderingSettingsOptions {\n }\n /**\n * Creates a query to retrieve a list of menu ordering settings objects.\n *\n * The `queryMenuOrderingSettings()` function builds a query to retrieve a list of menu ordering settings objects and returns an `MenuOrderingSettingsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the [`find()`](/menu-ordering-settings/menu-ordering-settings-query-builder/find) function.\n *\n * You can refine the query by chaining `MenuOrderingSettingsQueryBuilder` functions onto the query. `MenuOrderingSettingsQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenuOrderingSettings()` returns.\n *\n * `queryMenuOrderingSettings()` runs with the following `MenuOrderingSettingsQueryBuilder` defaults, which you can override:\n *\n * - [`limit(50)`](/menu-ordering-settings/menu-ordering-settings-query-builder/limit)\n * - [ascending('_id')](/menu-ordering-settings/menu-ordering-settings-query-builder/ascending)\n *\n * The following `MenuOrderingSettingsQueryBuilder` functions are supported for `queryMenuOrderingSettings()`. For a full description of the menu ordering settings object, see the object returned for the [`items`](/menu-ordering-settings/menu-ordering-settings-query-result/items) property in `MenuOrderingSettingsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryMenuOrderingSettings(): MenuOrderingSettingsQueryBuilder;\n interface QueryCursorResult$5 {\n cursors: Cursors$5;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface MenuOrderingSettingsQueryResult extends QueryCursorResult$5 {\n items: MenuOrderingSettings[];\n query: MenuOrderingSettingsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface MenuOrderingSettingsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"_id\" | \"operationId\" | \"menuId\", value: string) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n * @documentationMaturity preview\n */\n hasSome: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\", value: any[]) => MenuOrderingSettingsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\", value: any) => MenuOrderingSettingsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\", value: boolean) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<\"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\">) => MenuOrderingSettingsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n * @documentationMaturity preview\n */\n descending: (...propertyNames: Array<\"_id\" | \"_createdDate\" | \"_updatedDate\" | \"operationId\" | \"menuId\" | \"onlineOrderingEnabled\" | \"availability.type\">) => MenuOrderingSettingsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => MenuOrderingSettingsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => MenuOrderingSettingsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates multiple menu ordering settings entities at once.\n * Each time a menu ordering settings entity is updated, `revision` increments by 1. The existing revision must be included when updating the menu ordering settings entity. This ensures you're working with the entity's latest information, and it prevents unintended overwrites.\n * @param menusOrderingSettings - Menu ordering settings entities to update.\n * @public\n * @documentationMaturity preview\n * @requiredField menusOrderingSettings\n * @requiredField menusOrderingSettings.menuOrderingSettings._id\n * @requiredField menusOrderingSettings.menuOrderingSettings.revision\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_UPDATE\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateMenuOrderingSettings(menusOrderingSettings: MaskedMenuOrderingSettings[], options?: BulkUpdateMenuOrderingSettingsOptions): Promise;\n interface BulkUpdateMenuOrderingSettingsOptions {\n /** Whether to receive the entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * Retrieves a list of a menu's availability statuses for a given time slot and [restaurant operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/operations/introduction).\n * Returns the availability status for the given time slot per menu.\n * @param timeSlot - The time slot for which to check the availability of menus.\n * @public\n * @documentationMaturity preview\n * @requiredField timeSlot\n * @requiredField timeSlot.endTime\n * @requiredField timeSlot.startTime\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_READ\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listMenusAvailabilityStatus(timeSlot: TimeSlot, options?: ListMenusAvailabilityStatusOptions): Promise;\n interface ListMenusAvailabilityStatusOptions {\n /** The ID of the [restaurant operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/operations/introduction) whose menus will be checked. */\n operationId?: string | null;\n /** Cursor paging */\n cursorPaging?: CursorPaging$5;\n }\n /**\n * Updates extended fields of a menu ordering settings entity without incrementing its revision.\n * @param _id - ID of the entity to update.\n * @param namespace - Identifier for the app whose extended fields are being updated.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField namespace\n * @requiredField options\n * @requiredField options.namespaceData\n * @permissionId RESTAURANTS.MENU_ORDERING_SETTINGS_UPDATE\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise;\n interface UpdateExtendedFieldsOptions {\n /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */\n namespaceData: Record | null;\n }\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuOrderingSettings = MenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityAvailabilityTypeOptionsOneOf = AvailabilityAvailabilityTypeOptionsOneOf;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityType = AvailabilityType;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityType: typeof AvailabilityType;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_WeeklyScheduleOptions = WeeklyScheduleOptions;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_TimestampRangesOptions = TimestampRangesOptions;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailableRange = AvailableRange;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_CreateMenuOrderingSettingsRequest = CreateMenuOrderingSettingsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_CreateMenuOrderingSettingsResponse = CreateMenuOrderingSettingsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetMenuOrderingSettingsRequest = GetMenuOrderingSettingsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetMenuOrderingSettingsResponse = GetMenuOrderingSettingsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdRequest = UpsertMenuOrderingSettingsByMenuIdRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdResponse = UpsertMenuOrderingSettingsByMenuIdResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettingsRequest = UpdateMenuOrderingSettingsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettingsResponse = UpdateMenuOrderingSettingsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_DeleteMenuOrderingSettingsRequest = DeleteMenuOrderingSettingsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_DeleteMenuOrderingSettingsResponse = DeleteMenuOrderingSettingsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_QueryMenuOrderingSettingsRequest = QueryMenuOrderingSettingsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_QueryMenuOrderingSettingsResponse = QueryMenuOrderingSettingsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkUpdateMenuOrderingSettingsRequest = BulkUpdateMenuOrderingSettingsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MaskedMenuOrderingSettings = MaskedMenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkUpdateMenuOrderingSettingsResponse = BulkUpdateMenuOrderingSettingsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkMenuOrderingSettingsResult = BulkMenuOrderingSettingsResult;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_ListMenusAvailabilityStatusRequest = ListMenusAvailabilityStatusRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_TimeSlot = TimeSlot;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_ListMenusAvailabilityStatusResponse = ListMenusAvailabilityStatusResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuAvailabilityStatus = MenuAvailabilityStatus;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityStatus = AvailabilityStatus;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityStatus: typeof AvailabilityStatus;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateExtendedFieldsRequest = UpdateExtendedFieldsRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetRestaurantsAppClonesStatusRequest = GetRestaurantsAppClonesStatusRequest;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetRestaurantsAppClonesStatusResponse = GetRestaurantsAppClonesStatusResponse;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_RestaurantsAppCloneStatus = RestaurantsAppCloneStatus;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_OperationsDataCloningCompleted = OperationsDataCloningCompleted;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenusDataCloningCompleted = MenusDataCloningCompleted;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_getMenuOrderingSettings: typeof getMenuOrderingSettings;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_upsertMenuOrderingSettingsByMenuId: typeof upsertMenuOrderingSettingsByMenuId;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdMenuOrderingSettings = UpsertMenuOrderingSettingsByMenuIdMenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdOptions = UpsertMenuOrderingSettingsByMenuIdOptions;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_updateMenuOrderingSettings: typeof updateMenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettings = UpdateMenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettingsOptions = UpdateMenuOrderingSettingsOptions;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_queryMenuOrderingSettings: typeof queryMenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuOrderingSettingsQueryResult = MenuOrderingSettingsQueryResult;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuOrderingSettingsQueryBuilder = MenuOrderingSettingsQueryBuilder;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_bulkUpdateMenuOrderingSettings: typeof bulkUpdateMenuOrderingSettings;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkUpdateMenuOrderingSettingsOptions = BulkUpdateMenuOrderingSettingsOptions;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_listMenusAvailabilityStatus: typeof listMenusAvailabilityStatus;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_ListMenusAvailabilityStatusOptions = ListMenusAvailabilityStatusOptions;\n const restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_updateExtendedFields: typeof updateExtendedFields;\n type restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateExtendedFieldsOptions = UpdateExtendedFieldsOptions;\n namespace restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d {\n export { restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuOrderingSettings as MenuOrderingSettings, Availability$1 as Availability, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityAvailabilityTypeOptionsOneOf as AvailabilityAvailabilityTypeOptionsOneOf, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityType as AvailabilityType, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_WeeklyScheduleOptions as WeeklyScheduleOptions, DayOfWeekAvailability$1 as DayOfWeekAvailability, EntitiesDayOfWeek$1 as EntitiesDayOfWeek, TimeOfDayRange$1 as TimeOfDayRange, TimeOfDay$1 as TimeOfDay, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_TimestampRangesOptions as TimestampRangesOptions, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailableRange as AvailableRange, ExtendedFields$4 as ExtendedFields, InvalidateCache$5 as InvalidateCache, InvalidateCacheGetByOneOf$5 as InvalidateCacheGetByOneOf, App$5 as App, Page$5 as Page, URI$5 as URI, File$5 as File, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_CreateMenuOrderingSettingsRequest as CreateMenuOrderingSettingsRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_CreateMenuOrderingSettingsResponse as CreateMenuOrderingSettingsResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetMenuOrderingSettingsRequest as GetMenuOrderingSettingsRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetMenuOrderingSettingsResponse as GetMenuOrderingSettingsResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdRequest as UpsertMenuOrderingSettingsByMenuIdRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdResponse as UpsertMenuOrderingSettingsByMenuIdResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettingsRequest as UpdateMenuOrderingSettingsRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettingsResponse as UpdateMenuOrderingSettingsResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_DeleteMenuOrderingSettingsRequest as DeleteMenuOrderingSettingsRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_DeleteMenuOrderingSettingsResponse as DeleteMenuOrderingSettingsResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_QueryMenuOrderingSettingsRequest as QueryMenuOrderingSettingsRequest, CursorQuery$5 as CursorQuery, CursorQueryPagingMethodOneOf$5 as CursorQueryPagingMethodOneOf, Sorting$5 as Sorting, SortOrder$5 as SortOrder, CursorPaging$5 as CursorPaging, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_QueryMenuOrderingSettingsResponse as QueryMenuOrderingSettingsResponse, CursorPagingMetadata$5 as CursorPagingMetadata, Cursors$5 as Cursors, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkUpdateMenuOrderingSettingsRequest as BulkUpdateMenuOrderingSettingsRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MaskedMenuOrderingSettings as MaskedMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkUpdateMenuOrderingSettingsResponse as BulkUpdateMenuOrderingSettingsResponse, ItemMetadata$4 as ItemMetadata, ApplicationError$4 as ApplicationError, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkMenuOrderingSettingsResult as BulkMenuOrderingSettingsResult, BulkActionMetadata$4 as BulkActionMetadata, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_ListMenusAvailabilityStatusRequest as ListMenusAvailabilityStatusRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_TimeSlot as TimeSlot, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_ListMenusAvailabilityStatusResponse as ListMenusAvailabilityStatusResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuAvailabilityStatus as MenuAvailabilityStatus, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_AvailabilityStatus as AvailabilityStatus, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse, DomainEvent$5 as DomainEvent, DomainEventBodyOneOf$5 as DomainEventBodyOneOf, EntityCreatedEvent$5 as EntityCreatedEvent, RestoreInfo$5 as RestoreInfo, EntityUpdatedEvent$5 as EntityUpdatedEvent, EntityDeletedEvent$5 as EntityDeletedEvent, ActionEvent$5 as ActionEvent, Empty$5 as Empty, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetRestaurantsAppClonesStatusRequest as GetRestaurantsAppClonesStatusRequest, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_GetRestaurantsAppClonesStatusResponse as GetRestaurantsAppClonesStatusResponse, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_RestaurantsAppCloneStatus as RestaurantsAppCloneStatus, SitePropertiesNotification$1 as SitePropertiesNotification, SitePropertiesEvent$1 as SitePropertiesEvent, Properties$1 as Properties, Categories$1 as Categories, Locale$1 as Locale, Address$1 as Address, AddressHint$1 as AddressHint, PlacementType$1 as PlacementType, GeoCoordinates$1 as GeoCoordinates, BusinessSchedule$1 as BusinessSchedule, TimePeriod$1 as TimePeriod, DayOfWeek$1 as DayOfWeek, SpecialHourPeriod$1 as SpecialHourPeriod, Multilingual$1 as Multilingual, SupportedLanguage$1 as SupportedLanguage, ResolutionMethod$1 as ResolutionMethod, ConsentPolicy$1 as ConsentPolicy, Translation$1 as Translation, ChangeContext$1 as ChangeContext, ChangeContextPayloadOneOf$1 as ChangeContextPayloadOneOf, PropertiesChange$1 as PropertiesChange, SiteCreated$1 as SiteCreated, SiteCloned$1 as SiteCloned, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_OperationsDataCloningCompleted as OperationsDataCloningCompleted, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenusDataCloningCompleted as MenusDataCloningCompleted, MessageEnvelope$5 as MessageEnvelope, IdentificationData$5 as IdentificationData, IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, WebhookIdentityType$5 as WebhookIdentityType, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_getMenuOrderingSettings as getMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_upsertMenuOrderingSettingsByMenuId as upsertMenuOrderingSettingsByMenuId, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdMenuOrderingSettings as UpsertMenuOrderingSettingsByMenuIdMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpsertMenuOrderingSettingsByMenuIdOptions as UpsertMenuOrderingSettingsByMenuIdOptions, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_updateMenuOrderingSettings as updateMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettings as UpdateMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateMenuOrderingSettingsOptions as UpdateMenuOrderingSettingsOptions, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_queryMenuOrderingSettings as queryMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuOrderingSettingsQueryResult as MenuOrderingSettingsQueryResult, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_MenuOrderingSettingsQueryBuilder as MenuOrderingSettingsQueryBuilder, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_bulkUpdateMenuOrderingSettings as bulkUpdateMenuOrderingSettings, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_BulkUpdateMenuOrderingSettingsOptions as BulkUpdateMenuOrderingSettingsOptions, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_listMenusAvailabilityStatus as listMenusAvailabilityStatus, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_ListMenusAvailabilityStatusOptions as ListMenusAvailabilityStatusOptions, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_updateExtendedFields as updateExtendedFields, restaurantsMenuSettingsV1MenuOrderingSettingsMenuOrderingSettings_universal_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions, };\n }\n interface Item extends ItemPricingOneOf {\n /** Item price variants. */\n priceVariants?: PriceVariants;\n /** Item price info. */\n priceInfo?: PriceInfo;\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item is updated. To prevent conflicting changes, the current revision must be passed when updating the item. Ignored when creating a item.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item name. */\n name?: string;\n /** Item description. */\n description?: string | null;\n /** Main item image. */\n image?: string;\n /** Additional item images. */\n additionalImages?: string[];\n /** Item labels. */\n labels?: Label$1[];\n /** Whether the item is visible in the menu for site visitors. */\n visible?: boolean | null;\n /** Online order settings. */\n orderSettings?: OrderSettings;\n /** Item modifier groups. */\n modifierGroups?: ModifierGroup$1[];\n /** Extended fields. */\n extendedFields?: ExtendedFields$3;\n }\n /** @oneof */\n interface ItemPricingOneOf {\n /** Item price variants. */\n priceVariants?: PriceVariants;\n /** Item price info. */\n priceInfo?: PriceInfo;\n }\n interface PriceVariants {\n /** List of price variants. */\n variants?: PriceVariant[];\n }\n /** flynt-deleted-field-enum-reserved */\n interface PriceVariant {\n /** Price variant ID. */\n variantId?: string | null;\n /**\n * Price of a variant.\n * @deprecated Price of a variant.\n * @replacedBy pricing.price_variants.variants.price_info\n * @targetRemovalDate 2024-08-01\n */\n price?: string | null;\n /** Price info of a variant. */\n priceInfo?: PriceInfo;\n }\n interface PriceInfo {\n /** Price. */\n price?: string;\n }\n interface Label$1 {\n /** Item label ID. */\n _id?: string;\n }\n interface OrderSettings {\n /**\n * Whether the item is in stock.\n * Default: `true`.\n */\n inStock?: boolean | null;\n /**\n * Whether a customer can add a special request when ordering this item.\n * Default: `true`.\n */\n acceptSpecialRequests?: boolean | null;\n }\n interface ModifierGroup$1 {\n /** Modifier group ID. */\n _id?: string | null;\n }\n interface ExtendedFields$3 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: DocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update documents matching filter */\n updateByFilter?: UpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: UpdateExistingOperation;\n /** application which owns documents */\n appDefId?: string | null;\n /** type of the documents */\n documentType?: string | null;\n /** language of the documents */\n language?: string | null;\n /** site documents belong to */\n msId?: string | null;\n }\n /** @oneof */\n interface UpdateDocumentsEventOperationOneOf {\n /** insert/update documents */\n update?: DocumentUpdateOperation;\n /** delete by document ids */\n deleteByIds?: DeleteByIdsOperation;\n /** delete documents matching filter */\n deleteByFilter?: DeleteByFilterOperation;\n /** update documents matching filter */\n updateByFilter?: UpdateByFilterOperation;\n /** update only existing documents */\n updateExisting?: UpdateExistingOperation;\n }\n interface DocumentUpdateOperation {\n /** documents to index or update */\n documents?: IndexDocument[];\n }\n interface IndexDocument {\n /** data bag with non-searchable fields (url, image) */\n payload?: DocumentPayload;\n /** what type of users should documents be visible to */\n exposure?: Enum;\n /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */\n document?: Record | null;\n /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */\n permittedMemberGroups?: string[];\n /** if true SEO is disabled for this document */\n seoHidden?: boolean | null;\n /** if true the page is a lightbox popup */\n isPopup?: boolean | null;\n }\n interface DocumentPayload {\n /** url of the page representing the document */\n url?: string | null;\n /** image which represents the document */\n documentImage?: DocumentImage;\n }\n interface DocumentImage {\n /** the name of the image */\n name?: string;\n /** the width of the image */\n width?: number;\n /** the height of the image */\n height?: number;\n }\n enum Enum {\n /** Default value. Means that permission not set */\n UNKNOWN = \"UNKNOWN\",\n /** Protected exposure. Exposed to members and owners */\n PROTECTED = \"PROTECTED\",\n /** Private exposure. Exposed to owners */\n PRIVATE = \"PRIVATE\",\n /** Public exposure. Visible to everyone */\n PUBLIC = \"PUBLIC\",\n /** Used for partial updates, to state that exposure is not changing */\n UNCHANGED = \"UNCHANGED\",\n /** Protected to members of permitted groups and owners */\n GROUP_PROTECTED = \"GROUP_PROTECTED\"\n }\n interface DeleteByIdsOperation {\n /** ids of the documents to delete */\n documentIds?: string[];\n }\n interface DeleteByFilterOperation {\n /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */\n filter?: Record | null;\n }\n interface UpdateByFilterOperation {\n /** documents matching this filter will be updated */\n filter?: Record | null;\n /** partial document to apply */\n document?: IndexDocument;\n }\n interface UpdateExistingOperation {\n /** documents to update */\n documents?: IndexDocument[];\n }\n interface DomainEvent$4 extends DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$4 {\n createdEvent?: EntityCreatedEvent$4;\n updatedEvent?: EntityUpdatedEvent$4;\n deletedEvent?: EntityDeletedEvent$4;\n actionEvent?: ActionEvent$4;\n }\n interface EntityCreatedEvent$4 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$4 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$4 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface Empty$4 {\n }\n interface SearchIndexingNotification {\n /** new state of indexing for the site specified in ms_id */\n indexState?: State;\n /** type of the document the notification is targeted for. Applies to all types if not provided */\n documentType?: string | null;\n /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */\n language?: string | null;\n /** site for which notification is targeted */\n msId?: string | null;\n }\n enum State {\n /** default state */\n Unknown = \"Unknown\",\n /** metasite does not require site search indexing */\n Off = \"Off\",\n /** metasite requires site search indexing */\n On = \"On\"\n }\n interface MessageEnvelope$4 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$4;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$4;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$4 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$4 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface InvalidateCache$4 extends InvalidateCacheGetByOneOf$4 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$4;\n /** Invalidate by page id */\n page?: Page$4;\n /** Invalidate by URI path */\n uri?: URI$4;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$4;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$4 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$4;\n /** Invalidate by page id */\n page?: Page$4;\n /** Invalidate by URI path */\n uri?: URI$4;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$4;\n }\n interface App$4 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$4 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$4 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$4 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface CreateItemRequest {\n /** Item details. */\n item: Item;\n }\n interface CreateItemResponse {\n /** Item. */\n item?: Item;\n }\n interface BulkCreateItemsRequest {\n /** Items details. */\n items: Item[];\n /** Whether to return entity in the response. */\n returnEntity?: boolean;\n }\n interface BulkCreateItemsResponse {\n /** Information about the created items. */\n results?: BulkCreateItemResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface BulkCreateItemResult {\n /** Metadata for item update. */\n itemMetadata?: ItemMetadata$3;\n /** Created item. */\n item?: Item;\n }\n interface ItemMetadata$3 {\n /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */\n _id?: string | null;\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number;\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean;\n /** Details about the error in case of failure. */\n error?: ApplicationError$3;\n }\n interface ApplicationError$3 {\n /** Error code. */\n code?: string;\n /** Description of the error. */\n description?: string;\n /** Data related to the error. */\n data?: Record | null;\n }\n interface BulkActionMetadata$3 {\n /** Number of items that were successfully processed. */\n totalSuccesses?: number;\n /** Number of items that couldn't be processed. */\n totalFailures?: number;\n /** Number of failures without details because detailed failure threshold was exceeded. */\n undetailedFailures?: number;\n }\n interface GetItemRequest {\n /** Item ID. */\n itemId: string;\n }\n interface GetItemResponse {\n /** Item. */\n item?: Item;\n }\n interface ListItemsRequest {\n /** Item IDs. */\n itemIds?: string[];\n /** The metadata of the paginated results. */\n paging?: CursorPaging$4;\n }\n interface CursorPaging$4 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface ListItemsResponse {\n /** Items. */\n items?: Item[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$4;\n }\n interface CursorPagingMetadata$4 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$4;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$4 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface QueryItemsRequest {\n /** Query options. */\n query?: CursorQuery$4;\n }\n interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$4;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$4[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$4 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$4;\n }\n interface Sorting$4 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$4;\n }\n enum SortOrder$4 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryItemsResponse {\n /** Retrieved items. */\n items?: Item[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$4;\n }\n interface CountItemsRequest {\n /** Filter for counting items. */\n filter?: Record | null;\n }\n interface CountItemsResponse {\n /** Counted items. */\n count?: number;\n }\n interface UpdateItemRequest {\n /** Item to update. */\n item: Item;\n }\n interface UpdateItemResponse {\n /** Updated item. */\n item?: Item;\n }\n interface BulkUpdateItemRequest {\n /** Items to update. */\n items: MaskedItem[];\n /** Whether to return entity in the response. */\n returnEntity?: boolean;\n }\n interface MaskedItem {\n /** Item to update. */\n item?: Item;\n }\n interface BulkUpdateItemResponse {\n /** Information about the updated items. */\n results?: BulkItemResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface BulkItemResult {\n /** Metadata for item update. */\n itemMetadata?: ItemMetadata$3;\n /** Updated item. Only returned if `returnEntity` is set to `true`. */\n item?: Item;\n }\n interface DeleteItemRequest {\n /** Item ID. */\n itemId: string;\n }\n interface DeleteItemResponse {\n }\n interface BulkDeleteItemsRequest {\n /** Item IDs. */\n ids: string[];\n }\n interface BulkDeleteItemsResponse {\n /** Information about the deleted items. */\n results?: BulkDeleteItemResult[];\n /** Metadata for the API call. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface BulkDeleteItemResult {\n /** Metadata for item delete. */\n itemMetadata?: ItemMetadata$3;\n }\n interface CloneItemsRequest {\n /** The MetaSiteId to clone from. */\n metaSiteId: string;\n }\n interface CloneItemsResponse {\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates an item.\n *\n * To create multiple items at once, use [Bulk Create Items](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item/bulk-create-items).\n * @param item - Item details.\n * @public\n * @documentationMaturity preview\n * @requiredField item\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Item.\n */\n function createItem(item: Item, options?: CreateItemOptions): Promise;\n interface CreateItemOptions {\n }\n /**\n * > **Note:** The Items API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates multiple items at once.\n * @param items - Items details.\n * @public\n * @documentationMaturity preview\n * @requiredField items\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkCreateItems(items: Item[], options?: BulkCreateItemsOptions): Promise;\n interface BulkCreateItemsOptions {\n /** Whether to return entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves an item by ID.\n * @param itemId - Item ID.\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Item.\n */\n function getItem(itemId: string): Promise;\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves a list of up to 500 items.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function listItems(options?: ListItemsOptions): Promise;\n interface ListItemsOptions {\n /** Item IDs. */\n itemIds?: string[];\n /** The metadata of the paginated results. */\n paging?: CursorPaging$4;\n }\n /**\n * Creates a query to retrieve a list of items.\n *\n * The `queryItems()` function builds a query to retrieve a list of items and returns a `ItemsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is used to run the query using the [`find()`](/items/items-query-builder/find) function.\n *\n * You can refine the query by chaining `ItemsQueryBuilder` functions onto the query. `ItemsQueryBuilder` functions enable you to filter, sort, and control the results that `queryItems()` returns.\n *\n * `queryItems()` runs with the following `ItemsQueryBuilder` defaults, which you can override:\n *\n * * [`limit(500)`](/items/items-query-builder/limit)\n * * [`ascending('entityId')`](/items/items-query-builder/ascending)\n *\n * The following `ItemsQueryBuilder` functions are supported for `queryItems()`. For a full description of the item object, see the object returned for the [`items`](/items/items-query-result/items) property in `ItemsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @permissionId RESTAURANTS.ITEM_READ\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function queryItems(): ItemsQueryBuilder;\n interface QueryCursorResult$4 {\n cursors: Cursors$4;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ItemsQueryResult extends QueryCursorResult$4 {\n items: Item[];\n query: ItemsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ItemsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: \"priceVariants.variants.price\" | \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"image.id\" | \"orderSettings.inStock\" | \"orderSettings.acceptSpecialRequests\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: \"priceVariants.variants.price\" | \"_id\" | \"_createdDate\" | \"_updatedDate\" | \"name\" | \"description\" | \"image.id\" | \"orderSettings.inStock\" | \"orderSettings.acceptSpecialRequests\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: \"_createdDate\" | \"_updatedDate\", value: any) => ItemsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n * @documentationMaturity preview\n */\n startsWith: (propertyName: \"name\" | \"description\", value: string) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: \"_id\" | \"name\" | \"description\" | \"orderSettings.inStock\" | \"orderSettings.acceptSpecialRequests\", value: any) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: \"priceVariants.variants\" | \"image\" | \"labels\" | \"orderSettings\", value: boolean) => ItemsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n * @documentationMaturity preview\n */\n limit: (limit: number) => ItemsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Retrieves the number of items that match a specified filter.\n *\n * If a filter isn't passed in the request, the endpoint returns the count of all items.\n * @public\n * @documentationMaturity preview\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n */\n function countItems(options?: CountItemsOptions): Promise;\n interface CountItemsOptions {\n /** Filter for counting items. */\n filter?: Record | null;\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates an item.\n *\n * To update multiple items at once, use [Bulk Update Item](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item/bulk-update-item)\n *\n * Each time an item is updated, its revision increments by 1. The existing revision must be included when updating the item. This ensures you're working with the latest item information, and it prevents unintended overwrites.\n * @param _id - Item ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField item\n * @requiredField item.revision\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Updated item.\n */\n function updateItem(_id: string | null, item: UpdateItem, options?: UpdateItemOptions): Promise;\n interface UpdateItem {\n /** Item price variants. */\n priceVariants?: PriceVariants;\n /** Item price info. */\n priceInfo?: PriceInfo;\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item is updated. To prevent conflicting changes, the current revision must be passed when updating the item. Ignored when creating a item.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item name. */\n name?: string;\n /** Item description. */\n description?: string | null;\n /** Main item image. */\n image?: string;\n /** Additional item images. */\n additionalImages?: string[];\n /** Item labels. */\n labels?: Label$1[];\n /** Whether the item is visible in the menu for site visitors. */\n visible?: boolean | null;\n /** Online order settings. */\n orderSettings?: OrderSettings;\n /** Item modifier groups. */\n modifierGroups?: ModifierGroup$1[];\n /** Extended fields. */\n extendedFields?: ExtendedFields$3;\n }\n interface UpdateItemOptions {\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Updates up to 100 multiple items at once.\n *\n * Each time an item is updated, its revision increments by 1. The existing revision must be included when updating item. This ensures you're working with the latest item information, and it prevents unintended overwrites.\n * @param items - Items to update.\n * @public\n * @documentationMaturity preview\n * @requiredField items\n * @requiredField items.item._id\n * @requiredField items.item.revision\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkUpdateItem(items: MaskedItem[], options?: BulkUpdateItemOptions): Promise;\n interface BulkUpdateItemOptions {\n /** Whether to return entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Deletes an item.\n * @param itemId - Item ID.\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function deleteItem(itemId: string, options?: DeleteItemOptions): Promise;\n interface DeleteItemOptions {\n }\n /**\n * > **Note:** The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Deletes multiple items at once.\n * @param ids - Item IDs.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n */\n function bulkDeleteItems(ids: string[], options?: BulkDeleteItemsOptions): Promise;\n interface BulkDeleteItemsOptions {\n }\n type restaurantsMenusV1ItemItems_universal_d_Item = Item;\n type restaurantsMenusV1ItemItems_universal_d_ItemPricingOneOf = ItemPricingOneOf;\n type restaurantsMenusV1ItemItems_universal_d_PriceVariants = PriceVariants;\n type restaurantsMenusV1ItemItems_universal_d_PriceVariant = PriceVariant;\n type restaurantsMenusV1ItemItems_universal_d_PriceInfo = PriceInfo;\n type restaurantsMenusV1ItemItems_universal_d_OrderSettings = OrderSettings;\n type restaurantsMenusV1ItemItems_universal_d_UpdateDocumentsEvent = UpdateDocumentsEvent;\n type restaurantsMenusV1ItemItems_universal_d_UpdateDocumentsEventOperationOneOf = UpdateDocumentsEventOperationOneOf;\n type restaurantsMenusV1ItemItems_universal_d_DocumentUpdateOperation = DocumentUpdateOperation;\n type restaurantsMenusV1ItemItems_universal_d_IndexDocument = IndexDocument;\n type restaurantsMenusV1ItemItems_universal_d_DocumentPayload = DocumentPayload;\n type restaurantsMenusV1ItemItems_universal_d_DocumentImage = DocumentImage;\n type restaurantsMenusV1ItemItems_universal_d_Enum = Enum;\n const restaurantsMenusV1ItemItems_universal_d_Enum: typeof Enum;\n type restaurantsMenusV1ItemItems_universal_d_DeleteByIdsOperation = DeleteByIdsOperation;\n type restaurantsMenusV1ItemItems_universal_d_DeleteByFilterOperation = DeleteByFilterOperation;\n type restaurantsMenusV1ItemItems_universal_d_UpdateByFilterOperation = UpdateByFilterOperation;\n type restaurantsMenusV1ItemItems_universal_d_UpdateExistingOperation = UpdateExistingOperation;\n type restaurantsMenusV1ItemItems_universal_d_SearchIndexingNotification = SearchIndexingNotification;\n type restaurantsMenusV1ItemItems_universal_d_State = State;\n const restaurantsMenusV1ItemItems_universal_d_State: typeof State;\n type restaurantsMenusV1ItemItems_universal_d_CreateItemRequest = CreateItemRequest;\n type restaurantsMenusV1ItemItems_universal_d_CreateItemResponse = CreateItemResponse;\n type restaurantsMenusV1ItemItems_universal_d_BulkCreateItemsRequest = BulkCreateItemsRequest;\n type restaurantsMenusV1ItemItems_universal_d_BulkCreateItemsResponse = BulkCreateItemsResponse;\n type restaurantsMenusV1ItemItems_universal_d_BulkCreateItemResult = BulkCreateItemResult;\n type restaurantsMenusV1ItemItems_universal_d_GetItemRequest = GetItemRequest;\n type restaurantsMenusV1ItemItems_universal_d_GetItemResponse = GetItemResponse;\n type restaurantsMenusV1ItemItems_universal_d_ListItemsRequest = ListItemsRequest;\n type restaurantsMenusV1ItemItems_universal_d_ListItemsResponse = ListItemsResponse;\n type restaurantsMenusV1ItemItems_universal_d_QueryItemsRequest = QueryItemsRequest;\n type restaurantsMenusV1ItemItems_universal_d_QueryItemsResponse = QueryItemsResponse;\n type restaurantsMenusV1ItemItems_universal_d_CountItemsRequest = CountItemsRequest;\n type restaurantsMenusV1ItemItems_universal_d_CountItemsResponse = CountItemsResponse;\n type restaurantsMenusV1ItemItems_universal_d_UpdateItemRequest = UpdateItemRequest;\n type restaurantsMenusV1ItemItems_universal_d_UpdateItemResponse = UpdateItemResponse;\n type restaurantsMenusV1ItemItems_universal_d_BulkUpdateItemRequest = BulkUpdateItemRequest;\n type restaurantsMenusV1ItemItems_universal_d_MaskedItem = MaskedItem;\n type restaurantsMenusV1ItemItems_universal_d_BulkUpdateItemResponse = BulkUpdateItemResponse;\n type restaurantsMenusV1ItemItems_universal_d_BulkItemResult = BulkItemResult;\n type restaurantsMenusV1ItemItems_universal_d_DeleteItemRequest = DeleteItemRequest;\n type restaurantsMenusV1ItemItems_universal_d_DeleteItemResponse = DeleteItemResponse;\n type restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemsRequest = BulkDeleteItemsRequest;\n type restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemsResponse = BulkDeleteItemsResponse;\n type restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemResult = BulkDeleteItemResult;\n type restaurantsMenusV1ItemItems_universal_d_CloneItemsRequest = CloneItemsRequest;\n type restaurantsMenusV1ItemItems_universal_d_CloneItemsResponse = CloneItemsResponse;\n const restaurantsMenusV1ItemItems_universal_d_createItem: typeof createItem;\n type restaurantsMenusV1ItemItems_universal_d_CreateItemOptions = CreateItemOptions;\n const restaurantsMenusV1ItemItems_universal_d_bulkCreateItems: typeof bulkCreateItems;\n type restaurantsMenusV1ItemItems_universal_d_BulkCreateItemsOptions = BulkCreateItemsOptions;\n const restaurantsMenusV1ItemItems_universal_d_getItem: typeof getItem;\n const restaurantsMenusV1ItemItems_universal_d_listItems: typeof listItems;\n type restaurantsMenusV1ItemItems_universal_d_ListItemsOptions = ListItemsOptions;\n const restaurantsMenusV1ItemItems_universal_d_queryItems: typeof queryItems;\n type restaurantsMenusV1ItemItems_universal_d_ItemsQueryResult = ItemsQueryResult;\n type restaurantsMenusV1ItemItems_universal_d_ItemsQueryBuilder = ItemsQueryBuilder;\n const restaurantsMenusV1ItemItems_universal_d_countItems: typeof countItems;\n type restaurantsMenusV1ItemItems_universal_d_CountItemsOptions = CountItemsOptions;\n const restaurantsMenusV1ItemItems_universal_d_updateItem: typeof updateItem;\n type restaurantsMenusV1ItemItems_universal_d_UpdateItem = UpdateItem;\n type restaurantsMenusV1ItemItems_universal_d_UpdateItemOptions = UpdateItemOptions;\n const restaurantsMenusV1ItemItems_universal_d_bulkUpdateItem: typeof bulkUpdateItem;\n type restaurantsMenusV1ItemItems_universal_d_BulkUpdateItemOptions = BulkUpdateItemOptions;\n const restaurantsMenusV1ItemItems_universal_d_deleteItem: typeof deleteItem;\n type restaurantsMenusV1ItemItems_universal_d_DeleteItemOptions = DeleteItemOptions;\n const restaurantsMenusV1ItemItems_universal_d_bulkDeleteItems: typeof bulkDeleteItems;\n type restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemsOptions = BulkDeleteItemsOptions;\n namespace restaurantsMenusV1ItemItems_universal_d {\n export { restaurantsMenusV1ItemItems_universal_d_Item as Item, restaurantsMenusV1ItemItems_universal_d_ItemPricingOneOf as ItemPricingOneOf, restaurantsMenusV1ItemItems_universal_d_PriceVariants as PriceVariants, restaurantsMenusV1ItemItems_universal_d_PriceVariant as PriceVariant, restaurantsMenusV1ItemItems_universal_d_PriceInfo as PriceInfo, Label$1 as Label, restaurantsMenusV1ItemItems_universal_d_OrderSettings as OrderSettings, ModifierGroup$1 as ModifierGroup, ExtendedFields$3 as ExtendedFields, restaurantsMenusV1ItemItems_universal_d_UpdateDocumentsEvent as UpdateDocumentsEvent, restaurantsMenusV1ItemItems_universal_d_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf, restaurantsMenusV1ItemItems_universal_d_DocumentUpdateOperation as DocumentUpdateOperation, restaurantsMenusV1ItemItems_universal_d_IndexDocument as IndexDocument, restaurantsMenusV1ItemItems_universal_d_DocumentPayload as DocumentPayload, restaurantsMenusV1ItemItems_universal_d_DocumentImage as DocumentImage, restaurantsMenusV1ItemItems_universal_d_Enum as Enum, restaurantsMenusV1ItemItems_universal_d_DeleteByIdsOperation as DeleteByIdsOperation, restaurantsMenusV1ItemItems_universal_d_DeleteByFilterOperation as DeleteByFilterOperation, restaurantsMenusV1ItemItems_universal_d_UpdateByFilterOperation as UpdateByFilterOperation, restaurantsMenusV1ItemItems_universal_d_UpdateExistingOperation as UpdateExistingOperation, DomainEvent$4 as DomainEvent, DomainEventBodyOneOf$4 as DomainEventBodyOneOf, EntityCreatedEvent$4 as EntityCreatedEvent, RestoreInfo$4 as RestoreInfo, EntityUpdatedEvent$4 as EntityUpdatedEvent, EntityDeletedEvent$4 as EntityDeletedEvent, ActionEvent$4 as ActionEvent, Empty$4 as Empty, restaurantsMenusV1ItemItems_universal_d_SearchIndexingNotification as SearchIndexingNotification, restaurantsMenusV1ItemItems_universal_d_State as State, MessageEnvelope$4 as MessageEnvelope, IdentificationData$4 as IdentificationData, IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, WebhookIdentityType$4 as WebhookIdentityType, InvalidateCache$4 as InvalidateCache, InvalidateCacheGetByOneOf$4 as InvalidateCacheGetByOneOf, App$4 as App, Page$4 as Page, URI$4 as URI, File$4 as File, restaurantsMenusV1ItemItems_universal_d_CreateItemRequest as CreateItemRequest, restaurantsMenusV1ItemItems_universal_d_CreateItemResponse as CreateItemResponse, restaurantsMenusV1ItemItems_universal_d_BulkCreateItemsRequest as BulkCreateItemsRequest, restaurantsMenusV1ItemItems_universal_d_BulkCreateItemsResponse as BulkCreateItemsResponse, restaurantsMenusV1ItemItems_universal_d_BulkCreateItemResult as BulkCreateItemResult, ItemMetadata$3 as ItemMetadata, ApplicationError$3 as ApplicationError, BulkActionMetadata$3 as BulkActionMetadata, restaurantsMenusV1ItemItems_universal_d_GetItemRequest as GetItemRequest, restaurantsMenusV1ItemItems_universal_d_GetItemResponse as GetItemResponse, restaurantsMenusV1ItemItems_universal_d_ListItemsRequest as ListItemsRequest, CursorPaging$4 as CursorPaging, restaurantsMenusV1ItemItems_universal_d_ListItemsResponse as ListItemsResponse, CursorPagingMetadata$4 as CursorPagingMetadata, Cursors$4 as Cursors, restaurantsMenusV1ItemItems_universal_d_QueryItemsRequest as QueryItemsRequest, CursorQuery$4 as CursorQuery, CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf, Sorting$4 as Sorting, SortOrder$4 as SortOrder, restaurantsMenusV1ItemItems_universal_d_QueryItemsResponse as QueryItemsResponse, restaurantsMenusV1ItemItems_universal_d_CountItemsRequest as CountItemsRequest, restaurantsMenusV1ItemItems_universal_d_CountItemsResponse as CountItemsResponse, restaurantsMenusV1ItemItems_universal_d_UpdateItemRequest as UpdateItemRequest, restaurantsMenusV1ItemItems_universal_d_UpdateItemResponse as UpdateItemResponse, restaurantsMenusV1ItemItems_universal_d_BulkUpdateItemRequest as BulkUpdateItemRequest, restaurantsMenusV1ItemItems_universal_d_MaskedItem as MaskedItem, restaurantsMenusV1ItemItems_universal_d_BulkUpdateItemResponse as BulkUpdateItemResponse, restaurantsMenusV1ItemItems_universal_d_BulkItemResult as BulkItemResult, restaurantsMenusV1ItemItems_universal_d_DeleteItemRequest as DeleteItemRequest, restaurantsMenusV1ItemItems_universal_d_DeleteItemResponse as DeleteItemResponse, restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemsRequest as BulkDeleteItemsRequest, restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemsResponse as BulkDeleteItemsResponse, restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemResult as BulkDeleteItemResult, restaurantsMenusV1ItemItems_universal_d_CloneItemsRequest as CloneItemsRequest, restaurantsMenusV1ItemItems_universal_d_CloneItemsResponse as CloneItemsResponse, restaurantsMenusV1ItemItems_universal_d_createItem as createItem, restaurantsMenusV1ItemItems_universal_d_CreateItemOptions as CreateItemOptions, restaurantsMenusV1ItemItems_universal_d_bulkCreateItems as bulkCreateItems, restaurantsMenusV1ItemItems_universal_d_BulkCreateItemsOptions as BulkCreateItemsOptions, restaurantsMenusV1ItemItems_universal_d_getItem as getItem, restaurantsMenusV1ItemItems_universal_d_listItems as listItems, restaurantsMenusV1ItemItems_universal_d_ListItemsOptions as ListItemsOptions, restaurantsMenusV1ItemItems_universal_d_queryItems as queryItems, restaurantsMenusV1ItemItems_universal_d_ItemsQueryResult as ItemsQueryResult, restaurantsMenusV1ItemItems_universal_d_ItemsQueryBuilder as ItemsQueryBuilder, restaurantsMenusV1ItemItems_universal_d_countItems as countItems, restaurantsMenusV1ItemItems_universal_d_CountItemsOptions as CountItemsOptions, restaurantsMenusV1ItemItems_universal_d_updateItem as updateItem, restaurantsMenusV1ItemItems_universal_d_UpdateItem as UpdateItem, restaurantsMenusV1ItemItems_universal_d_UpdateItemOptions as UpdateItemOptions, restaurantsMenusV1ItemItems_universal_d_bulkUpdateItem as bulkUpdateItem, restaurantsMenusV1ItemItems_universal_d_BulkUpdateItemOptions as BulkUpdateItemOptions, restaurantsMenusV1ItemItems_universal_d_deleteItem as deleteItem, restaurantsMenusV1ItemItems_universal_d_DeleteItemOptions as DeleteItemOptions, restaurantsMenusV1ItemItems_universal_d_bulkDeleteItems as bulkDeleteItems, restaurantsMenusV1ItemItems_universal_d_BulkDeleteItemsOptions as BulkDeleteItemsOptions, };\n }\n interface Label {\n /**\n * Item label ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the item label was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time the item label was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Item label name. */\n name?: string;\n /** Item label icon. */\n icon?: string;\n /** Extended fields. */\n extendedFields?: ExtendedFields$2;\n }\n interface ExtendedFields$2 {\n /**\n * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n * The value of each key is structured according to the schema defined when the extended fields were configured.\n *\n * You can only access fields for which you have the appropriate permissions.\n *\n * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n */\n namespaces?: Record>;\n }\n interface InvalidateCache$3 extends InvalidateCacheGetByOneOf$3 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$3;\n /** Invalidate by page id */\n page?: Page$3;\n /** Invalidate by URI path */\n uri?: URI$3;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$3;\n /** tell us why you're invalidating the cache. You don't need to add your app name */\n reason?: string | null;\n /** Is local DS */\n localDc?: boolean;\n }\n /** @oneof */\n interface InvalidateCacheGetByOneOf$3 {\n /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */\n metaSiteId?: string;\n /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */\n siteId?: string;\n /** Invalidate by App */\n app?: App$3;\n /** Invalidate by page id */\n page?: Page$3;\n /** Invalidate by URI path */\n uri?: URI$3;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$3;\n }\n interface App$3 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$3 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$3 {\n /** the msid the URI is on */\n metaSiteId?: string;\n /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */\n uriPath?: string;\n }\n interface File$3 {\n /** the msid the file is related to */\n metaSiteId?: string;\n /** Invalidate by filename (for media files such as PDFs) */\n fileName?: string;\n }\n interface CreateLabelRequest {\n /** Item label details. */\n label: Label;\n }\n interface CreateLabelResponse {\n /** Item label. */\n label?: Label;\n }\n interface GetLabelRequest {\n /** Item label ID. */\n labelId: string;\n }\n interface GetLabelResponse {\n /** Item label. */\n label?: Label;\n }\n interface ListLabelsRequest {\n }\n interface ListLabelsResponse {\n /** Retrieved item labels. */\n labels?: Label[];\n }\n interface QueryLabelsRequest {\n /** Query options. */\n query?: CursorQuery$3;\n }\n interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$3;\n /**\n * Filter object in the following format:\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n */\n filter?: Record | null;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$3 {\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */\n cursorPaging?: CursorPaging$3;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n }\n enum SortOrder$3 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$3 {\n /** Number of items to load. */\n limit?: number | null;\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null;\n }\n interface QueryLabelsResponse {\n /** Retrieved item labels. */\n labels?: Label[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata$3;\n }\n interface CursorPagingMetadata$3 {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$3;\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n */\n hasNext?: boolean | null;\n }\n interface Cursors$3 {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null;\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface UpdateLabelRequest {\n /** Item label to update. */\n label: Label;\n }\n interface UpdateLabelResponse {\n /** Updated item label. */\n label?: Label;\n }\n interface DeleteLabelRequest {\n /** ID of the item label. */\n labelId: string;\n }\n interface DeleteLabelResponse {\n }\n interface CloneLabelsRequest {\n /** The MetaSiteId to clone from. */\n metaSiteId: string;\n }\n interface CloneLabelsResponse {\n }\n interface DomainEvent$3 extends DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n /**\n * Unique event ID.\n * Allows clients to ignore duplicate webhooks.\n */\n _id?: string;\n /**\n * Assumes actions are also always typed to an entity_type\n * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction\n */\n entityFqdn?: string;\n /**\n * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\n * This is although the created/updated/deleted notion is duplication of the oneof types\n * Example: created/updated/deleted/started/completed/email_opened\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */\n eventTime?: Date;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number defining the order of updates to the underlying entity.\n * For example, given that some entity was updated at 16:00 and than again at 16:01,\n * it is guaranteed that the sequence number of the second update is strictly higher than the first.\n * As the consumer, you can use this value to ensure that you handle messages in the correct order.\n * To do so, you will need to persist this number on your end, and compare the sequence number from the\n * message against the one you have stored. Given that the stored number is higher, you should ignore the message.\n */\n entityEventSequence?: string | null;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$3 {\n createdEvent?: EntityCreatedEvent$3;\n updatedEvent?: EntityUpdatedEvent$3;\n deletedEvent?: EntityDeletedEvent$3;\n actionEvent?: ActionEvent$3;\n }\n interface EntityCreatedEvent$3 {\n entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n }\n interface RestoreInfo$3 {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$3 {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntityAsJson?: string;\n }\n interface EntityDeletedEvent$3 {\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface Empty$3 {\n }\n interface MessageEnvelope$3 {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$3;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityType$3;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$3 {\n /** ID of a site visitor that has not logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor that has logged in to the site. */\n memberId?: string;\n /** ID of a Wix user (site owner, contributor, etc.). */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n }\n enum WebhookIdentityType$3 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * > **Note:** The Label API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).\n *\n * Creates an item label.\n * @param label - Item label details.\n * @public\n * @documentationMaturity preview\n * @requiredField label\n * @permissionScope Manage Bookings Services and Settings\n * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION\n * @permissionScope Manage Restaurants Menus\n * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS\n * @permissionScope Manage Portfolio\n * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO\n * @permissionScope Manage Restaurants - all permissions\n * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES\n * @applicableIdentity APP\n * @adminMethod\n * @returns Item label.\n */\n function createLabel(label: Label): Promise